eventespresso / event-espresso-core

core/EE_Deprecated.core.php

Indentation +87 added lines, -87 removed lines

@@ -1047,11 +1047,11 @@ 
 			'filter'
 		);
 		return apply_filters(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            $existing_attendee, $registration, $attendee_data
-        );
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			$existing_attendee, $registration, $attendee_data
+		);
 	},
-    10,3
+	10,3
 );
 
 
@@ -1064,88 +1064,88 @@ 
 class EE_Event_List_Query extends WP_Query
 {
 
-    private $title;
-
-    private $css_class;
-
-    private $category_slug;
-
-    /**
-     * EE_Event_List_Query constructor.
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
-                'event_espresso'
-            ),
-            '4.9.27',
-            '5.0.0'
-        );
-        $this->title = isset($args['title']) ? $args['title'] : '';
-        $this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
-        $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
-        $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        $args = array_merge(
-            $args, array(
-            'post_type'              => 'espresso_events',
-            'posts_per_page'         => $limit,
-            'update_post_term_cache' => false,
-            'update_post_meta_cache' => false,
-            'paged'                  => $paged,
-            'offset'                 => ($paged - 1) * $limit
-        )
-        );
-        // run the query
-        parent::__construct($args);
-    }
-
-
-
-    /**
-     * event_list_title
-     *
-     * @param string $event_list_title
-     * @return string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-
-    /**
-     * event_list_css
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->css_class)
-            ? $this->css_class
-            : '';
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->category_slug)
-            ? $this->category_slug
-            : '';
-        return $event_list_css;
-    }
+	private $title;
+
+	private $css_class;
+
+	private $category_slug;
+
+	/**
+	 * EE_Event_List_Query constructor.
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
+				'event_espresso'
+			),
+			'4.9.27',
+			'5.0.0'
+		);
+		$this->title = isset($args['title']) ? $args['title'] : '';
+		$this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
+		$this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
+		$limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		$args = array_merge(
+			$args, array(
+			'post_type'              => 'espresso_events',
+			'posts_per_page'         => $limit,
+			'update_post_term_cache' => false,
+			'update_post_meta_cache' => false,
+			'paged'                  => $paged,
+			'offset'                 => ($paged - 1) * $limit
+		)
+		);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+
+	/**
+	 * event_list_title
+	 *
+	 * @param string $event_list_title
+	 * @return string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+
+	/**
+	 * event_list_css
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->css_class)
+			? $this->css_class
+			: '';
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->category_slug)
+			? $this->category_slug
+			: '';
+		return $event_list_css;
+	}
 
 }

Spacing +177 added lines, -177 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * ************************************************************************
@@ -43,8 +43,8 @@ 
 	$action_or_filter = 'action'
 ) {
 	$action_or_filter = $action_or_filter === 'action'
-		? esc_html__( 'action', 'event_espresso' )
-		: esc_html__( 'filter', 'event_espresso' );
+		? esc_html__('action', 'event_espresso')
+		: esc_html__('filter', 'event_espresso');
 	EE_Error::doing_it_wrong(
 		$deprecated_filter,
 		sprintf(
@@ -68,7 +68,7 @@ 
  * @param \EE_Checkout $checkout
  * @return string
  */
-function ee_deprecated__registration_checkout__button_text( $submit_button_text, EE_Checkout $checkout ) {
+function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout) {
 	// list of old filters
 	$deprecated_filters = array(
 		'update_registration_details' => true,
@@ -78,16 +78,16 @@ 
 		'proceed_to' => true,
 	);
 	// loop thru and call doing_it_wrong() or remove any that aren't being used
-	foreach ( $deprecated_filters as $deprecated_filter => $on ) {
+	foreach ($deprecated_filters as $deprecated_filter => $on) {
 		// was this filter called ?
-		if ( has_action( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter )) {
+		if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) {
 			// only display doing_it_wrong() notice to Event Admins during non-AJAX requests
-			if ( EE_Registry::instance()->CAP->current_user_can( 'ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter' ) && ! defined( 'DOING_AJAX' ) ) {
+			if (EE_Registry::instance()->CAP->current_user_can('ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter') && ! defined('DOING_AJAX')) {
 				EE_Error::doing_it_wrong(
-					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
 					sprintf(
-						__( 'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso' ),
-						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+						__('The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso'),
+						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
 						'<br />',
 						'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
 						'/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
@@ -96,24 +96,24 @@ 
 				);
 			}
 		} else {
-			unset( $deprecated_filters[ $deprecated_filter ] );
+			unset($deprecated_filters[$deprecated_filter]);
 		}
 	}
-	if ( ! empty( $deprecated_filters )) {
-
-		if ( $checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset( $deprecated_filters[ 'update_registration_details' ] )) {
-			$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text );
-		} else if ( $checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset( $deprecated_filters[ 'process_payment' ] ) ) {
-			$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text );
-		} else if ( $checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset( $deprecated_filters[ 'finalize_registration' ] ) ) {
-			$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text );
+	if ( ! empty($deprecated_filters)) {
+
+		if ($checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
+			$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text);
+		} else if ($checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
+			$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text);
+		} else if ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
+			$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text);
 		}
-		if ( $checkout->next_step instanceof EE_SPCO_Reg_Step ) {
-			if ( $checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset( $deprecated_filters[ 'and_proceed_to_payment' ] ) ) {
-				$submit_button_text .= apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text );
+		if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
+				$submit_button_text .= apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text);
 			}
-			if ( $checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset( $deprecated_filters[ 'proceed_to' ] ) ) {
-				$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text ) . $checkout->next_step->name();
+			if ($checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
+				$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text).$checkout->next_step->name();
 			}
 		}
 
@@ -121,7 +121,7 @@ 
 	return $submit_button_text;
 
 }
-add_filter( 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2 );
+add_filter('FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2);
 
 
 
@@ -132,16 +132,16 @@ 
  * @param \EE_Checkout $checkout
  * @param boolean $status_updates
  */
-function ee_deprecated_finalize_transaction( EE_Checkout $checkout, $status_updates ) {
+function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates) {
 	$action_ref = NULL;
-	$action_ref = has_action( 'AHEE__EE_Transaction__finalize__new_transaction' ) ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
-	$action_ref = has_action( 'AHEE__EE_Transaction__finalize__all_transaction' ) ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
-	if ( $action_ref ) {
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction') ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction') ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
+	if ($action_ref) {
 
 		EE_Error::doing_it_wrong(
 			$action_ref,
 			sprintf(
-				__( 'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso' ),
+				__('This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso'),
 				'<br />',
 				'/core/business/EE_Transaction_Processor.class.php',
 				'AHEE__EE_Transaction_Processor__finalize',
@@ -151,39 +151,39 @@ 
 			),
 			'4.6.0'
 		);
-		switch ( $action_ref ) {
+		switch ($action_ref) {
 			case 'AHEE__EE_Transaction__finalize__new_transaction' :
-				do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request );
+				do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request);
 				break;
 			case 'AHEE__EE_Transaction__finalize__all_transaction' :
-				do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array( 'new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates ), $checkout->admin_request );
+				do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates), $checkout->admin_request);
 				break;
 		}
 	}
 }
-add_action( 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2 );
+add_action('AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2);
 /**
  * ee_deprecated_finalize_registration
  *
  * @param EE_Registration $registration
  */
-function ee_deprecated_finalize_registration( EE_Registration $registration ) {
-	$action_ref = has_action( 'AHEE__EE_Registration__finalize__update_and_new_reg' ) ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL;
-	if ( $action_ref ) {
+function ee_deprecated_finalize_registration(EE_Registration $registration) {
+	$action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg') ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL;
+	if ($action_ref) {
 		EE_Error::doing_it_wrong(
 			$action_ref,
 			sprintf(
-				__( 'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso' ),
+				__('This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso'),
 				'<br />',
 				'/core/business/EE_Registration_Processor.class.php',
 				'AHEE__EE_Registration_Processor__trigger_registration_status_changed_hook'
 			),
 			'4.6.0'
 		);
-		do_action( 'AHEE__EE_Registration__finalize__update_and_new_reg', $registration, ( is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )));
+		do_action('AHEE__EE_Registration__finalize__update_and_new_reg', $registration, (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX)));
 	}
 }
-add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1 );
+add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1);
 
 
 
@@ -191,7 +191,7 @@ 
  * Called after EED_Module::set_hooks() and EED_Module::set_admin_hooks() was called.
  * Checks if any deprecated hooks were hooked-into and provide doing_it_wrong messages appropriately.
  */
-function ee_deprecated_hooks(){
+function ee_deprecated_hooks() {
 	/**
 	 * @var $hooks array where keys are hook names, and their values are array{
 	 *			@type string $version  when deprecated
@@ -202,25 +202,25 @@ 
 	$hooks = array(
 		'AHEE__EE_System___do_setup_validations' => array(
 			'version' => '4.6.0',
-			'alternative' => __( 'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso' ),
+			'alternative' => __('Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso'),
 			'still_works' => FALSE
 		)
 	);
-	foreach( $hooks as $name => $deprecation_info ){
-		if( has_action( $name ) ){
+	foreach ($hooks as $name => $deprecation_info) {
+		if (has_action($name)) {
 			EE_Error::doing_it_wrong(
 				$name,
 				sprintf(
-					__('This filter is deprecated. %1$s%2$s','event_espresso'),
-					$deprecation_info[ 'still_works' ] ?  __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __( 'It has been completely removed.', 'event_espresso' ),
-					isset( $deprecation_info[ 'alternative' ] ) ? $deprecation_info[ 'alternative' ] : __( 'Please read the current EE4 documentation further or contact Support.', 'event_espresso' )
+					__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
+					$deprecation_info['still_works'] ? __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __('It has been completely removed.', 'event_espresso'),
+					isset($deprecation_info['alternative']) ? $deprecation_info['alternative'] : __('Please read the current EE4 documentation further or contact Support.', 'event_espresso')
 				),
-				isset( $deprecation_info[ 'version' ] ) ? $deprecation_info[ 'version' ] : __( 'recently', 'event_espresso' )
+				isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso')
 			);
 		}
 	}
 }
-add_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks' );
+add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks');
 
 
 
@@ -231,9 +231,9 @@ 
  * @return boolean
  */
 function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() {
-	$in_use =  has_filter( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns' )
-			|| has_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save' );
-	if( $in_use ) {
+	$in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
+			|| has_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save');
+	if ($in_use) {
 		$msg = __(
 			'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
 			. 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
@@ -242,18 +242,18 @@ 
 			'event_espresso' )
 		;
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FUNCTION__,
+			__CLASS__.'::'.__FUNCTION__,
 			$msg,
 			'4.8.32.rc.000'
 		);
 		//it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
-		if ( is_admin() && ! defined( 'DOING_AJAX' ) ) {
-			EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if (is_admin() && ! defined('DOING_AJAX')) {
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 		}
 	}
 	return $in_use;
 }
-add_action( 'AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks' );
+add_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks');
 
 /**
  * @deprecated since 4.8.32.rc.000 because it has issues on https://events.codebasehq.com/projects/event-espresso/tickets/9165
@@ -262,34 +262,34 @@ 
  * @param EE_Admin_Page $admin_page
  * @return void
  */
-function ee_deprecated_update_attendee_registration_form_old( $admin_page ) {
+function ee_deprecated_update_attendee_registration_form_old($admin_page) {
 	//check if the old hooks are in use. If not, do the default
-	if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-		|| ! $admin_page instanceof EE_Admin_Page ) {
+	if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
 		return;
 	}
 	$req_data = $admin_page->get_request_data();
-	$qstns = isset( $req_data['qstn'] ) ? $req_data['qstn'] : FALSE;
-	$REG_ID = isset( $req_data['_REG_ID'] ) ? absint( $req_data['_REG_ID'] ) : FALSE;
-	$qstns = apply_filters( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns );
-	if ( ! $REG_ID || ! $qstns ) {
-		EE_Error::add_error( __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+	$qstns = isset($req_data['qstn']) ? $req_data['qstn'] : FALSE;
+	$REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : FALSE;
+	$qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
+	if ( ! $REG_ID || ! $qstns) {
+		EE_Error::add_error(__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 	}
 	$success = TRUE;
 
 	// allow others to get in on this awesome fun   :D
-	do_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns );
+	do_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns);
 	// loop thru questions... FINALLY!!!
 
-	foreach ( $qstns as $QST_ID => $qstn ) {
+	foreach ($qstns as $QST_ID => $qstn) {
 		//if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-		if ( !is_array($qstn) ) {
-			$success = $this->_save_new_answer( $REG_ID, $QST_ID, $qstn);
+		if ( ! is_array($qstn)) {
+			$success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
 			continue;
 		}
 
 
-		foreach ( $qstn as $ANS_ID => $ANS_value ) {
+		foreach ($qstn as $ANS_ID => $ANS_value) {
 			//get answer
 			$query_params = array(
 				0 => array(
@@ -300,7 +300,7 @@ 
 				);
 			$answer = EEM_Answer::instance()->get_one($query_params);
 			//this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-			if ( ! $answer instanceof EE_Answer ) {
+			if ( ! $answer instanceof EE_Answer) {
 				$set_values = array(
 					'QST_ID' => $QST_ID,
 					'REG_ID' => $REG_ID,
@@ -315,11 +315,11 @@ 
 		}
 	}
 	$what = __('Registration Form', 'event_espresso');
-	$route = $REG_ID ? array( 'action' => 'view_registration', '_REG_ID' => $REG_ID ) : array( 'action' => 'default' );
-	$admin_page->redirect_after_action( $success, $what, __('updated', 'event_espresso'), $route );
+	$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
+	$admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
 	exit;
 }
-add_action( 'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1 );
+add_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1);
 /**
  * Render the registration admin page's custom questions area in the old fashion
  * and firing the old hooks. When this method is removed, we can probably also
@@ -332,31 +332,31 @@ 
  * @return bool
  * @throws \EE_Error
  */
-function ee_deprecated_reg_questions_meta_box_old( $do_default_action, $admin_page, $registration ) {
+function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration) {
 	//check if the old hooks are in use. If not, do the default
-	if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-		|| ! $admin_page instanceof EE_Admin_Page ) {
+	if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
 		return $do_default_action;
 	}
-	add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array( $admin_page, 'form_before_question_group' ), 10, 1 );
-	add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array( $admin_page, 'form_after_question_group' ), 10, 1 );
-	add_filter( 'FHEE__EEH_Form_Fields__label_html', array( $admin_page, 'form_form_field_label_wrap' ), 10, 1 );
-	add_filter( 'FHEE__EEH_Form_Fields__input_html', array( $admin_page, 'form_form_field_input__wrap' ), 10, 1 );
+	add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array($admin_page, 'form_before_question_group'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array($admin_page, 'form_after_question_group'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
 
-	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options( $registration, $registration->get('EVT_ID') );
+	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options($registration, $registration->get('EVT_ID'));
 
-	EE_Registry::instance()->load_helper( 'Form_Fields' );
+	EE_Registry::instance()->load_helper('Form_Fields');
 	$template_args = array(
-		'att_questions' => EEH_Form_Fields::generate_question_groups_html( $question_groups ),
+		'att_questions' => EEH_Form_Fields::generate_question_groups_html($question_groups),
 		'reg_questions_form_action' => 'edit_registration',
 		'REG_ID' => $registration->ID()
 	);
-	$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-	echo EEH_Template::display_template( $template_path, $template_args, TRUE );
+	$template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
+	echo EEH_Template::display_template($template_path, $template_args, TRUE);
 	//indicate that we should not do the default admin page code
 	return false;
 }
-add_action( 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3 );
+add_action('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3);
 
 
 
@@ -397,9 +397,9 @@ 
 			'4.9.0'
 		);
 		/** @var EE_Message_Resource_Manager $message_resource_manager */
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$messenger = $message_resource_manager->get_messenger( $messenger_name );
-		$message_type = $message_resource_manager->get_message_type( $message_type_name );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $message_resource_manager->get_messenger($messenger_name);
+		$message_type = $message_resource_manager->get_message_type($message_type_name);
 		return EE_Registry::instance()->load_lib(
 			'Messages_Template_Defaults',
 			array(
@@ -464,15 +464,15 @@ 
 	/**
 	 * @param string $method
 	 */
-	public function _class_is_deprecated( $method ) {
+	public function _class_is_deprecated($method) {
 		EE_Error::doing_it_wrong(
-			'EE_messages::' . $method,
-			__( 'EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.' ),
+			'EE_messages::'.$method,
+			__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
 			'4.9.0',
 			'4.10.0.p'
 		);
 		// Please use EE_Message_Resource_Manager instead
-		$this->_message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 	}
 
 
@@ -482,10 +482,10 @@ 
 	 * @param string $messenger_name
 	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
 	 */
-	public function ensure_messenger_is_active( $messenger_name ) {
+	public function ensure_messenger_is_active($messenger_name) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->ensure_messenger_is_active( $messenger_name );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
 	}
 
 
@@ -497,10 +497,10 @@ 
 	 * @return bool true if it got activated (or was active) and false if not.
 	 * @throws \EE_Error
 	 */
-	public function ensure_message_type_is_active( $message_type, $messenger ) {
+	public function ensure_message_type_is_active($message_type, $messenger) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->ensure_message_type_is_active( $message_type, $messenger );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
 	}
 
 
@@ -513,10 +513,10 @@ 
 	 *                                            they are already setup.)
 	 * @return boolean an array of generated templates or false if nothing generated/activated.
 	 */
-	public function activate_messenger( $messenger_name, $mts_to_activate = array() ) {
+	public function activate_messenger($messenger_name, $mts_to_activate = array()) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->activate_messenger( $messenger_name, $mts_to_activate );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
 	}
 
 
@@ -528,10 +528,10 @@ 
 	 *
 	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
 	 */
-	public function is_generating_messenger_and_active( EE_messenger $messenger, EE_message_type $message_type ) {
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->is_generating_messenger_and_active( $messenger, $message_type );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
 	}
 
 
@@ -541,10 +541,10 @@ 
 	 * @param string $messenger
 	 * @return EE_messenger | null
 	 */
-	public function get_messenger_if_active( $messenger ) {
+	public function get_messenger_if_active($messenger) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_active_messenger( $messenger );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_messenger($messenger);
 	}
 
 
@@ -565,9 +565,9 @@ 
 	 *                  'message_type' => null
 	 *                  )
 	 */
-	public function validate_for_use( EE_Message $message ) {
+	public function validate_for_use(EE_Message $message) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return array(
 			'messenger'    => $message->messenger_object(),
 			'message_type' => $message->message_type_object(),
@@ -595,41 +595,41 @@ 
 		$send = true
 	) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		/** @type EE_Messages_Processor $processor */
-		$processor = EE_Registry::instance()->load_lib( 'Messages_Processor' );
+		$processor = EE_Registry::instance()->load_lib('Messages_Processor');
 		$error = false;
 		//try to intelligently determine what method we'll call based on the incoming data.
 		//if generating and sending are different then generate and send immediately.
-		if ( ! empty( $sending_messenger ) && $sending_messenger != $generating_messenger && $send ) {
+		if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
 			//in the legacy system, when generating and sending were different, that means all the
 			//vars are already in the request object.  So let's just use that.
 			try {
 				/** @type EE_Message_To_Generate_From_Request $mtg */
-				$mtg = EE_Registry::instance()->load_lib( 'Message_To_Generate_From_Request' );
-				$processor->generate_and_send_now( $mtg );
-			} catch ( EE_Error $e ) {
+				$mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+				$processor->generate_and_send_now($mtg);
+			} catch (EE_Error $e) {
 				$error_msg = __(
 					'Please note that a system message failed to send due to a technical issue.',
 					'event_espresso'
 				);
 				// add specific message for developers if WP_DEBUG in on
-				$error_msg .= '||' . $e->getMessage();
-				EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
+				$error_msg .= '||'.$e->getMessage();
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
 				$error = true;
 			}
 		} else {
-			$processor->generate_for_all_active_messengers( $type, $vars, $send );
+			$processor->generate_for_all_active_messengers($type, $vars, $send);
 			//let's find out if there were any errors and how many successfully were queued.
 			$count_errors = $processor->get_queue()->count_STS_in_queue(
-				array( EEM_Message::status_failed, EEM_Message::status_debug_only )
+				array(EEM_Message::status_failed, EEM_Message::status_debug_only)
 			);
-			$count_queued = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_incomplete );
-			$count_retry = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_retry );
+			$count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
+			$count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
 			$count_errors = $count_errors + $count_retry;
-			if ( $count_errors > 0 ) {
+			if ($count_errors > 0) {
 				$error = true;
-				if ( $count_errors > 1 && $count_retry > 1 && $count_queued > 1 ) {
+				if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
 					$message = sprintf(
 						__(
 							'There were %d errors and %d messages successfully queued for generation and sending',
@@ -638,7 +638,7 @@ 
 						$count_errors,
 						$count_queued
 					);
-				} elseif ( $count_errors > 1 && $count_queued === 1 ) {
+				} elseif ($count_errors > 1 && $count_queued === 1) {
 					$message = sprintf(
 						__(
 							'There were %d errors and %d message successfully queued for generation.',
@@ -647,7 +647,7 @@ 
 						$count_errors,
 						$count_queued
 					);
-				} elseif ( $count_errors === 1 && $count_queued > 1 ) {
+				} elseif ($count_errors === 1 && $count_queued > 1) {
 					$message = sprintf(
 						__(
 							'There was %d error and %d messages successfully queued for generation.',
@@ -665,9 +665,9 @@ 
 						$count_errors
 					);
 				}
-				EE_Error::add_error( $message, __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
 			} else {
-				if ( $count_queued === 1 ) {
+				if ($count_queued === 1) {
 					$message = sprintf(
 						__(
 							'%d message successfully queued for generation.',
@@ -684,18 +684,18 @@ 
 						$count_queued
 					);
 				}
-				EE_Error::add_success( $message );
+				EE_Error::add_success($message);
 			}
 		}
 		//if no error then return the generated message(s).
-		if ( ! $error && ! $send ) {
-			$generated_queue = $processor->generate_queue( false );
+		if ( ! $error && ! $send) {
+			$generated_queue = $processor->generate_queue(false);
 			//get message and return.
 			$generated_queue->get_message_repository()->rewind();
 			$messages = array();
-			while ( $generated_queue->get_message_repository()->valid() ) {
+			while ($generated_queue->get_message_repository()->valid()) {
 				$message = $generated_queue->get_message_repository()->current();
-				if ( $message instanceof EE_Message ) {
+				if ($message instanceof EE_Message) {
 					//set properties that might be expected by add-ons (backward compat)
 					$message->content = $message->content();
 					$message->template_pack = $message->get_template_pack();
@@ -720,10 +720,10 @@ 
 	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular preview
 	 * @return string          The body of the message.
 	 */
-	public function preview_message( $type, $context, $messenger, $send = false ) {
+	public function preview_message($type, $context, $messenger, $send = false) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return EED_Messages::preview_message( $type, $context, $messenger, $send );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return EED_Messages::preview_message($type, $context, $messenger, $send);
 	}
 
 
@@ -737,14 +737,14 @@ 
 	 *
 	 * @return bool          success or fail.
 	 */
-	public function send_message_with_messenger_only( $messenger, $message_type, $message ) {
+	public function send_message_with_messenger_only($messenger, $message_type, $message) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		//setup for sending to new method.
 		/** @type EE_Messages_Queue $queue */
-		$queue = EE_Registry::instance()->load_lib( 'Messages_Queue' );
+		$queue = EE_Registry::instance()->load_lib('Messages_Queue');
 		//make sure we have a proper message object
-		if ( ! $message instanceof EE_Message && is_object( $message ) && isset( $message->content ) ) {
+		if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
 			$msg = EE_Message_Factory::create(
 				array(
 					'MSG_messenger'    => $messenger,
@@ -756,15 +756,15 @@ 
 		} else {
 			$msg = $message;
 		}
-		if ( ! $msg instanceof EE_Message ) {
+		if ( ! $msg instanceof EE_Message) {
 			return false;
 		}
 		//make sure any content in a content property (if not empty) is set on the MSG_content.
-		if ( ! empty( $msg->content ) ) {
-			$msg->set( 'MSG_content', $msg->content );
+		if ( ! empty($msg->content)) {
+			$msg->set('MSG_content', $msg->content);
 		}
-		$queue->add( $msg );
-		return EED_Messages::send_message_with_messenger_only( $messenger, $message_type, $queue );
+		$queue->add($msg);
+		return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
 	}
 
 
@@ -778,11 +778,11 @@ 
 	 * @return array|object if creation is successful then we return an array of info, otherwise an error_object is returned.
 	 * @throws \EE_Error
 	 */
-	public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) {
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::create_new_templates( $messenger, $message_type, $GRP_ID, $is_global );
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
 	}
 
 
@@ -793,11 +793,11 @@ 
 	 * @param  string $message_type_name name of EE_message_type
 	 * @return array
 	 */
-	public function get_fields( $messenger_name, $message_type_name ) {
+	public function get_fields($messenger_name, $message_type_name) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::get_fields( $messenger_name, $message_type_name );
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
 	}
 
 
@@ -811,13 +811,13 @@ 
 	 * @return array                    multidimensional array of messenger and message_type objects
 	 *                                    (messengers index, and message_type index);
 	 */
-	public function get_installed( $type = 'all', $skip_cache = false ) {
+	public function get_installed($type = 'all', $skip_cache = false) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		if ( $skip_cache ) {
+		$this->_class_is_deprecated(__FUNCTION__);
+		if ($skip_cache) {
 			$this->_message_resource_manager->reset_active_messengers_and_message_types();
 		}
-		switch ( $type ) {
+		switch ($type) {
 			case 'messengers' :
 				return array(
 					'messenger' => $this->_message_resource_manager->installed_messengers(),
@@ -846,7 +846,7 @@ 
 	 */
 	public function get_active_messengers() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->active_messengers();
 	}
 
@@ -858,7 +858,7 @@ 
 	 */
 	public function get_active_message_types() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->list_of_active_message_types();
 	}
 
@@ -870,7 +870,7 @@ 
 	 */
 	public function get_active_message_type_objects() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->get_active_message_type_objects();
 	}
 
@@ -882,10 +882,10 @@ 
 	 * @param string $messenger The messenger being checked
 	 * @return EE_message_type[]    (or empty array if none present)
 	 */
-	public function get_active_message_types_per_messenger( $messenger ) {
+	public function get_active_message_types_per_messenger($messenger) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_active_message_types_for_messenger( $messenger );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
 	}
 
 
@@ -896,10 +896,10 @@ 
 	 * @param string $message_type The string should correspond to a message type.
 	 * @return EE_message_type|null
 	 */
-	public function get_active_message_type( $messenger, $message_type ) {
+	public function get_active_message_type($messenger, $message_type) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_active_message_type_for_messenger( $messenger, $message_type );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
 	}
 
 
@@ -910,7 +910,7 @@ 
 	 */
 	public function get_installed_message_types() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->installed_message_types();
 	}
 
@@ -922,7 +922,7 @@ 
 	 */
 	public function get_installed_messengers() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->installed_messengers();
 	}
 
@@ -933,10 +933,10 @@ 
 	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by message type.
 	 * @return array
 	 */
-	public function get_all_contexts( $slugs_only = true ) {
+	public function get_all_contexts($slugs_only = true) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_all_contexts( $slugs_only );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_all_contexts($slugs_only);
 	}
 
 
@@ -995,7 +995,7 @@ 
 add_filter(
 	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
 	function($event_list_iframe_css) {
-		if ( ! has_filter( 'FHEE__EventsArchiveIframe__event_list_iframe__css' )) {
+		if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
 			return $event_list_iframe_css;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1015,7 +1015,7 @@ 
 add_filter(
 	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
 	function($event_list_iframe_js) {
-		if ( ! has_filter( 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js' )) {
+		if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
 			return $event_list_iframe_js;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1035,7 +1035,7 @@ 
 add_filter(
 	'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
 	function($existing_attendee, $registration, $attendee_data) {
-		if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
+		if ( ! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
 			return $existing_attendee;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1051,7 +1051,7 @@ 
             $existing_attendee, $registration, $attendee_data
         );
 	},
-    10,3
+    10, 3
 );
 
 
@@ -1117,7 +1117,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;

core/db_classes/EE_Registration.class.php

Indentation +1685 added lines, -1685 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\EntityNotFoundException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -15,1690 +15,1690 @@ 
 {
 
 
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Registration
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param        int $EVT_ID Event ID
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code' :
-                if (! empty($field_value) && $this->reg_code() === null) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID' :
-                $this->set_status($field_value, $use_default);
-                break;
-            default :
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string  $new_STS_ID
-     * @param boolean $use_default
-     * @return bool
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function set_status($new_STS_ID = null, $use_default = false)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if (
-            $old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->_reserve_registration_space();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
-                // OR FROM  approved
-            } else if ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->_release_registration_space();
-                do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-            $this->transaction()->update_status_based_on_total_paid(true);
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID);
-            return true;
-        }
-        //even though the old value matches the new value, it's still good to
-        //allow the parent set method to have a say
-        parent::set('STS_ID', $new_STS_ID, $use_default);
-        return true;
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string $new_STS_ID
-     * @param string $old_STS_ID
-     * @throws \EE_Error
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
-            return;
-        }
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
-        }
-    }
-
-
-    /**
-     *        get Status ID
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _reserve_registration_space()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket();
-        $ticket = $this->ticket();
-        $ticket->increase_sold();
-        $ticket->save();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = array();
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     */
-    public function event()
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @since 4.5.0
-     * @return int
-     */
-    public function wp_user()
-    {
-        $event = $this->event();
-        if ($event instanceof EE_Event) {
-            return $event->wp_user();
-        }
-        return 0;
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _release_registration_space()
-    {
-        $ticket = $this->ticket();
-        $ticket->decrease_sold();
-        $ticket->save();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function reserve_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param        int $ATT_ID Attendee ID
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param        int $TXN_ID Transaction ID
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param    string $REG_session PHP Session ID
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param    string $REG_url_link Registration URL Link
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param        int $REG_count Primary Attendee
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param        boolean $REG_group_size Group Registration
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                       Date
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @access    public
-     * @param    float $REG_final_price
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @access    public
-     * @param    float $REG_paid
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param        boolean $REG_att_is_going Attendee Is Going
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Event
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function receipt_url($messenger = 'html')
-    {
-
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-        $has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
-
-        if ($has_custom) {
-            return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
-        }
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-        $has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
-
-        if ($has_custom) {
-            if ($messenger == 'html') {
-                return $this->invoice_url('launch');
-            }
-            $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
-
-            $query_args = array('ee' => $route, 'id' => $this->reg_url_link());
-            if ($messenger == 'html') {
-                $query_args['html'] = true;
-            }
-            return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
-        }
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @access public
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_url_link()
-    {
-        return (string)$this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo $this->invoice_url($type);
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo $this->payment_overview_url();
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     */
-    public function payment_overview_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'payment_options',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'attendee_information',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(array(
-            'page'    => 'espresso_registrations',
-            'action'  => 'view_registration',
-            '_REG_ID' => $this->ID(),
-        ), admin_url('admin.php'));
-    }
-
-
-    /**
-     *    is_primary_registrant?
-     */
-    public function is_primary_registrant()
-    {
-        return $this->get('REG_count') == 1 ? true : false;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        $primary_registrant = EEM_Registration::instance()->get_one(array(
-            array(
-                'TXN_ID'    => $this->transaction_ID(),
-                'REG_count' => 1,
-            ),
-        ));
-        return $primary_registrant;
-    }
-
-
-    /**
-     *        get  Attendee Number
-     *
-     * @access        public
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     *        get Group Size
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     *        get Registration Date
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return    float
-     */
-    public function final_price()
-    {
-        return $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return    float
-     */
-    public function paid()
-    {
-        return $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return    float
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment
-     * @return bool
-     */
-    public function owes_monies_and_can_pay($requires_payment = array())
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
-        if (
-            in_array($this->status_ID(), $requires_payment) &&
-            $this->final_price() != 0 &&
-            $this->final_price() != $this->paid()
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')),
-            false, 'sentence');
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
-                break;
-        }
-        return $icon . $status[$this->status_ID()];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Answer[]
-     */
-    public function answers($query_params = null)
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     */
-    public function question_groups()
-    {
-        $question_groups = array();
-        if ($this->event() instanceof EE_Event) {
-            $question_groups = $this->event()->question_groups(
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC'),
-                )
-            );
-        }
-        return $question_groups;
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     */
-    public function count_question_groups()
-    {
-        $qg_count = 0;
-        if ($this->event() instanceof EE_Event) {
-            $qg_count = $this->event()->count_related(
-                'Question_Group',
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                )
-            );
-        }
-        return $qg_count;
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Datetime_Ticket
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Datetime_Ticket
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return boolean
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        //first check registration status
-        if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
-            return false;
-        }
-        //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
-            array(
-                'TKT_ID' => $this->get('TKT_ID'),
-                'DTT_ID' => $DTT_ID,
-            ),
-        )))
-        ) {
-            return false;
-        }
-
-        //final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool   true means can checkin.  false means cannot checkin.
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
-        // or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        //does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        //go ahead and toggle.
-        if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
-            return true;
-        }
-
-        //made it here so the last check is whether the number of checkins per unique datetime on this registration
-        //disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
-            array(
-                'REG_ID' => $this->ID(),
-                'CHK_in' => true,
-            ),
-        ), 'DTT_ID', true);
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        $status_paths = array(
-            EE_Registration::checkin_status_never => EE_Registration::checkin_status_in,
-            EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
-            EE_Registration::checkin_status_out   => EE_Registration::checkin_status_in,
-        );
-        //start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
-        $status_to  = $status_paths[$cur_status];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(array(
-            'REG_ID' => $this->ID(),
-            'DTT_ID' => $DTT_ID,
-            'CHK_in' => $new_status,
-        ));
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    __('Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = __('Registration check in update failed because of an unknown database error',
-                    'event_espresso');
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws \EE_Error
-     */
-    public function get_latest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'DESC'),
-            )
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws \EE_Error
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int       $DTT_ID  The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                Integer representing Check-in status.
-     * @throws \EE_Error
-     */
-    public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
-    {
-        $checkin_query_params = array(
-            'order_by' => array('CHK_timestamp' => 'DESC'),
-        );
-
-        if ($DTT_ID > 0) {
-            $checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
-        }
-
-        //get checkin object (if exists)
-        $checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related('Checkin', $checkin_query_params);
-        if ($checkin instanceof EE_Checkin) {
-            if ($checkin->get('CHK_in')) {
-                return EE_Registration::checkin_status_in; //checked in
-            }
-            return EE_Registration::checkin_status_out; //had checked in but is now checked out.
-        }
-        return EE_Registration::checkin_status_never; //never been checked in
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                     then it is assumed Check-in for primary datetime was toggled.
-     * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
-     *                     message can be customized with the attendee name.
-     * @return string         internationalized message
-     */
-    public function get_checkin_msg($DTT_ID, $error = false)
-    {
-        //let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            //what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Registration::checkin_status_never :
-                    return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
-                        $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_in :
-                    return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                    break;
-                case EE_Registration::checkin_status_out :
-                    return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-                    break;
-            }
-        }
-        return __("The check-in status could not be determined.", "event_espresso");
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *        get Registration Code
-     */
-    public function reg_code()
-    {
-        return $this->get('REG_code');
-    }
-
-
-    /**
-     *        get Transaction ID
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     *        Set Registration Code
-     *
-     * @access    public
-     * @param    string  $REG_code Registration Code
-     * @param    boolean $use_default
-     */
-    public function set_reg_code($REG_code, $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                __('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @since 4.5.0
-     * @return EE_Registration[]  or empty array if this isn't a group registration.
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return array();
-        }
-
-        $query[0] = array(
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => array('!=', $this->ID()),
-            'TKT_ID' => $this->ticket_ID(),
-        );
-
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page' => 'espresso_registrations',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration[]
-     * @throws \EE_Error
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::price_paid()',
-            __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        return $this->final_price();
-    }
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     * @param    float $REG_final_price
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
-            __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.7.0
-     * @return string
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
-            __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'), '4.7.0');
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Registration
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param        int $EVT_ID Event ID
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code' :
+				if (! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID' :
+				$this->set_status($field_value, $use_default);
+				break;
+			default :
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string  $new_STS_ID
+	 * @param boolean $use_default
+	 * @return bool
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if (
+			$old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->_reserve_registration_space();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
+				// OR FROM  approved
+			} else if ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->_release_registration_space();
+				do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID);
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+			$this->transaction()->update_status_based_on_total_paid(true);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID);
+			return true;
+		}
+		//even though the old value matches the new value, it's still good to
+		//allow the parent set method to have a say
+		parent::set('STS_ID', $new_STS_ID, $use_default);
+		return true;
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string $new_STS_ID
+	 * @param string $old_STS_ID
+	 * @throws \EE_Error
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__canceled_or_declined', $this, $old_STS_ID, $new_STS_ID);
+			return;
+		}
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action('AHEE__EE_Registration__set_status__after_reinstated', $this, $old_STS_ID, $new_STS_ID);
+		}
+	}
+
+
+	/**
+	 *        get Status ID
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _reserve_registration_space()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
+		$ticket = $this->ticket();
+		$ticket->increase_sold();
+		$ticket->save();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = array();
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 */
+	public function event()
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof \EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		$event = $this->event();
+		if ($event instanceof EE_Event) {
+			return $event->wp_user();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _release_registration_space()
+	{
+		$ticket = $this->ticket();
+		$ticket->decrease_sold();
+		$ticket->save();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function reserve_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param        int $ATT_ID Attendee ID
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param        int $TXN_ID Transaction ID
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param    string $REG_session PHP Session ID
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param    string $REG_url_link Registration URL Link
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param        int $REG_count Primary Attendee
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param        boolean $REG_group_size Group Registration
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                       Date
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @access    public
+	 * @param    float $REG_final_price
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @access    public
+	 * @param    float $REG_paid
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param        boolean $REG_att_is_going Attendee Is Going
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Event
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
+		$has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
+
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
+		}
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
+		$has_custom             = EEH_Template::locate_template($template_relative_path, array(), true, true, true);
+
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
+			}
+			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
+
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
+				$query_args['html'] = true;
+			}
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
+		}
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @access public
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_url_link()
+	{
+		return (string)$this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo $this->invoice_url($type);
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo $this->payment_overview_url();
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 */
+	public function payment_overview_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'payment_options',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'attendee_information',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(array(
+			'page'    => 'espresso_registrations',
+			'action'  => 'view_registration',
+			'_REG_ID' => $this->ID(),
+		), admin_url('admin.php'));
+	}
+
+
+	/**
+	 *    is_primary_registrant?
+	 */
+	public function is_primary_registrant()
+	{
+		return $this->get('REG_count') == 1 ? true : false;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		$primary_registrant = EEM_Registration::instance()->get_one(array(
+			array(
+				'TXN_ID'    => $this->transaction_ID(),
+				'REG_count' => 1,
+			),
+		));
+		return $primary_registrant;
+	}
+
+
+	/**
+	 *        get  Attendee Number
+	 *
+	 * @access        public
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 *        get Group Size
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 *        get Registration Date
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return    float
+	 */
+	public function final_price()
+	{
+		return $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return    float
+	 */
+	public function paid()
+	{
+		return $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return    float
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment
+	 * @return bool
+	 */
+	public function owes_monies_and_can_pay($requires_payment = array())
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
+		if (
+			in_array($this->status_ID(), $requires_payment) &&
+			$this->final_price() != 0 &&
+			$this->final_price() != $this->paid()
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')),
+			false, 'sentence');
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>' : '';
+				break;
+		}
+		return $icon . $status[$this->status_ID()];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Answer[]
+	 */
+	public function answers($query_params = null)
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 */
+	public function question_groups()
+	{
+		$question_groups = array();
+		if ($this->event() instanceof EE_Event) {
+			$question_groups = $this->event()->question_groups(
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+					'order_by' => array('QSG_order' => 'ASC'),
+				)
+			);
+		}
+		return $question_groups;
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 */
+	public function count_question_groups()
+	{
+		$qg_count = 0;
+		if ($this->event() instanceof EE_Event) {
+			$qg_count = $this->event()->count_related(
+				'Question_Group',
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+				)
+			);
+		}
+		return $qg_count;
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Datetime_Ticket
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Datetime_Ticket
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return boolean
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		//first check registration status
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
+			return false;
+		}
+		//is there a datetime ticket that matches this dtt_ID?
+		if (! (EEM_Datetime_Ticket::instance()->exists(array(
+			array(
+				'TKT_ID' => $this->get('TKT_ID'),
+				'DTT_ID' => $DTT_ID,
+			),
+		)))
+		) {
+			return false;
+		}
+
+		//final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool   true means can checkin.  false means cannot checkin.
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
+		// or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		//go ahead and toggle.
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
+			return true;
+		}
+
+		//made it here so the last check is whether the number of checkins per unique datetime on this registration
+		//disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
+			array(
+				'REG_ID' => $this->ID(),
+				'CHK_in' => true,
+			),
+		), 'DTT_ID', true);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					__('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		$status_paths = array(
+			EE_Registration::checkin_status_never => EE_Registration::checkin_status_in,
+			EE_Registration::checkin_status_in    => EE_Registration::checkin_status_out,
+			EE_Registration::checkin_status_out   => EE_Registration::checkin_status_in,
+		);
+		//start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
+		$status_to  = $status_paths[$cur_status];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Registration::checkin_status_in ? true : false;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(array(
+			'REG_ID' => $this->ID(),
+			'DTT_ID' => $DTT_ID,
+			'CHK_in' => $new_status,
+		));
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					__('Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = __('Registration check in update failed because of an unknown database error',
+					'event_espresso');
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws \EE_Error
+	 */
+	public function get_latest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'DESC'),
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws \EE_Error
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int       $DTT_ID  The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                Integer representing Check-in status.
+	 * @throws \EE_Error
+	 */
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
+	{
+		$checkin_query_params = array(
+			'order_by' => array('CHK_timestamp' => 'DESC'),
+		);
+
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
+		}
+
+		//get checkin object (if exists)
+		$checkin = $checkin instanceof EE_Checkin
+			? $checkin
+			: $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
+				return EE_Registration::checkin_status_in; //checked in
+			}
+			return EE_Registration::checkin_status_out; //had checked in but is now checked out.
+		}
+		return EE_Registration::checkin_status_never; //never been checked in
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                     then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                     message can be customized with the attendee name.
+	 * @return string         internationalized message
+	 */
+	public function get_checkin_msg($DTT_ID, $error = false)
+	{
+		//let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			//what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Registration::checkin_status_never :
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
+						$attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_in :
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+					break;
+				case EE_Registration::checkin_status_out :
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+					break;
+			}
+		}
+		return __("The check-in status could not be determined.", "event_espresso");
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *        get Registration Code
+	 */
+	public function reg_code()
+	{
+		return $this->get('REG_code');
+	}
+
+
+	/**
+	 *        get Transaction ID
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 *        Set Registration Code
+	 *
+	 * @access    public
+	 * @param    string  $REG_code Registration Code
+	 * @param    boolean $use_default
+	 */
+	public function set_reg_code($REG_code, $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @since 4.5.0
+	 * @return EE_Registration[]  or empty array if this isn't a group registration.
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return array();
+		}
+
+		$query[0] = array(
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => array('!=', $this->ID()),
+			'TKT_ID' => $this->ticket_ID(),
+		);
+
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page' => 'espresso_registrations',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration[]
+	 * @throws \EE_Error
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()',
+			__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 * @param    float $REG_final_price
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
+			__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.7.0
+	 * @return string
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
+			__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'), '4.7.0');
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 }

modules/ticket_selector/DisplayTicketSelector.php

Indentation +675 added lines, -675 removed lines

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

admin_pages/events/Events_Admin_Page.core.php

Indentation +2687 added lines, -2687 removed lines

@@ -15,2694 +15,2694 @@
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * This will hold the event object for event_details screen.
-     *
-     * @access protected
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug = EVENTS_PG_SLUG;
-        $this->page_label = EVENTS_LABEL;
-        $this->_admin_base_url = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = array(
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_events' => 'edit',
-        );
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            array($this, 'verify_event_edit'), 10, 2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels = array(
-            'buttons'      => array(
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ),
-            'editor_title' => array(
-                'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
-            ),
-            'publishbox'   => array(
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ),
-        );
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        //load formatter helper
-        //load field generator helper
-        //is there a evt_id in the request?
-        $evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
-            ? $this->_req_data['EVT_ID']
-            : 0;
-        $evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
-        $this->_page_routes = array(
-            'default'                       => array(
-                'func'       => '_events_overview_list_table',
-                'capability' => 'ee_read_events',
-            ),
-            'create_new'                    => array(
-                'func'       => '_create_new_cpt_item',
-                'capability' => 'ee_edit_events',
-            ),
-            'edit'                          => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-            ),
-            'copy_event'                    => array(
-                'func'       => '_copy_events',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'trash_event'                   => array(
-                'func'       => '_trash_or_restore_event',
-                'args'       => array('event_status' => 'trash'),
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'trash_events'                  => array(
-                'func'       => '_trash_or_restore_events',
-                'args'       => array('event_status' => 'trash'),
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'restore_event'                 => array(
-                'func'       => '_trash_or_restore_event',
-                'args'       => array('event_status' => 'draft'),
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'restore_events'                => array(
-                'func'       => '_trash_or_restore_events',
-                'args'       => array('event_status' => 'draft'),
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'delete_event'                  => array(
-                'func'       => '_delete_event',
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $evt_id,
-                'noheader'   => true,
-            ),
-            'delete_events'                 => array(
-                'func'       => '_delete_events',
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ),
-            'view_report'                   => array(
-                'func'      => '_view_report',
-                'capablity' => 'ee_edit_events',
-            ),
-            'default_event_settings'        => array(
-                'func'       => '_default_event_settings',
-                'capability' => 'manage_options',
-            ),
-            'update_default_event_settings' => array(
-                'func'       => '_update_default_event_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'template_settings'             => array(
-                'func'       => '_template_settings',
-                'capability' => 'manage_options',
-            ),
-            //event category tab related
-            'add_category'                  => array(
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => array('add'),
-            ),
-            'edit_category'                 => array(
-                'func'       => '_category_details',
-                'capability' => 'ee_edit_event_category',
-                'args'       => array('edit'),
-            ),
-            'delete_categories'             => array(
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ),
-            'delete_category'               => array(
-                'func'       => '_delete_categories',
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ),
-            'insert_category'               => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => true),
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ),
-            'update_category'               => array(
-                'func'       => '_insert_or_update_category',
-                'args'       => array('new_category' => false),
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ),
-            'category_list'                 => array(
-                'func'       => '_category_list_table',
-                'capability' => 'ee_manage_event_categories',
-            ),
-        );
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => array(
-                    'events_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ),
-                    'events_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ),
-                    'events_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ),
-                    'events_overview_view_help_tab'                  => array(
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ),
-                    'events_overview_other_help_tab'                 => array(
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Overview_Help_Tour',
-                    //'New_Features_Test_Help_Tour' for testing multiple help tour
-                ),
-                'qtips'         => array(
-                    'EE_Event_List_Table_Tips',
-                ),
-                'require_nonce' => false,
-            ),
-            'create_new'             => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
-                'help_tabs'     => array(
-                    'event_editor_help_tab'                            => array(
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ),
-                    'event_editor_title_richtexteditor_help_tab'       => array(
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ),
-                    'event_editor_venue_details_help_tab'              => array(
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ),
-                    'event_editor_event_datetimes_help_tab'            => array(
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ),
-                    'event_editor_event_tickets_help_tab'              => array(
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ),
-                    'event_editor_event_registration_options_help_tab' => array(
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ),
-                    'event_editor_tags_categories_help_tab'            => array(
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ),
-                    'event_editor_questions_registrants_help_tab'      => array(
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ),
-                    'event_editor_save_new_event_help_tab'             => array(
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ),
-                    'event_editor_other_help_tab'                      => array(
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Editor_Help_Tour',
-                ),
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
-                'require_nonce' => false,
-            ),
-            'edit'                   => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['post'])
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            array('post' => $this->_req_data['post'], 'action' => 'edit'),
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('_register_event_editor_meta_boxes'),
-                'help_tabs'     => array(
-                    'event_editor_help_tab'                            => array(
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ),
-                    'event_editor_title_richtexteditor_help_tab'       => array(
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ),
-                    'event_editor_venue_details_help_tab'              => array(
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ),
-                    'event_editor_event_datetimes_help_tab'            => array(
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ),
-                    'event_editor_event_tickets_help_tab'              => array(
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ),
-                    'event_editor_event_registration_options_help_tab' => array(
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ),
-                    'event_editor_tags_categories_help_tab'            => array(
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ),
-                    'event_editor_questions_registrants_help_tab'      => array(
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ),
-                    'event_editor_save_new_event_help_tab'             => array(
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ),
-                    'event_editor_other_help_tab'                      => array(
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ),
-                ),
-                /*'help_tour' => array(
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @access protected
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug = EVENTS_PG_SLUG;
+		$this->page_label = EVENTS_LABEL;
+		$this->_admin_base_url = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = array(
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_events' => 'edit',
+		);
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			array($this, 'verify_event_edit'), 10, 2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', array($this, 'save_timezonestring_setting'));
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels = array(
+			'buttons'      => array(
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			),
+			'editor_title' => array(
+				'espresso_events' => esc_html__('Enter event title here', 'event_espresso'),
+			),
+			'publishbox'   => array(
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			),
+		);
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		//load formatter helper
+		//load field generator helper
+		//is there a evt_id in the request?
+		$evt_id = ! empty($this->_req_data['EVT_ID']) && ! is_array($this->_req_data['EVT_ID'])
+			? $this->_req_data['EVT_ID']
+			: 0;
+		$evt_id = ! empty($this->_req_data['post']) ? $this->_req_data['post'] : $evt_id;
+		$this->_page_routes = array(
+			'default'                       => array(
+				'func'       => '_events_overview_list_table',
+				'capability' => 'ee_read_events',
+			),
+			'create_new'                    => array(
+				'func'       => '_create_new_cpt_item',
+				'capability' => 'ee_edit_events',
+			),
+			'edit'                          => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+			),
+			'copy_event'                    => array(
+				'func'       => '_copy_events',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'trash_event'                   => array(
+				'func'       => '_trash_or_restore_event',
+				'args'       => array('event_status' => 'trash'),
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'trash_events'                  => array(
+				'func'       => '_trash_or_restore_events',
+				'args'       => array('event_status' => 'trash'),
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'restore_event'                 => array(
+				'func'       => '_trash_or_restore_event',
+				'args'       => array('event_status' => 'draft'),
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'restore_events'                => array(
+				'func'       => '_trash_or_restore_events',
+				'args'       => array('event_status' => 'draft'),
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'delete_event'                  => array(
+				'func'       => '_delete_event',
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $evt_id,
+				'noheader'   => true,
+			),
+			'delete_events'                 => array(
+				'func'       => '_delete_events',
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			),
+			'view_report'                   => array(
+				'func'      => '_view_report',
+				'capablity' => 'ee_edit_events',
+			),
+			'default_event_settings'        => array(
+				'func'       => '_default_event_settings',
+				'capability' => 'manage_options',
+			),
+			'update_default_event_settings' => array(
+				'func'       => '_update_default_event_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'template_settings'             => array(
+				'func'       => '_template_settings',
+				'capability' => 'manage_options',
+			),
+			//event category tab related
+			'add_category'                  => array(
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => array('add'),
+			),
+			'edit_category'                 => array(
+				'func'       => '_category_details',
+				'capability' => 'ee_edit_event_category',
+				'args'       => array('edit'),
+			),
+			'delete_categories'             => array(
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			),
+			'delete_category'               => array(
+				'func'       => '_delete_categories',
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			),
+			'insert_category'               => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => true),
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			),
+			'update_category'               => array(
+				'func'       => '_insert_or_update_category',
+				'args'       => array('new_category' => false),
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			),
+			'category_list'                 => array(
+				'func'       => '_category_list_table',
+				'capability' => 'ee_manage_event_categories',
+			),
+		);
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => array(
+					'events_overview_help_tab'                       => array(
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					),
+					'events_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					),
+					'events_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					),
+					'events_overview_view_help_tab'                  => array(
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					),
+					'events_overview_other_help_tab'                 => array(
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Overview_Help_Tour',
+					//'New_Features_Test_Help_Tour' for testing multiple help tour
+				),
+				'qtips'         => array(
+					'EE_Event_List_Table_Tips',
+				),
+				'require_nonce' => false,
+			),
+			'create_new'             => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
+				'help_tabs'     => array(
+					'event_editor_help_tab'                            => array(
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					),
+					'event_editor_title_richtexteditor_help_tab'       => array(
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					),
+					'event_editor_venue_details_help_tab'              => array(
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					),
+					'event_editor_event_datetimes_help_tab'            => array(
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					),
+					'event_editor_event_tickets_help_tab'              => array(
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					),
+					'event_editor_event_registration_options_help_tab' => array(
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					),
+					'event_editor_tags_categories_help_tab'            => array(
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					),
+					'event_editor_questions_registrants_help_tab'      => array(
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					),
+					'event_editor_save_new_event_help_tab'             => array(
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					),
+					'event_editor_other_help_tab'                      => array(
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Editor_Help_Tour',
+				),
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
+				'require_nonce' => false,
+			),
+			'edit'                   => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['post'])
+						? EE_Admin_Page::add_query_args_and_nonce(
+							array('post' => $this->_req_data['post'], 'action' => 'edit'),
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('_register_event_editor_meta_boxes'),
+				'help_tabs'     => array(
+					'event_editor_help_tab'                            => array(
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					),
+					'event_editor_title_richtexteditor_help_tab'       => array(
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					),
+					'event_editor_venue_details_help_tab'              => array(
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					),
+					'event_editor_event_datetimes_help_tab'            => array(
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					),
+					'event_editor_event_tickets_help_tab'              => array(
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					),
+					'event_editor_event_registration_options_help_tab' => array(
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					),
+					'event_editor_tags_categories_help_tab'            => array(
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					),
+					'event_editor_questions_registrants_help_tab'      => array(
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					),
+					'event_editor_save_new_event_help_tab'             => array(
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					),
+					'event_editor_other_help_tab'                      => array(
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					),
+				),
+				/*'help_tour' => array(
 					'Event_Edit_Help_Tour'
 				),*/
-                'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
-                'require_nonce' => false,
-            ),
-            'default_event_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'labels'        => array(
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ),
-                'help_tabs'     => array(
-                    'default_settings_help_tab'        => array(
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ),
-                    'default_settings_status_help_tab' => array(
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ),
-                    'default_maximum_tickets_help_tab' => array(
-                        'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    )
-                ),
-                'help_tour'     => array('Event_Default_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            //template settings
-            'template_settings'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => array(
-                    'general_settings_templates_help_tab' => array(
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ),
-                ),
-                'help_tour'     => array('Templates_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            //event category stuff
-            'add_category'           => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'add_category_help_tab' => array(
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ),
-                ),
-                'help_tour'     => array('Event_Add_Category_Help_Tour'),
-                'metaboxes'     => array('_publish_post_box'),
-                'require_nonce' => false,
-            ),
-            'edit_category'          => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['EVT_CAT_ID'])
-                        ? add_query_arg(
-                            array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ),
-                'help_tabs'     => array(
-                    'edit_category_help_tab' => array(
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ),
-                ),
-                /*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
-                'metaboxes'     => array('_publish_post_box'),
-                'require_nonce' => false,
-            ),
-            'category_list'          => array(
-                'nav'           => array(
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => array(
-                    'events_categories_help_tab'                       => array(
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ),
-                    'events_categories_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ),
-                    'events_categories_view_help_tab'                  => array(
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ),
-                    'events_categories_other_help_tab'                 => array(
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ),
-                ),
-                'help_tour'     => array(
-                    'Event_Categories_Help_Tour',
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        //todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
-        //registers for all views
-        //scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        //scripts
-        wp_register_script(
-            'event-datetime-metabox',
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-            array('event_editor_js', 'ee-datepicker'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script('event-datetime-metabox');
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param  EE_Event $event Event object
-     * @param string    $req_type
-     * @return void
-     * @throws EE_Error
-     * @access public
-     */
-    public function verify_event_edit($event = null, $req_type = '')
-    {
-        // don't need to do this when processing
-        if(!empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (empty($event)) {
-            // set event
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        //made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        } else if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        //now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if ( ! $event->tickets_on_sale()) {
-            return;
-        }
-        //made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            esc_html__(
-                'Please be advised that this event has been published and is open for registrations on your website. If you update any registration-related details (i.e. custom questions, messages, tickets, datetimes, etc.) while a registration is in process, the registration process could be interrupted and result in errors for the person registering and potentially incorrect registration or transaction data inside Event Espresso. We recommend editing events during a period of slow traffic, or even temporarily changing the status of an event to "Draft" until your edits are complete.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        //only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button-secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-            'draft' => array(
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     * @return array
-     */
-    protected function _event_legend_items()
-    {
-        $items = array(
-            'view_details'   => array(
-                'class' => 'dashicons dashicons-search',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ),
-            'edit_event'     => array(
-                'class' => 'ee-icon ee-icon-calendar-edit',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ),
-            'view_attendees' => array(
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ),
-        );
-        $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = array(
-            'sold_out_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ),
-            'active_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ),
-            'upcoming_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ),
-            'postponed_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ),
-            'expired_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ),
-            'inactive_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ),
-        );
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-
-    /**
-     * @return EEM_Event
-     */
-    private function _event_model()
-    {
-        if ( ! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * 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 extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        //make sure this is only when editing
-        if ( ! empty($id)) {
-            $post = get_post($id);
-            $return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
-                       . esc_html__('Shortcode', 'event_espresso')
-                       . '</a> ';
-            $return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
-                       . $post->ID
-                       . ']">';
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _events_overview_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
-            ? (array)$this->_template_args['after_list_table']
-            : array();
-        $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
-                                                                              . EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__("View Event Archive Page", "event_espresso"),
-                'button'
-            );
-        $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'create_new',
-                'add',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from other meta saves.
-     * So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param  object $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            //get out we're not processing an event save.
-            return;
-        }
-        $event_values = array(
-            'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
-            'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
-            'EVT_additional_limit'            => min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                ! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
-            ),
-            'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
-                ? $this->_req_data['EVT_default_registration_status']
-                : EE_Registry::instance()->CFG->registration->default_STS_ID,
-            'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
-            'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
-            'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
-                ? $this->_req_data['timezone_string'] : null,
-            'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
-                ? $this->_req_data['externalURL'] : null,
-            'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
-                ? $this->_req_data['event_phone'] : null,
-        );
-        //update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        //get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
-        $get_one_where = array(
-            $this->_event_model()->primary_key_name() => $post_id,
-            'OR' => array(
-                'status' => $post->post_status,
-                // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                // but the returned object here has a status of "publish", so use the original post status as well
-                'status*1' => $this->_req_data['original_post_status'],
-            )
-        );
-        $event = $this->_event_model()->get_one(array($get_one_where));
-        //the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array(
-                array($this, '_default_venue_update'),
-                array($this, '_default_tickets_update')
-            )
-        );
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = $e_callback($event, $this->_req_data);
-            //if ANY of these updates fail then we want the appropriate global error message
-            $att_success = ! $att_success ? $att_success : $_success;
-        }
-        //any errors?
-        if ($success && false === $att_success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else if ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-
-    /**
-     * @see parent::restore_item()
-     * @param int $post_id
-     * @param int $revision_id
-     */
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-        //copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            //meta revision restore
-            $post_evt->restore_revision($revision_id);
-            //related objs restore
-            $post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
-        }
-    }
-
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param  \EE_Event $evtobj Event Object to add the venue to
-     * @param  array     $data   The request data from the form
-     * @return bool           Success or fail.
-     */
-    protected function _default_venue_update(\EE_Event $evtobj, $data)
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $rows_affected = null;
-        $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = array(
-            'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
-            'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        );
-        //if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if ( ! empty($venue_id)) {
-            $update_where = array($venue_model->primary_key_name() => $venue_id);
-            $rows_affected = $venue_model->update($venue_array, array($update_where));
-            //we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0 ? true : false;
-        } else {
-            //we insert the venue
-            $venue_id = $venue_model->insert($venue_array);
-            $evtobj->_add_relation_to($venue_id, 'Venue');
-            return ! empty($venue_id) ? true : false;
-        }
-        //when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param  EE_Event $evtobj The Event object we're attaching data to
-     * @param  array    $data   The request data from the form
-     * @return array
-     */
-    protected function _default_tickets_update(EE_Event $evtobj, $data)
-    {
-        $success = true;
-        $saved_dtt = null;
-        $saved_tickets = array();
-        $incoming_date_formats = array('Y-m-d', 'h:i a');
-        foreach ($data['edit_event_datetimes'] as $row => $dtt) {
-            //trim all values to ensure any excess whitespace is removed.
-            $dtt = array_map('trim', $dtt);
-            $dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
-                : $dtt['DTT_EVT_start'];
-            $datetime_values = array(
-                'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
-                'DTT_EVT_start' => $dtt['DTT_EVT_start'],
-                'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            );
-            //if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
-            if ( ! empty($dtt['DTT_ID'])) {
-                $DTM = EE_Registry::instance()
-                                  ->load_model('Datetime', array($evtobj->get_timezone()))
-                                  ->get_one_by_ID($dtt['DTT_ID']);
-                $DTM->set_date_format($incoming_date_formats[0]);
-                $DTM->set_time_format($incoming_date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-                //make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
-                $saved_dtts[$DTM->ID()] = $DTM;
-            } else {
-                $DTM = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
-                    false,
-                    false
-                );
-                foreach ($datetime_values as $field => $value) {
-                    $DTM->set($field, $value);
-                }
-            }
-            $DTM->save();
-            $DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
-            //load DTT helper
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
-                $DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
-                $DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
-                $DTT->save();
-            }
-            //now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
-            $saved_dtt = $DTT;
-            $success = ! $success ? $success : $DTT;
-            //if ANY of these updates fail then we want the appropriate global error message.
-            // //todo this is actually sucky we need a better error message but this is what it is for now.
-        }
-        //no dtts get deleted so we don't do any of that logic here.
-        //update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
-        foreach ($data['edit_tickets'] as $row => $tkt) {
-            $incoming_date_formats = array('Y-m-d', 'h:i a');
-            $update_prices = false;
-            $ticket_price = isset($data['edit_prices'][$row][1]['PRC_amount'])
-                ? $data['edit_prices'][$row][1]['PRC_amount'] : 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map('trim', $tkt);
-            if (empty($tkt['TKT_start_date'])) {
-                //let's use now in the set timezone.
-                $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
-            }
-            if (empty($tkt['TKT_end_date'])) {
-                //use the start date of the first datetime
-                $dtt = $evtobj->first_datetime();
-                $tkt['TKT_end_date'] = $dtt->start_date_and_time(
-                    $incoming_date_formats[0],
-                    $incoming_date_formats[1]
-                );
-            }
-            $TKT_values = array(
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
-                'TKT_price'       => $ticket_price,
-            );
-            //if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID'] = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $TKT_values['TKT_price'] = $ticket_price;
-                $update_prices = true;
-            }
-            //if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            //we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
-            //keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if ( ! empty($tkt['TKT_ID'])) {
-                $TKT = EE_Registry::instance()
-                                  ->load_model('Ticket', array($evtobj->get_timezone()))
-                                  ->get_one_by_ID($tkt['TKT_ID']);
-                if ($TKT instanceof EE_Ticket) {
-                    $ticket_sold = $TKT->count_related(
-                        'Registration',
-                        array(
-                            array(
-                                'STS_ID' => array(
-                                    'NOT IN',
-                                    array(EEM_Registration::status_id_incomplete),
-                                ),
-                            ),
-                        )
-                    ) > 0 ? true : false;
-                    //let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
-                                      && ! $TKT->get(
-                        'TKT_deleted'
-                    ) ? true : false;
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field == 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    //if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        //archive the old ticket first
-                        $TKT->set('TKT_deleted', 1);
-                        $TKT->save();
-                        //make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
-                        $saved_tickets[$TKT->ID()] = $TKT;
-                        //create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
-                        $TKT = clone $TKT;
-                        $TKT->set('TKT_ID', 0);
-                        $TKT->set('TKT_deleted', 0);
-                        $TKT->set('TKT_price', $ticket_price);
-                        $TKT->set('TKT_sold', 0);
-                        //now we need to make sure that $new prices are created as well and attached to new ticket.
-                        $update_prices = true;
-                    }
-                    //make sure price is set if it hasn't been already
-                    $TKT->set('TKT_price', $ticket_price);
-                }
-            } else {
-                //no TKT_id so a new TKT
-                $TKT_values['TKT_price'] = $ticket_price;
-                $TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
-                if ($TKT instanceof EE_Ticket) {
-                    //need to reset values to properly account for the date formats
-                    $TKT->set_date_format($incoming_date_formats[0]);
-                    $TKT->set_time_format($incoming_date_formats[1]);
-                    $TKT->set_timezone($evtobj->get_timezone());
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field == 'TKT_qty') {
-                            $TKT->set_qty($value);
-                        } else {
-                            $TKT->set($field, $value);
-                        }
-                    }
-                    $update_prices = true;
-                }
-            }
-            // cap ticket qty by datetime reg limits
-            $TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
-            //update ticket.
-            $TKT->save();
-            //before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
-            if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
-                $TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
-                $TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
-                $TKT->save();
-            }
-            //initially let's add the ticket to the dtt
-            $saved_dtt->_add_relation_to($TKT, 'Ticket');
-            $saved_tickets[$TKT->ID()] = $TKT;
-            //add prices to ticket
-            $this->_add_prices_to_ticket($data['edit_prices'][$row], $TKT, $update_prices);
-        }
-        //however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            //get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
-            //need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
-            $dtts = $tkt_to_remove->get_many_related('Datetime');
-            foreach ($dtts as $dtt) {
-                $tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
-            }
-            //need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
-            //finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
-        return array($saved_dtt, $saved_tickets);
-    }
-
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices     Array of prices from the form.
-     * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
-     * @return  void
-     */
-    private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
-    {
-        foreach ($prices as $row => $prc) {
-            $PRC_values = array(
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => 0, //make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            );
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
-            } else {
-                $PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                //update this price with new values
-                foreach ($PRC_values as $field => $newprc) {
-                    $PRC->set($field, $newprc);
-                }
-                $PRC->save();
-            }
-            $ticket->_add_relation_to($PRC, 'Price');
-        }
-    }
-
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-        return; //TEMPORARILY EXITING CAUSE THIS IS A TODO
-    }
-
-
-
-    /**
-     *    _generate_publish_box_extra_content
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        //load formatter helper
-        //args for getting related registrations
-        $approved_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ),
-        );
-        $not_approved_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ),
-        );
-        $pending_payment_query_args = array(
-            array(
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ),
-        );
-        // publish box
-        $publish_box_extra_args = array(
-            'view_approved_reg_url'        => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ),
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ),
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                array(
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ),
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        );
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_tickets',
-            esc_html__('Event Datetime & Ticket', 'event_espresso'),
-            array($this, 'ticket_metabox'),
-            $this->page_slug,
-            'normal',
-            'high'
-        );
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            array($this, 'registration_options_meta_box'),
-            $this->page_slug,
-            'side',
-            'default'
-        );
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = array();
-        //defaults for template args
-        $template_args = array(
-            'existing_datetime_ids'    => '',
-            'event_datetime_help_link' => '',
-            'ticket_options_help_link' => '',
-            'time'                     => null,
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'trash_icon'               => 'ee-lock-icon',
-            'disabled'                 => '',
-        );
-        $event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        $times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        //do we get related tickets?
-        if ($first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time'] = $first_datetime;
-            $related_tickets = $first_datetime->tickets(
-                array(
-                    array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
-                    'default_where_conditions' => 'none',
-                )
-            );
-            if ( ! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[] = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket $ticket */
-            $ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure'] = $this->_get_ticket_row(
-            EE_Registry::instance()->load_model('Ticket')->create_default_object(),
-            true
-        );
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param  EE_Ticket $ticket   the ticket object
-     * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int        $row
-     * @return string generated html for the ticket row.
-     */
-    private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
-    {
-        $template_args = array(
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
-            'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        );
-        $price = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
-            : EE_Registry::instance()->load_model('Price')->create_default_object();
-        $price_args = array(
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        );
-        //make sure we have default start and end dates if skeleton
-        //handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            //if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            //get the earliest datetime (if present);
-            $earliest_dtt = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    array('order_by' => array('DTT_EVT_start' => 'ASC'))
-                )
-                : null;
-            if ( ! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
-            } else {
-                $template_args['TKT_end_date'] = date(
-                    'Y-m-d h:i a',
-                    mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
-                );
-            }
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws DomainException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = array(
-            array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
-            array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
-        );
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-            ),
-            true
-        );
-        //$template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event'] = $this->_cpt_model_obj;
-        $template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description'] = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array an array of event objects.
-     */
-    public function get_events($per_page = 10, $current_page = 1, $count = false)
-    {
-        $EEME = $this->_event_model();
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : $offset . ',' . $per_page;
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
-        if (isset($this->_req_data['month_range'])) {
-            $pieces = explode(' ', $this->_req_data['month_range'], 3);
-            //simulate the FIRST day of the month, that fixes issues for months like February
-            //where PHP doesn't know what to assume for date.
-            //@see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where = array();
-        $status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
-        //determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month' :
-            case 'today' :
-            case null :
-            case 'all' :
-                break;
-            case 'draft' :
-                $where['status'] = array('IN', array('draft', 'auto-draft'));
-                break;
-            default :
-                $where['status'] = $status;
-        }
-        //categories?
-        $category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
-            ? $this->_req_data['EVT_CAT'] : null;
-        if ( ! empty ($category)) {
-            $where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Term_Taxonomy.term_id'] = $category;
-        }
-        //date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone(EEM_Datetime::instance()->get_timezone())
-            );
-            $start = $DateTime->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate($year_r, $month_r, $DateTime
-                ->format('t'))->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        } else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
-            $DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        } else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
-            $now = date('Y-m-01');
-            $DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
-            $end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                            ->setTime(23, 59, 59)
-                            ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
-        }
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if ( ! isset($where['status'])) {
-                if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = array(
-                        'status*restrict_private' => array('!=', 'private'),
-                        'AND'                     => array(
-                            'status*inclusive' => array('=', 'private'),
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ),
-                    );
-                }
-            }
-        }
-        if (isset($this->_req_data['EVT_wp_user'])) {
-            if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
-                && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-            ) {
-                $where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
-            }
-        }
-        //search query handling
-        if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'EVT_name'       => array('LIKE', $search_string),
-                'EVT_desc'       => array('LIKE', $search_string),
-                'EVT_short_desc' => array('LIKE', $search_string),
-            );
-        }
-        $where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
-        $query_params = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            array(
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ),
-            $this->_req_data
-        );
-        //let's first check if we have special requests coming in.
-        if (isset($this->_req_data['active_status'])) {
-            switch ($this->_req_data['active_status']) {
-                case 'upcoming' :
-                    return $EEME->get_upcoming_events($query_params, $count);
-                    break;
-                case 'expired' :
-                    return $EEME->get_expired_events($query_params, $count);
-                    break;
-                case 'active' :
-                    return $EEME->get_active_events($query_params, $count);
-                    break;
-                case 'inactive' :
-                    return $EEME->get_inactive_events($query_params, $count);
-                    break;
-            }
-        }
-        $events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
-        return $events;
-    }
-
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-
-    /**
-     * @param string $post_id
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-
-    /**
-     * @param string $post_id
-     */
-    public function delete_cpt_item($post_id)
-    {
-        $this->_req_data['EVT_ID'] = $post_id;
-        $this->_delete_event(false);
-    }
-
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param  string $event_status
-     * @param bool    $redirect_after
-     */
-    protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
-    {
-        //determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if ( ! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
-        }
-    }
-
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param  string $event_status
-     * @return void
-     */
-    protected function _trash_or_restore_events($event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if ( ! empty($event_status)) {
-            $success = true;
-            //determine the event id and set to array.
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
-    }
-
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access  private
-     * @param  int    $EVT_ID
-     * @param  string $event_status
-     * @return bool
-     */
-    private function _change_event_status($EVT_ID = 0, $event_status = '')
-    {
-        // grab event id
-        if ( ! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft' :
-                $action = 'restored from the trash';
-                $hook = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash' :
-                $action = 'moved to the trash';
-                $hook = 'AHEE_event_moved_to_trash';
-                break;
-            default :
-                $action = 'updated';
-                $hook = false;
-        }
-        //use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if ($success === false) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * _delete_event
-     *
-     * @access protected
-     * @param bool $redirect_after
-     */
-    protected function _delete_event($redirect_after = true)
-    {
-        //determine the event id and set to array.
-        $EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
-        $EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
-        // loop thru events
-        if ($EVT_ID) {
-            $success = $this->_permanently_delete_event($EVT_ID);
-            // get list of events with no prices
-            $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
-            // remove this event from the list of events with no prices
-            if (isset($espresso_no_ticket_prices[$EVT_ID])) {
-                unset($espresso_no_ticket_prices[$EVT_ID]);
-            }
-            update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
-        } else {
-            $success = false;
-            $msg = esc_html__(
-                'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        if ($redirect_after) {
-            $this->_redirect_after_action(
-                $success,
-                'Event',
-                'deleted',
-                array('action' => 'default', 'status' => 'trash')
-            );
-        }
-    }
-
-
-
-    /**
-     * _delete_events
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _delete_events()
-    {
-        $success = true;
-        // get list of events with no prices
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
-        //determine the event id and set to array.
-        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
-        // loop thru events
-        foreach ($EVT_IDs as $EVT_ID) {
-            $EVT_ID = absint($EVT_ID);
-            if ($EVT_ID) {
-                $results = $this->_permanently_delete_event($EVT_ID);
-                $success = $results !== false ? $success : false;
-                // remove this event from the list of events with no prices
-                unset($espresso_no_ticket_prices[$EVT_ID]);
-            } else {
-                $success = false;
-                $msg = esc_html__(
-                    'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
-    }
-
-
-
-    /**
-     * _permanently_delete_event
-     *
-     * @access  private
-     * @param  int $EVT_ID
-     * @return bool
-     */
-    private function _permanently_delete_event($EVT_ID = 0)
-    {
-        // grab event id
-        if ( ! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (
-            ! $this->_cpt_model_obj instanceof EE_Event
-            || $this->_cpt_model_obj->ID() !== $EVT_ID
-        ) {
-            $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        if ( ! $this->_cpt_model_obj instanceof EE_Event) {
-            return false;
-        }
-        //need to delete related tickets and prices first.
-        $datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
-        foreach ($datetimes as $datetime) {
-            $this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
-            $tickets = $datetime->get_many_related('Ticket');
-            foreach ($tickets as $ticket) {
-                $ticket->_remove_relation_to($datetime, 'Datetime');
-                $ticket->delete_related_permanently('Price');
-                $ticket->delete_permanently();
-            }
-            $datetime->delete();
-        }
-        //what about related venues or terms?
-        $venues = $this->_cpt_model_obj->get_many_related('Venue');
-        foreach ($venues as $venue) {
-            $this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
-        }
-        //any attached question groups?
-        $question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
-        if ( ! empty($question_groups)) {
-            foreach ($question_groups as $question_group) {
-                $this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
-            }
-        }
-        //Message Template Groups
-        $this->_cpt_model_obj->_remove_relations('Message_Template_Group');
-        /** @type EE_Term_Taxonomy[] $term_taxonomies */
-        $term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
-        foreach ($term_taxonomies as $term_taxonomy) {
-            $this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
-        }
-        $success = $this->_cpt_model_obj->delete_permanently();
-        // did it all go as planned ?
-        if ($success) {
-            $msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
-            EE_Error::add_success($msg);
-        } else {
-            $msg = sprintf(
-                esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
-                $EVT_ID
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
-        return true;
-    }
-
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_events()
-    {
-        $count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_events_draft()
-    {
-        $where = array(
-            'status' => array('IN', array('draft', 'auto-draft')),
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     */
-    public function total_trashed_events()
-    {
-        $where = array(
-            'status' => 'trash',
-        );
-        $count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
-        return $count;
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     * @return EE_Form_Section_Proper
-     */
-    protected function _default_event_settings_form()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        //exclude
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ),
-            true
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'name' => 'update_default_event_settings',
-                'html_id' => 'update_default_event_settings',
-                'html_class' => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections' => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    array(
-                        'default_reg_status' => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            array(
-                                'default' => isset($registration_config->default_STS_ID)
-                                             && array_key_exists(
-                                                $registration_config->default_STS_ID,
-                                                $registration_stati_for_selection
-                                             )
-                                            ? sanitize_text_field($registration_config->default_STS_ID)
-                                            : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                    . EEH_Template::get_help_tab_link(
-                                                        'default_settings_status_help_tab'
-                                                    ),
-                                'html_help_text' => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'default_max_tickets' => new EE_Integer_Input(
-                            array(
-                                'default' => isset($registration_config->default_maximum_number_of_tickets)
-                                    ? $registration_config->default_maximum_number_of_tickets
-                                    : EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                ) . EEH_Template::get_help_tab_link(
-                                    'default_maximum_tickets_help_tab"'
-                                    ),
-                                'html_help_text' => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                )
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _update_default_event_settings
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_default_event_settings()
-    {
-        $registration_config = EE_Registry::instance()->CFG->registration;
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                //update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    __('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
-    }
-
-
-
-    /*************        Templates        *************/
-    protected function _template_settings()
-    {
-        $this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img'] = '<img src="'
-                                               . EVENTS_ASSETS_URL
-                                               . DS
-                                               . 'images'
-                                               . DS
-                                               . 'caffeinated_template_features.jpg" alt="'
-                                               . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                               . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__(
-                'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                'event_espresso'
-            ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        //set default category object
-        $this->_set_empty_category_object();
-        //only set if we've got an id
-        if ( ! isset($this->_req_data['EVT_CAT_ID'])) {
-            return;
-        }
-        $category_id = absint($this->_req_data['EVT_CAT_ID']);
-        $term = get_term($category_id, 'espresso_event_categories');
-        if ( ! empty($term)) {
-            $this->_category->category_name = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc = $term->description;
-            $this->_category->id = $term->term_id;
-            $this->_category->parent = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                'add_category',
-                'add_category',
-                array(),
-                'add-new-h2'
-            );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Output category details view.
-     */
-    protected function _category_details($view)
-    {
-        //load formatter helper
-        //load field generator helper
-        $route = $view == 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        //custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'category_list'),
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
-        //take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Output category details content.
-     */
-    protected function _category_details_content()
-    {
-        $editor_args['category_desc'] = array(
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => array('media_buttons' => false),
-        );
-        $_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms = get_terms(
-            array('espresso_event_categories'),
-            array('hide_empty' => 0, 'exclude' => array($this->_category->id))
-        );
-        //setup category select for term parents.
-        $category_select_values[] = array(
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        );
-        foreach ($all_terms as $term) {
-            $category_select_values[] = array(
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            );
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args = array(
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     */
-    protected function _delete_categories()
-    {
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
-            : (array)$this->_req_data['category_id'];
-        foreach ($cat_ids as $cat_id) {
-            $this->_delete_category($cat_id);
-        }
-        //doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = array(
-            'action' => 'category_list',
-        );
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-
-    /**
-     * Handles deleting specific category.
-     * @param int $cat_id
-     */
-    protected function _delete_category($cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, 'espresso_event_categories');
-    }
-
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     * @param bool $new_category  true means we're triggering the insert of a new category.
-     */
-    protected function _insert_or_update_category($new_category)
-    {
-        $cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
-        $success = 0; //we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = array(
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            );
-        } else {
-            $query_args = array('action' => 'add_category');
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-
-    /**
-     * Inserts or updates category
-     * @param bool $update (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category($update = false)
-    {
-        $cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
-        $category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
-        $category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
-        $category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $term_args = array(
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        );
-        //was the category_identifier input disabled?
-        if (isset($this->_req_data['category_identifier'])) {
-            $term_args['slug'] = $this->_req_data['category_identifier'];
-        }
-        $insert_ids = $update
-            ? wp_update_term($cat_id, 'espresso_event_categories', $term_args)
-            : wp_insert_term($category_name, 'espresso_event_categories', $term_args);
-        if ( ! is_array($insert_ids)) {
-            $msg = esc_html__(
-                'An error occurred and the category has not been saved to the database.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            $cat_id = $insert_ids['term_id'];
-            $msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
-            EE_Error::add_success($msg);
-        }
-        return $cat_id;
-    }
-
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
-     */
-    public function get_categories($per_page = 10, $current_page = 1, $count = false)
-    {
-        //testing term stuff
-        $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
-        $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
-        $limit = ($current_page - 1) * $per_page;
-        $where = array('taxonomy' => 'espresso_event_categories');
-        if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
-            $where['OR'] = array(
-                'Term.name'   => array('LIKE', $sstr),
-                'description' => array('LIKE', $sstr),
-            );
-        }
-        $query_params = array(
-            $where,
-            'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => array('Term'),
-        );
-        $categories = $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-        return $categories;
-    }
-
-    /* end category stuff */
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     * @throws EE_Error
-     */
-    public function save_timezonestring_setting()
-    {
-        $timezone_string = isset($this->_req_data['timezone_selected'])
-            ? $this->_req_data['timezone_selected']
-            : '';
-        if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
-        {
-            EE_Error::add_error(
-                esc_html('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, array('action' => 'create_new'));
-    }
+				'qtips'         => array('EE_Event_Editor_Decaf_Tips'),
+				'require_nonce' => false,
+			),
+			'default_event_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'labels'        => array(
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				),
+				'help_tabs'     => array(
+					'default_settings_help_tab'        => array(
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					),
+					'default_settings_status_help_tab' => array(
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					),
+					'default_maximum_tickets_help_tab' => array(
+						'title' => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					)
+				),
+				'help_tour'     => array('Event_Default_Settings_Help_Tour'),
+				'require_nonce' => false,
+			),
+			//template settings
+			'template_settings'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'order' => 30,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => array(
+					'general_settings_templates_help_tab' => array(
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					),
+				),
+				'help_tour'     => array('Templates_Help_Tour'),
+				'require_nonce' => false,
+			),
+			//event category stuff
+			'add_category'           => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'add_category_help_tab' => array(
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					),
+				),
+				'help_tour'     => array('Event_Add_Category_Help_Tour'),
+				'metaboxes'     => array('_publish_post_box'),
+				'require_nonce' => false,
+			),
+			'edit_category'          => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['EVT_CAT_ID'])
+						? add_query_arg(
+							array('EVT_CAT_ID' => $this->_req_data['EVT_CAT_ID']),
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				),
+				'help_tabs'     => array(
+					'edit_category_help_tab' => array(
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					),
+				),
+				/*'help_tour' => array('Event_Edit_Category_Help_Tour'),*/
+				'metaboxes'     => array('_publish_post_box'),
+				'require_nonce' => false,
+			),
+			'category_list'          => array(
+				'nav'           => array(
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => array(
+					'events_categories_help_tab'                       => array(
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					),
+					'events_categories_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					),
+					'events_categories_view_help_tab'                  => array(
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					),
+					'events_categories_other_help_tab'                 => array(
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					),
+				),
+				'help_tour'     => array(
+					'Event_Categories_Help_Tour',
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		//todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
+		//registers for all views
+		//scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		//scripts
+		wp_register_script(
+			'event-datetime-metabox',
+			EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+			array('event_editor_js', 'ee-datepicker'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script('event-datetime-metabox');
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param  EE_Event $event Event object
+	 * @param string    $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @access public
+	 */
+	public function verify_event_edit($event = null, $req_type = '')
+	{
+		// don't need to do this when processing
+		if(!empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (empty($event)) {
+			// set event
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		//made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		} else if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		//now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if ( ! $event->tickets_on_sale()) {
+			return;
+		}
+		//made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			esc_html__(
+				'Please be advised that this event has been published and is open for registrations on your website. If you update any registration-related details (i.e. custom questions, messages, tickets, datetimes, etc.) while a registration is in process, the registration process could be interrupted and result in errors for the person registering and potentially incorrect registration or transaction data inside Event Espresso. We recommend editing events during a period of slow traffic, or even temporarily changing the status of an event to "Draft" until your edits are complete.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		//only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button-secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+			'draft' => array(
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 * @return array
+	 */
+	protected function _event_legend_items()
+	{
+		$items = array(
+			'view_details'   => array(
+				'class' => 'dashicons dashicons-search',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			),
+			'edit_event'     => array(
+				'class' => 'ee-icon ee-icon-calendar-edit',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			),
+			'view_attendees' => array(
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			),
+		);
+		$items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = array(
+			'sold_out_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			),
+			'active_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			),
+			'upcoming_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			),
+			'postponed_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			),
+			'expired_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			),
+			'inactive_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			),
+		);
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+
+	/**
+	 * @return EEM_Event
+	 */
+	private function _event_model()
+	{
+		if ( ! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * 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 extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		//make sure this is only when editing
+		if ( ! empty($id)) {
+			$post = get_post($id);
+			$return .= '<a class="button button-small" onclick="prompt(\'Shortcode:\', jQuery(\'#shortcode\').val()); return false;" href="#"  tabindex="-1">'
+					   . esc_html__('Shortcode', 'event_espresso')
+					   . '</a> ';
+			$return .= '<input id="shortcode" type="hidden" value="[ESPRESSO_TICKET_SELECTOR event_id='
+					   . $post->ID
+					   . ']">';
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _events_overview_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
+			? (array)$this->_template_args['after_list_table']
+			: array();
+		$this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
+																			  . EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__("View Event Archive Page", "event_espresso"),
+				'button'
+			);
+		$this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'create_new',
+				'add',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from other meta saves.
+	 * So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param  object $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			//get out we're not processing an event save.
+			return;
+		}
+		$event_values = array(
+			'EVT_display_desc'                => ! empty($this->_req_data['display_desc']) ? 1 : 0,
+			'EVT_display_ticket_selector'     => ! empty($this->_req_data['display_ticket_selector']) ? 1 : 0,
+			'EVT_additional_limit'            => min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				! empty($this->_req_data['additional_limit']) ? $this->_req_data['additional_limit'] : null
+			),
+			'EVT_default_registration_status' => ! empty($this->_req_data['EVT_default_registration_status'])
+				? $this->_req_data['EVT_default_registration_status']
+				: EE_Registry::instance()->CFG->registration->default_STS_ID,
+			'EVT_member_only'                 => ! empty($this->_req_data['member_only']) ? 1 : 0,
+			'EVT_allow_overflow'              => ! empty($this->_req_data['EVT_allow_overflow']) ? 1 : 0,
+			'EVT_timezone_string'             => ! empty($this->_req_data['timezone_string'])
+				? $this->_req_data['timezone_string'] : null,
+			'EVT_external_URL'                => ! empty($this->_req_data['externalURL'])
+				? $this->_req_data['externalURL'] : null,
+			'EVT_phone'                       => ! empty($this->_req_data['event_phone'])
+				? $this->_req_data['event_phone'] : null,
+		);
+		//update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		//get event_object for other metaboxes... though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id ).. i have to setup where conditions to override the filters in the model that filter out autodraft and inherit statuses so we GET the inherit id!
+		$get_one_where = array(
+			$this->_event_model()->primary_key_name() => $post_id,
+			'OR' => array(
+				'status' => $post->post_status,
+				// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+				// but the returned object here has a status of "publish", so use the original post status as well
+				'status*1' => $this->_req_data['original_post_status'],
+			)
+		);
+		$event = $this->_event_model()->get_one(array($get_one_where));
+		//the following are default callbacks for event attachment updates that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array(
+				array($this, '_default_venue_update'),
+				array($this, '_default_tickets_update')
+			)
+		);
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = $e_callback($event, $this->_req_data);
+			//if ANY of these updates fail then we want the appropriate global error message
+			$att_success = ! $att_success ? $att_success : $_success;
+		}
+		//any errors?
+		if ($success && false === $att_success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else if ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+
+	/**
+	 * @see parent::restore_item()
+	 * @param int $post_id
+	 * @param int $revision_id
+	 */
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+		//copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			//meta revision restore
+			$post_evt->restore_revision($revision_id);
+			//related objs restore
+			$post_evt->restore_revision($revision_id, array('Venue', 'Datetime', 'Price'));
+		}
+	}
+
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param  \EE_Event $evtobj Event Object to add the venue to
+	 * @param  array     $data   The request data from the form
+	 * @return bool           Success or fail.
+	 */
+	protected function _default_venue_update(\EE_Event $evtobj, $data)
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$rows_affected = null;
+		$venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = array(
+			'VNU_wp_user'         => $evtobj->get('EVT_wp_user'),
+			'VNU_name'            => ! empty($data['venue_title']) ? $data['venue_title'] : null,
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description']) ? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		);
+		//if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if ( ! empty($venue_id)) {
+			$update_where = array($venue_model->primary_key_name() => $venue_id);
+			$rows_affected = $venue_model->update($venue_array, array($update_where));
+			//we've gotta make sure that the venue is always attached to a revision.. add_relation_to should take care of making sure that the relation is already present.
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0 ? true : false;
+		} else {
+			//we insert the venue
+			$venue_id = $venue_model->insert($venue_array);
+			$evtobj->_add_relation_to($venue_id, 'Venue');
+			return ! empty($venue_id) ? true : false;
+		}
+		//when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param  EE_Event $evtobj The Event object we're attaching data to
+	 * @param  array    $data   The request data from the form
+	 * @return array
+	 */
+	protected function _default_tickets_update(EE_Event $evtobj, $data)
+	{
+		$success = true;
+		$saved_dtt = null;
+		$saved_tickets = array();
+		$incoming_date_formats = array('Y-m-d', 'h:i a');
+		foreach ($data['edit_event_datetimes'] as $row => $dtt) {
+			//trim all values to ensure any excess whitespace is removed.
+			$dtt = array_map('trim', $dtt);
+			$dtt['DTT_EVT_end'] = isset($dtt['DTT_EVT_end']) && ! empty($dtt['DTT_EVT_end']) ? $dtt['DTT_EVT_end']
+				: $dtt['DTT_EVT_start'];
+			$datetime_values = array(
+				'DTT_ID'        => ! empty($dtt['DTT_ID']) ? $dtt['DTT_ID'] : null,
+				'DTT_EVT_start' => $dtt['DTT_EVT_start'],
+				'DTT_EVT_end'   => $dtt['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($dtt['DTT_reg_limit']) ? EE_INF : $dtt['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			);
+			//if we have an id then let's get existing object first and then set the new values.  Otherwise we instantiate a new object for save.
+			if ( ! empty($dtt['DTT_ID'])) {
+				$DTM = EE_Registry::instance()
+								  ->load_model('Datetime', array($evtobj->get_timezone()))
+								  ->get_one_by_ID($dtt['DTT_ID']);
+				$DTM->set_date_format($incoming_date_formats[0]);
+				$DTM->set_time_format($incoming_date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+				//make sure the $dtt_id here is saved just in case after the add_relation_to() the autosave replaces it.  We need to do this so we dont' TRASH the parent DTT.
+				$saved_dtts[$DTM->ID()] = $DTM;
+			} else {
+				$DTM = EE_Registry::instance()->load_class(
+					'Datetime',
+					array($datetime_values, $evtobj->get_timezone(), $incoming_date_formats),
+					false,
+					false
+				);
+				foreach ($datetime_values as $field => $value) {
+					$DTM->set($field, $value);
+				}
+			}
+			$DTM->save();
+			$DTT = $evtobj->_add_relation_to($DTM, 'Datetime');
+			//load DTT helper
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($DTT->get_raw('DTT_EVT_start') > $DTT->get_raw('DTT_EVT_end')) {
+				$DTT->set('DTT_EVT_end', $DTT->get('DTT_EVT_start'));
+				$DTT = EEH_DTT_Helper::date_time_add($DTT, 'DTT_EVT_end', 'days');
+				$DTT->save();
+			}
+			//now we got to make sure we add the new DTT_ID to the $saved_dtts array  because it is possible there was a new one created for the autosave.
+			$saved_dtt = $DTT;
+			$success = ! $success ? $success : $DTT;
+			//if ANY of these updates fail then we want the appropriate global error message.
+			// //todo this is actually sucky we need a better error message but this is what it is for now.
+		}
+		//no dtts get deleted so we don't do any of that logic here.
+		//update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
+		foreach ($data['edit_tickets'] as $row => $tkt) {
+			$incoming_date_formats = array('Y-m-d', 'h:i a');
+			$update_prices = false;
+			$ticket_price = isset($data['edit_prices'][$row][1]['PRC_amount'])
+				? $data['edit_prices'][$row][1]['PRC_amount'] : 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map('trim', $tkt);
+			if (empty($tkt['TKT_start_date'])) {
+				//let's use now in the set timezone.
+				$now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
+			}
+			if (empty($tkt['TKT_end_date'])) {
+				//use the start date of the first datetime
+				$dtt = $evtobj->first_datetime();
+				$tkt['TKT_end_date'] = $dtt->start_date_and_time(
+					$incoming_date_formats[0],
+					$incoming_date_formats[1]
+				);
+			}
+			$TKT_values = array(
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description']) ? $tkt['TKT_description'] : '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' ? EE_INF : $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' ? EE_INF : $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : $row,
+				'TKT_price'       => $ticket_price,
+			);
+			//if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID'] = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$TKT_values['TKT_price'] = $ticket_price;
+				$update_prices = true;
+			}
+			//if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			//we actually do our saves a head of doing any add_relations to because its entirely possible that this ticket didn't removed or added to any datetime in the session but DID have it's items modified.
+			//keep in mind that if the TKT has been sold (and we have changed pricing information), then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if ( ! empty($tkt['TKT_ID'])) {
+				$TKT = EE_Registry::instance()
+								  ->load_model('Ticket', array($evtobj->get_timezone()))
+								  ->get_one_by_ID($tkt['TKT_ID']);
+				if ($TKT instanceof EE_Ticket) {
+					$ticket_sold = $TKT->count_related(
+						'Registration',
+						array(
+							array(
+								'STS_ID' => array(
+									'NOT IN',
+									array(EEM_Registration::status_id_incomplete),
+								),
+							),
+						)
+					) > 0 ? true : false;
+					//let's just check the total price for the existing ticket and determine if it matches the new total price.  if they are different then we create a new ticket (if tkts sold) if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $ticket_sold && $ticket_price != $TKT->get('TKT_price')
+									  && ! $TKT->get(
+						'TKT_deleted'
+					) ? true : false;
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field == 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					//if $create_new_TKT is false then we can safely update the existing ticket.  Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						//archive the old ticket first
+						$TKT->set('TKT_deleted', 1);
+						$TKT->save();
+						//make sure this ticket is still recorded in our saved_tkts so we don't run it through the regular trash routine.
+						$saved_tickets[$TKT->ID()] = $TKT;
+						//create new ticket that's a copy of the existing except a new id of course (and not archived) AND has the new TKT_price associated with it.
+						$TKT = clone $TKT;
+						$TKT->set('TKT_ID', 0);
+						$TKT->set('TKT_deleted', 0);
+						$TKT->set('TKT_price', $ticket_price);
+						$TKT->set('TKT_sold', 0);
+						//now we need to make sure that $new prices are created as well and attached to new ticket.
+						$update_prices = true;
+					}
+					//make sure price is set if it hasn't been already
+					$TKT->set('TKT_price', $ticket_price);
+				}
+			} else {
+				//no TKT_id so a new TKT
+				$TKT_values['TKT_price'] = $ticket_price;
+				$TKT = EE_Registry::instance()->load_class('Ticket', array($TKT_values), false, false);
+				if ($TKT instanceof EE_Ticket) {
+					//need to reset values to properly account for the date formats
+					$TKT->set_date_format($incoming_date_formats[0]);
+					$TKT->set_time_format($incoming_date_formats[1]);
+					$TKT->set_timezone($evtobj->get_timezone());
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field == 'TKT_qty') {
+							$TKT->set_qty($value);
+						} else {
+							$TKT->set($field, $value);
+						}
+					}
+					$update_prices = true;
+				}
+			}
+			// cap ticket qty by datetime reg limits
+			$TKT->set_qty(min($TKT->qty(), $TKT->qty('reg_limit')));
+			//update ticket.
+			$TKT->save();
+			//before going any further make sure our dates are setup correctly so that the end date is always equal or greater than the start date.
+			if ($TKT->get_raw('TKT_start_date') > $TKT->get_raw('TKT_end_date')) {
+				$TKT->set('TKT_end_date', $TKT->get('TKT_start_date'));
+				$TKT = EEH_DTT_Helper::date_time_add($TKT, 'TKT_end_date', 'days');
+				$TKT->save();
+			}
+			//initially let's add the ticket to the dtt
+			$saved_dtt->_add_relation_to($TKT, 'Ticket');
+			$saved_tickets[$TKT->ID()] = $TKT;
+			//add prices to ticket
+			$this->_add_prices_to_ticket($data['edit_prices'][$row], $TKT, $update_prices);
+		}
+		//however now we need to handle permanently deleting tickets via the ui.  Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.  However, it does allow for deleting tickets that have no tickets sold, in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets = isset($old_tickets[0]) && $old_tickets[0] == '' ? array() : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			//get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			//need to get all the related datetimes on this ticket and remove from every single one of them (remember this process can ONLY kick off if there are NO tkts_sold)
+			$dtts = $tkt_to_remove->get_many_related('Datetime');
+			foreach ($dtts as $dtt) {
+				$tkt_to_remove->_remove_relation_to($dtt, 'Datetime');
+			}
+			//need to do the same for prices (except these prices can also be deleted because again, tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
+			//finally let's delete this ticket (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
+		return array($saved_dtt, $saved_tickets);
+	}
+
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices     Array of prices from the form.
+	 * @param EE_Ticket $ticket     EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 */
+	private function _add_prices_to_ticket($prices, EE_Ticket $ticket, $new_prices = false)
+	{
+		foreach ($prices as $row => $prc) {
+			$PRC_values = array(
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => 0, //make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			);
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$PRC = EE_Registry::instance()->load_class('Price', array($PRC_values), false, false);
+			} else {
+				$PRC = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				//update this price with new values
+				foreach ($PRC_values as $field => $newprc) {
+					$PRC->set($field, $newprc);
+				}
+				$PRC->save();
+			}
+			$ticket->_add_relation_to($PRC, 'Price');
+		}
+	}
+
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+		return; //TEMPORARILY EXITING CAUSE THIS IS A TODO
+	}
+
+
+
+	/**
+	 *    _generate_publish_box_extra_content
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		//load formatter helper
+		//args for getting related registrations
+		$approved_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			),
+		);
+		$not_approved_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			),
+		);
+		$pending_payment_query_args = array(
+			array(
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			),
+		);
+		// publish box
+		$publish_box_extra_args = array(
+			'view_approved_reg_url'        => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+				),
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				),
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				array(
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				),
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		);
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_tickets',
+			esc_html__('Event Datetime & Ticket', 'event_espresso'),
+			array($this, 'ticket_metabox'),
+			$this->page_slug,
+			'normal',
+			'high'
+		);
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			array($this, 'registration_options_meta_box'),
+			$this->page_slug,
+			'side',
+			'default'
+		);
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = array();
+		//defaults for template args
+		$template_args = array(
+			'existing_datetime_ids'    => '',
+			'event_datetime_help_link' => '',
+			'ticket_options_help_link' => '',
+			'time'                     => null,
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'trash_icon'               => 'ee-lock-icon',
+			'disabled'                 => '',
+		);
+		$event_id = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		$times = EE_Registry::instance()->load_model('Datetime')->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		//do we get related tickets?
+		if ($first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time'] = $first_datetime;
+			$related_tickets = $first_datetime->tickets(
+				array(
+					array('OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0)),
+					'default_where_conditions' => 'none',
+				)
+			);
+			if ( ! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[] = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket = EE_Registry::instance()->load_model('Ticket')->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket $ticket */
+			$ticket = EE_Registry::instance()->load_model('Ticket')->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure'] = $this->_get_ticket_row(
+			EE_Registry::instance()->load_model('Ticket')->create_default_object(),
+			true
+		);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param  EE_Ticket $ticket   the ticket object
+	 * @param  boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int        $row
+	 * @return string generated html for the ticket row.
+	 */
+	private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
+	{
+		$template_args = array(
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && ( ! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'ee-lock-icon',
+			'disabled'            => $skeleton || ( ! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		);
+		$price = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', array('default_where_conditions' => 'none'))
+			: EE_Registry::instance()->load_model('Price')->create_default_object();
+		$price_args = array(
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		);
+		//make sure we have default start and end dates if skeleton
+		//handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			//if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			//get the earliest datetime (if present);
+			$earliest_dtt = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					array('order_by' => array('DTT_EVT_start' => 'ASC'))
+				)
+				: null;
+			if ( ! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a');
+			} else {
+				$template_args['TKT_end_date'] = date(
+					'Y-m-d h:i a',
+					mktime(0, 0, 0, date("m"), date("d") + 7, date("Y"))
+				);
+			}
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = array(
+			array('id' => true, 'text' => esc_html__('Yes', 'event_espresso')),
+			array('id' => false, 'text' => esc_html__('No', 'event_espresso')),
+		);
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+			),
+			true
+		);
+		//$template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event'] = $this->_cpt_model_obj;
+		$template_args['active_status'] = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status'] = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description'] = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array an array of event objects.
+	 */
+	public function get_events($per_page = 10, $current_page = 1, $count = false)
+	{
+		$EEME = $this->_event_model();
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $count ? null : $offset . ',' . $per_page;
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
+		if (isset($this->_req_data['month_range'])) {
+			$pieces = explode(' ', $this->_req_data['month_range'], 3);
+			//simulate the FIRST day of the month, that fixes issues for months like February
+			//where PHP doesn't know what to assume for date.
+			//@see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where = array();
+		$status = isset($this->_req_data['status']) ? $this->_req_data['status'] : null;
+		//determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month' :
+			case 'today' :
+			case null :
+			case 'all' :
+				break;
+			case 'draft' :
+				$where['status'] = array('IN', array('draft', 'auto-draft'));
+				break;
+			default :
+				$where['status'] = $status;
+		}
+		//categories?
+		$category = isset($this->_req_data['EVT_CAT']) && $this->_req_data['EVT_CAT'] > 0
+			? $this->_req_data['EVT_CAT'] : null;
+		if ( ! empty ($category)) {
+			$where['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Term_Taxonomy.term_id'] = $category;
+		}
+		//date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone(EEM_Datetime::instance()->get_timezone())
+			);
+			$start = $DateTime->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate($year_r, $month_r, $DateTime
+				->format('t'))->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		} else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'today') {
+			$DateTime = new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		} else if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'month') {
+			$now = date('Y-m-01');
+			$DateTime = new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start = $DateTime->setTime(0, 0, 0)->format(implode(' ', $start_formats));
+			$end = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+							->setTime(23, 59, 59)
+							->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = array('BETWEEN', array($start, $end));
+		}
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if ( ! isset($where['status'])) {
+				if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = array(
+						'status*restrict_private' => array('!=', 'private'),
+						'AND'                     => array(
+							'status*inclusive' => array('=', 'private'),
+							'EVT_wp_user'      => get_current_user_id(),
+						),
+					);
+				}
+			}
+		}
+		if (isset($this->_req_data['EVT_wp_user'])) {
+			if ($this->_req_data['EVT_wp_user'] != get_current_user_id()
+				&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+			) {
+				$where['EVT_wp_user'] = $this->_req_data['EVT_wp_user'];
+			}
+		}
+		//search query handling
+		if (isset($this->_req_data['s'])) {
+			$search_string = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'EVT_name'       => array('LIKE', $search_string),
+				'EVT_desc'       => array('LIKE', $search_string),
+				'EVT_short_desc' => array('LIKE', $search_string),
+			);
+		}
+		$where = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $this->_req_data);
+		$query_params = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			array(
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			),
+			$this->_req_data
+		);
+		//let's first check if we have special requests coming in.
+		if (isset($this->_req_data['active_status'])) {
+			switch ($this->_req_data['active_status']) {
+				case 'upcoming' :
+					return $EEME->get_upcoming_events($query_params, $count);
+					break;
+				case 'expired' :
+					return $EEME->get_expired_events($query_params, $count);
+					break;
+				case 'active' :
+					return $EEME->get_active_events($query_params, $count);
+					break;
+				case 'inactive' :
+					return $EEME->get_inactive_events($query_params, $count);
+					break;
+			}
+		}
+		$events = $count ? $EEME->count(array($where), 'EVT_ID', true) : $EEME->get_all($query_params);
+		return $events;
+	}
+
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+
+	/**
+	 * @param string $post_id
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+
+	/**
+	 * @param string $post_id
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		$this->_req_data['EVT_ID'] = $post_id;
+		$this->_delete_event(false);
+	}
+
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param  string $event_status
+	 * @param bool    $redirect_after
+	 */
+	protected function _trash_or_restore_event($event_status = 'trash', $redirect_after = true)
+	{
+		//determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : false;
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if ( ! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, array('action' => 'default'));
+		}
+	}
+
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param  string $event_status
+	 * @return void
+	 */
+	protected function _trash_or_restore_events($event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if ( ! empty($event_status)) {
+			$success = true;
+			//determine the event id and set to array.
+			$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action = $event_status == 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, array('action' => 'default'));
+	}
+
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access  private
+	 * @param  int    $EVT_ID
+	 * @param  string $event_status
+	 * @return bool
+	 */
+	private function _change_event_status($EVT_ID = 0, $event_status = '')
+	{
+		// grab event id
+		if ( ! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft' :
+				$action = 'restored from the trash';
+				$hook = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash' :
+				$action = 'moved to the trash';
+				$hook = 'AHEE_event_moved_to_trash';
+				break;
+			default :
+				$action = 'updated';
+				$hook = false;
+		}
+		//use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if ($success === false) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * _delete_event
+	 *
+	 * @access protected
+	 * @param bool $redirect_after
+	 */
+	protected function _delete_event($redirect_after = true)
+	{
+		//determine the event id and set to array.
+		$EVT_ID = isset($this->_req_data['EVT_ID']) ? absint($this->_req_data['EVT_ID']) : null;
+		$EVT_ID = isset($this->_req_data['post']) ? absint($this->_req_data['post']) : $EVT_ID;
+		// loop thru events
+		if ($EVT_ID) {
+			$success = $this->_permanently_delete_event($EVT_ID);
+			// get list of events with no prices
+			$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
+			// remove this event from the list of events with no prices
+			if (isset($espresso_no_ticket_prices[$EVT_ID])) {
+				unset($espresso_no_ticket_prices[$EVT_ID]);
+			}
+			update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
+		} else {
+			$success = false;
+			$msg = esc_html__(
+				'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		if ($redirect_after) {
+			$this->_redirect_after_action(
+				$success,
+				'Event',
+				'deleted',
+				array('action' => 'default', 'status' => 'trash')
+			);
+		}
+	}
+
+
+
+	/**
+	 * _delete_events
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _delete_events()
+	{
+		$success = true;
+		// get list of events with no prices
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
+		//determine the event id and set to array.
+		$EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+		// loop thru events
+		foreach ($EVT_IDs as $EVT_ID) {
+			$EVT_ID = absint($EVT_ID);
+			if ($EVT_ID) {
+				$results = $this->_permanently_delete_event($EVT_ID);
+				$success = $results !== false ? $success : false;
+				// remove this event from the list of events with no prices
+				unset($espresso_no_ticket_prices[$EVT_ID]);
+			} else {
+				$success = false;
+				$msg = esc_html__(
+					'An error occurred. An event could not be deleted because a valid event ID was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		update_option('ee_no_ticket_prices', $espresso_no_ticket_prices);
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$this->_redirect_after_action($success, 'Events', 'deleted', array('action' => 'default'));
+	}
+
+
+
+	/**
+	 * _permanently_delete_event
+	 *
+	 * @access  private
+	 * @param  int $EVT_ID
+	 * @return bool
+	 */
+	private function _permanently_delete_event($EVT_ID = 0)
+	{
+		// grab event id
+		if ( ! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (
+			! $this->_cpt_model_obj instanceof EE_Event
+			|| $this->_cpt_model_obj->ID() !== $EVT_ID
+		) {
+			$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		if ( ! $this->_cpt_model_obj instanceof EE_Event) {
+			return false;
+		}
+		//need to delete related tickets and prices first.
+		$datetimes = $this->_cpt_model_obj->get_many_related('Datetime');
+		foreach ($datetimes as $datetime) {
+			$this->_cpt_model_obj->_remove_relation_to($datetime, 'Datetime');
+			$tickets = $datetime->get_many_related('Ticket');
+			foreach ($tickets as $ticket) {
+				$ticket->_remove_relation_to($datetime, 'Datetime');
+				$ticket->delete_related_permanently('Price');
+				$ticket->delete_permanently();
+			}
+			$datetime->delete();
+		}
+		//what about related venues or terms?
+		$venues = $this->_cpt_model_obj->get_many_related('Venue');
+		foreach ($venues as $venue) {
+			$this->_cpt_model_obj->_remove_relation_to($venue, 'Venue');
+		}
+		//any attached question groups?
+		$question_groups = $this->_cpt_model_obj->get_many_related('Question_Group');
+		if ( ! empty($question_groups)) {
+			foreach ($question_groups as $question_group) {
+				$this->_cpt_model_obj->_remove_relation_to($question_group, 'Question_Group');
+			}
+		}
+		//Message Template Groups
+		$this->_cpt_model_obj->_remove_relations('Message_Template_Group');
+		/** @type EE_Term_Taxonomy[] $term_taxonomies */
+		$term_taxonomies = $this->_cpt_model_obj->term_taxonomies();
+		foreach ($term_taxonomies as $term_taxonomy) {
+			$this->_cpt_model_obj->remove_relation_to_term_taxonomy($term_taxonomy);
+		}
+		$success = $this->_cpt_model_obj->delete_permanently();
+		// did it all go as planned ?
+		if ($success) {
+			$msg = sprintf(esc_html__('Event ID # %d has been deleted.', 'event_espresso'), $EVT_ID);
+			EE_Error::add_success($msg);
+		} else {
+			$msg = sprintf(
+				esc_html__('An error occurred. Event ID # %d could not be deleted.', 'event_espresso'),
+				$EVT_ID
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		do_action('AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted', $EVT_ID);
+		return true;
+	}
+
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_events()
+	{
+		$count = EEM_Event::instance()->count(array('caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_events_draft()
+	{
+		$where = array(
+			'status' => array('IN', array('draft', 'auto-draft')),
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function total_trashed_events()
+	{
+		$where = array(
+			'status' => 'trash',
+		);
+		$count = EEM_Event::instance()->count(array($where, 'caps' => 'read_admin'), 'EVT_ID', true);
+		return $count;
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = $this->_default_event_settings_form()->get_html();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _default_event_settings_form()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		//exclude
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			),
+			true
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'name' => 'update_default_event_settings',
+				'html_id' => 'update_default_event_settings',
+				'html_class' => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections' => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					array(
+						'default_reg_status' => new EE_Select_Input(
+							$registration_stati_for_selection,
+							array(
+								'default' => isset($registration_config->default_STS_ID)
+											 && array_key_exists(
+												$registration_config->default_STS_ID,
+												$registration_stati_for_selection
+											 )
+											? sanitize_text_field($registration_config->default_STS_ID)
+											: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													. EEH_Template::get_help_tab_link(
+														'default_settings_status_help_tab'
+													),
+								'html_help_text' => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								)
+							)
+						),
+						'default_max_tickets' => new EE_Integer_Input(
+							array(
+								'default' => isset($registration_config->default_maximum_number_of_tickets)
+									? $registration_config->default_maximum_number_of_tickets
+									: EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								) . EEH_Template::get_help_tab_link(
+									'default_maximum_tickets_help_tab"'
+									),
+								'html_help_text' => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								)
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _update_default_event_settings
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_default_event_settings()
+	{
+		$registration_config = EE_Registry::instance()->CFG->registration;
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				//update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'default_event_settings'), true);
+	}
+
+
+
+	/*************        Templates        *************/
+	protected function _template_settings()
+	{
+		$this->_admin_page_title = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img'] = '<img src="'
+											   . EVENTS_ASSETS_URL
+											   . DS
+											   . 'images'
+											   . DS
+											   . 'caffeinated_template_features.jpg" alt="'
+											   . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+											   . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . esc_html__(
+				'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+				'event_espresso'
+			) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		//set default category object
+		$this->_set_empty_category_object();
+		//only set if we've got an id
+		if ( ! isset($this->_req_data['EVT_CAT_ID'])) {
+			return;
+		}
+		$category_id = absint($this->_req_data['EVT_CAT_ID']);
+		$term = get_term($category_id, 'espresso_event_categories');
+		if ( ! empty($term)) {
+			$this->_category->category_name = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc = $term->description;
+			$this->_category->id = $term->term_id;
+			$this->_category->parent = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+				'add_category',
+				'add_category',
+				array(),
+				'add-new-h2'
+			);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Output category details view.
+	 */
+	protected function _category_details($view)
+	{
+		//load formatter helper
+		//load field generator helper
+		$route = $view == 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		//custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'category_list'),
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect);
+		//take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Output category details content.
+	 */
+	protected function _category_details_content()
+	{
+		$editor_args['category_desc'] = array(
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => array('media_buttons' => false),
+		);
+		$_wp_editor = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms = get_terms(
+			array('espresso_event_categories'),
+			array('hide_empty' => 0, 'exclude' => array($this->_category->id))
+		);
+		//setup category select for term parents.
+		$category_select_values[] = array(
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		);
+		foreach ($all_terms as $term) {
+			$category_select_values[] = array(
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			);
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args = array(
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		);
+		$template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 */
+	protected function _delete_categories()
+	{
+		$cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
+			: (array)$this->_req_data['category_id'];
+		foreach ($cat_ids as $cat_id) {
+			$this->_delete_category($cat_id);
+		}
+		//doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = array(
+			'action' => 'category_list',
+		);
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+
+	/**
+	 * Handles deleting specific category.
+	 * @param int $cat_id
+	 */
+	protected function _delete_category($cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, 'espresso_event_categories');
+	}
+
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 * @param bool $new_category  true means we're triggering the insert of a new category.
+	 */
+	protected function _insert_or_update_category($new_category)
+	{
+		$cat_id = $new_category ? $this->_insert_category() : $this->_insert_category(true);
+		$success = 0; //we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = array(
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			);
+		} else {
+			$query_args = array('action' => 'add_category');
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+
+	/**
+	 * Inserts or updates category
+	 * @param bool $update (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category($update = false)
+	{
+		$cat_id = $update ? $this->_req_data['EVT_CAT_ID'] : '';
+		$category_name = isset($this->_req_data['category_name']) ? $this->_req_data['category_name'] : '';
+		$category_desc = isset($this->_req_data['category_desc']) ? $this->_req_data['category_desc'] : '';
+		$category_parent = isset($this->_req_data['category_parent']) ? $this->_req_data['category_parent'] : 0;
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$term_args = array(
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		);
+		//was the category_identifier input disabled?
+		if (isset($this->_req_data['category_identifier'])) {
+			$term_args['slug'] = $this->_req_data['category_identifier'];
+		}
+		$insert_ids = $update
+			? wp_update_term($cat_id, 'espresso_event_categories', $term_args)
+			: wp_insert_term($category_name, 'espresso_event_categories', $term_args);
+		if ( ! is_array($insert_ids)) {
+			$msg = esc_html__(
+				'An error occurred and the category has not been saved to the database.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			$cat_id = $insert_ids['term_id'];
+			$msg = sprintf(esc_html__('The category %s was successfully saved', 'event_espresso'), $category_name);
+			EE_Error::add_success($msg);
+		}
+		return $cat_id;
+	}
+
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Base_Class[]|EE_Term_Taxonomy[]|int
+	 */
+	public function get_categories($per_page = 10, $current_page = 1, $count = false)
+	{
+		//testing term stuff
+		$orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'Term.term_id';
+		$order = isset($this->_req_data['order']) ? $this->_req_data['order'] : 'DESC';
+		$limit = ($current_page - 1) * $per_page;
+		$where = array('taxonomy' => 'espresso_event_categories');
+		if (isset($this->_req_data['s'])) {
+			$sstr = '%' . $this->_req_data['s'] . '%';
+			$where['OR'] = array(
+				'Term.name'   => array('LIKE', $sstr),
+				'description' => array('LIKE', $sstr),
+			);
+		}
+		$query_params = array(
+			$where,
+			'order_by'   => array($orderby => $order),
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => array('Term'),
+		);
+		$categories = $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+		return $categories;
+	}
+
+	/* end category stuff */
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 * @throws EE_Error
+	 */
+	public function save_timezonestring_setting()
+	{
+		$timezone_string = isset($this->_req_data['timezone_selected'])
+			? $this->_req_data['timezone_selected']
+			: '';
+		if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
+		{
+			EE_Error::add_error(
+				esc_html('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, array('action' => 'create_new'));
+	}
 }
 //end class Events_Admin_Page

Spacing +39 added lines, -39 removed lines

@@ -553,11 +553,11 @@ 
     {
         wp_register_style(
             'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
+            EVENTS_ASSETS_URL.'events-admin-page.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
-        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL . 'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-cat-admin', EVENTS_ASSETS_URL.'ee-cat-admin.css', array(), EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('events-admin-css');
         wp_enqueue_style('ee-cat-admin');
         //todo note: we also need to load_scripts_styles per view (i.e. default/view_report/event_details
@@ -565,7 +565,7 @@ 
         //scripts
         wp_register_script(
             'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
+            EVENTS_ASSETS_URL.'event_editor.js',
             array('ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -593,7 +593,7 @@ 
         wp_enqueue_style('espresso-ui-theme');
         wp_register_style(
             'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
+            EVENTS_ASSETS_URL.'event-editor.css',
             array('ee-admin-css'),
             EVENT_ESPRESSO_VERSION
         );
@@ -601,7 +601,7 @@ 
         //scripts
         wp_register_script(
             'event-datetime-metabox',
-            EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+            EVENTS_ASSETS_URL.'event-datetime-metabox.js',
             array('event_editor_js', 'ee-datepicker'),
             EVENT_ESPRESSO_VERSION
         );
@@ -670,7 +670,7 @@ 
     public function verify_event_edit($event = null, $req_type = '')
     {
         // don't need to do this when processing
-        if(!empty($req_type)) {
+        if ( ! empty($req_type)) {
             return;
         }
         // no event?
@@ -679,7 +679,7 @@ 
             $event = $this->_cpt_model_obj;
         }
         // STILL no event?
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             return;
         }
         $orig_status = $event->status();
@@ -761,7 +761,7 @@ 
     {
         $has_timezone_string = get_option('timezone_string');
         //only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
+        if ( ! $has_timezone_string && ! EEM_Event::instance()->exists(array())) {
             EE_Error::add_attention(
                 sprintf(
                     __(
@@ -845,31 +845,31 @@ 
         $items = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
         $statuses = array(
             'sold_out_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::sold_out,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::sold_out,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
             ),
             'active_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::active,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::active,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
             ),
             'upcoming_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::upcoming,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::upcoming,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
             ),
             'postponed_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::postponed,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::postponed,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::cancelled,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
             ),
             'expired_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::expired,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::expired,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
             ),
             'inactive_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EE_Datetime::inactive,
+                'class' => 'ee-status-legend ee-status-legend-'.EE_Datetime::inactive,
                 'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
             ),
         );
@@ -931,7 +931,7 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $this->_template_args['after_list_table'] = ! empty($this->_template_args['after_list_table'])
-            ? (array)$this->_template_args['after_list_table']
+            ? (array) $this->_template_args['after_list_table']
             : array();
         $this->_template_args['after_list_table']['view_event_list_button'] = EEH_HTML::br()
                                                                               . EEH_Template::get_button_or_link(
@@ -940,7 +940,7 @@ 
                 'button'
             );
         $this->_template_args['after_list_table']['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'create_new',
                 'add',
                 array(),
@@ -1081,7 +1081,7 @@ 
      */
     protected function _default_venue_update(\EE_Event $evtobj, $data)
     {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
+        require_once(EE_MODELS.'EEM_Venue.model.php');
         $venue_model = EE_Registry::instance()->load_model('Venue');
         $rows_affected = null;
         $venue_id = ! empty($data['venue_id']) ? $data['venue_id'] : null;
@@ -1205,7 +1205,7 @@ 
             if (empty($tkt['TKT_start_date'])) {
                 //let's use now in the set timezone.
                 $now = new DateTime('now', new DateTimeZone($evtobj->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0] . ' ' . $incoming_date_formats[1]);
+                $tkt['TKT_start_date'] = $now->format($incoming_date_formats[0].' '.$incoming_date_formats[1]);
             }
             if (empty($tkt['TKT_end_date'])) {
                 //use the start date of the first datetime
@@ -1484,7 +1484,7 @@ 
         $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
         // load template
         EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+            EVENTS_TEMPLATE_PATH.'event_publish_box_extras.template.php',
             $publish_box_extra_args
         );
     }
@@ -1611,7 +1611,7 @@ 
         );
         $template = apply_filters(
             'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+            EVENTS_TEMPLATE_PATH.'event_tickets_metabox_main.template.php'
         );
         EEH_Template::display_template($template, $template_args);
     }
@@ -1630,7 +1630,7 @@ 
     private function _get_ticket_row($ticket, $skeleton = false, $row = 0)
     {
         $template_args = array(
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+            'tkt_status_class'    => ' tkt-status-'.$ticket->ticket_status(),
             'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
                 : '',
             'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
@@ -1684,7 +1684,7 @@ 
         $template_args = array_merge($template_args, $price_args);
         $template = apply_filters(
             'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+            EVENTS_TEMPLATE_PATH.'event_tickets_metabox_ticket_row.template.php',
             $ticket
         );
         return EEH_Template::display_template($template, $template_args, true);
@@ -1738,7 +1738,7 @@ 
             $default_reg_status_values
         );
         EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+            EVENTS_TEMPLATE_PATH.'event_registration_options.template.php',
             $template_args
         );
     }
@@ -1761,7 +1761,7 @@ 
     {
         $EEME = $this->_event_model();
         $offset = ($current_page - 1) * $per_page;
-        $limit = $count ? null : $offset . ',' . $per_page;
+        $limit = $count ? null : $offset.','.$per_page;
         $orderby = isset($this->_req_data['orderby']) ? $this->_req_data['orderby'] : 'EVT_ID';
         $order = isset($this->_req_data['order']) ? $this->_req_data['order'] : "DESC";
         if (isset($this->_req_data['month_range'])) {
@@ -1798,7 +1798,7 @@ 
         $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
         if (isset($this->_req_data['month_range']) && $this->_req_data['month_range'] != '') {
             $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
+                $year_r.'-'.$month_r.'-01 00:00:00',
                 new DateTimeZone(EEM_Datetime::instance()->get_timezone())
             );
             $start = $DateTime->format(implode(' ', $start_formats));
@@ -1844,7 +1844,7 @@ 
         }
         //search query handling
         if (isset($this->_req_data['s'])) {
-            $search_string = '%' . $this->_req_data['s'] . '%';
+            $search_string = '%'.$this->_req_data['s'].'%';
             $where['OR'] = array(
                 'EVT_name'       => array('LIKE', $search_string),
                 'EVT_desc'       => array('LIKE', $search_string),
@@ -1978,7 +1978,7 @@ 
         if ( ! empty($event_status)) {
             $success = true;
             //determine the event id and set to array.
-            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+            $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
             // loop thru events
             foreach ($EVT_IDs as $EVT_ID) {
                 if ($EVT_ID = absint($EVT_ID)) {
@@ -2126,7 +2126,7 @@ 
         // get list of events with no prices
         $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', array());
         //determine the event id and set to array.
-        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array)$this->_req_data['EVT_IDs'] : array();
+        $EVT_IDs = isset($this->_req_data['EVT_IDs']) ? (array) $this->_req_data['EVT_IDs'] : array();
         // loop thru events
         foreach ($EVT_IDs as $EVT_ID) {
             $EVT_ID = absint($EVT_ID);
@@ -2346,7 +2346,7 @@ 
                                 'html_label_text' => esc_html__(
                                     'Default Maximum Tickets Allowed Per Order:',
                                     'event_espresso'
-                                ) . EEH_Template::get_help_tab_link(
+                                ).EEH_Template::get_help_tab_link(
                                     'default_maximum_tickets_help_tab"'
                                     ),
                                 'html_help_text' => esc_html__(
@@ -2408,10 +2408,10 @@ 
                                                . 'caffeinated_template_features.jpg" alt="'
                                                . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
                                                . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . esc_html__(
+        $this->_template_args['preview_text'] = '<strong>'.esc_html__(
                 'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
                 'event_espresso'
-            ) . '</strong>';
+            ).'</strong>';
         $this->display_admin_caf_preview_page('template_settings_tab');
     }
 
@@ -2464,7 +2464,7 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
                 'add_category',
                 'add_category',
                 array(),
@@ -2540,7 +2540,7 @@ 
             'disable'                  => '',
             'disabled_message'         => false,
         );
-        $template = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+        $template = EVENTS_TEMPLATE_PATH.'event_category_details.template.php';
         return EEH_Template::display_template($template, $template_args, true);
     }
 
@@ -2550,8 +2550,8 @@ 
      */
     protected function _delete_categories()
     {
-        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array)$this->_req_data['EVT_CAT_ID']
-            : (array)$this->_req_data['category_id'];
+        $cat_ids = isset($this->_req_data['EVT_CAT_ID']) ? (array) $this->_req_data['EVT_CAT_ID']
+            : (array) $this->_req_data['category_id'];
         foreach ($cat_ids as $cat_id) {
             $this->_delete_category($cat_id);
         }
@@ -2656,7 +2656,7 @@ 
         $limit = ($current_page - 1) * $per_page;
         $where = array('taxonomy' => 'espresso_event_categories');
         if (isset($this->_req_data['s'])) {
-            $sstr = '%' . $this->_req_data['s'] . '%';
+            $sstr = '%'.$this->_req_data['s'].'%';
             $where['OR'] = array(
                 'Term.name'   => array('LIKE', $sstr),
                 'description' => array('LIKE', $sstr),
@@ -2665,7 +2665,7 @@ 
         $query_params = array(
             $where,
             'order_by'   => array($orderby => $order),
-            'limit'      => $limit . ',' . $per_page,
+            'limit'      => $limit.','.$per_page,
             'force_join' => array('Term'),
         );
         $categories = $count
@@ -2687,7 +2687,7 @@ 
         $timezone_string = isset($this->_req_data['timezone_selected'])
             ? $this->_req_data['timezone_selected']
             : '';
-        if  (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
+        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false))
         {
             EE_Error::add_error(
                 esc_html('An invalid timezone string submitted.', 'event_espresso'),

admin_pages/registrations/Registrations_Admin_Page.core.php

Indentation +3427 added lines, -3427 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -23,2113 +23,2113 @@ 
 class Registrations_Admin_Page extends EE_Admin_Page_CPT
 {
 
-    /**
-     * @var EE_Registration
-     */
-    private $_registration;
-
-    /**
-     * @var EE_Event
-     */
-    private $_reg_event;
-
-    /**
-     * @var EE_Session
-     */
-    private $_session;
-
-    private static $_reg_status;
-
-    /**
-     * Form for displaying the custom questions for this registration.
-     * This gets used a few times throughout the request so its best to cache it
-     *
-     * @var EE_Registration_Custom_Questions_Form
-     */
-    protected $_reg_custom_questions_form = null;
-
-
-    /**
-     *        constructor
-     *
-     * @Constructor
-     * @access public
-     * @param bool $routing
-     * @return Registrations_Admin_Page
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        add_action('wp_loaded', array($this, 'wp_loaded'));
-    }
-
-
-    public function wp_loaded()
-    {
-        // when adding a new registration...
-        if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
-            EE_System::do_not_cache();
-            if (! isset($this->_req_data['processing_registration'])
-                 || absint($this->_req_data['processing_registration']) !== 1
-            ) {
-                // and it's NOT the attendee information reg step
-                // force cookie expiration by setting time to last week
-                setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
-                // and update the global
-                $_COOKIE['ee_registration_added'] = 0;
-            }
-        }
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REG_PG_SLUG;
-        $this->_admin_base_url  = REG_ADMIN_URL;
-        $this->_admin_base_path = REG_ADMIN;
-        $this->page_label       = esc_html__('Registrations', 'event_espresso');
-        $this->_cpt_routes      = array(
-            'add_new_attendee' => 'espresso_attendees',
-            'edit_attendee'    => 'espresso_attendees',
-            'insert_attendee'  => 'espresso_attendees',
-            'update_attendee'  => 'espresso_attendees',
-        );
-        $this->_cpt_model_names = array(
-            'add_new_attendee' => 'EEM_Attendee',
-            'edit_attendee'    => 'EEM_Attendee',
-        );
-        $this->_cpt_edit_routes = array(
-            'espresso_attendees' => 'edit_attendee',
-        );
-        $this->_pagenow_map     = array(
-            'add_new_attendee' => 'post-new.php',
-            'edit_attendee'    => 'post.php',
-            'trash'            => 'post.php',
-        );
-        add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
-        //add filters so that the comment urls don't take users to a confusing 404 page
-        add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
-    }
-
-
-    public function clear_comment_link($link, $comment, $args)
-    {
-        //gotta make sure this only happens on this route
-        $post_type = get_post_type($comment->comment_post_ID);
-        if ($post_type === 'espresso_attendees') {
-            return '#commentsdiv';
-        }
-        return $link;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        //todo: all hooks for registrations ajax goes in here
-        add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'                      => array(
-                'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
-                'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
-                'edit'                => esc_html__('Edit Contact', 'event_espresso'),
-                'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
-                'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
-                'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
-                'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
-                'contact_list_export' => esc_html__("Export Data", "event_espresso"),
-            ),
-            'publishbox'                   => array(
-                'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
-                'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
-            ),
-            'hide_add_button_on_cpt_route' => array(
-                'edit_attendee' => true,
-            ),
-        );
-    }
-
-
-    /**
-     *        grab url requests and route them
-     *
-     * @access private
-     * @return void
-     */
-    public function _set_page_routes()
-    {
-        $this->_get_registration_status_array();
-        $reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID'] : 0;
-        $att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
-            ? $this->_req_data['ATT_ID'] : 0;
-        $att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
-            ? $this->_req_data['post']
-            : $att_id;
-        $this->_page_routes = array(
-            'default'                            => array(
-                'func'       => '_registrations_overview_list_table',
-                'capability' => 'ee_read_registrations',
-            ),
-            'view_registration'                  => array(
-                'func'       => '_registration_details',
-                'capability' => 'ee_read_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'edit_registration'                  => array(
-                'func'               => '_update_attendee_registration_form',
-                'noheader'           => true,
-                'headers_sent_route' => 'view_registration',
-                'capability'         => 'ee_edit_registration',
-                'obj_id'             => $reg_id,
-                '_REG_ID'            => $reg_id,
-            ),
-            'trash_registrations'                => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'restore_registrations'              => array(
-                'func'       => '_trash_or_restore_registrations',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'delete_registrations'               => array(
-                'func'       => '_delete_registrations',
-                'noheader'   => true,
-                'capability' => 'ee_delete_registrations',
-            ),
-            'new_registration'                   => array(
-                'func'       => 'new_registration',
-                'capability' => 'ee_edit_registrations',
-            ),
-            'process_reg_step'                   => array(
-                'func'       => 'process_reg_step',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'redirect_to_txn'                    => array(
-                'func'       => 'redirect_to_txn',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registrations',
-            ),
-            'change_reg_status'                  => array(
-                'func'       => '_change_reg_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_registration'               => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'approve_and_notify_registration'    => array(
-                'func'       => 'approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_registration'               => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'decline_and_notify_registration'    => array(
-                'func'       => 'decline_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_registration'               => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'pending_and_notify_registration'    => array(
-                'func'       => 'pending_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_registration'            => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'no_approve_and_notify_registration' => array(
-                'func'       => 'not_approve_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_registration'                => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'cancel_and_notify_registration'     => array(
-                'func'       => 'cancel_registration',
-                'noheader'   => true,
-                'args'       => array(true),
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'wait_list_registration' => array(
-                'func'       => 'wait_list_registration',
-                'noheader'   => true,
-                'capability' => 'ee_edit_registration',
-                'obj_id'     => $reg_id,
-            ),
-            'contact_list'                       => array(
-                'func'       => '_attendee_contact_list_table',
-                'capability' => 'ee_read_contacts',
-            ),
-            'add_new_attendee'                   => array(
-                'func' => '_create_new_cpt_item',
-                'args' => array(
-                    'new_attendee' => true,
-                    'capability'   => 'ee_edit_contacts',
-                ),
-            ),
-            'edit_attendee'                      => array(
-                'func'       => '_edit_cpt_item',
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'duplicate_attendee'                 => array(
-                'func'       => '_duplicate_attendee',
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'insert_attendee'                    => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-            ),
-            'update_attendee'                    => array(
-                'func'       => '_insert_or_update_attendee',
-                'args'       => array(
-                    'new_attendee' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_edit_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'trash_attendee'                    => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => true,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'restore_attendees'                  => array(
-                'func'       => '_trash_or_restore_attendees',
-                'args'       => array(
-                    'trash' => false,
-                ),
-                'noheader'   => true,
-                'capability' => 'ee_delete_contacts',
-                'obj_id'     => $att_id,
-            ),
-            'resend_registration'                => array(
-                'func'       => '_resend_registration',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'registrations_report'               => array(
-                'func'       => '_registrations_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-            'contact_list_export'                => array(
-                'func'       => '_contact_list_export',
-                'noheader'   => true,
-                'capability' => 'export',
-            ),
-            'contact_list_report'                => array(
-                'func'       => '_contact_list_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_contacts',
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'           => array(
-                'nav'           => array(
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'order' => 5,
-                ),
-                'help_tabs'     => array(
-                    'registrations_overview_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Overview', 'event_espresso'),
-                        'filename' => 'registrations_overview',
-                    ),
-                    'registrations_overview_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_overview_table_column_headings',
-                    ),
-                    'registrations_overview_filters_help_tab'               => array(
-                        'title'    => esc_html__('Registration Filters', 'event_espresso'),
-                        'filename' => 'registrations_overview_filters',
-                    ),
-                    'registrations_overview_views_help_tab'                 => array(
-                        'title'    => esc_html__('Registration Views', 'event_espresso'),
-                        'filename' => 'registrations_overview_views',
-                    ),
-                    'registrations_regoverview_other_help_tab'              => array(
-                        'title'    => esc_html__('Registrations Other', 'event_espresso'),
-                        'filename' => 'registrations_overview_other',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Overview_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Registrations_List_Table',
-                'require_nonce' => false,
-            ),
-            'view_registration' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('REG Details', 'event_espresso'),
-                    'order'      => 15,
-                    'url'        => isset($this->_req_data['_REG_ID'])
-                        ? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'registrations_details_help_tab'                    => array(
-                        'title'    => esc_html__('Registration Details', 'event_espresso'),
-                        'filename' => 'registrations_details',
-                    ),
-                    'registrations_details_table_help_tab'              => array(
-                        'title'    => esc_html__('Registration Details Table', 'event_espresso'),
-                        'filename' => 'registrations_details_table',
-                    ),
-                    'registrations_details_form_answers_help_tab'       => array(
-                        'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
-                        'filename' => 'registrations_details_form_answers',
-                    ),
-                    'registrations_details_registrant_details_help_tab' => array(
-                        'title'    => esc_html__('Contact Details', 'event_espresso'),
-                        'filename' => 'registrations_details_registrant_details',
-                    ),
-                ),
-                'help_tour'     => array('Registration_Details_Help_Tour'),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_registration_details_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'new_registration'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add New Registration', 'event_espresso'),
-                    'url'        => '#',
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'labels'        => array(
-                    'publishbox' => esc_html__('Save Registration', 'event_espresso'),
-                ),
-                'require_nonce' => false,
-            ),
-            'add_new_attendee'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge(
-                    $this->_default_espresso_metaboxes,
-                    array('_publish_post_box', 'attendee_editor_metaboxes')
-                ),
-                'require_nonce' => false,
-            ),
-            'edit_attendee'     => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Contact', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['ATT_ID'])
-                        ? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
-                        : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array('attendee_editor_metaboxes'),
-                'require_nonce' => false,
-            ),
-            'contact_list'      => array(
-                'nav'           => array(
-                    'label' => esc_html__('Contact List', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'EE_Attendee_Contact_List_Table',
-                'help_tabs'     => array(
-                    'registrations_contact_list_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
-                        'filename' => 'registrations_contact_list',
-                    ),
-                    'registrations_contact-list_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_table_column_headings',
-                    ),
-                    'registrations_contact_list_views_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Views', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_views',
-                    ),
-                    'registrations_contact_list_other_help_tab'                 => array(
-                        'title'    => esc_html__('Contact List Other', 'event_espresso'),
-                        'filename' => 'registrations_contact_list_other',
-                    ),
-                ),
-                'help_tour'     => array('Contact_List_Help_Tour'),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            //override default cpt routes
-            'create_new'        => '',
-            'edit'              => '',
-        );
-    }
-
-
-    /**
-     * The below methods aren't used by this class currently
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
-            'click "Update Registration Questions" to save your changes',
-            'event_espresso'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access private
-     * @return void
-     */
-    private function _get_registration_status_array()
-    {
-        self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    protected function _add_screen_options_contact_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    public function load_scripts_styles()
-    {
-        //style
-        wp_register_style(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_reg');
-        //script
-        wp_register_script(
-            'espresso_reg',
-            REG_ASSETS_URL . 'espresso_registrations_admin.js',
-            array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_reg');
-    }
-
-
-    public function load_scripts_styles_edit_attendee()
-    {
-        //stuff to only show up on our attendee edit details page.
-        $attendee_details_translations = array(
-            'att_publish_text' => sprintf(
-                esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
-                $this->_cpt_model_obj->get_datetime('ATT_created')
-            ),
-        );
-        wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
-        wp_enqueue_script('jquery-validate');
-    }
-
-
-    public function load_scripts_styles_view_registration()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        //scripts
-        $this->_get_reg_custom_questions_form($this->_registration->ID());
-        $this->_reg_custom_questions_form->wp_enqueue_scripts(true);
-    }
-
-
-    public function load_scripts_styles_contact_list()
-    {
-        wp_deregister_style('espresso_reg');
-        wp_register_style(
-            'espresso_att',
-            REG_ASSETS_URL . 'espresso_attendees_admin.css',
-            array('ee-admin-css'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_att');
-    }
-
-
-    public function load_scripts_styles_new_registration()
-    {
-        wp_register_script(
-            'ee-spco-for-admin',
-            REG_ASSETS_URL . 'spco_for_admin.js',
-            array('underscore', 'jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-spco-for-admin');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        EE_Form_Section_Proper::wp_enqueue_scripts();
-        EED_Ticket_Selector::load_tckt_slctr_assets();
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
-    {
-        add_filter('FHEE_load_EE_messages', '__return_true');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        //for notification related bulk actions we need to make sure only active messengers have an option.
-        EED_Messages::set_autoloaders();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts               = $message_resource_manager->list_of_active_message_types();
-        //key= bulk_action_slug, value= message type.
-        $match_array = array(
-            'approve_registration'    => 'registration',
-            'decline_registration'    => 'declined_registration',
-            'pending_registration'    => 'pending_approval',
-            'no_approve_registration' => 'not_approved_registration',
-            'cancel_registration'     => 'cancelled_registration',
-        );
-        $can_send = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'batch_send_messages'
-        );
-        /** setup reg status bulk actions **/
-        $def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['approve_registration'], $active_mts, true)) {
-                $def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations',
-                    'event_espresso');
-        }
-        $def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['decline_registration'], $active_mts, true)) {
-                $def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations',
-                    'event_espresso');
-        }
-        $def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso');
-        if ($can_send && in_array($match_array['pending_registration'], $active_mts, true)) {
-                $def_reg_status_actions['pending_and_notify_registration'] = __(
-                    'Set Registrations to Pending Payment and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso');
-        if ($can_send && in_array($match_array['no_approve_registration'], $active_mts, true)) {
-                $def_reg_status_actions['no_approve_and_notify_registration'] = __(
-                    'Set Registrations to Not Approved and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso');
-        if ($can_send && in_array($match_array['cancel_registration'], $active_mts, true)) {
-                $def_reg_status_actions['cancel_and_notify_registration'] = __(
-                    'Cancel Registrations and Notify',
-                    'event_espresso'
-                );
-        }
-        $def_reg_status_actions = apply_filters(
-            'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
-            $def_reg_status_actions,
-            $active_mts
-        );
-
-        $this->_views = array(
-            'all'   => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Registrations', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-            'month' => array(
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-            'today' => array(
-                'slug'        => 'today',
-                'label'       => sprintf(
-                    esc_html__('Today - %s', 'event_espresso'),
-                    date('M d, Y', current_time('timestamp'))
-                ),
-                'count'       => 0,
-                'bulk_action' => array_merge($def_reg_status_actions, array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                )),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_registrations',
-            'espresso_registrations_delete_registration'
-        )) {
-            $this->_views['incomplete'] = array(
-                'slug'        => 'incomplete',
-                'label'       => esc_html__('Incomplete', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
-                ),
-            );
-            $this->_views['trash']      = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
-                    'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _set_list_table_views_contact_list()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => esc_html__('In Use', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
-                ),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
-            'espresso_registrations_trash_attendees')
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    protected function _registration_legend_items()
-    {
-        $fc_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
-            ),
-            'view_details'     => array(
-                'class' => 'dashicons dashicons-clipboard',
-                'desc'  => esc_html__('View Registration Details', 'event_espresso'),
-            ),
-            'edit_attendee'    => array(
-                'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
-                'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
-            ),
-            'view_transaction' => array(
-                'class' => 'dashicons dashicons-cart',
-                'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
-            ),
-            'view_invoice'     => array(
-                'class' => 'dashicons dashicons-media-spreadsheet',
-                'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
-            ),
-        );
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_resend_registration'
-        )) {
-            $fc_items['resend_registration'] = array(
-                'class' => 'dashicons dashicons-email-alt',
-                'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
-            );
-        } else {
-            $fc_items['blank'] = array('class' => 'blank', 'desc' => '');
-        }
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $fc_items['view_related_messages'] = array(
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                );
-            }
-        }
-        $sc_items = array(
-            'approved_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'pending_status'    => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_pending_payment,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'wait_list'         => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_wait_list,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_incomplete,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'not_approved'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_not_approved,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'declined_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_declined,
-                    false,
-                    'sentence'
-                ),
-            ),
-            'cancelled_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(
-                    EEM_Registration::status_id_cancelled,
-                    false,
-                    'sentence'
-                ),
-            ),
-        );
-        return array_merge($fc_items, $sc_items);
-    }
-
-
-
-    /***************************************        REGISTRATION OVERVIEW        **************************************/
-    /**
-     * @throws \EE_Error
-     */
-    protected function _registrations_overview_list_table()
-    {
-        $this->_template_args['admin_page_header'] = '';
-        $EVT_ID                                    = ! empty($this->_req_data['event_id'])
-            ? absint($this->_req_data['event_id'])
-            : 0;
-        if ($EVT_ID) {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registrations',
-                'espresso_registrations_new_registration',
-                $EVT_ID
-            )) {
-                $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-                    'new_registration',
-                    'add-registrant',
-                    array('event_id' => $EVT_ID),
-                    'add-new-h2'
-                );
-            }
-            $event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-            if ($event instanceof EE_Event) {
-                $this->_template_args['admin_page_header'] = sprintf(
-                    esc_html__(
-                        '%s Viewing registrations for the event: %s%s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<br /><a href="'
-                        . EE_Admin_Page::add_query_args_and_nonce(
-                            array(
-                                'action' => 'edit',
-                                'post'   => $event->ID(),
-                            ),
-                            EVENTS_ADMIN_URL
-                        )
-                        . '">&nbsp;'
-                        . $event->get('EVT_name')
-                        . '&nbsp;</a>&nbsp;',
-                    '</h3>'
-                );
-            }
-            $DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
-                $this->_template_args['admin_page_header'] = substr(
-                    $this->_template_args['admin_page_header'],
-                    0,
-                    -5
-                );
-                $this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
-                $this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
-                $this->_template_args['admin_page_header'] .= $datetime->name();
-                $this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
-                $this->_template_args['admin_page_header'] .= '</span></h3>';
-            }
-        }
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * This sets the _registration property for the registration details screen
-     *
-     * @access private
-     * @return bool
-     */
-    private function _set_registration_object()
-    {
-        //get out if we've already set the object
-        if (is_object($this->_registration)) {
-            return true;
-        }
-        $REG    = EEM_Registration::instance();
-        $REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
-        if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
-            return true;
-        } else {
-            $error_msg = sprintf(
-                esc_html__(
-                    'An error occurred and the details for Registration ID #%s could not be retrieved.',
-                    'event_espresso'
-                ),
-                $REG_ID
-            );
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_registration = null;
-            return false;
-        }
-    }
-
-
-    /**
-     * Used to retrieve registrations for the list table.
-     *
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $this_month
-     * @param bool $today
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     */
-    public function get_registrations(
-        $per_page = 10,
-        $count = false,
-        $this_month = false,
-        $today = false
-    ) {
-        if ($this_month) {
-            $this->_req_data['status'] = 'month';
-        }
-        if ($today) {
-            $this->_req_data['status'] = 'today';
-        }
-        $query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see EEM_Base::get_all()
-         */
-        $query_params['group_by'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
-
-
-
-    /**
-     * Retrieves the query parameters to be used by the Registration model for getting registrations.
-     * Note: this listens to values on the request for some of the query parameters.
-     *
-     * @param array $request
-     * @param int    $per_page
-     * @param bool   $count
-     * @return array
-     */
-    protected function _get_registration_query_parameters(
-        $request = array(),
-        $per_page = 10,
-        $count = false
-    ) {
-
-        $query_params = array(
-            0                          => $this->_get_where_conditions_for_registrations_query(
-                $request
-            ),
-            'caps'                     => EEM_Registration::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        );
-        if (! $count) {
-            $query_params = array_merge(
-                $query_params,
-                $this->_get_orderby_for_registrations_query(),
-                $this->_get_limit($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $where array for EE model query parameters.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_event_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['event_id'])) {
-            $where['EVT_ID'] = absint($request['event_id']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_category_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
-            $where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_datetime_id_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['datetime_id'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
-        }
-        if (! empty($request['DTT_ID'])) {
-            $where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_registration_status_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $registration_status = ! empty($request['_reg_status'])
-            ? sanitize_text_field($request['_reg_status'])
-            : '';
-
-        /*
+	/**
+	 * @var EE_Registration
+	 */
+	private $_registration;
+
+	/**
+	 * @var EE_Event
+	 */
+	private $_reg_event;
+
+	/**
+	 * @var EE_Session
+	 */
+	private $_session;
+
+	private static $_reg_status;
+
+	/**
+	 * Form for displaying the custom questions for this registration.
+	 * This gets used a few times throughout the request so its best to cache it
+	 *
+	 * @var EE_Registration_Custom_Questions_Form
+	 */
+	protected $_reg_custom_questions_form = null;
+
+
+	/**
+	 *        constructor
+	 *
+	 * @Constructor
+	 * @access public
+	 * @param bool $routing
+	 * @return Registrations_Admin_Page
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		add_action('wp_loaded', array($this, 'wp_loaded'));
+	}
+
+
+	public function wp_loaded()
+	{
+		// when adding a new registration...
+		if (isset($this->_req_data['action']) && $this->_req_data['action'] === 'new_registration') {
+			EE_System::do_not_cache();
+			if (! isset($this->_req_data['processing_registration'])
+				 || absint($this->_req_data['processing_registration']) !== 1
+			) {
+				// and it's NOT the attendee information reg step
+				// force cookie expiration by setting time to last week
+				setcookie('ee_registration_added', 0, time() - WEEK_IN_SECONDS, '/');
+				// and update the global
+				$_COOKIE['ee_registration_added'] = 0;
+			}
+		}
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REG_PG_SLUG;
+		$this->_admin_base_url  = REG_ADMIN_URL;
+		$this->_admin_base_path = REG_ADMIN;
+		$this->page_label       = esc_html__('Registrations', 'event_espresso');
+		$this->_cpt_routes      = array(
+			'add_new_attendee' => 'espresso_attendees',
+			'edit_attendee'    => 'espresso_attendees',
+			'insert_attendee'  => 'espresso_attendees',
+			'update_attendee'  => 'espresso_attendees',
+		);
+		$this->_cpt_model_names = array(
+			'add_new_attendee' => 'EEM_Attendee',
+			'edit_attendee'    => 'EEM_Attendee',
+		);
+		$this->_cpt_edit_routes = array(
+			'espresso_attendees' => 'edit_attendee',
+		);
+		$this->_pagenow_map     = array(
+			'add_new_attendee' => 'post-new.php',
+			'edit_attendee'    => 'post.php',
+			'trash'            => 'post.php',
+		);
+		add_action('edit_form_after_title', array($this, 'after_title_form_fields'), 10);
+		//add filters so that the comment urls don't take users to a confusing 404 page
+		add_filter('get_comment_link', array($this, 'clear_comment_link'), 10, 3);
+	}
+
+
+	public function clear_comment_link($link, $comment, $args)
+	{
+		//gotta make sure this only happens on this route
+		$post_type = get_post_type($comment->comment_post_ID);
+		if ($post_type === 'espresso_attendees') {
+			return '#commentsdiv';
+		}
+		return $link;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		//todo: all hooks for registrations ajax goes in here
+		add_action('wp_ajax_toggle_checkin_status', array($this, 'toggle_checkin_status'));
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'                      => array(
+				'add-registrant'      => esc_html__('Add New Registration', 'event_espresso'),
+				'add-attendee'        => esc_html__('Add Contact', 'event_espresso'),
+				'edit'                => esc_html__('Edit Contact', 'event_espresso'),
+				'report'              => esc_html__("Event Registrations CSV Report", "event_espresso"),
+				'report_all'          => esc_html__('All Registrations CSV Report', 'event_espresso'),
+				'report_filtered'     => esc_html__('Filtered CSV Report', 'event_espresso'),
+				'contact_list_report' => esc_html__('Contact List Report', 'event_espresso'),
+				'contact_list_export' => esc_html__("Export Data", "event_espresso"),
+			),
+			'publishbox'                   => array(
+				'add_new_attendee' => esc_html__("Add Contact Record", 'event_espresso'),
+				'edit_attendee'    => esc_html__("Update Contact Record", 'event_espresso'),
+			),
+			'hide_add_button_on_cpt_route' => array(
+				'edit_attendee' => true,
+			),
+		);
+	}
+
+
+	/**
+	 *        grab url requests and route them
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function _set_page_routes()
+	{
+		$this->_get_registration_status_array();
+		$reg_id             = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID'] : 0;
+		$att_id             = ! empty($this->_req_data['ATT_ID']) && ! is_array($this->_req_data['ATT_ID'])
+			? $this->_req_data['ATT_ID'] : 0;
+		$att_id             = ! empty($this->_req_data['post']) && ! is_array($this->_req_data['post'])
+			? $this->_req_data['post']
+			: $att_id;
+		$this->_page_routes = array(
+			'default'                            => array(
+				'func'       => '_registrations_overview_list_table',
+				'capability' => 'ee_read_registrations',
+			),
+			'view_registration'                  => array(
+				'func'       => '_registration_details',
+				'capability' => 'ee_read_registration',
+				'obj_id'     => $reg_id,
+			),
+			'edit_registration'                  => array(
+				'func'               => '_update_attendee_registration_form',
+				'noheader'           => true,
+				'headers_sent_route' => 'view_registration',
+				'capability'         => 'ee_edit_registration',
+				'obj_id'             => $reg_id,
+				'_REG_ID'            => $reg_id,
+			),
+			'trash_registrations'                => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'restore_registrations'              => array(
+				'func'       => '_trash_or_restore_registrations',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'delete_registrations'               => array(
+				'func'       => '_delete_registrations',
+				'noheader'   => true,
+				'capability' => 'ee_delete_registrations',
+			),
+			'new_registration'                   => array(
+				'func'       => 'new_registration',
+				'capability' => 'ee_edit_registrations',
+			),
+			'process_reg_step'                   => array(
+				'func'       => 'process_reg_step',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'redirect_to_txn'                    => array(
+				'func'       => 'redirect_to_txn',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registrations',
+			),
+			'change_reg_status'                  => array(
+				'func'       => '_change_reg_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_registration'               => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'approve_and_notify_registration'    => array(
+				'func'       => 'approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_registration'               => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'decline_and_notify_registration'    => array(
+				'func'       => 'decline_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_registration'               => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'pending_and_notify_registration'    => array(
+				'func'       => 'pending_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_registration'            => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'no_approve_and_notify_registration' => array(
+				'func'       => 'not_approve_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_registration'                => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'cancel_and_notify_registration'     => array(
+				'func'       => 'cancel_registration',
+				'noheader'   => true,
+				'args'       => array(true),
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'wait_list_registration' => array(
+				'func'       => 'wait_list_registration',
+				'noheader'   => true,
+				'capability' => 'ee_edit_registration',
+				'obj_id'     => $reg_id,
+			),
+			'contact_list'                       => array(
+				'func'       => '_attendee_contact_list_table',
+				'capability' => 'ee_read_contacts',
+			),
+			'add_new_attendee'                   => array(
+				'func' => '_create_new_cpt_item',
+				'args' => array(
+					'new_attendee' => true,
+					'capability'   => 'ee_edit_contacts',
+				),
+			),
+			'edit_attendee'                      => array(
+				'func'       => '_edit_cpt_item',
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'duplicate_attendee'                 => array(
+				'func'       => '_duplicate_attendee',
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'insert_attendee'                    => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+			),
+			'update_attendee'                    => array(
+				'func'       => '_insert_or_update_attendee',
+				'args'       => array(
+					'new_attendee' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_edit_contacts',
+				'obj_id'     => $att_id,
+			),
+			'trash_attendee'                    => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => true,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'restore_attendees'                  => array(
+				'func'       => '_trash_or_restore_attendees',
+				'args'       => array(
+					'trash' => false,
+				),
+				'noheader'   => true,
+				'capability' => 'ee_delete_contacts',
+				'obj_id'     => $att_id,
+			),
+			'resend_registration'                => array(
+				'func'       => '_resend_registration',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'registrations_report'               => array(
+				'func'       => '_registrations_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+			'contact_list_export'                => array(
+				'func'       => '_contact_list_export',
+				'noheader'   => true,
+				'capability' => 'export',
+			),
+			'contact_list_report'                => array(
+				'func'       => '_contact_list_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_contacts',
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'           => array(
+				'nav'           => array(
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'order' => 5,
+				),
+				'help_tabs'     => array(
+					'registrations_overview_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Overview', 'event_espresso'),
+						'filename' => 'registrations_overview',
+					),
+					'registrations_overview_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Registrations Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_overview_table_column_headings',
+					),
+					'registrations_overview_filters_help_tab'               => array(
+						'title'    => esc_html__('Registration Filters', 'event_espresso'),
+						'filename' => 'registrations_overview_filters',
+					),
+					'registrations_overview_views_help_tab'                 => array(
+						'title'    => esc_html__('Registration Views', 'event_espresso'),
+						'filename' => 'registrations_overview_views',
+					),
+					'registrations_regoverview_other_help_tab'              => array(
+						'title'    => esc_html__('Registrations Other', 'event_espresso'),
+						'filename' => 'registrations_overview_other',
+					),
+				),
+				'help_tour'     => array('Registration_Overview_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Registrations_List_Table',
+				'require_nonce' => false,
+			),
+			'view_registration' => array(
+				'nav'           => array(
+					'label'      => esc_html__('REG Details', 'event_espresso'),
+					'order'      => 15,
+					'url'        => isset($this->_req_data['_REG_ID'])
+						? add_query_arg(array('_REG_ID' => $this->_req_data['_REG_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'registrations_details_help_tab'                    => array(
+						'title'    => esc_html__('Registration Details', 'event_espresso'),
+						'filename' => 'registrations_details',
+					),
+					'registrations_details_table_help_tab'              => array(
+						'title'    => esc_html__('Registration Details Table', 'event_espresso'),
+						'filename' => 'registrations_details_table',
+					),
+					'registrations_details_form_answers_help_tab'       => array(
+						'title'    => esc_html__('Registration Form Answers', 'event_espresso'),
+						'filename' => 'registrations_details_form_answers',
+					),
+					'registrations_details_registrant_details_help_tab' => array(
+						'title'    => esc_html__('Contact Details', 'event_espresso'),
+						'filename' => 'registrations_details_registrant_details',
+					),
+				),
+				'help_tour'     => array('Registration_Details_Help_Tour'),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_registration_details_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'new_registration'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add New Registration', 'event_espresso'),
+					'url'        => '#',
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'labels'        => array(
+					'publishbox' => esc_html__('Save Registration', 'event_espresso'),
+				),
+				'require_nonce' => false,
+			),
+			'add_new_attendee'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge(
+					$this->_default_espresso_metaboxes,
+					array('_publish_post_box', 'attendee_editor_metaboxes')
+				),
+				'require_nonce' => false,
+			),
+			'edit_attendee'     => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Contact', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['ATT_ID'])
+						? add_query_arg(array('ATT_ID' => $this->_req_data['ATT_ID']), $this->_current_page_view_url)
+						: $this->_admin_base_url,
+				),
+				'metaboxes'     => array('attendee_editor_metaboxes'),
+				'require_nonce' => false,
+			),
+			'contact_list'      => array(
+				'nav'           => array(
+					'label' => esc_html__('Contact List', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'EE_Attendee_Contact_List_Table',
+				'help_tabs'     => array(
+					'registrations_contact_list_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Contact List', 'event_espresso'),
+						'filename' => 'registrations_contact_list',
+					),
+					'registrations_contact-list_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Contact List Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_contact_list_table_column_headings',
+					),
+					'registrations_contact_list_views_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Views', 'event_espresso'),
+						'filename' => 'registrations_contact_list_views',
+					),
+					'registrations_contact_list_other_help_tab'                 => array(
+						'title'    => esc_html__('Contact List Other', 'event_espresso'),
+						'filename' => 'registrations_contact_list_other',
+					),
+				),
+				'help_tour'     => array('Contact_List_Help_Tour'),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			//override default cpt routes
+			'create_new'        => '',
+			'edit'              => '',
+		);
+	}
+
+
+	/**
+	 * The below methods aren't used by this class currently
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['update_att_qstns'] = esc_html__(
+			'click "Update Registration Questions" to save your changes',
+			'event_espresso'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _get_registration_status_array()
+	{
+		self::$_reg_status = EEM_Registration::reg_status_array(array(), true);
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	protected function _add_screen_options_contact_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__("Contacts", 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	public function load_scripts_styles()
+	{
+		//style
+		wp_register_style(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_reg');
+		//script
+		wp_register_script(
+			'espresso_reg',
+			REG_ASSETS_URL . 'espresso_registrations_admin.js',
+			array('jquery-ui-datepicker', 'jquery-ui-draggable', 'ee_admin_js'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_reg');
+	}
+
+
+	public function load_scripts_styles_edit_attendee()
+	{
+		//stuff to only show up on our attendee edit details page.
+		$attendee_details_translations = array(
+			'att_publish_text' => sprintf(
+				esc_html__('Created on: <b>%1$s</b>', 'event_espresso'),
+				$this->_cpt_model_obj->get_datetime('ATT_created')
+			),
+		);
+		wp_localize_script('espresso_reg', 'ATTENDEE_DETAILS', $attendee_details_translations);
+		wp_enqueue_script('jquery-validate');
+	}
+
+
+	public function load_scripts_styles_view_registration()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		//scripts
+		$this->_get_reg_custom_questions_form($this->_registration->ID());
+		$this->_reg_custom_questions_form->wp_enqueue_scripts(true);
+	}
+
+
+	public function load_scripts_styles_contact_list()
+	{
+		wp_deregister_style('espresso_reg');
+		wp_register_style(
+			'espresso_att',
+			REG_ASSETS_URL . 'espresso_attendees_admin.css',
+			array('ee-admin-css'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_att');
+	}
+
+
+	public function load_scripts_styles_new_registration()
+	{
+		wp_register_script(
+			'ee-spco-for-admin',
+			REG_ASSETS_URL . 'spco_for_admin.js',
+			array('underscore', 'jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-spco-for-admin');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		EE_Form_Section_Proper::wp_enqueue_scripts();
+		EED_Ticket_Selector::load_tckt_slctr_assets();
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_resend_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	public function AHEE__EE_Admin_Page__route_admin_request_approve_registration()
+	{
+		add_filter('FHEE_load_EE_messages', '__return_true');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		//for notification related bulk actions we need to make sure only active messengers have an option.
+		EED_Messages::set_autoloaders();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts               = $message_resource_manager->list_of_active_message_types();
+		//key= bulk_action_slug, value= message type.
+		$match_array = array(
+			'approve_registration'    => 'registration',
+			'decline_registration'    => 'declined_registration',
+			'pending_registration'    => 'pending_approval',
+			'no_approve_registration' => 'not_approved_registration',
+			'cancel_registration'     => 'cancelled_registration',
+		);
+		$can_send = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'batch_send_messages'
+		);
+		/** setup reg status bulk actions **/
+		$def_reg_status_actions['approve_registration'] = __('Approve Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['approve_registration'], $active_mts, true)) {
+				$def_reg_status_actions['approve_and_notify_registration'] = __('Approve and Notify Registrations',
+					'event_espresso');
+		}
+		$def_reg_status_actions['decline_registration'] = __('Decline Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['decline_registration'], $active_mts, true)) {
+				$def_reg_status_actions['decline_and_notify_registration'] = __('Decline and Notify Registrations',
+					'event_espresso');
+		}
+		$def_reg_status_actions['pending_registration'] = __('Set Registrations to Pending Payment', 'event_espresso');
+		if ($can_send && in_array($match_array['pending_registration'], $active_mts, true)) {
+				$def_reg_status_actions['pending_and_notify_registration'] = __(
+					'Set Registrations to Pending Payment and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['no_approve_registration'] = __('Set Registrations to Not Approved', 'event_espresso');
+		if ($can_send && in_array($match_array['no_approve_registration'], $active_mts, true)) {
+				$def_reg_status_actions['no_approve_and_notify_registration'] = __(
+					'Set Registrations to Not Approved and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions['cancel_registration'] = __('Cancel Registrations', 'event_espresso');
+		if ($can_send && in_array($match_array['cancel_registration'], $active_mts, true)) {
+				$def_reg_status_actions['cancel_and_notify_registration'] = __(
+					'Cancel Registrations and Notify',
+					'event_espresso'
+				);
+		}
+		$def_reg_status_actions = apply_filters(
+			'FHEE__Registrations_Admin_Page___set_list_table_views_default__def_reg_status_actions_array',
+			$def_reg_status_actions,
+			$active_mts
+		);
+
+		$this->_views = array(
+			'all'   => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Registrations', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+			'month' => array(
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+			'today' => array(
+				'slug'        => 'today',
+				'label'       => sprintf(
+					esc_html__('Today - %s', 'event_espresso'),
+					date('M d, Y', current_time('timestamp'))
+				),
+				'count'       => 0,
+				'bulk_action' => array_merge($def_reg_status_actions, array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				)),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_registrations',
+			'espresso_registrations_delete_registration'
+		)) {
+			$this->_views['incomplete'] = array(
+				'slug'        => 'incomplete',
+				'label'       => esc_html__('Incomplete', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_registrations' => esc_html__('Trash Registrations', 'event_espresso'),
+				),
+			);
+			$this->_views['trash']      = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_registrations' => esc_html__('Restore Registrations', 'event_espresso'),
+					'delete_registrations'  => esc_html__('Delete Registrations Permanently', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _set_list_table_views_contact_list()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => esc_html__('In Use', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_attendees' => esc_html__('Move to Trash', 'event_espresso'),
+				),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_contacts',
+			'espresso_registrations_trash_attendees')
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'restore_attendees' => esc_html__('Restore from Trash', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	protected function _registration_legend_items()
+	{
+		$fc_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => esc_html__('This is the Primary Registrant', 'event_espresso'),
+			),
+			'view_details'     => array(
+				'class' => 'dashicons dashicons-clipboard',
+				'desc'  => esc_html__('View Registration Details', 'event_espresso'),
+			),
+			'edit_attendee'    => array(
+				'class' => 'ee-icon ee-icon-user-edit ee-icon-size-16',
+				'desc'  => esc_html__('Edit Contact Details', 'event_espresso'),
+			),
+			'view_transaction' => array(
+				'class' => 'dashicons dashicons-cart',
+				'desc'  => esc_html__('View Transaction Details', 'event_espresso'),
+			),
+			'view_invoice'     => array(
+				'class' => 'dashicons dashicons-media-spreadsheet',
+				'desc'  => esc_html__('View Transaction Invoice', 'event_espresso'),
+			),
+		);
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_resend_registration'
+		)) {
+			$fc_items['resend_registration'] = array(
+				'class' => 'dashicons dashicons-email-alt',
+				'desc'  => esc_html__('Resend Registration Details', 'event_espresso'),
+			);
+		} else {
+			$fc_items['blank'] = array('class' => 'blank', 'desc' => '');
+		}
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$fc_items['view_related_messages'] = array(
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				);
+			}
+		}
+		$sc_items = array(
+			'approved_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_approved,
+					false,
+					'sentence'
+				),
+			),
+			'pending_status'    => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_pending_payment,
+					false,
+					'sentence'
+				),
+			),
+			'wait_list'         => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_wait_list,
+					false,
+					'sentence'
+				),
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_incomplete,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_incomplete,
+					false,
+					'sentence'
+				),
+			),
+			'not_approved'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_not_approved,
+					false,
+					'sentence'
+				),
+			),
+			'declined_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_declined,
+					false,
+					'sentence'
+				),
+			),
+			'cancelled_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(
+					EEM_Registration::status_id_cancelled,
+					false,
+					'sentence'
+				),
+			),
+		);
+		return array_merge($fc_items, $sc_items);
+	}
+
+
+
+	/***************************************        REGISTRATION OVERVIEW        **************************************/
+	/**
+	 * @throws \EE_Error
+	 */
+	protected function _registrations_overview_list_table()
+	{
+		$this->_template_args['admin_page_header'] = '';
+		$EVT_ID                                    = ! empty($this->_req_data['event_id'])
+			? absint($this->_req_data['event_id'])
+			: 0;
+		if ($EVT_ID) {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registrations',
+				'espresso_registrations_new_registration',
+				$EVT_ID
+			)) {
+				$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+					'new_registration',
+					'add-registrant',
+					array('event_id' => $EVT_ID),
+					'add-new-h2'
+				);
+			}
+			$event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+			if ($event instanceof EE_Event) {
+				$this->_template_args['admin_page_header'] = sprintf(
+					esc_html__(
+						'%s Viewing registrations for the event: %s%s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<br /><a href="'
+						. EE_Admin_Page::add_query_args_and_nonce(
+							array(
+								'action' => 'edit',
+								'post'   => $event->ID(),
+							),
+							EVENTS_ADMIN_URL
+						)
+						. '">&nbsp;'
+						. $event->get('EVT_name')
+						. '&nbsp;</a>&nbsp;',
+					'</h3>'
+				);
+			}
+			$DTT_ID   = ! empty($this->_req_data['datetime_id']) ? absint($this->_req_data['datetime_id']) : 0;
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime && $this->_template_args['admin_page_header'] !== '') {
+				$this->_template_args['admin_page_header'] = substr(
+					$this->_template_args['admin_page_header'],
+					0,
+					-5
+				);
+				$this->_template_args['admin_page_header'] .= ' &nbsp;<span class="drk-grey-text">';
+				$this->_template_args['admin_page_header'] .= '<span class="dashicons dashicons-calendar"></span>';
+				$this->_template_args['admin_page_header'] .= $datetime->name();
+				$this->_template_args['admin_page_header'] .= ' ( ' . $datetime->start_date() . ' )';
+				$this->_template_args['admin_page_header'] .= '</span></h3>';
+			}
+		}
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_registration_legend_items());
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * This sets the _registration property for the registration details screen
+	 *
+	 * @access private
+	 * @return bool
+	 */
+	private function _set_registration_object()
+	{
+		//get out if we've already set the object
+		if (is_object($this->_registration)) {
+			return true;
+		}
+		$REG    = EEM_Registration::instance();
+		$REG_ID = ( ! empty($this->_req_data['_REG_ID'])) ? absint($this->_req_data['_REG_ID']) : false;
+		if ($this->_registration = $REG->get_one_by_ID($REG_ID)) {
+			return true;
+		} else {
+			$error_msg = sprintf(
+				esc_html__(
+					'An error occurred and the details for Registration ID #%s could not be retrieved.',
+					'event_espresso'
+				),
+				$REG_ID
+			);
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_registration = null;
+			return false;
+		}
+	}
+
+
+	/**
+	 * Used to retrieve registrations for the list table.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $this_month
+	 * @param bool $today
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 */
+	public function get_registrations(
+		$per_page = 10,
+		$count = false,
+		$this_month = false,
+		$today = false
+	) {
+		if ($this_month) {
+			$this->_req_data['status'] = 'month';
+		}
+		if ($today) {
+			$this->_req_data['status'] = 'today';
+		}
+		$query_params = $this->_get_registration_query_parameters($this->_req_data, $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see EEM_Base::get_all()
+		 */
+		$query_params['group_by'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Retrieves the query parameters to be used by the Registration model for getting registrations.
+	 * Note: this listens to values on the request for some of the query parameters.
+	 *
+	 * @param array $request
+	 * @param int    $per_page
+	 * @param bool   $count
+	 * @return array
+	 */
+	protected function _get_registration_query_parameters(
+		$request = array(),
+		$per_page = 10,
+		$count = false
+	) {
+
+		$query_params = array(
+			0                          => $this->_get_where_conditions_for_registrations_query(
+				$request
+			),
+			'caps'                     => EEM_Registration::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		);
+		if (! $count) {
+			$query_params = array_merge(
+				$query_params,
+				$this->_get_orderby_for_registrations_query(),
+				$this->_get_limit($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $where array for EE model query parameters.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_event_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['event_id'])) {
+			$where['EVT_ID'] = absint($request['event_id']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_category_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['EVT_CAT']) && (int)$request['EVT_CAT'] !== -1) {
+			$where['Event.Term_Taxonomy.term_id'] = absint($request['EVT_CAT']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_datetime_id_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['datetime_id'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['datetime_id']);
+		}
+		if (! empty($request['DTT_ID'])) {
+			$where['Ticket.Datetime.DTT_ID'] = absint($request['DTT_ID']);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_registration_status_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$registration_status = ! empty($request['_reg_status'])
+			? sanitize_text_field($request['_reg_status'])
+			: '';
+
+		/*
          * If filtering by registration status, then we show registrations matching that status.
          * If not filtering by specified status, then we show all registrations excluding incomplete registrations
          * UNLESS viewing trashed registrations.
          */
-        if (! empty($registration_status)) {
-            $where['STS_ID'] = $registration_status;
-        } else {
-            //make sure we exclude incomplete registrations, but only if not trashed.
-            if ($view === 'trash') {
-                $where['REG_deleted'] = true;
-            } elseif ($view === 'incomplete') {
-                $where['STS_ID'] = EEM_Registration::status_id_incomplete;
-            } else {
-                $where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _add_date_to_where_conditions(array $request)
-    {
-        $where = array();
-        $view = EEH_Array::is_set($request, 'status', '');
-        $month_range             = ! empty($request['month_range'])
-            ? sanitize_text_field($request['month_range'])
-            : '';
-        $retrieve_for_today      = $view === 'today';
-        $retrieve_for_this_month = $view === 'month';
-
-        if ($retrieve_for_today) {
-            $now               = date('Y-m-d', current_time('timestamp'));
-            $where['REG_date'] = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($retrieve_for_this_month) {
-            $current_year_and_month = date('Y-m', current_time('timestamp'));
-            $days_this_month        = date('t', current_time('timestamp'));
-            $where['REG_date']      = array(
-                'BETWEEN',
-                array(
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    EEM_Registration::instance()->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ),
-            );
-        } elseif ($month_range) {
-            $pieces          = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested  = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            //if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $where['REG_date'] = array(
-                    'BETWEEN',
-                    array(
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s'
-                        ),
-                        EEM_Registration::instance()->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s'
-                        ),
-                    ),
-                );
-            }
-        }
-        return $where;
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     *
-     * @param array $request usually the same as $this->_req_data but not necessarily
-     * @return array
-     */
-    protected function _add_search_to_where_conditions(array $request)
-    {
-        $where = array();
-        if (! empty($request['s'])) {
-            $search_string = '%' . sanitize_text_field($request['s']) . '%';
-            $where['OR*search_conditions'] = array(
-                'Event.EVT_name'                          => array('LIKE', $search_string),
-                'Event.EVT_desc'                          => array('LIKE', $search_string),
-                'Event.EVT_short_desc'                    => array('LIKE', $search_string),
-                'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
-                'Attendee.ATT_fname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_lname'                      => array('LIKE', $search_string),
-                'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
-                'Attendee.ATT_email'                      => array('LIKE', $search_string),
-                'Attendee.ATT_address'                    => array('LIKE', $search_string),
-                'Attendee.ATT_address2'                   => array('LIKE', $search_string),
-                'Attendee.ATT_city'                       => array('LIKE', $search_string),
-                'REG_final_price'                         => array('LIKE', $search_string),
-                'REG_code'                                => array('LIKE', $search_string),
-                'REG_count'                               => array('LIKE', $search_string),
-                'REG_group_size'                          => array('LIKE', $search_string),
-                'Ticket.TKT_name'                         => array('LIKE', $search_string),
-                'Ticket.TKT_description'                  => array('LIKE', $search_string),
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
-            );
-        }
-        return $where;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param array $request
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_where_conditions_for_registrations_query($request)
-    {
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            array_merge(
-                $this->_add_event_id_to_where_conditions($request),
-                $this->_add_category_id_to_where_conditions($request),
-                $this->_add_datetime_id_to_where_conditions($request),
-                $this->_add_registration_status_to_where_conditions($request),
-                $this->_add_date_to_where_conditions($request),
-                $this->_add_search_to_where_conditions($request)
-            ),
-            $request
-        );
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function _get_orderby_for_registrations_query()
-    {
-        $orderby_field = ! empty($this->_req_data['orderby'])
-            ? sanitize_text_field($this->_req_data['orderby'])
-            : '';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby_field = 'REG_ID';
-                break;
-            case '_Reg_status':
-                $orderby_field = 'STS_ID';
-                break;
-            case 'ATT_fname':
-                $orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
-                break;
-            case 'ATT_lname':
-                $orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
-                break;
-            case 'event_name':
-                $orderby_field = 'Event.EVT_name';
-                break;
-            case 'DTT_EVT_start':
-                $orderby_field = 'Event.Datetime.DTT_EVT_start';
-                break;
-            default: //'REG_date'
-                $orderby_field = 'REG_date';
-        }
-
-        //order
-        $order = ! empty($this->_req_data['order'])
-            ? sanitize_text_field($this->_req_data['order'])
-            : 'DESC';
-
-        //mutate orderby_field
-        $orderby_field = array_combine(
-            (array) $orderby_field,
-            array_fill(0, count($orderby_field), $order)
-        );
-        return array('order_by' => $orderby_field);
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param $per_page
-     * @return array
-     */
-    protected function _get_limit($per_page)
-    {
-        $current_page = ! empty($this->_req_data['paged'])
-            ? absint($this->_req_data['paged'])
-            : 1;
-        $per_page     = ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-
-        //-1 means return all results so get out if that's set.
-        if ((int)$per_page === -1) {
-            return array();
-        }
-        $per_page = absint($per_page);
-        $offset   = ($current_page - 1) * $per_page;
-        return array('limit' => array($offset, $per_page));
-    }
-
-
-    public function get_registration_status_array()
-    {
-        return self::$_reg_status;
-    }
-
-
-
-
-    /***************************************        REGISTRATION DETAILS        ***************************************/
-    /**
-     *        generates HTML for the View Registration Details Admin page
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _registration_details()
-    {
-        $this->_template_args = array();
-        $this->_set_registration_object();
-        if (is_object($this->_registration)) {
-            $transaction                                   = $this->_registration->transaction()
-                ? $this->_registration->transaction()
-                : EE_Transaction::new_instance();
-            $this->_session                                = $transaction->session_data();
-            $event_id                                      = $this->_registration->event_ID();
-            $this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
-            $this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
-            $this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
-            $this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
-            $this->_template_args['grand_total']           = $transaction->total();
-            $this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
-            // link back to overview
-            $this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
-            $this->_template_args['registration']                = $this->_registration;
-            $this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'default',
-                    'event_id' => $event_id,
-                ),
-                REG_ADMIN_URL
-            );
-            $this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'default',
-                    'EVT_ID' => $event_id,
-                    'page'   => 'espresso_transactions',
-                ),
-                admin_url('admin.php')
-            );
-            $this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => 'espresso_events',
-                    'action' => 'edit',
-                    'post'   => $event_id,
-                ),
-                admin_url('admin.php')
-            );
-            //next and previous links
-            $next_reg                                      = $this->_registration->next(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['next_registration']     = $next_reg
-                ? $this->_next_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $next_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-right ee-icon-size-22'
-                )
-                : '';
-            $previous_reg                                  = $this->_registration->previous(
-                null,
-                array(),
-                'REG_ID'
-            );
-            $this->_template_args['previous_registration'] = $previous_reg
-                ? $this->_previous_link(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action'  => 'view_registration',
-                            '_REG_ID' => $previous_reg['REG_ID'],
-                        ),
-                        REG_ADMIN_URL
-                    ),
-                    'dashicons dashicons-arrow-left ee-icon-size-22'
-                )
-                : '';
-            // grab header
-            $template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
-            $this->_template_args['REG_ID']            = $this->_registration->ID();
-            $this->_template_args['admin_page_header'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-            );
-        } else {
-            $this->_template_args['admin_page_header'] = $this->display_espresso_notices();
-        }
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    protected function _registration_details_metaboxes()
-    {
-        do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
-        $this->_set_registration_object();
-        $attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
-        add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
-            array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
-        add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
-            array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registration',
-                'edit-reg-questions-mbox'
-            )
-        ) {
-            add_meta_box(
-                'edit-reg-questions-mbox',
-                esc_html__('Registration Form Answers', 'event_espresso'),
-                array($this, '_reg_questions_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-        add_meta_box(
-            'edit-reg-registrant-mbox',
-            esc_html__('Contact Details', 'event_espresso'),
-            array($this, '_reg_registrant_side_meta_box'),
-            $this->wp_page_slug,
-            'side',
-            'high'
-        );
-        if ($this->_registration->group_size() > 1) {
-            add_meta_box(
-                'edit-reg-attendees-mbox',
-                esc_html__('Other Registrations in this Transaction', 'event_espresso'),
-                array($this, '_reg_attendees_meta_box'),
-                $this->wp_page_slug,
-                'normal',
-                'high'
-            );
-        }
-    }
-
-
-    /**
-     * set_reg_status_buttons_metabox
-     *
-     * @access protected
-     * @return string
-     * @throws \EE_Error
-     */
-    public function set_reg_status_buttons_metabox()
-    {
-        $this->_set_registration_object();
-        $change_reg_status_form = $this->_generate_reg_status_change_form();
-        echo $change_reg_status_form->form_open(
-            self::add_query_args_and_nonce(
-                array(
-                    'action' => 'change_reg_status',
-                ),
-                REG_ADMIN_URL
-            )
-        );
-        echo $change_reg_status_form->get_html();
-        echo $change_reg_status_form->form_close();
-    }
-
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _generate_reg_status_change_form()
-    {
-        return new EE_Form_Section_Proper(array(
-            'name'            => 'reg_status_change_form',
-            'html_id'         => 'reg-status-change-form',
-            'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-            'subsections'     => array(
-                'return'             => new EE_Hidden_Input(array(
-                    'name'    => 'return',
-                    'default' => 'view_registration',
-                )),
-                'REG_ID'             => new EE_Hidden_Input(array(
-                    'name'    => 'REG_ID',
-                    'default' => $this->_registration->ID(),
-                )),
-                'current_status'     => new EE_Form_Section_HTML(
-                    EEH_HTML::tr(
-                        EEH_HTML::th(
-                            EEH_HTML::label(
-                                EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
-                                )
-                            )
-                        )
-                        . EEH_HTML::td(
-                            EEH_HTML::strong(
-                                $this->_registration->pretty_status(),
-                                '',
-                                'status-' . $this->_registration->status_ID(),
-                                'line-height: 1em; font-size: 1.5em; font-weight: bold;'
-                            )
-                        )
-                    )
-                ),
-                'reg_status'         => new EE_Select_Input(
-                    $this->_get_reg_statuses(),
-                    array(
-                        'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
-                        'default'         => $this->_registration->status_ID(),
-                    )
-                ),
-                'send_notifications' => new EE_Yes_No_Input(
-                    array(
-                        'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
-                        'default'         => false,
-                        'html_help_text'  => esc_html__(
-                            'If set to "Yes", then the related messages will be sent to the registrant.',
-                            'event_espresso'
-                        ),
-                    )
-                ),
-                'submit'             => new EE_Submit_Input(
-                    array(
-                        'html_class'      => 'button-primary',
-                        'html_label_text' => '&nbsp;',
-                        'default'         => esc_html__('Update Registration Status', 'event_espresso'),
-                    )
-                ),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns an array of all the buttons for the various statuses and switch status actions
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _get_reg_statuses()
-    {
-        $reg_status_array = EEM_Registration::instance()->reg_status_array();
-        unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
-        // get current reg status
-        $current_status = $this->_registration->status_ID();
-        // is registration for free event? This will determine whether to display the pending payment option
-        if (
-            $current_status !== EEM_Registration::status_id_pending_payment
-            && $this->_registration->transaction()->is_free()
-        ) {
-            unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
-        }
-        return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
-    }
-
-
-
-    /**
-     * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
-     *
-     * @param bool $status REG status given for changing registrations to.
-     * @param bool $notify Whether to send messages notifications or not.
-     * @return array  (array with reg_id(s) updated and whether update was successful.
-     * @throws \EE_Error
-     */
-    protected function _set_registration_status_from_request($status = false, $notify = false)
-    {
-        if (isset($this->_req_data['reg_status_change_form'])) {
-            $REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
-                ? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
-        } else {
-            $REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
-        }
-        $success = $this->_set_registration_status($REG_IDs, $status);
-        //notify?
-        if ($success
-            && $notify
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_process_resend_registration();
-        }
-        return $success;
-    }
-
-
-
-    /**
-     * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
-     * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
-     *
-     * @param array $REG_IDs
-     * @param bool  $status
-     * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     *               the array of updated registrations).
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    protected function _set_registration_status($REG_IDs = array(), $status = false)
-    {
-        $success = false;
-        // typecast $REG_IDs
-        $REG_IDs = (array)$REG_IDs;
-        if ( ! empty($REG_IDs)) {
-            $success = true;
-            // set default status if none is passed
-            $status = $status ? $status : EEM_Registration::status_id_pending_payment;
-            // sanitize $REG_IDs
-            $REG_IDs = array_filter($REG_IDs, 'absint');
-            //loop through REG_ID's and change status
-            foreach ($REG_IDs as $REG_ID) {
-                $registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_status($status);
-                    $result = $registration->save();
-                    // verifying explicit fails because update *may* just return 0 for 0 rows affected
-                    $success = $result !== false ? $success : false;
-                }
-            }
-        }
-        //reset _req_data['_REG_ID'] for any potential future messages notifications
-        $this->_req_data['_REG_ID'] = $REG_IDs;
-        //return $success and processed registrations
-        return array('REG_ID' => $REG_IDs, 'success' => $success);
-    }
-
-
-    /**
-     * Common logic for setting up success message and redirecting to appropriate route
-     *
-     * @param  string $STS_ID status id for the registration changed to
-     * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
-     * @return void
-     */
-    protected function _reg_status_change_return($STS_ID, $notify = false)
-    {
-        $result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
-            : array('success' => false);
-        $success = isset($result['success']) && $result['success'];
-        //setup success message
-        if ($success) {
-            if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
-                $msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
-            } else {
-                $msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
-                    EEH_Template::pretty_status($STS_ID, false, 'lower'));
-            }
-            EE_Error::add_success($msg);
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong, and the status was not changed',
-                    'event_espresso'
-                ), __FILE__, __LINE__, __FUNCTION__
-            );
-        }
-        if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
-            $route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
-        } else {
-            $route = array('action' => 'default');
-        }
-        //unset nonces
-        foreach ($this->_req_data as $ref => $value) {
-            if (strpos($ref, 'nonce') !== false) {
-                unset($this->_req_data[$ref]);
-                continue;
-            }
-            $value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
-            $this->_req_data[$ref] = $value;
-        }
-        //merge request vars so that the reloaded list table contains any existing filter query params
-        $route = array_merge($this->_req_data, $route);
-        $this->_redirect_after_action($success, '', '', $route, true);
-    }
-
-
-    /**
-     * incoming reg status change from reg details page.
-     *
-     * @return void
-     */
-    protected function _change_reg_status()
-    {
-        $this->_req_data['return'] = 'view_registration';
-        //set notify based on whether the send notifications toggle is set or not
-        $notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
-        //$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
-        $this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
-            ? $this->_req_data['reg_status_change_form']['reg_status'] : '';
-        switch ($this->_req_data['reg_status_change_form']['reg_status']) {
-            case EEM_Registration::status_id_approved :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
-                $this->approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_pending_payment :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
-                $this->pending_registration($notify);
-                break;
-            case EEM_Registration::status_id_not_approved :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
-                $this->not_approve_registration($notify);
-                break;
-            case EEM_Registration::status_id_declined :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
-                $this->decline_registration($notify);
-                break;
-            case EEM_Registration::status_id_cancelled :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
-                $this->cancel_registration($notify);
-                break;
-            case EEM_Registration::status_id_wait_list :
-            case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
-                $this->wait_list_registration($notify);
-                break;
-            case EEM_Registration::status_id_incomplete :
-            default :
-                $result['success'] = false;
-                unset($this->_req_data['return']);
-                $this->_reg_status_change_return('', false);
-                break;
-        }
-    }
-
-
-    /**
-     * approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their approval.
-     * @return void
-     */
-    protected function approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function decline_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
-    }
-
-
-    /**
-     *        cancel_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function cancel_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
-    }
-
-
-    /**
-     *        not_approve_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function not_approve_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
-    }
-
-
-    /**
-     *        decline_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function pending_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
-    }
-
-
-    /**
-     * waitlist_registration
-     *
-     * @access protected
-     * @param bool $notify whether or not to notify the registrant about their status change.
-     * @return void
-     */
-    protected function wait_list_registration($notify = false)
-    {
-        $this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    public function _reg_details_meta_box()
-    {
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        EEH_Autoloader::register_line_item_filter_autoloaders();
-        EE_Registry::instance()->load_helper('Line_Item');
-        $transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
-            : EE_Transaction::new_instance();
-        $this->_session = $transaction->session_data();
-        $filters        = new EE_Line_Item_Filter_Collection();
-        //$filters->add( new EE_Non_Zero_Line_Item_Filter() );
-        $filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
-        $line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
-            $transaction->total_line_item());
-        $filtered_line_item_tree                 = $line_item_filter_processor->process();
-        $line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
-            'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
-        $this->_template_args['line_item_table'] = $line_item_display->display_line_item(
-            $filtered_line_item_tree,
-            array('EE_Registration' => $this->_registration)
-        );
-        $attendee                                = $this->_registration->attendee();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_transaction',
-            'espresso_transactions_view_transaction'
-        )) {
-            $this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action' => 'view_transaction',
-                        'TXN_ID' => $transaction->ID(),
-                    ),
-                    TXN_ADMIN_URL
-                ),
-                esc_html__(' View Transaction', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-cart'
-            );
-        } else {
-            $this->_template_args['view_transaction_button'] = '';
-        }
-        if ($attendee instanceof EE_Attendee
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_resend_registration'
-            )
-        ) {
-            $this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    array(
-                        'action'      => 'resend_registration',
-                        '_REG_ID'     => $this->_registration->ID(),
-                        'redirect_to' => 'view_registration',
-                    ),
-                    REG_ADMIN_URL
-                ),
-                esc_html__(' Resend Registration', 'event_espresso'),
-                'button secondary-button right',
-                'dashicons dashicons-email-alt'
-            );
-        } else {
-            $this->_template_args['resend_registration_button'] = '';
-        }
-        $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        $payment                               = $transaction->get_first_related('Payment');
-        $payment                               = ! $payment instanceof EE_Payment
-            ? EE_Payment::new_instance()
-            : $payment;
-        $payment_method                        = $payment->get_first_related('Payment_Method');
-        $payment_method                        = ! $payment_method instanceof EE_Payment_Method
-            ? EE_Payment_Method::new_instance()
-            : $payment_method;
-        $reg_details                           = array(
-            'payment_method'       => $payment_method->name(),
-            'response_msg'         => $payment->gateway_response(),
-            'registration_id'      => $this->_registration->get('REG_code'),
-            'registration_session' => $this->_registration->session_ID(),
-            'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
-            'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
-        );
-        if (isset($reg_details['registration_id'])) {
-            $this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
-            $this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
-                'Registration ID',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
-        }
-        if (isset($reg_details['payment_method'])) {
-            $this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
-            $this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
-                'Most Recent Payment Method',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
-            $this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
-            $this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
-                'Payment method response',
-                'event_espresso'
-            );
-            $this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
-        }
-        $this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
-        $this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
-            'Registration Session',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
-        $this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
-        $this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
-            'Registration placed from IP',
-            'event_espresso'
-        );
-        $this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
-        $this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
-        $this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
-            'event_espresso');
-        $this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
-        $this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action'   => 'default',
-                'event_id' => $this->_registration->event_ID(),
-            ),
-            REG_ADMIN_URL
-        );
-        $this->_template_args['REG_ID']                                       = $this->_registration->ID();
-        $this->_template_args['event_id']                                     = $this->_registration->event_ID();
-        $template_path                                                        =
-            REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * generates HTML for the Registration Questions meta box.
-     * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
-     * otherwise uses new forms system
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_questions_meta_box()
-    {
-        //allow someone to override this method entirely
-        if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
-            $this->_registration)) {
-            $form                                              = $this->_get_reg_custom_questions_form(
-                $this->_registration->ID()
-            );
-            $this->_template_args['att_questions']             = count($form->subforms()) > 0
-                ? $form->get_html_and_js()
-                : '';
-            $this->_template_args['reg_questions_form_action'] = 'edit_registration';
-            $this->_template_args['REG_ID']                    = $this->_registration->ID();
-            $template_path                                     =
-                REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-            echo EEH_Template::display_template($template_path, $this->_template_args, true);
-        }
-    }
-
-
-    /**
-     * form_before_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_before_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+		if (! empty($registration_status)) {
+			$where['STS_ID'] = $registration_status;
+		} else {
+			//make sure we exclude incomplete registrations, but only if not trashed.
+			if ($view === 'trash') {
+				$where['REG_deleted'] = true;
+			} elseif ($view === 'incomplete') {
+				$where['STS_ID'] = EEM_Registration::status_id_incomplete;
+			} else {
+				$where['STS_ID'] = array('!=', EEM_Registration::status_id_incomplete);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _add_date_to_where_conditions(array $request)
+	{
+		$where = array();
+		$view = EEH_Array::is_set($request, 'status', '');
+		$month_range             = ! empty($request['month_range'])
+			? sanitize_text_field($request['month_range'])
+			: '';
+		$retrieve_for_today      = $view === 'today';
+		$retrieve_for_this_month = $view === 'month';
+
+		if ($retrieve_for_today) {
+			$now               = date('Y-m-d', current_time('timestamp'));
+			$where['REG_date'] = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($retrieve_for_this_month) {
+			$current_year_and_month = date('Y-m', current_time('timestamp'));
+			$days_this_month        = date('t', current_time('timestamp'));
+			$where['REG_date']      = array(
+				'BETWEEN',
+				array(
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					EEM_Registration::instance()->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				),
+			);
+		} elseif ($month_range) {
+			$pieces          = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', \EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested  = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			//if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month     = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$where['REG_date'] = array(
+					'BETWEEN',
+					array(
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s'
+						),
+						EEM_Registration::instance()->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s'
+						),
+					),
+				);
+			}
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 *
+	 * @param array $request usually the same as $this->_req_data but not necessarily
+	 * @return array
+	 */
+	protected function _add_search_to_where_conditions(array $request)
+	{
+		$where = array();
+		if (! empty($request['s'])) {
+			$search_string = '%' . sanitize_text_field($request['s']) . '%';
+			$where['OR*search_conditions'] = array(
+				'Event.EVT_name'                          => array('LIKE', $search_string),
+				'Event.EVT_desc'                          => array('LIKE', $search_string),
+				'Event.EVT_short_desc'                    => array('LIKE', $search_string),
+				'Attendee.ATT_full_name'                  => array('LIKE', $search_string),
+				'Attendee.ATT_fname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_lname'                      => array('LIKE', $search_string),
+				'Attendee.ATT_short_bio'                  => array('LIKE', $search_string),
+				'Attendee.ATT_email'                      => array('LIKE', $search_string),
+				'Attendee.ATT_address'                    => array('LIKE', $search_string),
+				'Attendee.ATT_address2'                   => array('LIKE', $search_string),
+				'Attendee.ATT_city'                       => array('LIKE', $search_string),
+				'REG_final_price'                         => array('LIKE', $search_string),
+				'REG_code'                                => array('LIKE', $search_string),
+				'REG_count'                               => array('LIKE', $search_string),
+				'REG_group_size'                          => array('LIKE', $search_string),
+				'Ticket.TKT_name'                         => array('LIKE', $search_string),
+				'Ticket.TKT_description'                  => array('LIKE', $search_string),
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => array('LIKE', $search_string),
+			);
+		}
+		return $where;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param array $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_where_conditions_for_registrations_query($request)
+	{
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			array_merge(
+				$this->_add_event_id_to_where_conditions($request),
+				$this->_add_category_id_to_where_conditions($request),
+				$this->_add_datetime_id_to_where_conditions($request),
+				$this->_add_registration_status_to_where_conditions($request),
+				$this->_add_date_to_where_conditions($request),
+				$this->_add_search_to_where_conditions($request)
+			),
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function _get_orderby_for_registrations_query()
+	{
+		$orderby_field = ! empty($this->_req_data['orderby'])
+			? sanitize_text_field($this->_req_data['orderby'])
+			: '';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby_field = 'REG_ID';
+				break;
+			case '_Reg_status':
+				$orderby_field = 'STS_ID';
+				break;
+			case 'ATT_fname':
+				$orderby_field = array('Attendee.ATT_fname', 'Attendee.ATT_lname');
+				break;
+			case 'ATT_lname':
+				$orderby_field = array('Attendee.ATT_lname', 'Attendee.ATT_fname');
+				break;
+			case 'event_name':
+				$orderby_field = 'Event.EVT_name';
+				break;
+			case 'DTT_EVT_start':
+				$orderby_field = 'Event.Datetime.DTT_EVT_start';
+				break;
+			default: //'REG_date'
+				$orderby_field = 'REG_date';
+		}
+
+		//order
+		$order = ! empty($this->_req_data['order'])
+			? sanitize_text_field($this->_req_data['order'])
+			: 'DESC';
+
+		//mutate orderby_field
+		$orderby_field = array_combine(
+			(array) $orderby_field,
+			array_fill(0, count($orderby_field), $order)
+		);
+		return array('order_by' => $orderby_field);
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param $per_page
+	 * @return array
+	 */
+	protected function _get_limit($per_page)
+	{
+		$current_page = ! empty($this->_req_data['paged'])
+			? absint($this->_req_data['paged'])
+			: 1;
+		$per_page     = ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+
+		//-1 means return all results so get out if that's set.
+		if ((int)$per_page === -1) {
+			return array();
+		}
+		$per_page = absint($per_page);
+		$offset   = ($current_page - 1) * $per_page;
+		return array('limit' => array($offset, $per_page));
+	}
+
+
+	public function get_registration_status_array()
+	{
+		return self::$_reg_status;
+	}
+
+
+
+
+	/***************************************        REGISTRATION DETAILS        ***************************************/
+	/**
+	 *        generates HTML for the View Registration Details Admin page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _registration_details()
+	{
+		$this->_template_args = array();
+		$this->_set_registration_object();
+		if (is_object($this->_registration)) {
+			$transaction                                   = $this->_registration->transaction()
+				? $this->_registration->transaction()
+				: EE_Transaction::new_instance();
+			$this->_session                                = $transaction->session_data();
+			$event_id                                      = $this->_registration->event_ID();
+			$this->_template_args['reg_nmbr']['value']     = $this->_registration->ID();
+			$this->_template_args['reg_nmbr']['label']     = esc_html__('Registration Number', 'event_espresso');
+			$this->_template_args['reg_datetime']['value'] = $this->_registration->get_i18n_datetime('REG_date');
+			$this->_template_args['reg_datetime']['label'] = esc_html__('Date', 'event_espresso');
+			$this->_template_args['grand_total']           = $transaction->total();
+			$this->_template_args['currency_sign']         = EE_Registry::instance()->CFG->currency->sign;
+			// link back to overview
+			$this->_template_args['reg_overview_url']            = REG_ADMIN_URL;
+			$this->_template_args['registration']                = $this->_registration;
+			$this->_template_args['filtered_registrations_link'] = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'default',
+					'event_id' => $event_id,
+				),
+				REG_ADMIN_URL
+			);
+			$this->_template_args['filtered_transactions_link']  = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'default',
+					'EVT_ID' => $event_id,
+					'page'   => 'espresso_transactions',
+				),
+				admin_url('admin.php')
+			);
+			$this->_template_args['event_link']                  = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => 'espresso_events',
+					'action' => 'edit',
+					'post'   => $event_id,
+				),
+				admin_url('admin.php')
+			);
+			//next and previous links
+			$next_reg                                      = $this->_registration->next(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['next_registration']     = $next_reg
+				? $this->_next_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $next_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-right ee-icon-size-22'
+				)
+				: '';
+			$previous_reg                                  = $this->_registration->previous(
+				null,
+				array(),
+				'REG_ID'
+			);
+			$this->_template_args['previous_registration'] = $previous_reg
+				? $this->_previous_link(
+					EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action'  => 'view_registration',
+							'_REG_ID' => $previous_reg['REG_ID'],
+						),
+						REG_ADMIN_URL
+					),
+					'dashicons dashicons-arrow-left ee-icon-size-22'
+				)
+				: '';
+			// grab header
+			$template_path                             = REG_TEMPLATE_PATH . 'reg_admin_details_header.template.php';
+			$this->_template_args['REG_ID']            = $this->_registration->ID();
+			$this->_template_args['admin_page_header'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+			);
+		} else {
+			$this->_template_args['admin_page_header'] = $this->display_espresso_notices();
+		}
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	protected function _registration_details_metaboxes()
+	{
+		do_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', $this);
+		$this->_set_registration_object();
+		$attendee = $this->_registration instanceof EE_Registration ? $this->_registration->attendee() : null;
+		add_meta_box('edit-reg-status-mbox', esc_html__('Registration Status', 'event_espresso'),
+			array($this, 'set_reg_status_buttons_metabox'), $this->wp_page_slug, 'normal', 'high');
+		add_meta_box('edit-reg-details-mbox', esc_html__('Registration Details', 'event_espresso'),
+			array($this, '_reg_details_meta_box'), $this->wp_page_slug, 'normal', 'high');
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registration',
+				'edit-reg-questions-mbox'
+			)
+		) {
+			add_meta_box(
+				'edit-reg-questions-mbox',
+				esc_html__('Registration Form Answers', 'event_espresso'),
+				array($this, '_reg_questions_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+		add_meta_box(
+			'edit-reg-registrant-mbox',
+			esc_html__('Contact Details', 'event_espresso'),
+			array($this, '_reg_registrant_side_meta_box'),
+			$this->wp_page_slug,
+			'side',
+			'high'
+		);
+		if ($this->_registration->group_size() > 1) {
+			add_meta_box(
+				'edit-reg-attendees-mbox',
+				esc_html__('Other Registrations in this Transaction', 'event_espresso'),
+				array($this, '_reg_attendees_meta_box'),
+				$this->wp_page_slug,
+				'normal',
+				'high'
+			);
+		}
+	}
+
+
+	/**
+	 * set_reg_status_buttons_metabox
+	 *
+	 * @access protected
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function set_reg_status_buttons_metabox()
+	{
+		$this->_set_registration_object();
+		$change_reg_status_form = $this->_generate_reg_status_change_form();
+		echo $change_reg_status_form->form_open(
+			self::add_query_args_and_nonce(
+				array(
+					'action' => 'change_reg_status',
+				),
+				REG_ADMIN_URL
+			)
+		);
+		echo $change_reg_status_form->get_html();
+		echo $change_reg_status_form->form_close();
+	}
+
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _generate_reg_status_change_form()
+	{
+		return new EE_Form_Section_Proper(array(
+			'name'            => 'reg_status_change_form',
+			'html_id'         => 'reg-status-change-form',
+			'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+			'subsections'     => array(
+				'return'             => new EE_Hidden_Input(array(
+					'name'    => 'return',
+					'default' => 'view_registration',
+				)),
+				'REG_ID'             => new EE_Hidden_Input(array(
+					'name'    => 'REG_ID',
+					'default' => $this->_registration->ID(),
+				)),
+				'current_status'     => new EE_Form_Section_HTML(
+					EEH_HTML::tr(
+						EEH_HTML::th(
+							EEH_HTML::label(
+								EEH_HTML::strong(esc_html__('Current Registration Status', 'event_espresso')
+								)
+							)
+						)
+						. EEH_HTML::td(
+							EEH_HTML::strong(
+								$this->_registration->pretty_status(),
+								'',
+								'status-' . $this->_registration->status_ID(),
+								'line-height: 1em; font-size: 1.5em; font-weight: bold;'
+							)
+						)
+					)
+				),
+				'reg_status'         => new EE_Select_Input(
+					$this->_get_reg_statuses(),
+					array(
+						'html_label_text' => esc_html__('Change Registration Status to', 'event_espresso'),
+						'default'         => $this->_registration->status_ID(),
+					)
+				),
+				'send_notifications' => new EE_Yes_No_Input(
+					array(
+						'html_label_text' => esc_html__('Send Related Messages', 'event_espresso'),
+						'default'         => false,
+						'html_help_text'  => esc_html__(
+							'If set to "Yes", then the related messages will be sent to the registrant.',
+							'event_espresso'
+						),
+					)
+				),
+				'submit'             => new EE_Submit_Input(
+					array(
+						'html_class'      => 'button-primary',
+						'html_label_text' => '&nbsp;',
+						'default'         => esc_html__('Update Registration Status', 'event_espresso'),
+					)
+				),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns an array of all the buttons for the various statuses and switch status actions
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _get_reg_statuses()
+	{
+		$reg_status_array = EEM_Registration::instance()->reg_status_array();
+		unset ($reg_status_array[EEM_Registration::status_id_incomplete]);
+		// get current reg status
+		$current_status = $this->_registration->status_ID();
+		// is registration for free event? This will determine whether to display the pending payment option
+		if (
+			$current_status !== EEM_Registration::status_id_pending_payment
+			&& $this->_registration->transaction()->is_free()
+		) {
+			unset($reg_status_array[EEM_Registration::status_id_pending_payment]);
+		}
+		return EEM_Status::instance()->localized_status($reg_status_array, false, 'sentence');
+	}
+
+
+
+	/**
+	 * This method is used when using _REG_ID from request which may or may not be an array of reg_ids.
+	 *
+	 * @param bool $status REG status given for changing registrations to.
+	 * @param bool $notify Whether to send messages notifications or not.
+	 * @return array  (array with reg_id(s) updated and whether update was successful.
+	 * @throws \EE_Error
+	 */
+	protected function _set_registration_status_from_request($status = false, $notify = false)
+	{
+		if (isset($this->_req_data['reg_status_change_form'])) {
+			$REG_IDs = isset($this->_req_data['reg_status_change_form']['REG_ID'])
+				? (array)$this->_req_data['reg_status_change_form']['REG_ID'] : array();
+		} else {
+			$REG_IDs = isset($this->_req_data['_REG_ID']) ? (array)$this->_req_data['_REG_ID'] : array();
+		}
+		$success = $this->_set_registration_status($REG_IDs, $status);
+		//notify?
+		if ($success
+			&& $notify
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_process_resend_registration();
+		}
+		return $success;
+	}
+
+
+
+	/**
+	 * Set the registration status for the given reg_id (which may or may not be an array, it gets typecast to an
+	 * array). Note, this method does NOT take care of possible notifications.  That is required by calling code.
+	 *
+	 * @param array $REG_IDs
+	 * @param bool  $status
+	 * @return array (an array with 'success' key representing whether status change was successful, and 'REG_ID' as
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 *               the array of updated registrations).
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	protected function _set_registration_status($REG_IDs = array(), $status = false)
+	{
+		$success = false;
+		// typecast $REG_IDs
+		$REG_IDs = (array)$REG_IDs;
+		if ( ! empty($REG_IDs)) {
+			$success = true;
+			// set default status if none is passed
+			$status = $status ? $status : EEM_Registration::status_id_pending_payment;
+			// sanitize $REG_IDs
+			$REG_IDs = array_filter($REG_IDs, 'absint');
+			//loop through REG_ID's and change status
+			foreach ($REG_IDs as $REG_ID) {
+				$registration = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+				if ($registration instanceof EE_Registration) {
+					$registration->set_status($status);
+					$result = $registration->save();
+					// verifying explicit fails because update *may* just return 0 for 0 rows affected
+					$success = $result !== false ? $success : false;
+				}
+			}
+		}
+		//reset _req_data['_REG_ID'] for any potential future messages notifications
+		$this->_req_data['_REG_ID'] = $REG_IDs;
+		//return $success and processed registrations
+		return array('REG_ID' => $REG_IDs, 'success' => $success);
+	}
+
+
+	/**
+	 * Common logic for setting up success message and redirecting to appropriate route
+	 *
+	 * @param  string $STS_ID status id for the registration changed to
+	 * @param   bool  $notify indicates whether the _set_registration_status_from_request does notifications or not.
+	 * @return void
+	 */
+	protected function _reg_status_change_return($STS_ID, $notify = false)
+	{
+		$result  = ! empty($STS_ID) ? $this->_set_registration_status_from_request($STS_ID, $notify)
+			: array('success' => false);
+		$success = isset($result['success']) && $result['success'];
+		//setup success message
+		if ($success) {
+			if (is_array($result['REG_ID']) && count($result['REG_ID']) === 1) {
+				$msg = sprintf(esc_html__('Registration status has been set to %s', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
+			} else {
+				$msg = sprintf(esc_html__('Registrations have been set to %s.', 'event_espresso'),
+					EEH_Template::pretty_status($STS_ID, false, 'lower'));
+			}
+			EE_Error::add_success($msg);
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong, and the status was not changed',
+					'event_espresso'
+				), __FILE__, __LINE__, __FUNCTION__
+			);
+		}
+		if (isset($this->_req_data['return']) && $this->_req_data['return'] == 'view_registration') {
+			$route = array('action' => 'view_registration', '_REG_ID' => reset($result['REG_ID']));
+		} else {
+			$route = array('action' => 'default');
+		}
+		//unset nonces
+		foreach ($this->_req_data as $ref => $value) {
+			if (strpos($ref, 'nonce') !== false) {
+				unset($this->_req_data[$ref]);
+				continue;
+			}
+			$value                 = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
+			$this->_req_data[$ref] = $value;
+		}
+		//merge request vars so that the reloaded list table contains any existing filter query params
+		$route = array_merge($this->_req_data, $route);
+		$this->_redirect_after_action($success, '', '', $route, true);
+	}
+
+
+	/**
+	 * incoming reg status change from reg details page.
+	 *
+	 * @return void
+	 */
+	protected function _change_reg_status()
+	{
+		$this->_req_data['return'] = 'view_registration';
+		//set notify based on whether the send notifications toggle is set or not
+		$notify = ! empty($this->_req_data['reg_status_change_form']['send_notifications']);
+		//$notify = ! empty( $this->_req_data['txn_reg_status_change']['send_notifications'] );
+		$this->_req_data['reg_status_change_form']['reg_status'] = isset($this->_req_data['reg_status_change_form']['reg_status'])
+			? $this->_req_data['reg_status_change_form']['reg_status'] : '';
+		switch ($this->_req_data['reg_status_change_form']['reg_status']) {
+			case EEM_Registration::status_id_approved :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence') :
+				$this->approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_pending_payment :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence') :
+				$this->pending_registration($notify);
+				break;
+			case EEM_Registration::status_id_not_approved :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence') :
+				$this->not_approve_registration($notify);
+				break;
+			case EEM_Registration::status_id_declined :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence') :
+				$this->decline_registration($notify);
+				break;
+			case EEM_Registration::status_id_cancelled :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence') :
+				$this->cancel_registration($notify);
+				break;
+			case EEM_Registration::status_id_wait_list :
+			case EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence') :
+				$this->wait_list_registration($notify);
+				break;
+			case EEM_Registration::status_id_incomplete :
+			default :
+				$result['success'] = false;
+				unset($this->_req_data['return']);
+				$this->_reg_status_change_return('', false);
+				break;
+		}
+	}
+
+
+	/**
+	 * approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their approval.
+	 * @return void
+	 */
+	protected function approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function decline_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_declined, $notify);
+	}
+
+
+	/**
+	 *        cancel_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function cancel_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_cancelled, $notify);
+	}
+
+
+	/**
+	 *        not_approve_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function not_approve_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_not_approved, $notify);
+	}
+
+
+	/**
+	 *        decline_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function pending_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_pending_payment, $notify);
+	}
+
+
+	/**
+	 * waitlist_registration
+	 *
+	 * @access protected
+	 * @param bool $notify whether or not to notify the registrant about their status change.
+	 * @return void
+	 */
+	protected function wait_list_registration($notify = false)
+	{
+		$this->_reg_status_change_return(EEM_Registration::status_id_wait_list, $notify);
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	public function _reg_details_meta_box()
+	{
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		EEH_Autoloader::register_line_item_filter_autoloaders();
+		EE_Registry::instance()->load_helper('Line_Item');
+		$transaction    = $this->_registration->transaction() ? $this->_registration->transaction()
+			: EE_Transaction::new_instance();
+		$this->_session = $transaction->session_data();
+		$filters        = new EE_Line_Item_Filter_Collection();
+		//$filters->add( new EE_Non_Zero_Line_Item_Filter() );
+		$filters->add(new EE_Single_Registration_Line_Item_Filter($this->_registration));
+		$line_item_filter_processor              = new EE_Line_Item_Filter_Processor($filters,
+			$transaction->total_line_item());
+		$filtered_line_item_tree                 = $line_item_filter_processor->process();
+		$line_item_display                       = new EE_Line_Item_Display('reg_admin_table',
+			'EE_Admin_Table_Registration_Line_Item_Display_Strategy');
+		$this->_template_args['line_item_table'] = $line_item_display->display_line_item(
+			$filtered_line_item_tree,
+			array('EE_Registration' => $this->_registration)
+		);
+		$attendee                                = $this->_registration->attendee();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_transaction',
+			'espresso_transactions_view_transaction'
+		)) {
+			$this->_template_args['view_transaction_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action' => 'view_transaction',
+						'TXN_ID' => $transaction->ID(),
+					),
+					TXN_ADMIN_URL
+				),
+				esc_html__(' View Transaction', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-cart'
+			);
+		} else {
+			$this->_template_args['view_transaction_button'] = '';
+		}
+		if ($attendee instanceof EE_Attendee
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_resend_registration'
+			)
+		) {
+			$this->_template_args['resend_registration_button'] = EEH_Template::get_button_or_link(
+				EE_Admin_Page::add_query_args_and_nonce(
+					array(
+						'action'      => 'resend_registration',
+						'_REG_ID'     => $this->_registration->ID(),
+						'redirect_to' => 'view_registration',
+					),
+					REG_ADMIN_URL
+				),
+				esc_html__(' Resend Registration', 'event_espresso'),
+				'button secondary-button right',
+				'dashicons dashicons-email-alt'
+			);
+		} else {
+			$this->_template_args['resend_registration_button'] = '';
+		}
+		$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		$payment                               = $transaction->get_first_related('Payment');
+		$payment                               = ! $payment instanceof EE_Payment
+			? EE_Payment::new_instance()
+			: $payment;
+		$payment_method                        = $payment->get_first_related('Payment_Method');
+		$payment_method                        = ! $payment_method instanceof EE_Payment_Method
+			? EE_Payment_Method::new_instance()
+			: $payment_method;
+		$reg_details                           = array(
+			'payment_method'       => $payment_method->name(),
+			'response_msg'         => $payment->gateway_response(),
+			'registration_id'      => $this->_registration->get('REG_code'),
+			'registration_session' => $this->_registration->session_ID(),
+			'ip_address'           => isset($this->_session['ip_address']) ? $this->_session['ip_address'] : '',
+			'user_agent'           => isset($this->_session['user_agent']) ? $this->_session['user_agent'] : '',
+		);
+		if (isset($reg_details['registration_id'])) {
+			$this->_template_args['reg_details']['registration_id']['value'] = $reg_details['registration_id'];
+			$this->_template_args['reg_details']['registration_id']['label'] = esc_html__(
+				'Registration ID',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['registration_id']['class'] = 'regular-text';
+		}
+		if (isset($reg_details['payment_method'])) {
+			$this->_template_args['reg_details']['payment_method']['value'] = $reg_details['payment_method'];
+			$this->_template_args['reg_details']['payment_method']['label'] = esc_html__(
+				'Most Recent Payment Method',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['payment_method']['class'] = 'regular-text';
+			$this->_template_args['reg_details']['response_msg']['value']   = $reg_details['response_msg'];
+			$this->_template_args['reg_details']['response_msg']['label']   = esc_html__(
+				'Payment method response',
+				'event_espresso'
+			);
+			$this->_template_args['reg_details']['response_msg']['class']   = 'regular-text';
+		}
+		$this->_template_args['reg_details']['registration_session']['value'] = $reg_details['registration_session'];
+		$this->_template_args['reg_details']['registration_session']['label'] = esc_html__(
+			'Registration Session',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['registration_session']['class'] = 'regular-text';
+		$this->_template_args['reg_details']['ip_address']['value']           = $reg_details['ip_address'];
+		$this->_template_args['reg_details']['ip_address']['label']           = esc_html__(
+			'Registration placed from IP',
+			'event_espresso'
+		);
+		$this->_template_args['reg_details']['ip_address']['class']           = 'regular-text';
+		$this->_template_args['reg_details']['user_agent']['value']           = $reg_details['user_agent'];
+		$this->_template_args['reg_details']['user_agent']['label']           = esc_html__('Registrant User Agent',
+			'event_espresso');
+		$this->_template_args['reg_details']['user_agent']['class']           = 'large-text';
+		$this->_template_args['event_link']                                   = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action'   => 'default',
+				'event_id' => $this->_registration->event_ID(),
+			),
+			REG_ADMIN_URL
+		);
+		$this->_template_args['REG_ID']                                       = $this->_registration->ID();
+		$this->_template_args['event_id']                                     = $this->_registration->event_ID();
+		$template_path                                                        =
+			REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_details.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * generates HTML for the Registration Questions meta box.
+	 * If pre-4.8.32.rc.000 hooks are used, uses old methods (with its filters),
+	 * otherwise uses new forms system
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_questions_meta_box()
+	{
+		//allow someone to override this method entirely
+		if (apply_filters('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', true, $this,
+			$this->_registration)) {
+			$form                                              = $this->_get_reg_custom_questions_form(
+				$this->_registration->ID()
+			);
+			$this->_template_args['att_questions']             = count($form->subforms()) > 0
+				? $form->get_html_and_js()
+				: '';
+			$this->_template_args['reg_questions_form_action'] = 'edit_registration';
+			$this->_template_args['REG_ID']                    = $this->_registration->ID();
+			$template_path                                     =
+				REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+			echo EEH_Template::display_template($template_path, $this->_template_args, true);
+		}
+	}
+
+
+	/**
+	 * form_before_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_before_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 	<table class="form-table ee-width-100">
 		<tbody>
 			';
-    }
-
-
-    /**
-     * form_after_question_group
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $output
-     * @return        string
-     */
-    public function form_after_question_group($output)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_after_question_group
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $output
+	 * @return        string
+	 */
+	public function form_after_question_group($output)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr class="hide-if-no-js">
 				<th> </th>
 				<td class="reg-admin-edit-attendee-question-td">
 					<a class="reg-admin-edit-attendee-question-lnk" href="#" title="'
-               . esc_attr__('click to edit question', 'event_espresso')
-               . '">
+			   . esc_attr__('click to edit question', 'event_espresso')
+			   . '">
 						<span class="reg-admin-edit-question-group-spn lt-grey-txt">'
-               . esc_html__('edit the above question group', 'event_espresso')
-               . '</span>
+			   . esc_html__('edit the above question group', 'event_espresso')
+			   . '</span>
 						<div class="dashicons dashicons-edit"></div>
 					</a>
 				</td>
@@ -2137,558 +2137,558 @@ 
 		</tbody>
 	</table>
 ';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function form_form_field_label_wrap($label)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function form_form_field_label_wrap($label)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @deprecated    as of 4.8.32.rc.000
-     * @access        public
-     * @param        string $input
-     * @return        string
-     */
-    public function form_form_field_input__wrap($input)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            esc_html__(
-                'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
-                'event_espresso'
-            ),
-            '4.8.32.rc.000'
-        );
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @deprecated    as of 4.8.32.rc.000
+	 * @access        public
+	 * @param        string $input
+	 * @return        string
+	 */
+	public function form_form_field_input__wrap($input)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			esc_html__(
+				'This method would have been protected but was used on a filter callback so needed to be public. Please discontinue usage as it will be removed soon.',
+				'event_espresso'
+			),
+			'4.8.32.rc.000'
+		);
+		return '
 				<td class="reg-admin-attendee-questions-input-td disabled-input">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * Updates the registration's custom questions according to the form info, if the form is submitted.
-     * If it's not a post, the "view_registrations" route will be called next on the SAME request
-     * to display the page
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_attendee_registration_form()
-    {
-        do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
-            $REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
-            $success = $this->_save_reg_custom_questions_form($REG_ID);
-            if ($success) {
-                $what  = esc_html__('Registration Form', 'event_espresso');
-                $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
-                    : array('action' => 'default');
-                $this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
-            }
-        }
-    }
-
-
-    /**
-     * Gets the form for saving registrations custom questions (if done
-     * previously retrieves the cached form object, which may have validation errors in it)
-     *
-     * @param int $REG_ID
-     * @return EE_Registration_Custom_Questions_Form
-     * @throws EE_Error
-     */
-    protected function _get_reg_custom_questions_form($REG_ID)
-    {
-        if ( ! $this->_reg_custom_questions_form) {
-            require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
-            $this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
-                EEM_Registration::instance()->get_one_by_ID($REG_ID)
-            );
-            $this->_reg_custom_questions_form->_construct_finalize(null, null);
-        }
-        return $this->_reg_custom_questions_form;
-    }
-
-
-    /**
-     * Saves
-     *
-     * @access private
-     * @param bool $REG_ID
-     * @return bool
-     * @throws EE_Error
-     */
-    private function _save_reg_custom_questions_form($REG_ID = false)
-    {
-        if ( ! $REG_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No registration ID was received.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        $form = $this->_get_reg_custom_questions_form($REG_ID);
-        $form->receive_form_submission($this->_req_data);
-        $success = false;
-        if ($form->is_valid()) {
-            foreach ($form->subforms() as $question_group_id => $question_group_form) {
-                foreach ($question_group_form->inputs() as $question_id => $input) {
-                    $where_conditions    = array(
-                        'QST_ID' => $question_id,
-                        'REG_ID' => $REG_ID,
-                    );
-                    $possibly_new_values = array(
-                        'ANS_value' => $input->normalized_value(),
-                    );
-                    $answer              = EEM_Answer::instance()->get_one(array($where_conditions));
-                    if ($answer instanceof EE_Answer) {
-                        $success = $answer->save($possibly_new_values);
-                    } else {
-                        //insert it then
-                        $cols_n_vals = array_merge($where_conditions, $possibly_new_values);
-                        $answer      = EE_Answer::new_instance($cols_n_vals);
-                        $success     = $answer->save();
-                    }
-                }
-            }
-        } else {
-            EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $success;
-    }
-
-
-    /**
-     *        generates HTML for the Registration main meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_attendees_meta_box()
-    {
-        $REG = EEM_Registration::instance();
-        //get all other registrations on this transaction, and cache
-        //the attendees for them so we don't have to run another query using force_join
-        $registrations                           = $REG->get_all(array(
-            array(
-                'TXN_ID' => $this->_registration->transaction_ID(),
-                'REG_ID' => array('!=', $this->_registration->ID()),
-            ),
-            'force_join' => array('Attendee'),
-        ));
-        $this->_template_args['attendees']       = array();
-        $this->_template_args['attendee_notice'] = '';
-        if (empty($registrations)
-            || (is_array($registrations)
-                && ! EEH_Array::get_one_item_from_array($registrations))
-        ) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There are no records attached to this registration. Something may have gone wrong with the registration',
-                    'event_espresso'
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_template_args['attendee_notice'] = EE_Error::get_notices();
-        } else {
-            $att_nmbr = 1;
-            foreach ($registrations as $registration) {
-                /* @var $registration EE_Registration */
-                $attendee                                                    = $registration->attendee()
-                    ? $registration->attendee()
-                    : EEM_Attendee::instance()
-                                  ->create_default_object();
-                $this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
-                $this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
-                $this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
-                $this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
-                $this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
-                $this->_template_args['attendees'][$att_nmbr]['address']     = implode(
-                    ', ',
-                    $attendee->full_address_as_array()
-                );
-                $this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
-                    array(
-                        'action' => 'edit_attendee',
-                        'post'   => $attendee->ID(),
-                    ),
-                    REG_ADMIN_URL
-                );
-                $this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
-                $att_nmbr++;
-            }
-            $this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
-        }
-        $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Edit Registration side meta box
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function _reg_registrant_side_meta_box()
-    {
-        /*@var $attendee EE_Attendee */
-        $att_check = $this->_registration->attendee();
-        $attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
-        //now let's determine if this is not the primary registration.  If it isn't then we set the
-        //primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
-        //primary registration object (that way we know if we need to show create button or not)
-        if ( ! $this->_registration->is_primary_registrant()) {
-            $primary_registration = $this->_registration->get_primary_registration();
-            $primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
-                : null;
-            if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
-                //in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
-                //custom attendee object so let's not worry about the primary reg.
-                $primary_registration = null;
-            }
-        } else {
-            $primary_registration = null;
-        }
-        $this->_template_args['ATT_ID']            = $attendee->ID();
-        $this->_template_args['fname']             = $attendee->fname();
-        $this->_template_args['lname']             = $attendee->lname();
-        $this->_template_args['email']             = $attendee->email();
-        $this->_template_args['phone']             = $attendee->phone();
-        $this->_template_args['formatted_address'] = EEH_Address::format($attendee);
-        //edit link
-        $this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'edit_attendee',
-            'post'   => $attendee->ID(),
-        ), REG_ADMIN_URL);
-        $this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
-        //create link
-        $this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'duplicate_attendee',
-                '_REG_ID' => $this->_registration->ID(),
-            ), REG_ADMIN_URL) : '';
-        $this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
-        $this->_template_args['att_check']    = $att_check;
-        $template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
-        echo EEH_Template::display_template($template_path, $this->_template_args, true);
-    }
-
-
-    /**
-     * trash or restore registrations
-     *
-     * @param  boolean $trash whether to archive or restore
-     * @return void
-     * @throws EE_Error
-     * @throws RuntimeException
-     * @access protected
-     */
-    protected function _trash_or_restore_registrations($trash = true)
-    {
-        //if empty _REG_ID then get out because there's nothing to do
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
-                        'event_espresso'
-                    ),
-                    $trash ? 'trash' : 'restore'
-                ),
-                __FILE__, __LINE__, __FUNCTION__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-        $success = 0;
-        $overwrite_msgs = false;
-        //Checkboxes
-        if ( ! is_array($this->_req_data['_REG_ID'])) {
-            $this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
-        }
-        $reg_count = count($this->_req_data['_REG_ID']);
-        // cycle thru checkboxes
-        foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
-            /** @var EE_Registration $REG */
-            $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-            $payments = $REG->registration_payments();
-            if (! empty($payments)) {
-                $name = $REG->attendee() instanceof EE_Attendee
-                    ? $REG->attendee()->full_name()
-                    : esc_html__('Unknown Attendee', 'event_espresso');
-                $overwrite_msgs = true;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
-                            'event_espresso'
-                        ),
-                        $name
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                //can't trash this registration because it has payments.
-                continue;
-            }
-            $updated = $trash ? $REG->delete() : $REG->restore();
-            if ($updated) {
-                $success++;
-            }
-        }
-        $this->_redirect_after_action(
-            $success === $reg_count, // were ALL registrations affected?
-            $success > 1
-                ? esc_html__('Registrations', 'event_espresso')
-                : esc_html__('Registration', 'event_espresso'),
-            $trash
-                ? esc_html__('moved to the trash', 'event_espresso')
-                : esc_html__('restored', 'event_espresso'),
-            array('action' => 'default'),
-            $overwrite_msgs
-        );
-    }
-
-
-    /**
-     * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
-     * registration but also.
-     * 1. Removing relations to EE_Attendee
-     * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
-     * ALSO trashed.
-     * 3. Deleting permanently any related Line items but only if the above conditions are met.
-     * 4. Removing relationships between all tickets and the related registrations
-     * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
-     * 6. Deleting permanently any related Checkins.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _delete_registrations()
-    {
-        $REG_MDL = EEM_Registration::instance();
-        $success = 1;
-        //Checkboxes
-        if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
-                $REG = $REG_MDL->get_one_by_ID($REG_ID);
-                if ( ! $REG instanceof EE_Registration) {
-                    continue;
-                }
-                $deleted = $this->_delete_registration($REG);
-                if ( ! $deleted) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $REG_ID  = $this->_req_data['_REG_ID'];
-            $REG     = $REG_MDL->get_one_by_ID($REG_ID);
-            $deleted = $this->_delete_registration($REG);
-            if ( ! $deleted) {
-                $success = 0;
-            }
-        }
-        $what        = $success > 1
-            ? esc_html__('Registrations', 'event_espresso')
-            : esc_html__('Registration', 'event_espresso');
-        $action_desc = esc_html__('permanently deleted.', 'event_espresso');
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            array('action' => 'default'),
-            true
-        );
-    }
-
-
-    /**
-     * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
-     * models get affected.
-     *
-     * @param  EE_Registration $REG registration to be deleted permenantly
-     * @return bool true = successful deletion, false = fail.
-     * @throws EE_Error
-     */
-    protected function _delete_registration(EE_Registration $REG)
-    {
-        //first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
-        //registrations on the transaction that are NOT trashed.
-        $TXN         = $REG->get_first_related('Transaction');
-        $REGS        = $TXN->get_many_related('Registration');
-        $all_trashed = true;
-        foreach ($REGS as $registration) {
-            if ( ! $registration->get('REG_deleted')) {
-                $all_trashed = false;
-            }
-        }
-        if ( ! $all_trashed) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        //k made it here so that means we can delete all the related transactions and their answers (but let's do them
-        //separately from THIS one).
-        foreach ($REGS as $registration) {
-            //delete related answers
-            $registration->delete_related_permanently('Answer');
-            //remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
-            $attendee = $registration->get_first_related('Attendee');
-            if ($attendee instanceof EE_Attendee) {
-                $registration->_remove_relation_to($attendee, 'Attendee');
-            }
-            //now remove relationships to tickets on this registration.
-            $registration->_remove_relations('Ticket');
-            //now delete permanently the checkins related to this registration.
-            $registration->delete_related_permanently('Checkin');
-            if ($registration->ID() === $REG->ID()) {
-                continue;
-            } //we don't want to delete permanently the existing registration just yet.
-            //remove relation to transaction for these registrations if NOT the existing registrations
-            $registration->_remove_relations('Transaction');
-            //delete permanently any related messages.
-            $registration->delete_related_permanently('Message');
-            //now delete this registration permanently
-            $registration->delete_permanently();
-        }
-        //now all related registrations on the transaction are handled.  So let's just handle this registration itself
-        // (the transaction and line items should be all that's left).
-        // delete the line items related to the transaction for this registration.
-        $TXN->delete_related_permanently('Line_Item');
-        //we need to remove all the relationships on the transaction
-        $TXN->delete_related_permanently('Payment');
-        $TXN->delete_related_permanently('Extra_Meta');
-        $TXN->delete_related_permanently('Message');
-        //now we can delete this REG permanently (and the transaction of course)
-        $REG->delete_related_permanently('Transaction');
-        return $REG->delete_permanently();
-    }
-
-
-    /**
-     *    generates HTML for the Register New Attendee Admin page
-     *
-     * @access private
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function new_registration()
-    {
-        if ( ! $this->_set_reg_event()) {
-            throw new EE_Error(
-                esc_html__(
-                    'Unable to continue with registering because there is no Event ID in the request',
-                    'event_espresso'
-                )
-            );
-        }
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        // gotta start with a clean slate if we're not coming here via ajax
-        if ( ! defined('DOING_AJAX')
-             && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
-        ) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        $this->_template_args['event_name'] = '';
-        // event name
-        if ($this->_reg_event) {
-            $this->_template_args['event_name'] = $this->_reg_event->name();
-            $edit_event_url                     = self::add_query_args_and_nonce(array(
-                'action' => 'edit',
-                'post'   => $this->_reg_event->ID(),
-            ), EVENTS_ADMIN_URL);
-            $edit_event_lnk                     = '<a href="'
-                                                  . $edit_event_url
-                                                  . '" title="'
-                                                  . esc_attr__('Edit ', 'event_espresso')
-                                                  . $this->_reg_event->name()
-                                                  . '">'
-                                                  . esc_html__('Edit Event', 'event_espresso')
-                                                  . '</a>';
-            $this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
-                                                   . $edit_event_lnk
-                                                   . '</span>';
-        }
-        $this->_template_args['step_content'] = $this->_get_registration_step_content();
-        if (defined('DOING_AJAX')) {
-            $this->_return_json();
-        }
-        // grab header
-        $template_path                              =
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
-            $this->_template_args, true);
-        //$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This returns the content for a registration step
-     *
-     * @access protected
-     * @return string html
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_registration_step_content()
-    {
-        if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
-            $warning_msg = sprintf(
-                esc_html__(
-                    '%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                '<h3 class="important-notice">',
-                '</h3>',
-                '<div class="float-right">',
-                '<span id="redirect_timer" class="important-notice">30</span>',
-                '</div>',
-                '<b>',
-                '</b>'
-            );
-            return '
+	}
+
+
+	/**
+	 * Updates the registration's custom questions according to the form info, if the form is submitted.
+	 * If it's not a post, the "view_registrations" route will be called next on the SAME request
+	 * to display the page
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_attendee_registration_form()
+	{
+		do_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', $this);
+		if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+			$REG_ID  = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : false;
+			$success = $this->_save_reg_custom_questions_form($REG_ID);
+			if ($success) {
+				$what  = esc_html__('Registration Form', 'event_espresso');
+				$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID)
+					: array('action' => 'default');
+				$this->_redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
+			}
+		}
+	}
+
+
+	/**
+	 * Gets the form for saving registrations custom questions (if done
+	 * previously retrieves the cached form object, which may have validation errors in it)
+	 *
+	 * @param int $REG_ID
+	 * @return EE_Registration_Custom_Questions_Form
+	 * @throws EE_Error
+	 */
+	protected function _get_reg_custom_questions_form($REG_ID)
+	{
+		if ( ! $this->_reg_custom_questions_form) {
+			require_once(REG_ADMIN . 'form_sections' . DS . 'EE_Registration_Custom_Questions_Form.form.php');
+			$this->_reg_custom_questions_form = new EE_Registration_Custom_Questions_Form(
+				EEM_Registration::instance()->get_one_by_ID($REG_ID)
+			);
+			$this->_reg_custom_questions_form->_construct_finalize(null, null);
+		}
+		return $this->_reg_custom_questions_form;
+	}
+
+
+	/**
+	 * Saves
+	 *
+	 * @access private
+	 * @param bool $REG_ID
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function _save_reg_custom_questions_form($REG_ID = false)
+	{
+		if ( ! $REG_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No registration ID was received.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		$form = $this->_get_reg_custom_questions_form($REG_ID);
+		$form->receive_form_submission($this->_req_data);
+		$success = false;
+		if ($form->is_valid()) {
+			foreach ($form->subforms() as $question_group_id => $question_group_form) {
+				foreach ($question_group_form->inputs() as $question_id => $input) {
+					$where_conditions    = array(
+						'QST_ID' => $question_id,
+						'REG_ID' => $REG_ID,
+					);
+					$possibly_new_values = array(
+						'ANS_value' => $input->normalized_value(),
+					);
+					$answer              = EEM_Answer::instance()->get_one(array($where_conditions));
+					if ($answer instanceof EE_Answer) {
+						$success = $answer->save($possibly_new_values);
+					} else {
+						//insert it then
+						$cols_n_vals = array_merge($where_conditions, $possibly_new_values);
+						$answer      = EE_Answer::new_instance($cols_n_vals);
+						$success     = $answer->save();
+					}
+				}
+			}
+		} else {
+			EE_Error::add_error($form->get_validation_error_string(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *        generates HTML for the Registration main meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_attendees_meta_box()
+	{
+		$REG = EEM_Registration::instance();
+		//get all other registrations on this transaction, and cache
+		//the attendees for them so we don't have to run another query using force_join
+		$registrations                           = $REG->get_all(array(
+			array(
+				'TXN_ID' => $this->_registration->transaction_ID(),
+				'REG_ID' => array('!=', $this->_registration->ID()),
+			),
+			'force_join' => array('Attendee'),
+		));
+		$this->_template_args['attendees']       = array();
+		$this->_template_args['attendee_notice'] = '';
+		if (empty($registrations)
+			|| (is_array($registrations)
+				&& ! EEH_Array::get_one_item_from_array($registrations))
+		) {
+			EE_Error::add_error(
+				esc_html__(
+					'There are no records attached to this registration. Something may have gone wrong with the registration',
+					'event_espresso'
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_template_args['attendee_notice'] = EE_Error::get_notices();
+		} else {
+			$att_nmbr = 1;
+			foreach ($registrations as $registration) {
+				/* @var $registration EE_Registration */
+				$attendee                                                    = $registration->attendee()
+					? $registration->attendee()
+					: EEM_Attendee::instance()
+								  ->create_default_object();
+				$this->_template_args['attendees'][$att_nmbr]['STS_ID']      = $registration->status_ID();
+				$this->_template_args['attendees'][$att_nmbr]['fname']       = $attendee->fname();
+				$this->_template_args['attendees'][$att_nmbr]['lname']       = $attendee->lname();
+				$this->_template_args['attendees'][$att_nmbr]['email']       = $attendee->email();
+				$this->_template_args['attendees'][$att_nmbr]['final_price'] = $registration->final_price();
+				$this->_template_args['attendees'][$att_nmbr]['address']     = implode(
+					', ',
+					$attendee->full_address_as_array()
+				);
+				$this->_template_args['attendees'][$att_nmbr]['att_link']    = self::add_query_args_and_nonce(
+					array(
+						'action' => 'edit_attendee',
+						'post'   => $attendee->ID(),
+					),
+					REG_ADMIN_URL
+				);
+				$this->_template_args['attendees'][$att_nmbr]['event_name']  = $registration->event_obj()->name();
+				$att_nmbr++;
+			}
+			$this->_template_args['currency_sign'] = EE_Registry::instance()->CFG->currency->sign;
+		}
+		$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_attendees.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Edit Registration side meta box
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function _reg_registrant_side_meta_box()
+	{
+		/*@var $attendee EE_Attendee */
+		$att_check = $this->_registration->attendee();
+		$attendee  = $att_check instanceof EE_Attendee ? $att_check : EEM_Attendee::instance()->create_default_object();
+		//now let's determine if this is not the primary registration.  If it isn't then we set the
+		//primary_registration object for reference BUT ONLY if the Attendee object loaded is not the same as the
+		//primary registration object (that way we know if we need to show create button or not)
+		if ( ! $this->_registration->is_primary_registrant()) {
+			$primary_registration = $this->_registration->get_primary_registration();
+			$primary_attendee     = $primary_registration instanceof EE_Registration ? $primary_registration->attendee()
+				: null;
+			if ( ! $primary_attendee instanceof EE_Attendee || $attendee->ID() !== $primary_attendee->ID()) {
+				//in here?  This means the displayed registration is not the primary registrant but ALREADY HAS its own
+				//custom attendee object so let's not worry about the primary reg.
+				$primary_registration = null;
+			}
+		} else {
+			$primary_registration = null;
+		}
+		$this->_template_args['ATT_ID']            = $attendee->ID();
+		$this->_template_args['fname']             = $attendee->fname();
+		$this->_template_args['lname']             = $attendee->lname();
+		$this->_template_args['email']             = $attendee->email();
+		$this->_template_args['phone']             = $attendee->phone();
+		$this->_template_args['formatted_address'] = EEH_Address::format($attendee);
+		//edit link
+		$this->_template_args['att_edit_link']  = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'edit_attendee',
+			'post'   => $attendee->ID(),
+		), REG_ADMIN_URL);
+		$this->_template_args['att_edit_label'] = esc_html__('View/Edit Contact', 'event_espresso');
+		//create link
+		$this->_template_args['create_link']  = $primary_registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'duplicate_attendee',
+				'_REG_ID' => $this->_registration->ID(),
+			), REG_ADMIN_URL) : '';
+		$this->_template_args['create_label'] = esc_html__('Create Contact', 'event_espresso');
+		$this->_template_args['att_check']    = $att_check;
+		$template_path                        = REG_TEMPLATE_PATH . 'reg_admin_details_side_meta_box_registrant.template.php';
+		echo EEH_Template::display_template($template_path, $this->_template_args, true);
+	}
+
+
+	/**
+	 * trash or restore registrations
+	 *
+	 * @param  boolean $trash whether to archive or restore
+	 * @return void
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 * @access protected
+	 */
+	protected function _trash_or_restore_registrations($trash = true)
+	{
+		//if empty _REG_ID then get out because there's nothing to do
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'In order to %1$s registrations you must select which ones you wish to %1$s by clicking the checkboxes.',
+						'event_espresso'
+					),
+					$trash ? 'trash' : 'restore'
+				),
+				__FILE__, __LINE__, __FUNCTION__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+		$success = 0;
+		$overwrite_msgs = false;
+		//Checkboxes
+		if ( ! is_array($this->_req_data['_REG_ID'])) {
+			$this->_req_data['_REG_ID'] = array($this->_req_data['_REG_ID']);
+		}
+		$reg_count = count($this->_req_data['_REG_ID']);
+		// cycle thru checkboxes
+		foreach ($this->_req_data['_REG_ID'] as $REG_ID) {
+			/** @var EE_Registration $REG */
+			$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+			$payments = $REG->registration_payments();
+			if (! empty($payments)) {
+				$name = $REG->attendee() instanceof EE_Attendee
+					? $REG->attendee()->full_name()
+					: esc_html__('Unknown Attendee', 'event_espresso');
+				$overwrite_msgs = true;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The registration for %s could not be trashed because it has payments attached to the related transaction.  If you wish to trash this registration you must first delete the payments on the related transaction.',
+							'event_espresso'
+						),
+						$name
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				//can't trash this registration because it has payments.
+				continue;
+			}
+			$updated = $trash ? $REG->delete() : $REG->restore();
+			if ($updated) {
+				$success++;
+			}
+		}
+		$this->_redirect_after_action(
+			$success === $reg_count, // were ALL registrations affected?
+			$success > 1
+				? esc_html__('Registrations', 'event_espresso')
+				: esc_html__('Registration', 'event_espresso'),
+			$trash
+				? esc_html__('moved to the trash', 'event_espresso')
+				: esc_html__('restored', 'event_espresso'),
+			array('action' => 'default'),
+			$overwrite_msgs
+		);
+	}
+
+
+	/**
+	 * This is used to permanently delete registrations.  Note, this will handle not only deleting permanently the
+	 * registration but also.
+	 * 1. Removing relations to EE_Attendee
+	 * 2. Deleting permanently the related transaction, but ONLY if all related registrations to the transaction are
+	 * ALSO trashed.
+	 * 3. Deleting permanently any related Line items but only if the above conditions are met.
+	 * 4. Removing relationships between all tickets and the related registrations
+	 * 5. Deleting permanently any related Answers (and the answers for other related registrations that were deleted.)
+	 * 6. Deleting permanently any related Checkins.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _delete_registrations()
+	{
+		$REG_MDL = EEM_Registration::instance();
+		$success = 1;
+		//Checkboxes
+		if ( ! empty($this->_req_data['_REG_ID']) && is_array($this->_req_data['_REG_ID'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['_REG_ID']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ind, $REG_ID) = each($this->_req_data['_REG_ID'])) {
+				$REG = $REG_MDL->get_one_by_ID($REG_ID);
+				if ( ! $REG instanceof EE_Registration) {
+					continue;
+				}
+				$deleted = $this->_delete_registration($REG);
+				if ( ! $deleted) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$REG_ID  = $this->_req_data['_REG_ID'];
+			$REG     = $REG_MDL->get_one_by_ID($REG_ID);
+			$deleted = $this->_delete_registration($REG);
+			if ( ! $deleted) {
+				$success = 0;
+			}
+		}
+		$what        = $success > 1
+			? esc_html__('Registrations', 'event_espresso')
+			: esc_html__('Registration', 'event_espresso');
+		$action_desc = esc_html__('permanently deleted.', 'event_espresso');
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			array('action' => 'default'),
+			true
+		);
+	}
+
+
+	/**
+	 * handles the permanent deletion of a registration.  See comments with _delete_registrations() for details on what
+	 * models get affected.
+	 *
+	 * @param  EE_Registration $REG registration to be deleted permenantly
+	 * @return bool true = successful deletion, false = fail.
+	 * @throws EE_Error
+	 */
+	protected function _delete_registration(EE_Registration $REG)
+	{
+		//first we start with the transaction... ultimately, we WILL not delete permanently if there are any related
+		//registrations on the transaction that are NOT trashed.
+		$TXN         = $REG->get_first_related('Transaction');
+		$REGS        = $TXN->get_many_related('Registration');
+		$all_trashed = true;
+		foreach ($REGS as $registration) {
+			if ( ! $registration->get('REG_deleted')) {
+				$all_trashed = false;
+			}
+		}
+		if ( ! $all_trashed) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to permanently delete this registration. Before this registration can be permanently deleted, all registrations made in the same transaction must be trashed as well.  These registrations will be permanently deleted in the same action.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		//k made it here so that means we can delete all the related transactions and their answers (but let's do them
+		//separately from THIS one).
+		foreach ($REGS as $registration) {
+			//delete related answers
+			$registration->delete_related_permanently('Answer');
+			//remove relationship to EE_Attendee (but we ALWAYS leave the contact record intact)
+			$attendee = $registration->get_first_related('Attendee');
+			if ($attendee instanceof EE_Attendee) {
+				$registration->_remove_relation_to($attendee, 'Attendee');
+			}
+			//now remove relationships to tickets on this registration.
+			$registration->_remove_relations('Ticket');
+			//now delete permanently the checkins related to this registration.
+			$registration->delete_related_permanently('Checkin');
+			if ($registration->ID() === $REG->ID()) {
+				continue;
+			} //we don't want to delete permanently the existing registration just yet.
+			//remove relation to transaction for these registrations if NOT the existing registrations
+			$registration->_remove_relations('Transaction');
+			//delete permanently any related messages.
+			$registration->delete_related_permanently('Message');
+			//now delete this registration permanently
+			$registration->delete_permanently();
+		}
+		//now all related registrations on the transaction are handled.  So let's just handle this registration itself
+		// (the transaction and line items should be all that's left).
+		// delete the line items related to the transaction for this registration.
+		$TXN->delete_related_permanently('Line_Item');
+		//we need to remove all the relationships on the transaction
+		$TXN->delete_related_permanently('Payment');
+		$TXN->delete_related_permanently('Extra_Meta');
+		$TXN->delete_related_permanently('Message');
+		//now we can delete this REG permanently (and the transaction of course)
+		$REG->delete_related_permanently('Transaction');
+		return $REG->delete_permanently();
+	}
+
+
+	/**
+	 *    generates HTML for the Register New Attendee Admin page
+	 *
+	 * @access private
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function new_registration()
+	{
+		if ( ! $this->_set_reg_event()) {
+			throw new EE_Error(
+				esc_html__(
+					'Unable to continue with registering because there is no Event ID in the request',
+					'event_espresso'
+				)
+			);
+		}
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		// gotta start with a clean slate if we're not coming here via ajax
+		if ( ! defined('DOING_AJAX')
+			 && ( ! isset($this->_req_data['processing_registration']) || isset($this->_req_data['step_error']))
+		) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		$this->_template_args['event_name'] = '';
+		// event name
+		if ($this->_reg_event) {
+			$this->_template_args['event_name'] = $this->_reg_event->name();
+			$edit_event_url                     = self::add_query_args_and_nonce(array(
+				'action' => 'edit',
+				'post'   => $this->_reg_event->ID(),
+			), EVENTS_ADMIN_URL);
+			$edit_event_lnk                     = '<a href="'
+												  . $edit_event_url
+												  . '" title="'
+												  . esc_attr__('Edit ', 'event_espresso')
+												  . $this->_reg_event->name()
+												  . '">'
+												  . esc_html__('Edit Event', 'event_espresso')
+												  . '</a>';
+			$this->_template_args['event_name'] .= ' <span class="admin-page-header-edit-lnk not-bold">'
+												   . $edit_event_lnk
+												   . '</span>';
+		}
+		$this->_template_args['step_content'] = $this->_get_registration_step_content();
+		if (defined('DOING_AJAX')) {
+			$this->_return_json();
+		}
+		// grab header
+		$template_path                              =
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($template_path,
+			$this->_template_args, true);
+		//$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This returns the content for a registration step
+	 *
+	 * @access protected
+	 * @return string html
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_registration_step_content()
+	{
+		if (isset($_COOKIE['ee_registration_added']) && $_COOKIE['ee_registration_added']) {
+			$warning_msg = sprintf(
+				esc_html__(
+					'%2$sWARNING!!!%3$s%1$sPlease do not use the back button to return to this page for the purpose of adding another registration.%1$sThis can result in lost and/or corrupted data.%1$sIf you wish to add another registration, then please click the%1$s%7$s"Add Another New Registration to Event"%8$s button%1$son the Transaction details page, after you are redirected.%1$s%1$s%4$s redirecting in %5$s seconds %6$s',
+					'event_espresso'
+				),
+				'<br />',
+				'<h3 class="important-notice">',
+				'</h3>',
+				'<div class="float-right">',
+				'<span id="redirect_timer" class="important-notice">30</span>',
+				'</div>',
+				'<b>',
+				'</b>'
+			);
+			return '
 	<div id="ee-add-reg-back-button-dv"><p>' . $warning_msg . '</p></div>
 	<script >
 		// WHOAH !!! it appears that someone is using the back button from the Transaction admin page
@@ -2701,792 +2701,792 @@ 
 	        }
 	    }, 800 );
 	</script >';
-        }
-        $template_args = array(
-            'title'                    => '',
-            'content'                  => '',
-            'step_button_text'         => '',
-            'show_notification_toggle' => false,
-        );
-        //to indicate we're processing a new registration
-        $hidden_fields = array(
-            'processing_registration' => array(
-                'type'  => 'hidden',
-                'value' => 0,
-            ),
-            'event_id'                => array(
-                'type'  => 'hidden',
-                'value' => $this->_reg_event->ID(),
-            ),
-        );
-        //if the cart is empty then we know we're at step one so we'll display ticket selector
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        switch ($step) {
-            case 'ticket' :
-                $hidden_fields['processing_registration']['value'] = 1;
-                $template_args['title']                            = esc_html__(
-                    'Step One: Select the Ticket for this registration',
-                    'event_espresso'
-                );
-                $template_args['content']                          =
-                    EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
-                $template_args['step_button_text']                 = esc_html__(
-                    'Add Tickets and Continue to Registrant Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle']         = false;
-                break;
-            case 'questions' :
-                $hidden_fields['processing_registration']['value'] = 2;
-                $template_args['title']                            = esc_html__(
-                    'Step Two: Add Registrant Details for this Registration',
-                    'event_espresso'
-                );
-                //in theory we should be able to run EED_SPCO at this point because the cart should have been setup
-                // properly by the first process_reg_step run.
-                $template_args['content']                  =
-                    EED_Single_Page_Checkout::registration_checkout_for_admin();
-                $template_args['step_button_text']         = esc_html__(
-                    'Save Registration and Continue to Details',
-                    'event_espresso'
-                );
-                $template_args['show_notification_toggle'] = true;
-                break;
-        }
-        //we come back to the process_registration_step route.
-        $this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
-        return EEH_Template::display_template(
-            REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     *        set_reg_event
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     */
-    private function _set_reg_event()
-    {
-        if (is_object($this->_reg_event)) {
-            return true;
-        }
-        $EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
-        if ( ! $EVT_ID) {
-            return false;
-        }
-        $this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        return true;
-    }
-
-
-    /**
-     * process_reg_step
-     *
-     * @access        public
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function process_reg_step()
-    {
-        EE_System::do_not_cache();
-        $this->_set_reg_event();
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-        EE_Registry::instance()->REQ->set('uts', time());
-        //what step are we on?
-        $cart = EE_Registry::instance()->SSN->cart();
-        $step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
-        //if doing ajax then we need to verify the nonce
-        if (defined('DOING_AJAX')) {
-            $nonce = isset($this->_req_data[$this->_req_nonce])
-                ? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        switch ($step) {
-            case 'ticket' :
-                //process ticket selection
-                $success = EED_Ticket_Selector::instance()->process_ticket_selections();
-                if ($success) {
-                    EE_Error::add_success(
-                        esc_html__(
-                            'Tickets Selected. Now complete the registration.',
-                            'event_espresso'
-                        )
-                    );
-                } else {
-                    $query_args['step_error'] = $this->_req_data['step_error'] = true;
-                }
-                if (defined('DOING_AJAX')) {
-                    $this->new_registration(); //display next step
-                } else {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 1,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    $this->_redirect_after_action(
-                        false,
-                        '',
-                        '',
-                        $query_args,
-                        true
-                    );
-                }
-                break;
-            case 'questions' :
-                if (! isset(
-                    $this->_req_data['txn_reg_status_change'],
-                    $this->_req_data['txn_reg_status_change']['send_notifications'])
-                ) {
-                    add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
-                }
-                //process registration
-                $transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
-                if ($cart instanceof EE_Cart) {
-                    $grand_total = $cart->get_cart_grand_total();
-                    if ($grand_total instanceof EE_Line_Item) {
-                        $grand_total->save_this_and_descendants_to_txn();
-                    }
-                }
-                if ( ! $transaction instanceof EE_Transaction) {
-                    $query_args = array(
-                        'action'                  => 'new_registration',
-                        'processing_registration' => 2,
-                        'event_id'                => $this->_reg_event->ID(),
-                        'uts'                     => time(),
-                    );
-                    if (defined('DOING_AJAX')) {
-                        //display registration form again because there are errors (maybe validation?)
-                        $this->new_registration();
-                        return;
-                    } else {
-                        $this->_redirect_after_action(
-                            false,
-                            '',
-                            '',
-                            $query_args,
-                            true
-                        );
-                        return;
-                    }
-                }
-                // maybe update status, and make sure to save transaction if not done already
-                if ( ! $transaction->update_status_based_on_total_paid()) {
-                    $transaction->save();
-                }
-                EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-                $this->_req_data = array();
-                $query_args      = array(
-                    'action'        => 'redirect_to_txn',
-                    'TXN_ID'        => $transaction->ID(),
-                    'EVT_ID'        => $this->_reg_event->ID(),
-                    'event_name'    => urlencode($this->_reg_event->name()),
-                    'redirect_from' => 'new_registration',
-                );
-                $this->_redirect_after_action(false, '', '', $query_args, true);
-                break;
-        }
-        //what are you looking here for?  Should be nothing to do at this point.
-    }
-
-
-    /**
-     * redirect_to_txn
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public function redirect_to_txn()
-    {
-        EE_System::do_not_cache();
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        $query_args = array(
-            'action' => 'view_transaction',
-            'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
-            'page'   => 'espresso_transactions',
-        );
-        if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
-            $query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
-            $query_args['event_name']    = urlencode($this->_req_data['event_name']);
-            $query_args['redirect_from'] = $this->_req_data['redirect_from'];
-        }
-        EE_Error::add_success(
-            esc_html__(
-                'Registration Created.  Please review the transaction and add any payments as necessary',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-
-    /**
-     *        generates HTML for the Attendee Contact List
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _attendee_contact_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     *        get_attendees
-     *
-     * @param      $per_page
-     * @param bool $count whether to return count or data.
-     * @param bool $trash
-     * @return array
-     * @throws EE_Error
-     * @access public
-     */
-    public function get_attendees($per_page, $count = false, $trash = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
-        $ATT_MDL                    = EEM_Attendee::instance();
-        $this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
-        switch ($this->_req_data['orderby']) {
-            case 'ATT_ID':
-                $orderby = 'ATT_ID';
-                break;
-            case 'ATT_fname':
-                $orderby = 'ATT_fname';
-                break;
-            case 'ATT_email':
-                $orderby = 'ATT_email';
-                break;
-            case 'ATT_city':
-                $orderby = 'ATT_city';
-                break;
-            case 'STA_ID':
-                $orderby = 'STA_ID';
-                break;
-            case 'CNT_ID':
-                $orderby = 'CNT_ID';
-                break;
-            default:
-                $orderby = 'ATT_lname';
-        }
-        $sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-            ? $this->_req_data['order']
-            : 'ASC';
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $per_page;
-        $_where       = array();
-        if ( ! empty($this->_req_data['s'])) {
-            $sstr         = '%' . $this->_req_data['s'] . '%';
-            $_where['OR'] = array(
-                'Registration.Event.EVT_name'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
-                'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
-                'ATT_fname'                         => array('LIKE', $sstr),
-                'ATT_lname'                         => array('LIKE', $sstr),
-                'ATT_short_bio'                     => array('LIKE', $sstr),
-                'ATT_email'                         => array('LIKE', $sstr),
-                'ATT_address'                       => array('LIKE', $sstr),
-                'ATT_address2'                      => array('LIKE', $sstr),
-                'ATT_city'                          => array('LIKE', $sstr),
-                'Country.CNT_name'                  => array('LIKE', $sstr),
-                'State.STA_name'                    => array('LIKE', $sstr),
-                'ATT_phone'                         => array('LIKE', $sstr),
-                'Registration.REG_final_price'      => array('LIKE', $sstr),
-                'Registration.REG_code'             => array('LIKE', $sstr),
-                'Registration.REG_count'            => array('LIKE', $sstr),
-                'Registration.REG_group_size'       => array('LIKE', $sstr),
-            );
-        }
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $count ? null : array($offset, $per_page);
-        if ($trash) {
-            $_where['status'] = array('!=', 'publish');
-            $all_attendees    = $count
-                ? $ATT_MDL->count(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ), 'ATT_ID', true)
-                : $ATT_MDL->get_all(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ));
-        } else {
-            $_where['status'] = array('IN', array('publish'));
-            $all_attendees    = $count
-                ? $ATT_MDL->count(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ), 'ATT_ID', true)
-                : $ATT_MDL->get_all(array(
-                    $_where,
-                    'order_by' => array($orderby => $sort),
-                    'limit'    => $limit,
-                ));
-        }
-        return $all_attendees;
-    }
-
-
-    /**
-     * This is just taking care of resending the registration confirmation
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _resend_registration()
-    {
-        $this->_process_resend_registration();
-        $query_args = isset($this->_req_data['redirect_to'])
-            ? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
-            : array('action' => 'default');
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
-
-    /**
-     * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
-     * to use when selecting registrations
-     * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
-     *                                                     the query parameters from the request
-     * @return void ends the request with a redirect or download
-     */
-    public function _registrations_report_base( $method_name_for_getting_query_params )
-    {
-        if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'        => 'espresso_batch',
-                    'batch'       => 'file',
-                    'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-                    'filters'     => urlencode(
-                        serialize(
-                            call_user_func(
-                                array( $this, $method_name_for_getting_query_params ),
-                                EEH_Array::is_set(
-                                    $this->_req_data,
-                                    'filters',
-                                    array()
-                                )
-                            )
-                        )
-                ),
-                'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
-                'return_url'  => urlencode($this->_req_data['return_url']),
-            )));
-        } else {
-            $new_request_args = array(
-                'export' => 'report',
-                'action' => 'registrations_report_for_event',
-                'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
-            );
-            $this->_req_data = array_merge($this->_req_data, $new_request_args);
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->_req_data);
-                $EE_Export->export();
-            }
-        }
-    }
-
-
-
-    /**
-     * Creates a registration report using only query parameters in the request
-     * @return void
-     */
-    public function _registrations_report()
-    {
-        $this->_registrations_report_base('_get_registration_query_parameters');
-    }
-
-
-    public function _contact_list_export()
-    {
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->_req_data);
-            $EE_Export->export_attendees();
-        }
-    }
-
-
-    public function _contact_list_report()
-    {
-        if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
-            wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
-                'page'        => 'espresso_batch',
-                'batch'       => 'file',
-                'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
-                'return_url'  => urlencode($this->_req_data['return_url']),
-            )));
-        } else {
-            if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-                require_once(EE_CLASSES . 'EE_Export.class.php');
-                $EE_Export = EE_Export::instance($this->_req_data);
-                $EE_Export->report_attendees();
-            }
-        }
-    }
-
-
-
-
-
-    /***************************************        ATTENDEE DETAILS        ***************************************/
-    /**
-     * This duplicates the attendee object for the given incoming registration id and attendee_id.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _duplicate_attendee()
-    {
-        $action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
-        //verify we have necessary info
-        if (empty($this->_req_data['_REG_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
-                    'event_espresso'
-                ), __FILE__, __LINE__, __FUNCTION__
-            );
-            $query_args = array('action' => $action);
-            $this->_redirect_after_action('', '', '', $query_args, true);
-        }
-        //okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
-        $registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
-        $attendee     = $registration->attendee();
-        //remove relation of existing attendee on registration
-        $registration->_remove_relation_to($attendee, 'Attendee');
-        //new attendee
-        $new_attendee = clone $attendee;
-        $new_attendee->set('ATT_ID', 0);
-        $new_attendee->save();
-        //add new attendee to reg
-        $registration->_add_relation_to($new_attendee, 'Attendee');
-        EE_Error::add_success(
-            esc_html__(
-                'New Contact record created.  Now make any edits you wish to make for this contact.',
-                'event_espresso'
-            )
-        );
-        //redirect to edit page for attendee
-        $query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
-        $this->_redirect_after_action('', '', '', $query_args, true);
-    }
-
-
-    //related to cpt routes
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        $success  = true;
-        $attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
-        //for attendee updates
-        if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
-            //note we should only be UPDATING attendees at this point.
-            $updated_fields = array(
-                'ATT_fname'     => $this->_req_data['ATT_fname'],
-                'ATT_lname'     => $this->_req_data['ATT_lname'],
-                'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
-                'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
-                'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
-                'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
-                'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
-                'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
-                'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
-                'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
-                'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
-            );
-            foreach ($updated_fields as $field => $value) {
-                $attendee->set($field, $value);
-            }
-            $success                   = $attendee->save();
-            $attendee_update_callbacks = apply_filters(
-                'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
-                array()
-            );
-            foreach ($attendee_update_callbacks as $a_callback) {
-                if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
-                                'event_espresso'
-                            ),
-                            $a_callback
-                        )
-                    );
-                }
-            }
-        }
-        if ($success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with updating the meta table data for the registration.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-    public function trash_cpt_item($post_id)
-    {
-    }
-
-
-    public function delete_cpt_item($post_id)
-    {
-    }
-
-
-    public function restore_cpt_item($post_id)
-    {
-    }
-
-
-    protected function _restore_cpt_item($post_id, $revision_id)
-    {
-    }
-
-
-    public function attendee_editor_metaboxes()
-    {
-        $this->verify_cpt_object();
-        remove_meta_box(
-            'postexcerpt',
-            esc_html__('Excerpt', 'event_espresso'),
-            'post_excerpt_meta_box',
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'core'
-        );
-        remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
-        if (post_type_supports('espresso_attendees', 'excerpt')) {
-            add_meta_box(
-                'postexcerpt',
-                esc_html__('Short Biography', 'event_espresso'),
-                'post_excerpt_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'normal'
-            );
-        }
-        if (post_type_supports('espresso_attendees', 'comments')) {
-            add_meta_box(
-                'commentsdiv',
-                esc_html__('Notes on the Contact', 'event_espresso'),
-                'post_comment_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'normal',
-                'core'
-            );
-        }
-        add_meta_box(
-            'attendee_contact_info',
-            esc_html__('Contact Info', 'event_espresso'),
-            array($this, 'attendee_contact_info'),
-            $this->_cpt_routes[$this->_req_action],
-            'side',
-            'core'
-        );
-        add_meta_box(
-            'attendee_details_address',
-            esc_html__('Address Details', 'event_espresso'),
-            array($this, 'attendee_address_details'),
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'core'
-        );
-        add_meta_box(
-            'attendee_registrations',
-            esc_html__('Registrations for this Contact', 'event_espresso'),
-            array($this, 'attendee_registrations_meta_box'),
-            $this->_cpt_routes[$this->_req_action],
-            'normal',
-            'high'
-        );
-    }
-
-
-    /**
-     * Metabox for attendee contact info
-     *
-     * @param  WP_Post $post wp post object
-     * @return string attendee contact info ( and form )
-     * @throws DomainException
-     */
-    public function attendee_contact_info($post)
-    {
-        //get attendee object ( should already have it )
-        $this->_template_args['attendee'] = $this->_cpt_model_obj;
-        $template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * Metabox for attendee details
-     *
-     * @param  WP_Post $post wp post object
-     * @return string attendee address details (and form)
-     * @throws DomainException
-     */
-    public function attendee_address_details($post)
-    {
-        //get attendee object (should already have it)
-        $this->_template_args['attendee']     = $this->_cpt_model_obj;
-        $this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
-                        'QST_system'       => 'admin-state',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->state_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'STA_ID',
-                    'input_name'     => 'STA_ID',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
-            new EE_Question_Form_Input(
-                EE_Question::new_instance(
-                    array(
-                        'QST_ID'           => 0,
-                        'QST_display_text' => esc_html__('Country', 'event_espresso'),
-                        'QST_system'       => 'admin-country',
-                    )
-                ),
-                EE_Answer::new_instance(
-                    array(
-                        'ANS_ID'    => 0,
-                        'ANS_value' => $this->_cpt_model_obj->country_ID(),
-                    )
-                ),
-                array(
-                    'input_id'       => 'CNT_ISO',
-                    'input_name'     => 'CNT_ISO',
-                    'input_prefix'   => '',
-                    'append_qstn_id' => false,
-                )
-            )
-        );
-        $template                             =
-            REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     *        _attendee_details
-     *
-     * @access protected
-     * @param $post
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function attendee_registrations_meta_box($post)
-    {
-        $this->_template_args['attendee']      = $this->_cpt_model_obj;
-        $this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
-        $template                              =
-            REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
-        EEH_Template::display_template($template, $this->_template_args);
-    }
-
-
-    /**
-     * add in the form fields for the attendee edit
-     *
-     * @param  WP_Post $post wp post object
-     * @return string html for new form.
-     * @throws DomainException
-     */
-    public function after_title_form_fields($post)
-    {
-        if ($post->post_type == 'espresso_attendees') {
-            $template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
-            $template_args['attendee'] = $this->_cpt_model_obj;
-            EEH_Template::display_template($template, $template_args);
-        }
-    }
-
-
-    /**
-     *        _trash_or_restore_attendee
-     *
-     * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
-     * @return void
-     * @throws EE_Error
-     * @access protected
-     */
-    protected function _trash_or_restore_attendees($trash = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ATT_MDL = EEM_Attendee::instance();
-        $success = 1;
-        //Checkboxes
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru checkboxes
-            while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
-                $updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
-                    : $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
-                if ( ! $updated) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and delete
-            $ATT_ID = absint($this->_req_data['ATT_ID']);
-            //get attendee
-            $att     = $ATT_MDL->get_one_by_ID($ATT_ID);
-            $updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
-            $updated = $att->save();
-            if ( ! $updated) {
-                $success = 0;
-            }
-        }
-        $what        = $success > 1
-            ? esc_html__('Contacts', 'event_espresso')
-            : esc_html__('Contact', 'event_espresso');
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-        $this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
-    }
+		}
+		$template_args = array(
+			'title'                    => '',
+			'content'                  => '',
+			'step_button_text'         => '',
+			'show_notification_toggle' => false,
+		);
+		//to indicate we're processing a new registration
+		$hidden_fields = array(
+			'processing_registration' => array(
+				'type'  => 'hidden',
+				'value' => 0,
+			),
+			'event_id'                => array(
+				'type'  => 'hidden',
+				'value' => $this->_reg_event->ID(),
+			),
+		);
+		//if the cart is empty then we know we're at step one so we'll display ticket selector
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		switch ($step) {
+			case 'ticket' :
+				$hidden_fields['processing_registration']['value'] = 1;
+				$template_args['title']                            = esc_html__(
+					'Step One: Select the Ticket for this registration',
+					'event_espresso'
+				);
+				$template_args['content']                          =
+					EED_Ticket_Selector::instance()->display_ticket_selector($this->_reg_event);
+				$template_args['step_button_text']                 = esc_html__(
+					'Add Tickets and Continue to Registrant Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle']         = false;
+				break;
+			case 'questions' :
+				$hidden_fields['processing_registration']['value'] = 2;
+				$template_args['title']                            = esc_html__(
+					'Step Two: Add Registrant Details for this Registration',
+					'event_espresso'
+				);
+				//in theory we should be able to run EED_SPCO at this point because the cart should have been setup
+				// properly by the first process_reg_step run.
+				$template_args['content']                  =
+					EED_Single_Page_Checkout::registration_checkout_for_admin();
+				$template_args['step_button_text']         = esc_html__(
+					'Save Registration and Continue to Details',
+					'event_espresso'
+				);
+				$template_args['show_notification_toggle'] = true;
+				break;
+		}
+		//we come back to the process_registration_step route.
+		$this->_set_add_edit_form_tags('process_reg_step', $hidden_fields);
+		return EEH_Template::display_template(
+			REG_TEMPLATE_PATH . 'reg_admin_register_new_attendee_step_content.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 *        set_reg_event
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function _set_reg_event()
+	{
+		if (is_object($this->_reg_event)) {
+			return true;
+		}
+		$EVT_ID = (! empty($this->_req_data['event_id'])) ? absint($this->_req_data['event_id']) : false;
+		if ( ! $EVT_ID) {
+			return false;
+		}
+		$this->_reg_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		return true;
+	}
+
+
+	/**
+	 * process_reg_step
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function process_reg_step()
+	{
+		EE_System::do_not_cache();
+		$this->_set_reg_event();
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+		EE_Registry::instance()->REQ->set('uts', time());
+		//what step are we on?
+		$cart = EE_Registry::instance()->SSN->cart();
+		$step = ! $cart instanceof EE_Cart ? 'ticket' : 'questions';
+		//if doing ajax then we need to verify the nonce
+		if (defined('DOING_AJAX')) {
+			$nonce = isset($this->_req_data[$this->_req_nonce])
+				? sanitize_text_field($this->_req_data[$this->_req_nonce]) : '';
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		switch ($step) {
+			case 'ticket' :
+				//process ticket selection
+				$success = EED_Ticket_Selector::instance()->process_ticket_selections();
+				if ($success) {
+					EE_Error::add_success(
+						esc_html__(
+							'Tickets Selected. Now complete the registration.',
+							'event_espresso'
+						)
+					);
+				} else {
+					$query_args['step_error'] = $this->_req_data['step_error'] = true;
+				}
+				if (defined('DOING_AJAX')) {
+					$this->new_registration(); //display next step
+				} else {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 1,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					$this->_redirect_after_action(
+						false,
+						'',
+						'',
+						$query_args,
+						true
+					);
+				}
+				break;
+			case 'questions' :
+				if (! isset(
+					$this->_req_data['txn_reg_status_change'],
+					$this->_req_data['txn_reg_status_change']['send_notifications'])
+				) {
+					add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_false', 15);
+				}
+				//process registration
+				$transaction = EED_Single_Page_Checkout::instance()->process_registration_from_admin();
+				if ($cart instanceof EE_Cart) {
+					$grand_total = $cart->get_cart_grand_total();
+					if ($grand_total instanceof EE_Line_Item) {
+						$grand_total->save_this_and_descendants_to_txn();
+					}
+				}
+				if ( ! $transaction instanceof EE_Transaction) {
+					$query_args = array(
+						'action'                  => 'new_registration',
+						'processing_registration' => 2,
+						'event_id'                => $this->_reg_event->ID(),
+						'uts'                     => time(),
+					);
+					if (defined('DOING_AJAX')) {
+						//display registration form again because there are errors (maybe validation?)
+						$this->new_registration();
+						return;
+					} else {
+						$this->_redirect_after_action(
+							false,
+							'',
+							'',
+							$query_args,
+							true
+						);
+						return;
+					}
+				}
+				// maybe update status, and make sure to save transaction if not done already
+				if ( ! $transaction->update_status_based_on_total_paid()) {
+					$transaction->save();
+				}
+				EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+				$this->_req_data = array();
+				$query_args      = array(
+					'action'        => 'redirect_to_txn',
+					'TXN_ID'        => $transaction->ID(),
+					'EVT_ID'        => $this->_reg_event->ID(),
+					'event_name'    => urlencode($this->_reg_event->name()),
+					'redirect_from' => 'new_registration',
+				);
+				$this->_redirect_after_action(false, '', '', $query_args, true);
+				break;
+		}
+		//what are you looking here for?  Should be nothing to do at this point.
+	}
+
+
+	/**
+	 * redirect_to_txn
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function redirect_to_txn()
+	{
+		EE_System::do_not_cache();
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		$query_args = array(
+			'action' => 'view_transaction',
+			'TXN_ID' => isset($this->_req_data['TXN_ID']) ? absint($this->_req_data['TXN_ID']) : 0,
+			'page'   => 'espresso_transactions',
+		);
+		if (isset($this->_req_data['EVT_ID'], $this->_req_data['redirect_from'])) {
+			$query_args['EVT_ID']        = $this->_req_data['EVT_ID'];
+			$query_args['event_name']    = urlencode($this->_req_data['event_name']);
+			$query_args['redirect_from'] = $this->_req_data['redirect_from'];
+		}
+		EE_Error::add_success(
+			esc_html__(
+				'Registration Created.  Please review the transaction and add any payments as necessary',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+
+	/**
+	 *        generates HTML for the Attendee Contact List
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _attendee_contact_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Contacts', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *        get_attendees
+	 *
+	 * @param      $per_page
+	 * @param bool $count whether to return count or data.
+	 * @param bool $trash
+	 * @return array
+	 * @throws EE_Error
+	 * @access public
+	 */
+	public function get_attendees($per_page, $count = false, $trash = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		require_once(REG_ADMIN . 'EE_Attendee_Contact_List_Table.class.php');
+		$ATT_MDL                    = EEM_Attendee::instance();
+		$this->_req_data['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : '';
+		switch ($this->_req_data['orderby']) {
+			case 'ATT_ID':
+				$orderby = 'ATT_ID';
+				break;
+			case 'ATT_fname':
+				$orderby = 'ATT_fname';
+				break;
+			case 'ATT_email':
+				$orderby = 'ATT_email';
+				break;
+			case 'ATT_city':
+				$orderby = 'ATT_city';
+				break;
+			case 'STA_ID':
+				$orderby = 'STA_ID';
+				break;
+			case 'CNT_ID':
+				$orderby = 'CNT_ID';
+				break;
+			default:
+				$orderby = 'ATT_lname';
+		}
+		$sort         = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+			? $this->_req_data['order']
+			: 'ASC';
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page     = isset($per_page) && ! empty($per_page) ? $per_page : 10;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $per_page;
+		$_where       = array();
+		if ( ! empty($this->_req_data['s'])) {
+			$sstr         = '%' . $this->_req_data['s'] . '%';
+			$_where['OR'] = array(
+				'Registration.Event.EVT_name'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_desc'       => array('LIKE', $sstr),
+				'Registration.Event.EVT_short_desc' => array('LIKE', $sstr),
+				'ATT_fname'                         => array('LIKE', $sstr),
+				'ATT_lname'                         => array('LIKE', $sstr),
+				'ATT_short_bio'                     => array('LIKE', $sstr),
+				'ATT_email'                         => array('LIKE', $sstr),
+				'ATT_address'                       => array('LIKE', $sstr),
+				'ATT_address2'                      => array('LIKE', $sstr),
+				'ATT_city'                          => array('LIKE', $sstr),
+				'Country.CNT_name'                  => array('LIKE', $sstr),
+				'State.STA_name'                    => array('LIKE', $sstr),
+				'ATT_phone'                         => array('LIKE', $sstr),
+				'Registration.REG_final_price'      => array('LIKE', $sstr),
+				'Registration.REG_code'             => array('LIKE', $sstr),
+				'Registration.REG_count'            => array('LIKE', $sstr),
+				'Registration.REG_group_size'       => array('LIKE', $sstr),
+			);
+		}
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $count ? null : array($offset, $per_page);
+		if ($trash) {
+			$_where['status'] = array('!=', 'publish');
+			$all_attendees    = $count
+				? $ATT_MDL->count(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				), 'ATT_ID', true)
+				: $ATT_MDL->get_all(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				));
+		} else {
+			$_where['status'] = array('IN', array('publish'));
+			$all_attendees    = $count
+				? $ATT_MDL->count(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				), 'ATT_ID', true)
+				: $ATT_MDL->get_all(array(
+					$_where,
+					'order_by' => array($orderby => $sort),
+					'limit'    => $limit,
+				));
+		}
+		return $all_attendees;
+	}
+
+
+	/**
+	 * This is just taking care of resending the registration confirmation
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _resend_registration()
+	{
+		$this->_process_resend_registration();
+		$query_args = isset($this->_req_data['redirect_to'])
+			? array('action' => $this->_req_data['redirect_to'], '_REG_ID' => $this->_req_data['_REG_ID'])
+			: array('action' => 'default');
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
+
+	/**
+	 * Creates a registration report, but accepts the name of a method to use for preparing the query parameters
+	 * to use when selecting registrations
+	 * @param string $method_name_for_getting_query_params the name of the method (on this class) to use for preparing
+	 *                                                     the query parameters from the request
+	 * @return void ends the request with a redirect or download
+	 */
+	public function _registrations_report_base( $method_name_for_getting_query_params )
+	{
+		if (! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'        => 'espresso_batch',
+					'batch'       => 'file',
+					'EVT_ID'      => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+					'filters'     => urlencode(
+						serialize(
+							call_user_func(
+								array( $this, $method_name_for_getting_query_params ),
+								EEH_Array::is_set(
+									$this->_req_data,
+									'filters',
+									array()
+								)
+							)
+						)
+				),
+				'use_filters' => EEH_Array::is_set($this->_req_data, 'use_filters', false),
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\RegistrationsReport'),
+				'return_url'  => urlencode($this->_req_data['return_url']),
+			)));
+		} else {
+			$new_request_args = array(
+				'export' => 'report',
+				'action' => 'registrations_report_for_event',
+				'EVT_ID' => isset($this->_req_data['EVT_ID']) ? $this->_req_data['EVT_ID'] : null,
+			);
+			$this->_req_data = array_merge($this->_req_data, $new_request_args);
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->_req_data);
+				$EE_Export->export();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Creates a registration report using only query parameters in the request
+	 * @return void
+	 */
+	public function _registrations_report()
+	{
+		$this->_registrations_report_base('_get_registration_query_parameters');
+	}
+
+
+	public function _contact_list_export()
+	{
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->_req_data);
+			$EE_Export->export_attendees();
+		}
+	}
+
+
+	public function _contact_list_report()
+	{
+		if ( ! defined('EE_USE_OLD_CSV_REPORT_CLASS')) {
+			wp_redirect(EE_Admin_Page::add_query_args_and_nonce(array(
+				'page'        => 'espresso_batch',
+				'batch'       => 'file',
+				'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\AttendeesReport'),
+				'return_url'  => urlencode($this->_req_data['return_url']),
+			)));
+		} else {
+			if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+				require_once(EE_CLASSES . 'EE_Export.class.php');
+				$EE_Export = EE_Export::instance($this->_req_data);
+				$EE_Export->report_attendees();
+			}
+		}
+	}
+
+
+
+
+
+	/***************************************        ATTENDEE DETAILS        ***************************************/
+	/**
+	 * This duplicates the attendee object for the given incoming registration id and attendee_id.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _duplicate_attendee()
+	{
+		$action = ! empty($this->_req_data['return']) ? $this->_req_data['return'] : 'default';
+		//verify we have necessary info
+		if (empty($this->_req_data['_REG_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Unable to create the contact for the registration because the required parameters are not present (_REG_ID )',
+					'event_espresso'
+				), __FILE__, __LINE__, __FUNCTION__
+			);
+			$query_args = array('action' => $action);
+			$this->_redirect_after_action('', '', '', $query_args, true);
+		}
+		//okay necessary deets present... let's dupe the incoming attendee and attach to incoming registration.
+		$registration = EEM_Registration::instance()->get_one_by_ID($this->_req_data['_REG_ID']);
+		$attendee     = $registration->attendee();
+		//remove relation of existing attendee on registration
+		$registration->_remove_relation_to($attendee, 'Attendee');
+		//new attendee
+		$new_attendee = clone $attendee;
+		$new_attendee->set('ATT_ID', 0);
+		$new_attendee->save();
+		//add new attendee to reg
+		$registration->_add_relation_to($new_attendee, 'Attendee');
+		EE_Error::add_success(
+			esc_html__(
+				'New Contact record created.  Now make any edits you wish to make for this contact.',
+				'event_espresso'
+			)
+		);
+		//redirect to edit page for attendee
+		$query_args = array('post' => $new_attendee->ID(), 'action' => 'edit_attendee');
+		$this->_redirect_after_action('', '', '', $query_args, true);
+	}
+
+
+	//related to cpt routes
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		$success  = true;
+		$attendee = EEM_Attendee::instance()->get_one_by_ID($post_id);
+		//for attendee updates
+		if ($post->post_type = 'espresso_attendees' && ! empty($attendee)) {
+			//note we should only be UPDATING attendees at this point.
+			$updated_fields = array(
+				'ATT_fname'     => $this->_req_data['ATT_fname'],
+				'ATT_lname'     => $this->_req_data['ATT_lname'],
+				'ATT_full_name' => $this->_req_data['ATT_fname'] . ' ' . $this->_req_data['ATT_lname'],
+				'ATT_address'   => isset($this->_req_data['ATT_address']) ? $this->_req_data['ATT_address'] : '',
+				'ATT_address2'  => isset($this->_req_data['ATT_address2']) ? $this->_req_data['ATT_address2'] : '',
+				'ATT_city'      => isset($this->_req_data['ATT_city']) ? $this->_req_data['ATT_city'] : '',
+				'STA_ID'        => isset($this->_req_data['STA_ID']) ? $this->_req_data['STA_ID'] : '',
+				'CNT_ISO'       => isset($this->_req_data['CNT_ISO']) ? $this->_req_data['CNT_ISO'] : '',
+				'ATT_zip'       => isset($this->_req_data['ATT_zip']) ? $this->_req_data['ATT_zip'] : '',
+				'ATT_email'     => isset($this->_req_data['ATT_email']) ? $this->_req_data['ATT_email'] : '',
+				'ATT_phone'     => isset($this->_req_data['ATT_phone']) ? $this->_req_data['ATT_phone'] : '',
+			);
+			foreach ($updated_fields as $field => $value) {
+				$attendee->set($field, $value);
+			}
+			$success                   = $attendee->save();
+			$attendee_update_callbacks = apply_filters(
+				'FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update',
+				array()
+			);
+			foreach ($attendee_update_callbacks as $a_callback) {
+				if (false === call_user_func_array($a_callback, array($attendee, $this->_req_data))) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The %s callback given for the "FHEE__Registrations_Admin_Page__insert_update_cpt_item__attendee_update" filter is not a valid callback.  Please check the spelling.',
+								'event_espresso'
+							),
+							$a_callback
+						)
+					);
+				}
+			}
+		}
+		if ($success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with updating the meta table data for the registration.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+	public function trash_cpt_item($post_id)
+	{
+	}
+
+
+	public function delete_cpt_item($post_id)
+	{
+	}
+
+
+	public function restore_cpt_item($post_id)
+	{
+	}
+
+
+	protected function _restore_cpt_item($post_id, $revision_id)
+	{
+	}
+
+
+	public function attendee_editor_metaboxes()
+	{
+		$this->verify_cpt_object();
+		remove_meta_box(
+			'postexcerpt',
+			esc_html__('Excerpt', 'event_espresso'),
+			'post_excerpt_meta_box',
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'core'
+		);
+		remove_meta_box('commentstatusdiv', $this->_cpt_routes[$this->_req_action], 'normal', 'core');
+		if (post_type_supports('espresso_attendees', 'excerpt')) {
+			add_meta_box(
+				'postexcerpt',
+				esc_html__('Short Biography', 'event_espresso'),
+				'post_excerpt_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'normal'
+			);
+		}
+		if (post_type_supports('espresso_attendees', 'comments')) {
+			add_meta_box(
+				'commentsdiv',
+				esc_html__('Notes on the Contact', 'event_espresso'),
+				'post_comment_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'normal',
+				'core'
+			);
+		}
+		add_meta_box(
+			'attendee_contact_info',
+			esc_html__('Contact Info', 'event_espresso'),
+			array($this, 'attendee_contact_info'),
+			$this->_cpt_routes[$this->_req_action],
+			'side',
+			'core'
+		);
+		add_meta_box(
+			'attendee_details_address',
+			esc_html__('Address Details', 'event_espresso'),
+			array($this, 'attendee_address_details'),
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'core'
+		);
+		add_meta_box(
+			'attendee_registrations',
+			esc_html__('Registrations for this Contact', 'event_espresso'),
+			array($this, 'attendee_registrations_meta_box'),
+			$this->_cpt_routes[$this->_req_action],
+			'normal',
+			'high'
+		);
+	}
+
+
+	/**
+	 * Metabox for attendee contact info
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string attendee contact info ( and form )
+	 * @throws DomainException
+	 */
+	public function attendee_contact_info($post)
+	{
+		//get attendee object ( should already have it )
+		$this->_template_args['attendee'] = $this->_cpt_model_obj;
+		$template                         = REG_TEMPLATE_PATH . 'attendee_contact_info_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * Metabox for attendee details
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string attendee address details (and form)
+	 * @throws DomainException
+	 */
+	public function attendee_address_details($post)
+	{
+		//get attendee object (should already have it)
+		$this->_template_args['attendee']     = $this->_cpt_model_obj;
+		$this->_template_args['state_html']   = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('State/Province', 'event_espresso'),
+						'QST_system'       => 'admin-state',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->state_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'STA_ID',
+					'input_name'     => 'STA_ID',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$this->_template_args['country_html'] = EEH_Form_Fields::generate_form_input(
+			new EE_Question_Form_Input(
+				EE_Question::new_instance(
+					array(
+						'QST_ID'           => 0,
+						'QST_display_text' => esc_html__('Country', 'event_espresso'),
+						'QST_system'       => 'admin-country',
+					)
+				),
+				EE_Answer::new_instance(
+					array(
+						'ANS_ID'    => 0,
+						'ANS_value' => $this->_cpt_model_obj->country_ID(),
+					)
+				),
+				array(
+					'input_id'       => 'CNT_ISO',
+					'input_name'     => 'CNT_ISO',
+					'input_prefix'   => '',
+					'append_qstn_id' => false,
+				)
+			)
+		);
+		$template                             =
+			REG_TEMPLATE_PATH . 'attendee_address_details_metabox_content.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 *        _attendee_details
+	 *
+	 * @access protected
+	 * @param $post
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function attendee_registrations_meta_box($post)
+	{
+		$this->_template_args['attendee']      = $this->_cpt_model_obj;
+		$this->_template_args['registrations'] = $this->_cpt_model_obj->get_many_related('Registration');
+		$template                              =
+			REG_TEMPLATE_PATH . 'attendee_registrations_main_meta_box.template.php';
+		EEH_Template::display_template($template, $this->_template_args);
+	}
+
+
+	/**
+	 * add in the form fields for the attendee edit
+	 *
+	 * @param  WP_Post $post wp post object
+	 * @return string html for new form.
+	 * @throws DomainException
+	 */
+	public function after_title_form_fields($post)
+	{
+		if ($post->post_type == 'espresso_attendees') {
+			$template                  = REG_TEMPLATE_PATH . 'attendee_details_after_title_form_fields.template.php';
+			$template_args['attendee'] = $this->_cpt_model_obj;
+			EEH_Template::display_template($template, $template_args);
+		}
+	}
+
+
+	/**
+	 *        _trash_or_restore_attendee
+	 *
+	 * @param boolean $trash - whether to move item to trash (TRUE) or restore it (FALSE)
+	 * @return void
+	 * @throws EE_Error
+	 * @access protected
+	 */
+	protected function _trash_or_restore_attendees($trash = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ATT_MDL = EEM_Attendee::instance();
+		$success = 1;
+		//Checkboxes
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru checkboxes
+			while (list($ATT_ID, $value) = each($this->_req_data['checkbox'])) {
+				$updated = $trash ? $ATT_MDL->update_by_ID(array('status' => 'trash'), $ATT_ID)
+					: $ATT_MDL->update_by_ID(array('status' => 'publish'), $ATT_ID);
+				if ( ! $updated) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and delete
+			$ATT_ID = absint($this->_req_data['ATT_ID']);
+			//get attendee
+			$att     = $ATT_MDL->get_one_by_ID($ATT_ID);
+			$updated = $trash ? $att->set_status('trash') : $att->set_status('publish');
+			$updated = $att->save();
+			if ( ! $updated) {
+				$success = 0;
+			}
+		}
+		$what        = $success > 1
+			? esc_html__('Contacts', 'event_espresso')
+			: esc_html__('Contact', 'event_espresso');
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+		$this->_redirect_after_action($success, $what, $action_desc, array('action' => 'contact_list'));
+	}
 
 }

core/libraries/messages/messenger/EE_Pdf_messenger.class.php

Spacing +25 added lines, -25 removed lines

@@ -6,7 +6,7 @@ 
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -20,7 +20,7 @@ 
  * @subpackage		messages
  * @author			Darren Ethier
  */
-class EE_Pdf_messenger extends EE_messenger  {
+class EE_Pdf_messenger extends EE_messenger {
 
 
 	/**
@@ -93,7 +93,7 @@ 
 	 * @see abstract declaration in EE_messenger for details.
 	 */
 	protected function _set_admin_pages() {
-		$this->admin_registered_pages = array( 'events_edit' => false );
+		$this->admin_registered_pages = array('events_edit' => false);
 	}
 
 
@@ -113,10 +113,10 @@ 
 	protected function _set_validator_config() {
 		$this->_validator_config = array(
 			'subject' => array(
-				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email','event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
 				),
 			'content' => array(
-				'shortcodes' => array( 'recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email','event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
 				),
 			'attendee_list' => array(
 				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
@@ -127,7 +127,7 @@ 
 				'required' => array('[EVENT_LIST]')
 				),
 			'ticket_list' => array(
-				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list','primary_registration_details', 'recipient_details'),
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
 				'required' => array('[TICKET_LIST]')
 				),
 			'datetime_list' => array(
@@ -147,7 +147,7 @@ 
 	 */
 	public  function enqueue_scripts_styles() {
 		parent::enqueue_scripts_styles();
-		do_action( 'AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
 	}
 
 
@@ -273,18 +273,18 @@ 
 	 */
 	protected function _send_message() {
 		$this->_template_args = array(
-			'page_title' => html_entity_decode( stripslashes( $this->_subject ), ENT_QUOTES, "UTF-8"),
-			'base_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation ),
-			'print_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation ),
-			'main_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation ),
-			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-			'main_body' => apply_filters( 'FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep( html_entity_decode($this->_content,  ENT_QUOTES,"UTF-8" ) )), $this->_content )
+			'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), $this->_content)
 			);
 		$this->_deregister_wp_hooks();
-		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
 		$content = $this->_get_main_template();
 //		die( $content );
-		$this->_do_pdf( $content );
+		$this->_do_pdf($content);
 		exit(0);
 	}
 
@@ -308,8 +308,8 @@ 
 
 		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
 		add_action('wp_head', 'wp_enqueue_scripts');
-		add_action( 'wp_footer', 'wp_print_footer_scripts' );
-		add_action( 'wp_print_footer_scripts', '_wp_footer_scripts' );
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
 	}
 
 
@@ -322,11 +322,11 @@ 
 	 * @param bool $preview
 	 * @return string
 	 */
-	protected function _get_main_template( $preview = FALSE ) {
-		$wrapper_template = $this->_tmp_pack->get_wrapper( 'html', 'main' );
+	protected function _get_main_template($preview = FALSE) {
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
 		//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 );
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
 	}
 
 
@@ -339,15 +339,15 @@ 
 	 *
 	 * @return void
 	 */
-	protected function _do_pdf( $content = '' ) {
-		$invoice_name = html_entity_decode( $this->_subject, ENT_QUOTES, "UTF-8");
+	protected function _do_pdf($content = '') {
+		$invoice_name = html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8");
 
 		//only load dompdf if nobody else has yet...
-		if( ! defined('DOMPDF_DIR')){
+		if ( ! defined('DOMPDF_DIR')) {
 			define('DOMPDF_ENABLE_REMOTE', TRUE);
 			define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
 			define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-			require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+			require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php');
 		}
 		$dompdf = new DOMPDF();
 		if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
@@ -356,7 +356,7 @@ 
 		$dompdf->load_html($content);
 		$dompdf->render();
 		//forcing the browser to open a download dialog.
-		$dompdf->stream($invoice_name . ".pdf", array( 'Attachment' => TRUE ));
+		$dompdf->stream($invoice_name.".pdf", array('Attachment' => TRUE));
 	}
 
 

core/admin/EE_Admin_List_Table.core.php

Indentation +834 added lines, -834 removed lines

@@ -3,7 +3,7 @@ 
 defined('EVENT_ESPRESSO_VERSION') || exit('No direct access allowed.');
 
 if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -22,847 +22,847 @@ 
 abstract class EE_Admin_List_Table extends WP_List_Table
 {
 
-    /**
-     * holds the data that will be processed for the table
-     *
-     * @var array $_data
-     */
-    protected $_data;
-
-
-    /**
-     * This holds the value of all the data available for the given view (for all pages).
-     *
-     * @var int $_all_data_count
-     */
-    protected $_all_data_count;
-
-
-    /**
-     * Will contain the count of trashed items for the view label.
-     *
-     * @var int $_trashed_count
-     */
-    protected $_trashed_count;
-
-
-    /**
-     * This is what will be referenced as the slug for the current screen
-     *
-     * @var string $_screen
-     */
-    protected $_screen;
-
-
-    /**
-     * this is the EE_Admin_Page object
-     *
-     * @var EE_Admin_Page $_admin_page
-     */
-    protected $_admin_page;
-
-
-    /**
-     * The current view
-     *
-     * @var string $_view
-     */
-    protected $_view;
-
-
-    /**
-     * array of possible views for this table
-     *
-     * @var array $_views
-     */
-    protected $_views;
-
-
-    /**
-     * An array of key => value pairs containing information about the current table
-     * array(
-     *        'plural' => 'plural label',
-     *        'singular' => 'singular label',
-     *        'ajax' => false, //whether to use ajax or not
-     *        'screen' => null, //string used to reference what screen this is
-     *        (WP_List_table converts to screen object)
-     * )
-     *
-     * @var array $_wp_list_args
-     */
-    protected $_wp_list_args;
-
-    /**
-     * an array of column names
-     * array(
-     *    'internal-name' => 'Title'
-     * )
-     *
-     * @var array $_columns
-     */
-    protected $_columns;
-
-    /**
-     * An array of sortable columns
-     * array(
-     *    'internal-name' => 'orderby' //or
-     *    'internal-name' => array( 'orderby', true )
-     * )
-     *
-     * @var array $_sortable_columns
-     */
-    protected $_sortable_columns;
-
-    /**
-     * callback method used to perform AJAX row reordering
-     *
-     * @var string $_ajax_sorting_callback
-     */
-    protected $_ajax_sorting_callback;
-
-    /**
-     * An array of hidden columns (if needed)
-     * array('internal-name', 'internal-name')
-     *
-     * @var array $_hidden_columns
-     */
-    protected $_hidden_columns;
-
-    /**
-     * holds the per_page value
-     *
-     * @var int $_per_page
-     */
-    protected $_per_page;
-
-    /**
-     * holds what page number is currently being viewed
-     *
-     * @var int $_current_page
-     */
-    protected $_current_page;
-
-    /**
-     * the reference string for the nonce_action
-     *
-     * @var string $_nonce_action_ref
-     */
-    protected $_nonce_action_ref;
-
-    /**
-     * property to hold incoming request data (as set by the admin_page_core)
-     *
-     * @var array $_req_data
-     */
-    protected $_req_data;
-
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array $_yes_no
-     */
-    protected $_yes_no = array();
-
-    /**
-     * Array describing buttons that should appear at the bottom of the page
-     * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
-     * and the values are another array with the following keys
-     * array(
-     *    'route' => 'page_route',
-     *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
-     * )
-     *
-     * @var array $_bottom_buttons
-     */
-    protected $_bottom_buttons = array();
-
-
-    /**
-     * Used to indicate what should be the primary column for the list table.
-     * If not present then falls back to what WP calculates
-     * as the primary column.
-     *
-     * @type string $_primary_column
-     */
-    protected $_primary_column = '';
-
-
-    /**
-     * Used to indicate whether the table has a checkbox column or not.
-     *
-     * @type bool $_has_checkbox_column
-     */
-    protected $_has_checkbox_column = false;
-
-
-    /**
-     * @param \EE_Admin_Page $admin_page we use this for obtaining everything we need in the list table
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        $this->_admin_page   = $admin_page;
-        $this->_req_data     = $this->_admin_page->get_request_data();
-        $this->_view         = $this->_admin_page->get_view();
-        $this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
-        $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
-        $this->_yes_no       = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
-
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page', 10);
-
-        $this->_setup_data();
-        $this->_add_view_counts();
-
-        $this->_nonce_action_ref = $this->_view;
-
-        $this->_set_properties();
-
-        //set primary column
-        add_filter('list_table_primary_column', array($this, 'set_primary_column'));
-
-        //set parent defaults
-        parent::__construct($this->_wp_list_args);
-
-        $this->prepare_items();
-    }
-
-
-    /**
-     * _setup_data
-     * this method is used to setup the $_data, $_all_data_count, and _per_page properties
-     *
-     * @uses $this->_admin_page
-     * @return void
-     */
-    abstract protected function _setup_data();
-
-
-    /**
-     * set the properties that this class needs to be able to execute wp_list_table properly
-     * properties set:
-     * _wp_list_args = what the arguments required for the parent _wp_list_table.
-     * _columns = set the columns in an array.
-     * _sortable_columns = columns that are sortable (array).
-     * _hidden_columns = columns that are hidden (array)
-     * _default_orderby = the default orderby for sorting.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_properties();
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string
-     */
-    abstract protected function _get_table_filters();
-
-
-    /**
-     * this is a method that child class will do to add counts to the views array so when views are displayed the
-     * counts of the views is accurate.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_view_counts();
-
-
-    /**
-     * _get_hidden_fields
-     * returns a html string of hidden fields so if any table filters are used the current view will be respected.
-     *
-     * @return string
-     */
-    protected function _get_hidden_fields()
-    {
-        $action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
-        $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
-        //if action is STILL empty, then we set it to default
-        $action = empty($action) ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . $action . '" />' . "\n";/**/
-        $field  .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
-
-        $bulk_actions = $this->_get_bulk_actions();
-        foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
-        }
-
-        return $field;
-    }
-
-
-    /**
-     * _set_column_info
-     * we're using this to set the column headers property.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_column_info()
-    {
-        $columns   = $this->get_columns();
-        $hidden    = $this->get_hidden_columns();
-        $_sortable = $this->get_sortable_columns();
-
-        /**
-         * Dynamic hook allowing for adding sortable columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array
-         */
-        $_sortable = apply_filters("FHEE_manage_{$this->screen->id}_sortable_columns", $_sortable, $this->_screen);
-
-        $sortable = array();
-        foreach ($_sortable as $id => $data) {
-            if (empty($data)) {
-                continue;
-            }
-            //fix for offset errors with WP_List_Table default get_columninfo()
-            if (is_array($data)) {
-                $_data[0] = key($data);
-                $_data[1] = isset($data[1]) ? $data[1] : false;
-            } else {
-                $_data[0] = $data;
-            }
-
-            $data = (array)$data;
-
-            if (! isset($data[1])) {
-                $_data[1] = false;
-            }
-
-            $sortable[$id] = $_data;
-        }
-        $primary               = $this->get_primary_column_name();
-        $this->_column_headers = array($columns, $hidden, $sortable, $primary);
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @return string
-     */
-    protected function get_primary_column_name()
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
-                return parent::get_primary_column_name();
-            }
-        }
-        return $this->_primary_column;
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name
-     * @param string        $primary
-     * @return string
-     */
-    protected function handle_row_actions($item, $column_name, $primary)
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
-                return parent::handle_row_actions($item, $column_name, $primary);
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * _get_bulk_actions
-     * This is a wrapper called by WP_List_Table::get_bulk_actions()
-     *
-     * @access protected
-     * @return array bulk_actions
-     */
-    protected function _get_bulk_actions()
-    {
-        $actions = array();
-        //the _views property should have the bulk_actions, so let's go through and extract them into a properly
-        // formatted array for the wp_list_table();
-        foreach ($this->_views as $view => $args) {
-            if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
-                //each bulk action will correspond with a admin page route, so we can check whatever the capability is
-                // for that page route and skip adding the bulk action if no access for the current logged in user.
-                foreach ($args['bulk_action'] as $route => $label) {
-                    if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[$route] = $label;
-                    }
-                }
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * Generate the table navigation above or below the table.
-     * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
-     *
-     * @since 4.9.44.rc.001
-     */
-    public function display_tablenav($which)
-    {
-        if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
-        }
-        ?>
+	/**
+	 * holds the data that will be processed for the table
+	 *
+	 * @var array $_data
+	 */
+	protected $_data;
+
+
+	/**
+	 * This holds the value of all the data available for the given view (for all pages).
+	 *
+	 * @var int $_all_data_count
+	 */
+	protected $_all_data_count;
+
+
+	/**
+	 * Will contain the count of trashed items for the view label.
+	 *
+	 * @var int $_trashed_count
+	 */
+	protected $_trashed_count;
+
+
+	/**
+	 * This is what will be referenced as the slug for the current screen
+	 *
+	 * @var string $_screen
+	 */
+	protected $_screen;
+
+
+	/**
+	 * this is the EE_Admin_Page object
+	 *
+	 * @var EE_Admin_Page $_admin_page
+	 */
+	protected $_admin_page;
+
+
+	/**
+	 * The current view
+	 *
+	 * @var string $_view
+	 */
+	protected $_view;
+
+
+	/**
+	 * array of possible views for this table
+	 *
+	 * @var array $_views
+	 */
+	protected $_views;
+
+
+	/**
+	 * An array of key => value pairs containing information about the current table
+	 * array(
+	 *        'plural' => 'plural label',
+	 *        'singular' => 'singular label',
+	 *        'ajax' => false, //whether to use ajax or not
+	 *        'screen' => null, //string used to reference what screen this is
+	 *        (WP_List_table converts to screen object)
+	 * )
+	 *
+	 * @var array $_wp_list_args
+	 */
+	protected $_wp_list_args;
+
+	/**
+	 * an array of column names
+	 * array(
+	 *    'internal-name' => 'Title'
+	 * )
+	 *
+	 * @var array $_columns
+	 */
+	protected $_columns;
+
+	/**
+	 * An array of sortable columns
+	 * array(
+	 *    'internal-name' => 'orderby' //or
+	 *    'internal-name' => array( 'orderby', true )
+	 * )
+	 *
+	 * @var array $_sortable_columns
+	 */
+	protected $_sortable_columns;
+
+	/**
+	 * callback method used to perform AJAX row reordering
+	 *
+	 * @var string $_ajax_sorting_callback
+	 */
+	protected $_ajax_sorting_callback;
+
+	/**
+	 * An array of hidden columns (if needed)
+	 * array('internal-name', 'internal-name')
+	 *
+	 * @var array $_hidden_columns
+	 */
+	protected $_hidden_columns;
+
+	/**
+	 * holds the per_page value
+	 *
+	 * @var int $_per_page
+	 */
+	protected $_per_page;
+
+	/**
+	 * holds what page number is currently being viewed
+	 *
+	 * @var int $_current_page
+	 */
+	protected $_current_page;
+
+	/**
+	 * the reference string for the nonce_action
+	 *
+	 * @var string $_nonce_action_ref
+	 */
+	protected $_nonce_action_ref;
+
+	/**
+	 * property to hold incoming request data (as set by the admin_page_core)
+	 *
+	 * @var array $_req_data
+	 */
+	protected $_req_data;
+
+
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array $_yes_no
+	 */
+	protected $_yes_no = array();
+
+	/**
+	 * Array describing buttons that should appear at the bottom of the page
+	 * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
+	 * and the values are another array with the following keys
+	 * array(
+	 *    'route' => 'page_route',
+	 *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
+	 * )
+	 *
+	 * @var array $_bottom_buttons
+	 */
+	protected $_bottom_buttons = array();
+
+
+	/**
+	 * Used to indicate what should be the primary column for the list table.
+	 * If not present then falls back to what WP calculates
+	 * as the primary column.
+	 *
+	 * @type string $_primary_column
+	 */
+	protected $_primary_column = '';
+
+
+	/**
+	 * Used to indicate whether the table has a checkbox column or not.
+	 *
+	 * @type bool $_has_checkbox_column
+	 */
+	protected $_has_checkbox_column = false;
+
+
+	/**
+	 * @param \EE_Admin_Page $admin_page we use this for obtaining everything we need in the list table
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		$this->_admin_page   = $admin_page;
+		$this->_req_data     = $this->_admin_page->get_request_data();
+		$this->_view         = $this->_admin_page->get_view();
+		$this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
+		$this->_current_page = $this->get_pagenum();
+		$this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+		$this->_yes_no       = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
+
+		$this->_per_page = $this->get_items_per_page($this->_screen . '_per_page', 10);
+
+		$this->_setup_data();
+		$this->_add_view_counts();
+
+		$this->_nonce_action_ref = $this->_view;
+
+		$this->_set_properties();
+
+		//set primary column
+		add_filter('list_table_primary_column', array($this, 'set_primary_column'));
+
+		//set parent defaults
+		parent::__construct($this->_wp_list_args);
+
+		$this->prepare_items();
+	}
+
+
+	/**
+	 * _setup_data
+	 * this method is used to setup the $_data, $_all_data_count, and _per_page properties
+	 *
+	 * @uses $this->_admin_page
+	 * @return void
+	 */
+	abstract protected function _setup_data();
+
+
+	/**
+	 * set the properties that this class needs to be able to execute wp_list_table properly
+	 * properties set:
+	 * _wp_list_args = what the arguments required for the parent _wp_list_table.
+	 * _columns = set the columns in an array.
+	 * _sortable_columns = columns that are sortable (array).
+	 * _hidden_columns = columns that are hidden (array)
+	 * _default_orderby = the default orderby for sorting.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_properties();
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string
+	 */
+	abstract protected function _get_table_filters();
+
+
+	/**
+	 * this is a method that child class will do to add counts to the views array so when views are displayed the
+	 * counts of the views is accurate.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_view_counts();
+
+
+	/**
+	 * _get_hidden_fields
+	 * returns a html string of hidden fields so if any table filters are used the current view will be respected.
+	 *
+	 * @return string
+	 */
+	protected function _get_hidden_fields()
+	{
+		$action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
+		$action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
+		//if action is STILL empty, then we set it to default
+		$action = empty($action) ? 'default' : $action;
+		$field  = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
+		$field  .= '<input type="hidden" name="route" value="' . $action . '" />' . "\n";/**/
+		$field  .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
+
+		$bulk_actions = $this->_get_bulk_actions();
+		foreach ($bulk_actions as $bulk_action => $label) {
+			$field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
+				. ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+		}
+
+		return $field;
+	}
+
+
+	/**
+	 * _set_column_info
+	 * we're using this to set the column headers property.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_column_info()
+	{
+		$columns   = $this->get_columns();
+		$hidden    = $this->get_hidden_columns();
+		$_sortable = $this->get_sortable_columns();
+
+		/**
+		 * Dynamic hook allowing for adding sortable columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array
+		 */
+		$_sortable = apply_filters("FHEE_manage_{$this->screen->id}_sortable_columns", $_sortable, $this->_screen);
+
+		$sortable = array();
+		foreach ($_sortable as $id => $data) {
+			if (empty($data)) {
+				continue;
+			}
+			//fix for offset errors with WP_List_Table default get_columninfo()
+			if (is_array($data)) {
+				$_data[0] = key($data);
+				$_data[1] = isset($data[1]) ? $data[1] : false;
+			} else {
+				$_data[0] = $data;
+			}
+
+			$data = (array)$data;
+
+			if (! isset($data[1])) {
+				$_data[1] = false;
+			}
+
+			$sortable[$id] = $_data;
+		}
+		$primary               = $this->get_primary_column_name();
+		$this->_column_headers = array($columns, $hidden, $sortable, $primary);
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @return string
+	 */
+	protected function get_primary_column_name()
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
+				return parent::get_primary_column_name();
+			}
+		}
+		return $this->_primary_column;
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name
+	 * @param string        $primary
+	 * @return string
+	 */
+	protected function handle_row_actions($item, $column_name, $primary)
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
+				return parent::handle_row_actions($item, $column_name, $primary);
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * _get_bulk_actions
+	 * This is a wrapper called by WP_List_Table::get_bulk_actions()
+	 *
+	 * @access protected
+	 * @return array bulk_actions
+	 */
+	protected function _get_bulk_actions()
+	{
+		$actions = array();
+		//the _views property should have the bulk_actions, so let's go through and extract them into a properly
+		// formatted array for the wp_list_table();
+		foreach ($this->_views as $view => $args) {
+			if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
+				//each bulk action will correspond with a admin page route, so we can check whatever the capability is
+				// for that page route and skip adding the bulk action if no access for the current logged in user.
+				foreach ($args['bulk_action'] as $route => $label) {
+					if ($this->_admin_page->check_user_access($route, true)) {
+						$actions[$route] = $label;
+					}
+				}
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * Generate the table navigation above or below the table.
+	 * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
+	 *
+	 * @since 4.9.44.rc.001
+	 */
+	public function display_tablenav($which)
+	{
+		if ('top' === $which) {
+			wp_nonce_field('bulk-' . $this->_args['plural']);
+		}
+		?>
         <div class="tablenav <?php echo esc_attr($which); ?>">
             <?php if ($this->_get_bulk_actions()) { ?>
                 <div class="alignleft actions bulkactions">
                     <?php $this->bulk_actions(); ?>
                 </div>
             <?php }
-            $this->extra_tablenav($which);
-            $this->pagination($which);
-            ?>
+			$this->extra_tablenav($which);
+			$this->pagination($which);
+			?>
 
             <br class="clear"/>
         </div>
         <?php
-    }
-
-
-    /**
-     * _filters
-     * This receives the filters array from children _get_table_filters() and assembles the string including the filter
-     * button.
-     *
-     * @access private
-     * @return string html showing filters
-     */
-    private function _filters()
-    {
-        $classname = get_class($this);
-        $filters   = apply_filters(
-            "FHEE__{$classname}__filters",
-            (array) $this->_get_table_filters(),
-            $this,
-            $this->_screen
-        );
-
-        if (empty($filters)) {
-            return;
-        }
-        foreach ($filters as $filter) {
-            echo $filter;
-        }
-        //add filter button at end
-        echo '<input type="submit" class="button-secondary" value="'
-             . esc_html__('Filter', 'event_espresso')
-             . '" id="post-query-submit" />';
-        //add reset filters button at end
-        echo '<a class="button button-secondary"  href="'
-             . $this->_admin_page->get_current_page_view_url()
-             . '" style="display:inline-block">'
-             . esc_html__('Reset Filters', 'event_espresso')
-             . '</a>';
-    }
-
-
-    /**
-     * Callback for 'list_table_primary_column' WordPress filter
-     * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
-     * column when class is instantiated.
-     *
-     * @see WP_List_Table::get_primary_column_name
-     * @param string $column_name
-     * @return string
-     */
-    public function set_primary_column($column_name)
-    {
-        return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
-    }
-
-
-    /**
-     *
-     */
-    public function prepare_items()
-    {
-
-        $this->_set_column_info();
-        //$this->_column_headers = $this->get_column_info();
-        $total_items = $this->_all_data_count;
-        $this->process_bulk_action();
-
-        $this->items = $this->_data;
-        $this->set_pagination_args(
-            array(
-                'total_items' => $total_items,
-                'per_page'    => $this->_per_page,
-                'total_pages' => ceil($total_items / $this->_per_page),
-            )
-        );
-    }
-
-
-    /**
-     * This column is the default for when there is no defined column method for a registered column.
-     * This can be overridden by child classes, but allows for hooking in for custom columns.
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name The column being called.
-     * @return string html content for the column
-     */
-    public function column_default($item, $column_name)
-    {
-        /**
-         * Dynamic hook allowing for adding additional column content in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         */
-        do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
-            $item,
-            $this->_screen
-        );
-    }
-
-
-    /**
-     * Get a list of columns. The format is:
-     * 'internal-name' => 'Title'
-     *
-     * @since  3.1.0
-     * @access public
-     * @abstract
-     * @return array
-     */
-    public function get_columns()
-    {
-        /**
-         * Dynamic hook allowing for adding additional columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array
-         */
-        $columns = apply_filters('FHEE_manage_' . $this->screen->id . '_columns', $this->_columns, $this->_screen);
-        return $columns;
-    }
-
-
-    /**
-     * Get an associative array ( id => link ) with the list
-     * of views available on this table.
-     *
-     * @since  3.1.0
-     * @access protected
-     * @return array
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * Generate the views html.
-     */
-    public function display_views()
-    {
-        $views           = $this->get_views();
-        $assembled_views = array();
-
-        if (empty($views)) {
-            return;
-        }
-        echo "<ul class='subsubsub'>\n";
-        foreach ($views as $view) {
-            $count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
-            if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $assembled_views[$view['slug']] = "\t<li class='" . $view['class'] . "'>"
-                                                  . '<a href="' . $view['url'] . '">' . $view['label'] . '</a>'
-                                                  . ' <span class="count">(' . $count . ')</span>';
-            }
-        }
-
-        echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views) . "</li>\n" : '';
-        echo "</ul>";
-    }
-
-
-    /**
-     * Generates content for a single row of the table
-     *
-     * @since  4.1
-     * @access public
-     * @param EE_Base_Class $item The current item
-     */
-    public function single_row($item)
-    {
-        $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
-        $this->single_row_columns($item);
-        echo '</tr>';
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  EE_Base_Class $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class === '' ? 'alternate' : '');
-
-        $new_row_class = $row_class;
-
-        if (! empty($this->_ajax_sorting_callback)) {
-            $new_row_class .= ' rowsortable';
-        }
-
-        return $new_row_class;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_sortable_columns()
-    {
-        return (array)$this->_sortable_columns;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_ajax_sorting_callback()
-    {
-        return $this->_ajax_sorting_callback;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_hidden_columns()
-    {
-        $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
-        if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
-        }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
-        return (array) get_user_option($ref, $user_id);
-    }
-
-
-    /**
-     * Generates the columns for a single row of the table.
-     * Overridden from wp_list_table so as to allow us to filter the column content for a given
-     * column.
-     *
-     * @since 3.1.0
-     * @param EE_Base_Class $item The current item
-     */
-    public function single_row_columns($item)
-    {
-        list($columns, $hidden, $sortable, $primary) = $this->get_column_info();
-
-        global $wp_version;
-        $use_hidden_class = version_compare($wp_version, '4.3-RC', '>=');
-
-        foreach ($columns as $column_name => $column_display_name) {
-
-            /**
-             * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
-             * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
-             */
-            $hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
-            $style        = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
-
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
-            if ($primary === $column_name) {
-                $classes .= ' has-row-actions column-primary';
-            }
-
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
-
-            $class = "class='$classes'";
-
-            $attributes = "$class$style$data";
-
-            if ($column_name === 'cb') {
-                echo '<th scope="row" class="check-column">';
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
-                    $this->column_cb($item),
-                    $item,
-                    $this
-                );
-                echo '</th>';
-            } elseif (method_exists($this, 'column_' . $column_name)) {
-                echo "<td $attributes>";
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
-                    call_user_func(array($this, 'column_' . $column_name), $item),
-                    $item,
-                    $this
-                );
-                echo $this->handle_row_actions($item, $column_name, $primary);
-                echo "</td>";
-            } else {
-                echo "<td $attributes>";
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
-                    $this->column_default($item, $column_name),
-                    $item,
-                    $column_name,
-                    $this
-                );
-                echo $this->handle_row_actions($item, $column_name, $primary);
-                echo "</td>";
-            }
-        }
-    }
-
-
-    /**
-     * Extra controls to be displayed between bulk actions and pagination
-     *
-     * @access public
-     * @param string $which
-     * @throws \EE_Error
-     */
-    public function extra_tablenav($which)
-    {
-        if ($which === 'top') {
-            $this->_filters();
-            echo $this->_get_hidden_fields();
-        } else {
-            echo '<div class="list-table-bottom-buttons alignleft actions">';
-            foreach ($this->_bottom_buttons as $type => $action) {
-                $route         = isset($action['route']) ? $action['route'] : '';
-                $extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
-                echo $this->_admin_page->get_action_link_or_button(
-                    $route,
-                    $type,
-                    $extra_request,
-                    'button button-secondary',
-                    '',
-                    false
-                );
-            }
-            do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
-            echo '</div>';
-        }
-        //echo $this->_entries_per_page_dropdown;
-    }
-
-
-    /**
-     * Get an associative array ( option_name => option_title ) with the list
-     * of bulk actions available on this table.
-     *
-     * @since  3.1.0
-     * @access protected
-     * @return array
-     */
-    public function get_bulk_actions()
-    {
-        return (array) $this->_get_bulk_actions();
-    }
-
-    /**
-     * Processing bulk actions.
-     */
-    public function process_bulk_action()
-    {
-        //this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
-        //reference in case there is a case where it gets used.
-    }
-
-
-    /**
-     * returns the EE admin page this list table is associated with
-     *
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    /**
-     * A "helper" function for all children to provide an html string of
-     * actions to output in their content.  It is preferable for child classes
-     * to use this method for generating their actions content so that it's
-     * filterable by plugins
-     *
-     * @param string        $action_container           what are the html container
-     *                                                  elements for this actions string?
-     * @param string        $action_class               What class is for the container
-     *                                                  element.
-     * @param string        $action_items               The contents for the action items
-     *                                                  container.  This is filtered before
-     *                                                  returned.
-     * @param string        $action_id                  What id (optional) is used for the
-     *                                                  container element.
-     * @param EE_Base_Class $item                       The object for the column displaying
-     *                                                  the actions.
-     * @return string The assembled action elements container.
-     */
-    protected function _action_string(
-        $action_items,
-        $item,
-        $action_container = 'ul',
-        $action_class = '',
-        $action_id = ''
-    ) {
-        $content      = '';
-        $action_class = ! empty($action_class) ? ' class="' . $action_class . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . $action_id . '"' : '';
-        $content      .= ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        try {
-            $content .= apply_filters(
-                'FHEE__EE_Admin_List_Table___action_string__action_items',
-                $action_items,
-                $item,
-                $this
-            );
-        } catch (\Exception $e) {
-            if (WP_DEBUG) {
-                \EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            }
-            $content .= $action_items;
-        }
-        $content .= ! empty($action_container) ? '</' . $action_container . '>' : '';
-        return $content;
-    }
+	}
+
+
+	/**
+	 * _filters
+	 * This receives the filters array from children _get_table_filters() and assembles the string including the filter
+	 * button.
+	 *
+	 * @access private
+	 * @return string html showing filters
+	 */
+	private function _filters()
+	{
+		$classname = get_class($this);
+		$filters   = apply_filters(
+			"FHEE__{$classname}__filters",
+			(array) $this->_get_table_filters(),
+			$this,
+			$this->_screen
+		);
+
+		if (empty($filters)) {
+			return;
+		}
+		foreach ($filters as $filter) {
+			echo $filter;
+		}
+		//add filter button at end
+		echo '<input type="submit" class="button-secondary" value="'
+			 . esc_html__('Filter', 'event_espresso')
+			 . '" id="post-query-submit" />';
+		//add reset filters button at end
+		echo '<a class="button button-secondary"  href="'
+			 . $this->_admin_page->get_current_page_view_url()
+			 . '" style="display:inline-block">'
+			 . esc_html__('Reset Filters', 'event_espresso')
+			 . '</a>';
+	}
+
+
+	/**
+	 * Callback for 'list_table_primary_column' WordPress filter
+	 * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
+	 * column when class is instantiated.
+	 *
+	 * @see WP_List_Table::get_primary_column_name
+	 * @param string $column_name
+	 * @return string
+	 */
+	public function set_primary_column($column_name)
+	{
+		return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
+	}
+
+
+	/**
+	 *
+	 */
+	public function prepare_items()
+	{
+
+		$this->_set_column_info();
+		//$this->_column_headers = $this->get_column_info();
+		$total_items = $this->_all_data_count;
+		$this->process_bulk_action();
+
+		$this->items = $this->_data;
+		$this->set_pagination_args(
+			array(
+				'total_items' => $total_items,
+				'per_page'    => $this->_per_page,
+				'total_pages' => ceil($total_items / $this->_per_page),
+			)
+		);
+	}
+
+
+	/**
+	 * This column is the default for when there is no defined column method for a registered column.
+	 * This can be overridden by child classes, but allows for hooking in for custom columns.
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name The column being called.
+	 * @return string html content for the column
+	 */
+	public function column_default($item, $column_name)
+	{
+		/**
+		 * Dynamic hook allowing for adding additional column content in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 */
+		do_action(
+			'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+			$item,
+			$this->_screen
+		);
+	}
+
+
+	/**
+	 * Get a list of columns. The format is:
+	 * 'internal-name' => 'Title'
+	 *
+	 * @since  3.1.0
+	 * @access public
+	 * @abstract
+	 * @return array
+	 */
+	public function get_columns()
+	{
+		/**
+		 * Dynamic hook allowing for adding additional columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array
+		 */
+		$columns = apply_filters('FHEE_manage_' . $this->screen->id . '_columns', $this->_columns, $this->_screen);
+		return $columns;
+	}
+
+
+	/**
+	 * Get an associative array ( id => link ) with the list
+	 * of views available on this table.
+	 *
+	 * @since  3.1.0
+	 * @access protected
+	 * @return array
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * Generate the views html.
+	 */
+	public function display_views()
+	{
+		$views           = $this->get_views();
+		$assembled_views = array();
+
+		if (empty($views)) {
+			return;
+		}
+		echo "<ul class='subsubsub'>\n";
+		foreach ($views as $view) {
+			$count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
+			if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
+				$assembled_views[$view['slug']] = "\t<li class='" . $view['class'] . "'>"
+												  . '<a href="' . $view['url'] . '">' . $view['label'] . '</a>'
+												  . ' <span class="count">(' . $count . ')</span>';
+			}
+		}
+
+		echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views) . "</li>\n" : '';
+		echo "</ul>";
+	}
+
+
+	/**
+	 * Generates content for a single row of the table
+	 *
+	 * @since  4.1
+	 * @access public
+	 * @param EE_Base_Class $item The current item
+	 */
+	public function single_row($item)
+	{
+		$row_class = $this->_get_row_class($item);
+		echo '<tr class="' . esc_attr($row_class) . '">';
+		$this->single_row_columns($item);
+		echo '</tr>';
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  EE_Base_Class $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class === '' ? 'alternate' : '');
+
+		$new_row_class = $row_class;
+
+		if (! empty($this->_ajax_sorting_callback)) {
+			$new_row_class .= ' rowsortable';
+		}
+
+		return $new_row_class;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_sortable_columns()
+	{
+		return (array)$this->_sortable_columns;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_ajax_sorting_callback()
+	{
+		return $this->_ajax_sorting_callback;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_hidden_columns()
+	{
+		$user_id     = get_current_user_id();
+		$has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+		if (empty($has_default) && ! empty($this->_hidden_columns)) {
+			update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
+			update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+		}
+		$ref = 'manage' . $this->screen->id . 'columnshidden';
+		return (array) get_user_option($ref, $user_id);
+	}
+
+
+	/**
+	 * Generates the columns for a single row of the table.
+	 * Overridden from wp_list_table so as to allow us to filter the column content for a given
+	 * column.
+	 *
+	 * @since 3.1.0
+	 * @param EE_Base_Class $item The current item
+	 */
+	public function single_row_columns($item)
+	{
+		list($columns, $hidden, $sortable, $primary) = $this->get_column_info();
+
+		global $wp_version;
+		$use_hidden_class = version_compare($wp_version, '4.3-RC', '>=');
+
+		foreach ($columns as $column_name => $column_display_name) {
+
+			/**
+			 * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
+			 * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
+			 */
+			$hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
+			$style        = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
+
+			$classes = $column_name . ' column-' . $column_name . $hidden_class;
+			if ($primary === $column_name) {
+				$classes .= ' has-row-actions column-primary';
+			}
+
+			$data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+
+			$class = "class='$classes'";
+
+			$attributes = "$class$style$data";
+
+			if ($column_name === 'cb') {
+				echo '<th scope="row" class="check-column">';
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
+					$this->column_cb($item),
+					$item,
+					$this
+				);
+				echo '</th>';
+			} elseif (method_exists($this, 'column_' . $column_name)) {
+				echo "<td $attributes>";
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+					call_user_func(array($this, 'column_' . $column_name), $item),
+					$item,
+					$this
+				);
+				echo $this->handle_row_actions($item, $column_name, $primary);
+				echo "</td>";
+			} else {
+				echo "<td $attributes>";
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
+					$this->column_default($item, $column_name),
+					$item,
+					$column_name,
+					$this
+				);
+				echo $this->handle_row_actions($item, $column_name, $primary);
+				echo "</td>";
+			}
+		}
+	}
+
+
+	/**
+	 * Extra controls to be displayed between bulk actions and pagination
+	 *
+	 * @access public
+	 * @param string $which
+	 * @throws \EE_Error
+	 */
+	public function extra_tablenav($which)
+	{
+		if ($which === 'top') {
+			$this->_filters();
+			echo $this->_get_hidden_fields();
+		} else {
+			echo '<div class="list-table-bottom-buttons alignleft actions">';
+			foreach ($this->_bottom_buttons as $type => $action) {
+				$route         = isset($action['route']) ? $action['route'] : '';
+				$extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
+				echo $this->_admin_page->get_action_link_or_button(
+					$route,
+					$type,
+					$extra_request,
+					'button button-secondary',
+					'',
+					false
+				);
+			}
+			do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
+			echo '</div>';
+		}
+		//echo $this->_entries_per_page_dropdown;
+	}
+
+
+	/**
+	 * Get an associative array ( option_name => option_title ) with the list
+	 * of bulk actions available on this table.
+	 *
+	 * @since  3.1.0
+	 * @access protected
+	 * @return array
+	 */
+	public function get_bulk_actions()
+	{
+		return (array) $this->_get_bulk_actions();
+	}
+
+	/**
+	 * Processing bulk actions.
+	 */
+	public function process_bulk_action()
+	{
+		//this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
+		//reference in case there is a case where it gets used.
+	}
+
+
+	/**
+	 * returns the EE admin page this list table is associated with
+	 *
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	/**
+	 * A "helper" function for all children to provide an html string of
+	 * actions to output in their content.  It is preferable for child classes
+	 * to use this method for generating their actions content so that it's
+	 * filterable by plugins
+	 *
+	 * @param string        $action_container           what are the html container
+	 *                                                  elements for this actions string?
+	 * @param string        $action_class               What class is for the container
+	 *                                                  element.
+	 * @param string        $action_items               The contents for the action items
+	 *                                                  container.  This is filtered before
+	 *                                                  returned.
+	 * @param string        $action_id                  What id (optional) is used for the
+	 *                                                  container element.
+	 * @param EE_Base_Class $item                       The object for the column displaying
+	 *                                                  the actions.
+	 * @return string The assembled action elements container.
+	 */
+	protected function _action_string(
+		$action_items,
+		$item,
+		$action_container = 'ul',
+		$action_class = '',
+		$action_id = ''
+	) {
+		$content      = '';
+		$action_class = ! empty($action_class) ? ' class="' . $action_class . '"' : '';
+		$action_id    = ! empty($action_id) ? ' id="' . $action_id . '"' : '';
+		$content      .= ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
+		try {
+			$content .= apply_filters(
+				'FHEE__EE_Admin_List_Table___action_string__action_items',
+				$action_items,
+				$item,
+				$this
+			);
+		} catch (\Exception $e) {
+			if (WP_DEBUG) {
+				\EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			}
+			$content .= $action_items;
+		}
+		$content .= ! empty($action_container) ? '</' . $action_container . '>' : '';
+		return $content;
+	}
 }

Spacing +34 added lines, -34 removed lines

@@ -2,8 +2,8 @@ 
 
 defined('EVENT_ESPRESSO_VERSION') || exit('No direct access allowed.');
 
-if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+if ( ! class_exists('WP_List_Table')) {
+    require_once ABSPATH.'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -206,10 +206,10 @@ 
         $this->_view         = $this->_admin_page->get_view();
         $this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
         $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+        $this->_screen       = $this->_admin_page->get_current_page().'_'.$this->_admin_page->get_current_view();
         $this->_yes_no       = array(__('No', 'event_espresso'), __('Yes', 'event_espresso'));
 
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page', 10);
+        $this->_per_page = $this->get_items_per_page($this->_screen.'_per_page', 10);
 
         $this->_setup_data();
         $this->_add_view_counts();
@@ -289,14 +289,14 @@ 
         $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
         //if action is STILL empty, then we set it to default
         $action = empty($action) ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . $this->_req_data['page'] . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . $action . '" />' . "\n";/**/
-        $field  .= '<input type="hidden" name="perpage" value="' . $this->_per_page . '" />' . "\n";
+        $field  = '<input type="hidden" name="page" value="'.$this->_req_data['page'].'" />'."\n";
+        $field  .= '<input type="hidden" name="route" value="'.$action.'" />'."\n"; /**/
+        $field  .= '<input type="hidden" name="perpage" value="'.$this->_per_page.'" />'."\n";
 
         $bulk_actions = $this->_get_bulk_actions();
         foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+            $field .= '<input type="hidden" name="'.$bulk_action.'_nonce"'
+                . ' value="'.wp_create_nonce($bulk_action.'_nonce').'" />'."\n";
         }
 
         return $field;
@@ -341,9 +341,9 @@ 
                 $_data[0] = $data;
             }
 
-            $data = (array)$data;
+            $data = (array) $data;
 
-            if (! isset($data[1])) {
+            if ( ! isset($data[1])) {
                 $_data[1] = false;
             }
 
@@ -425,7 +425,7 @@ 
     public function display_tablenav($which)
     {
         if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
+            wp_nonce_field('bulk-'.$this->_args['plural']);
         }
         ?>
         <div class="tablenav <?php echo esc_attr($which); ?>">
@@ -537,7 +537,7 @@ 
          * hook prefix ("event-espresso") will be different.
          */
         do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+            'AHEE__EE_Admin_List_Table__column_'.$column_name.'__'.$this->screen->id,
             $item,
             $this->_screen
         );
@@ -565,7 +565,7 @@ 
          *
          * @var array
          */
-        $columns = apply_filters('FHEE_manage_' . $this->screen->id . '_columns', $this->_columns, $this->_screen);
+        $columns = apply_filters('FHEE_manage_'.$this->screen->id.'_columns', $this->_columns, $this->_screen);
         return $columns;
     }
 
@@ -599,13 +599,13 @@ 
         foreach ($views as $view) {
             $count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
             if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $assembled_views[$view['slug']] = "\t<li class='" . $view['class'] . "'>"
-                                                  . '<a href="' . $view['url'] . '">' . $view['label'] . '</a>'
-                                                  . ' <span class="count">(' . $count . ')</span>';
+                $assembled_views[$view['slug']] = "\t<li class='".$view['class']."'>"
+                                                  . '<a href="'.$view['url'].'">'.$view['label'].'</a>'
+                                                  . ' <span class="count">('.$count.')</span>';
             }
         }
 
-        echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views) . "</li>\n" : '';
+        echo ! empty($assembled_views) ? implode(" |</li>\n", $assembled_views)."</li>\n" : '';
         echo "</ul>";
     }
 
@@ -620,7 +620,7 @@ 
     public function single_row($item)
     {
         $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
+        echo '<tr class="'.esc_attr($row_class).'">';
         $this->single_row_columns($item);
         echo '</tr>';
     }
@@ -640,7 +640,7 @@ 
 
         $new_row_class = $row_class;
 
-        if (! empty($this->_ajax_sorting_callback)) {
+        if ( ! empty($this->_ajax_sorting_callback)) {
             $new_row_class .= ' rowsortable';
         }
 
@@ -653,7 +653,7 @@ 
      */
     public function get_sortable_columns()
     {
-        return (array)$this->_sortable_columns;
+        return (array) $this->_sortable_columns;
     }
 
 
@@ -672,12 +672,12 @@ 
     public function get_hidden_columns()
     {
         $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+        $has_default = get_user_option('default'.$this->screen->id.'columnshidden', $user_id);
         if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+            update_user_option($user_id, 'default'.$this->screen->id.'columnshidden', true);
+            update_user_option($user_id, 'manage'.$this->screen->id.'columnshidden', $this->_hidden_columns, true);
         }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
+        $ref = 'manage'.$this->screen->id.'columnshidden';
         return (array) get_user_option($ref, $user_id);
     }
 
@@ -706,12 +706,12 @@ 
             $hidden_class = $use_hidden_class && in_array($column_name, $hidden) ? ' hidden' : '';
             $style        = ! $use_hidden_class && in_array($column_name, $hidden) ? ' style="display:none;"' : '';
 
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
+            $classes = $column_name.' column-'.$column_name.$hidden_class;
             if ($primary === $column_name) {
                 $classes .= ' has-row-actions column-primary';
             }
 
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+            $data = ' data-colname="'.wp_strip_all_tags($column_display_name).'"';
 
             $class = "class='$classes'";
 
@@ -726,11 +726,11 @@ 
                     $this
                 );
                 echo '</th>';
-            } elseif (method_exists($this, 'column_' . $column_name)) {
+            } elseif (method_exists($this, 'column_'.$column_name)) {
                 echo "<td $attributes>";
                 echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
-                    call_user_func(array($this, 'column_' . $column_name), $item),
+                    'FHEE__EE_Admin_List_Table__single_row_columns__column_'.$column_name.'__column_content',
+                    call_user_func(array($this, 'column_'.$column_name), $item),
                     $item,
                     $this
                 );
@@ -846,9 +846,9 @@ 
         $action_id = ''
     ) {
         $content      = '';
-        $action_class = ! empty($action_class) ? ' class="' . $action_class . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . $action_id . '"' : '';
-        $content      .= ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
+        $action_class = ! empty($action_class) ? ' class="'.$action_class.'"' : '';
+        $action_id    = ! empty($action_id) ? ' id="'.$action_id.'"' : '';
+        $content .= ! empty($action_container) ? '<'.$action_container.$action_class.$action_id.'>' : '';
         try {
             $content .= apply_filters(
                 'FHEE__EE_Admin_List_Table___action_string__action_items',
@@ -862,7 +862,7 @@ 
             }
             $content .= $action_items;
         }
-        $content .= ! empty($action_container) ? '</' . $action_container . '>' : '';
+        $content .= ! empty($action_container) ? '</'.$action_container.'>' : '';
         return $content;
     }
 }

admin_pages/messages/Messages_Admin_Page.core.php

Indentation +3632 added lines, -3632 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -17,2222 +17,2222 @@ 
 class Messages_Admin_Page extends EE_Admin_Page
 {
     
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-    
-    /**
-     * @type string $_active_message_type_name
-     */
-    protected $_active_message_type_name = '';
-    
-    /**
-     * @type EE_messenger $_active_messenger
-     */
-    protected $_active_messenger;
-    protected $_activate_state;
-    protected $_activate_meta_box_type;
-    protected $_current_message_meta_box;
-    protected $_current_message_meta_box_object;
-    protected $_context_switcher;
-    protected $_shortcodes = array();
-    protected $_active_messengers = array();
-    protected $_active_message_types = array();
-    
-    /**
-     * @var EE_Message_Template_Group $_message_template_group
-     */
-    protected $_message_template_group;
-    protected $_m_mt_settings = array();
-    
-    
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
-     * IF there is no group then it gets automatically set to the Default template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-    
-    
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
-     * group is.  If there is no group then it automatically gets set to default.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
-    
-    
-    /**
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        //make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
-    
-    
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MSG_PG_SLUG;
-        $this->page_label       = __('Messages Settings', 'event_espresso');
-        $this->_admin_base_url  = EE_MSG_ADMIN_URL;
-        $this->_admin_base_path = EE_MSG_ADMIN;
-        
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
-        
-        $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
-        $this->_load_message_resource_manager();
-    }
-    
-    
-    /**
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
-     *
-     *
-     * @throws EE_Error
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+    
+	/**
+	 * @type string $_active_message_type_name
+	 */
+	protected $_active_message_type_name = '';
+    
+	/**
+	 * @type EE_messenger $_active_messenger
+	 */
+	protected $_active_messenger;
+	protected $_activate_state;
+	protected $_activate_meta_box_type;
+	protected $_current_message_meta_box;
+	protected $_current_message_meta_box_object;
+	protected $_context_switcher;
+	protected $_shortcodes = array();
+	protected $_active_messengers = array();
+	protected $_active_message_types = array();
+    
+	/**
+	 * @var EE_Message_Template_Group $_message_template_group
+	 */
+	protected $_message_template_group;
+	protected $_m_mt_settings = array();
+    
+    
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
+	 * IF there is no group then it gets automatically set to the Default template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+    
+    
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
+	 * group is.  If there is no group then it automatically gets set to default.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
+    
+    
+	/**
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		//make sure messages autoloader is running
+		EED_Messages::set_autoloaders();
+		parent::__construct($routing);
+	}
+    
+    
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MSG_PG_SLUG;
+		$this->page_label       = __('Messages Settings', 'event_espresso');
+		$this->_admin_base_url  = EE_MSG_ADMIN_URL;
+		$this->_admin_base_path = EE_MSG_ADMIN;
+        
+		$this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array();
+        
+		$this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
+		$this->_load_message_resource_manager();
+	}
+    
+    
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _load_message_resource_manager()
+	{
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a messenger filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_messengers_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $m_values          = array();
-        $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-        //setup messengers for selects
-        $i = 1;
-        foreach ($active_messengers as $active_messenger) {
-            if ($active_messenger instanceof EE_Message) {
-                $m_values[$i]['id']   = $active_messenger->messenger();
-                $m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
-                $i++;
-            }
-        }
-        
-        return $m_values;
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+			'4.9.9.rc.014'
+		);
+        
+		$m_values          = array();
+		$active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+		//setup messengers for selects
+		$i = 1;
+		foreach ($active_messengers as $active_messenger) {
+			if ($active_messenger instanceof EE_Message) {
+				$m_values[$i]['id']   = $active_messenger->messenger();
+				$m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
+				$i++;
+			}
+		}
+        
+		return $m_values;
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a message type filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_message_types_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $mt_values       = array();
-        $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-        $i               = 1;
-        foreach ($active_messages as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $mt_values[$i]['id']   = $active_message->message_type();
-                $mt_values[$i]['text'] = ucwords($active_message->message_type_label());
-                $i++;
-            }
-        }
-        
-        return $mt_values;
-    }
-    
-    
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
+			'4.9.9.rc.014'
+		);
+        
+		$mt_values       = array();
+		$active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+		$i               = 1;
+		foreach ($active_messages as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$mt_values[$i]['id']   = $active_message->message_type();
+				$mt_values[$i]['text'] = ucwords($active_message->message_type_label());
+				$i++;
+			}
+		}
+        
+		return $mt_values;
+	}
+    
+    
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__('This method is no longer in use.  There is no replacement for it. The method was used to generate a set of
 			values for use in creating a message type context filter dropdown which is now generated differently via
 			 Messages_Admin_Page::get_contexts_for_message_types_select_input', 'event_espresso'),
-            '4.9.9.rc.014'
-        );
-        
-        $contexts                = array();
-        $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-        foreach ($active_message_contexts as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[$context] = $context_details['label'];
-                    }
-                }
-            }
-        }
-        
-        return $contexts;
-    }
-    
-    
-    /**
-     * Generate select input with provided messenger options array.
-     *
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
-     *                                 labels.
-     *
-     * @return string
-     */
-    public function get_messengers_select_input($messenger_options)
-    {
-        //if empty or just one value then just return an empty string
-        if (empty($messenger_options)
-            || ! is_array($messenger_options)
-            || count($messenger_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $messenger_options = array_merge(
-            array('none_selected' => __('Show All Messengers', 'event_espresso')),
-            $messenger_options
-        );
-        $input             = new EE_Select_Input(
-            $messenger_options,
-            array(
-                'html_name'  => 'ee_messenger_filter_by',
-                'html_id'    => 'ee_messenger_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_messenger_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_messenger_filter_by'])
-                    : 'none_selected'
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    /**
-     * Generate select input with provided message type options array.
-     *
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
-     *                                    message type labels
-     *
-     * @return string
-     */
-    public function get_message_types_select_input($message_type_options)
-    {
-        //if empty or count of options is 1 then just return an empty string
-        if (empty($message_type_options)
-            || ! is_array($message_type_options)
-            || count($message_type_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $message_type_options = array_merge(
-            array('none_selected' => __('Show All Message Types', 'event_espresso')),
-            $message_type_options
-        );
-        $input                = new EE_Select_Input(
-            $message_type_options,
-            array(
-                'html_name'  => 'ee_message_type_filter_by',
-                'html_id'    => 'ee_message_type_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_message_type_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_message_type_filter_by'])
-                    : 'none_selected',
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    /**
-     * Generate select input with provide message type contexts array.
-     *
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
-     *                               context label.
-     *
-     * @return string
-     */
-    public function get_contexts_for_message_types_select_input($context_options)
-    {
-        //if empty or count of options is one then just return empty string
-        if (empty($context_options)
-            || ! is_array($context_options)
-            || count($context_options) === 1
-        ) {
-            return '';
-        }
-        //merge in default
-        $context_options = array_merge(
-            array('none_selected' => __('Show all Contexts', 'event_espresso')),
-            $context_options
-        );
-        $input           = new EE_Select_Input(
-            $context_options,
-            array(
-                'html_name'  => 'ee_context_filter_by',
-                'html_id'    => 'ee_context_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_context_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_context_filter_by'])
-                    : 'none_selected',
-            )
-        );
-        
-        return $input->get_html_for_input();
-    }
-    
-    
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
-        add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
-        add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
-        add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
-        add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
-    }
-    
-    
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'    => array(
-                'add'    => __('Add New Message Template', 'event_espresso'),
-                'edit'   => __('Edit Message Template', 'event_espresso'),
-                'delete' => __('Delete Message Template', 'event_espresso')
-            ),
-            'publishbox' => __('Update Actions', 'event_espresso')
-        );
-    }
-    
-    
-    /**
-     *        an array for storing key => value pairs of request actions and their corresponding methods
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
-            ? $this->_req_data['GRP_ID']
-            : 0;
-        $grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
-            ? $this->_req_data['id']
-            : $grp_id;
-        $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
-            ? $this->_req_data['MSG_ID']
-            : 0;
-        
-        $this->_page_routes = array(
-            'default'                          => array(
-                'func'       => '_message_queue_list_table',
-                'capability' => 'ee_read_global_messages'
-            ),
-            'global_mtps'                      => array(
-                'func'       => '_ee_default_messages_overview_list_table',
-                'capability' => 'ee_read_global_messages'
-            ),
-            'custom_mtps'                      => array(
-                'func'       => '_custom_mtps_preview',
-                'capability' => 'ee_read_messages'
-            ),
-            'add_new_message_template'         => array(
-                'func'       => '_add_message_template',
-                'capability' => 'ee_edit_messages',
-                'noheader'   => true
-            ),
-            'edit_message_template'            => array(
-                'func'       => '_edit_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id
-            ),
-            'preview_message'                  => array(
-                'func'               => '_preview_message',
-                'capability'         => 'ee_read_message',
-                'obj_id'             => $grp_id,
-                'noheader'           => true,
-                'headers_sent_route' => 'display_preview_message'
-            ),
-            'display_preview_message'          => array(
-                'func'       => '_display_preview_message',
-                'capability' => 'ee_read_message',
-                'obj_id'     => $grp_id
-            ),
-            'insert_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_messages',
-                'args'       => array('new_template' => true),
-                'noheader'   => true
-            ),
-            'update_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('new_template' => false),
-                'noheader'   => true
-            ),
-            'trash_message_template'           => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true, 'all' => true),
-                'noheader'   => true
-            ),
-            'trash_message_template_context'   => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true),
-                'noheader'   => true
-            ),
-            'restore_message_template'         => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false, 'all' => true),
-                'noheader'   => true
-            ),
-            'restore_message_template_context' => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true
-            ),
-            'delete_message_template'          => array(
-                'func'       => '_delete_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true
-            ),
-            'reset_to_default'                 => array(
-                'func'       => '_reset_to_default_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true
-            ),
-            'settings'                         => array(
-                'func'       => '_settings',
-                'capability' => 'manage_options'
-            ),
-            'update_global_settings'           => array(
-                'func'       => '_update_global_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true
-            ),
-            'generate_now'                     => array(
-                'func'       => '_generate_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'generate_and_send_now'            => array(
-                'func'       => '_generate_and_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'queue_for_resending'              => array(
-                'func'       => '_queue_for_resending',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'send_now'                         => array(
-                'func'       => '_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true
-            ),
-            'delete_ee_message'                => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_message',
-                'noheader'   => true
-            ),
-            'delete_ee_messages'               => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $msg_id
-            )
-        );
-    }
-    
-    
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                  => array(
-                'nav'           => array(
-                    'label' => __('Message Activity', 'event_espresso'),
-                    'order' => 10
-                ),
-                'list_table'    => 'EE_Message_List_Table',
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
-                'require_nonce' => false
-            ),
-            'global_mtps'              => array(
-                'nav'           => array(
-                    'label' => __('Default Message Templates', 'event_espresso'),
-                    'order' => 20
-                ),
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => array(
-                    'messages_overview_help_tab'                                => array(
-                        'title'    => __('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview'
-                    ),
-                    'messages_overview_messages_table_column_headings_help_tab' => array(
-                        'title'    => __('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings'
-                    ),
-                    'messages_overview_messages_filters_help_tab'               => array(
-                        'title'    => __('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters'
-                    ),
-                    'messages_overview_messages_views_help_tab'                 => array(
-                        'title'    => __('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views'
-                    ),
-                    'message_overview_message_types_help_tab'                   => array(
-                        'title'    => __('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types'
-                    ),
-                    'messages_overview_messengers_help_tab'                     => array(
-                        'title'    => __('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ),
-                ),
-                'help_tour'     => array('Messages_Overview_Help_Tour'),
-                'require_nonce' => false
-            ),
-            'custom_mtps'              => array(
-                'nav'           => array(
-                    'label' => __('Custom Message Templates', 'event_espresso'),
-                    'order' => 30
-                ),
-                'help_tabs'     => array(),
-                'help_tour'     => array(),
-                'require_nonce' => false
-            ),
-            'add_new_message_template' => array(
-                'nav'           => array(
-                    'label'      => __('Add New Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false
-                ),
-                'require_nonce' => false
-            ),
-            'edit_message_template'    => array(
-                'labels'        => array(
-                    'buttons'    => array(
-                        'reset' => __('Reset Templates'),
-                    ),
-                    'publishbox' => __('Update Actions', 'event_espresso')
-                ),
-                'nav'           => array(
-                    'label'      => __('Edit Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => ''
-                ),
-                'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
-                'has_metaboxes' => true,
-                'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
-                'help_tabs'     => array(
-                    'edit_message_template'       => array(
-                        'title'    => __('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab'
-                    ),
-                    'message_templates_help_tab'  => array(
-                        'title'    => __('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates'
-                    ),
-                    'message_template_shortcodes' => array(
-                        'title'    => __('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab'
-                    ),
-                    'message_preview_help_tab'    => array(
-                        'title'    => __('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview'
-                    ),
-                    'messages_overview_other_help_tab'                          => array(
-                        'title'    => __('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ),
-                ),
-                'require_nonce' => false
-            ),
-            'display_preview_message'  => array(
-                'nav'           => array(
-                    'label'      => __('Message Preview', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false
-                ),
-                'help_tabs'     => array(
-                    'preview_message' => array(
-                        'title'    => __('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab'
-                    )
-                ),
-                'require_nonce' => false
-            ),
-            'settings'                 => array(
-                'nav'           => array(
-                    'label' => __('Settings', 'event_espresso'),
-                    'order' => 40
-                ),
-                'metaboxes'     => array('_messages_settings_metaboxes'),
-                'help_tabs'     => array(
-                    'messages_settings_help_tab'               => array(
-                        'title'    => __('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings'
-                    ),
-                    'messages_settings_message_types_help_tab' => array(
-                        'title'    => __('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types'
-                    ),
-                    'messages_settings_messengers_help_tab'    => array(
-                        'title'    => __('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers'
-                    ),
-                ),
-                'help_tour'     => array('Messages_Settings_Help_Tour'),
-                'require_nonce' => false
-            )
-        );
-    }
-    
-    
-    protected function _add_screen_options()
-    {
-        //todo
-    }
-    
-    
-    protected function _add_screen_options_global_mtps()
-    {
-        /**
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
-         */
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = __('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-    
-    
-    protected function _add_screen_options_default()
-    {
-        $this->_admin_page_title = __('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
-    
-    
-    //none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
-    
-    public function admin_init()
-    {
-    }
-    
-    public function admin_notices()
-    {
-    }
-    
-    public function admin_footer_scripts()
-    {
-    }
-    
-    
-    public function messages_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
-    }
-    
-    
-    public function messengers_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
-    }
-    
-    
-    public function message_types_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
-    }
-    
-    
-    public function messages_overview_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
-    }
-    
-    
-    public function message_templates_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
-    }
-    
-    
-    public function edit_message_template_help_tab()
-    {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
-                'event_espresso') . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
-                'event_espresso') . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
-                'event_espresso') . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
-                'event_espresso') . '" />';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
-            $args);
-    }
-    
-    
-    public function message_template_shortcodes_help_tab()
-    {
-        $this->_set_shortcodes();
-        $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
-            $args);
-    }
+			'4.9.9.rc.014'
+		);
+        
+		$contexts                = array();
+		$active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+		foreach ($active_message_contexts as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					foreach ($message_type_contexts as $context => $context_details) {
+						$contexts[$context] = $context_details['label'];
+					}
+				}
+			}
+		}
+        
+		return $contexts;
+	}
+    
+    
+	/**
+	 * Generate select input with provided messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 *
+	 * @return string
+	 */
+	public function get_messengers_select_input($messenger_options)
+	{
+		//if empty or just one value then just return an empty string
+		if (empty($messenger_options)
+			|| ! is_array($messenger_options)
+			|| count($messenger_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$messenger_options = array_merge(
+			array('none_selected' => __('Show All Messengers', 'event_espresso')),
+			$messenger_options
+		);
+		$input             = new EE_Select_Input(
+			$messenger_options,
+			array(
+				'html_name'  => 'ee_messenger_filter_by',
+				'html_id'    => 'ee_messenger_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_messenger_filter_by'])
+					? sanitize_title($this->_req_data['ee_messenger_filter_by'])
+					: 'none_selected'
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	/**
+	 * Generate select input with provided message type options array.
+	 *
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
+	 *                                    message type labels
+	 *
+	 * @return string
+	 */
+	public function get_message_types_select_input($message_type_options)
+	{
+		//if empty or count of options is 1 then just return an empty string
+		if (empty($message_type_options)
+			|| ! is_array($message_type_options)
+			|| count($message_type_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$message_type_options = array_merge(
+			array('none_selected' => __('Show All Message Types', 'event_espresso')),
+			$message_type_options
+		);
+		$input                = new EE_Select_Input(
+			$message_type_options,
+			array(
+				'html_name'  => 'ee_message_type_filter_by',
+				'html_id'    => 'ee_message_type_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_message_type_filter_by'])
+					? sanitize_title($this->_req_data['ee_message_type_filter_by'])
+					: 'none_selected',
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	/**
+	 * Generate select input with provide message type contexts array.
+	 *
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
+	 *                               context label.
+	 *
+	 * @return string
+	 */
+	public function get_contexts_for_message_types_select_input($context_options)
+	{
+		//if empty or count of options is one then just return empty string
+		if (empty($context_options)
+			|| ! is_array($context_options)
+			|| count($context_options) === 1
+		) {
+			return '';
+		}
+		//merge in default
+		$context_options = array_merge(
+			array('none_selected' => __('Show all Contexts', 'event_espresso')),
+			$context_options
+		);
+		$input           = new EE_Select_Input(
+			$context_options,
+			array(
+				'html_name'  => 'ee_context_filter_by',
+				'html_id'    => 'ee_context_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_context_filter_by'])
+					? sanitize_title($this->_req_data['ee_context_filter_by'])
+					: 'none_selected',
+			)
+		);
+        
+		return $input->get_html_for_input();
+	}
+    
+    
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
+		add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
+		add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
+		add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
+		add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
+	}
+    
+    
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'    => array(
+				'add'    => __('Add New Message Template', 'event_espresso'),
+				'edit'   => __('Edit Message Template', 'event_espresso'),
+				'delete' => __('Delete Message Template', 'event_espresso')
+			),
+			'publishbox' => __('Update Actions', 'event_espresso')
+		);
+	}
+    
+    
+	/**
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
+			? $this->_req_data['GRP_ID']
+			: 0;
+		$grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
+			? $this->_req_data['id']
+			: $grp_id;
+		$msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
+			? $this->_req_data['MSG_ID']
+			: 0;
+        
+		$this->_page_routes = array(
+			'default'                          => array(
+				'func'       => '_message_queue_list_table',
+				'capability' => 'ee_read_global_messages'
+			),
+			'global_mtps'                      => array(
+				'func'       => '_ee_default_messages_overview_list_table',
+				'capability' => 'ee_read_global_messages'
+			),
+			'custom_mtps'                      => array(
+				'func'       => '_custom_mtps_preview',
+				'capability' => 'ee_read_messages'
+			),
+			'add_new_message_template'         => array(
+				'func'       => '_add_message_template',
+				'capability' => 'ee_edit_messages',
+				'noheader'   => true
+			),
+			'edit_message_template'            => array(
+				'func'       => '_edit_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id
+			),
+			'preview_message'                  => array(
+				'func'               => '_preview_message',
+				'capability'         => 'ee_read_message',
+				'obj_id'             => $grp_id,
+				'noheader'           => true,
+				'headers_sent_route' => 'display_preview_message'
+			),
+			'display_preview_message'          => array(
+				'func'       => '_display_preview_message',
+				'capability' => 'ee_read_message',
+				'obj_id'     => $grp_id
+			),
+			'insert_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_messages',
+				'args'       => array('new_template' => true),
+				'noheader'   => true
+			),
+			'update_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('new_template' => false),
+				'noheader'   => true
+			),
+			'trash_message_template'           => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true, 'all' => true),
+				'noheader'   => true
+			),
+			'trash_message_template_context'   => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true),
+				'noheader'   => true
+			),
+			'restore_message_template'         => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false, 'all' => true),
+				'noheader'   => true
+			),
+			'restore_message_template_context' => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true
+			),
+			'delete_message_template'          => array(
+				'func'       => '_delete_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true
+			),
+			'reset_to_default'                 => array(
+				'func'       => '_reset_to_default_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true
+			),
+			'settings'                         => array(
+				'func'       => '_settings',
+				'capability' => 'manage_options'
+			),
+			'update_global_settings'           => array(
+				'func'       => '_update_global_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true
+			),
+			'generate_now'                     => array(
+				'func'       => '_generate_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'generate_and_send_now'            => array(
+				'func'       => '_generate_and_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'queue_for_resending'              => array(
+				'func'       => '_queue_for_resending',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'send_now'                         => array(
+				'func'       => '_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true
+			),
+			'delete_ee_message'                => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_message',
+				'noheader'   => true
+			),
+			'delete_ee_messages'               => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+				'obj_id'     => $msg_id
+			)
+		);
+	}
+    
+    
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                  => array(
+				'nav'           => array(
+					'label' => __('Message Activity', 'event_espresso'),
+					'order' => 10
+				),
+				'list_table'    => 'EE_Message_List_Table',
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
+				'require_nonce' => false
+			),
+			'global_mtps'              => array(
+				'nav'           => array(
+					'label' => __('Default Message Templates', 'event_espresso'),
+					'order' => 20
+				),
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => array(
+					'messages_overview_help_tab'                                => array(
+						'title'    => __('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview'
+					),
+					'messages_overview_messages_table_column_headings_help_tab' => array(
+						'title'    => __('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings'
+					),
+					'messages_overview_messages_filters_help_tab'               => array(
+						'title'    => __('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters'
+					),
+					'messages_overview_messages_views_help_tab'                 => array(
+						'title'    => __('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views'
+					),
+					'message_overview_message_types_help_tab'                   => array(
+						'title'    => __('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types'
+					),
+					'messages_overview_messengers_help_tab'                     => array(
+						'title'    => __('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					),
+				),
+				'help_tour'     => array('Messages_Overview_Help_Tour'),
+				'require_nonce' => false
+			),
+			'custom_mtps'              => array(
+				'nav'           => array(
+					'label' => __('Custom Message Templates', 'event_espresso'),
+					'order' => 30
+				),
+				'help_tabs'     => array(),
+				'help_tour'     => array(),
+				'require_nonce' => false
+			),
+			'add_new_message_template' => array(
+				'nav'           => array(
+					'label'      => __('Add New Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false
+				),
+				'require_nonce' => false
+			),
+			'edit_message_template'    => array(
+				'labels'        => array(
+					'buttons'    => array(
+						'reset' => __('Reset Templates'),
+					),
+					'publishbox' => __('Update Actions', 'event_espresso')
+				),
+				'nav'           => array(
+					'label'      => __('Edit Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => ''
+				),
+				'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
+				'has_metaboxes' => true,
+				'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
+				'help_tabs'     => array(
+					'edit_message_template'       => array(
+						'title'    => __('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab'
+					),
+					'message_templates_help_tab'  => array(
+						'title'    => __('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates'
+					),
+					'message_template_shortcodes' => array(
+						'title'    => __('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab'
+					),
+					'message_preview_help_tab'    => array(
+						'title'    => __('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview'
+					),
+					'messages_overview_other_help_tab'                          => array(
+						'title'    => __('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					),
+				),
+				'require_nonce' => false
+			),
+			'display_preview_message'  => array(
+				'nav'           => array(
+					'label'      => __('Message Preview', 'event_espresso'),
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false
+				),
+				'help_tabs'     => array(
+					'preview_message' => array(
+						'title'    => __('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab'
+					)
+				),
+				'require_nonce' => false
+			),
+			'settings'                 => array(
+				'nav'           => array(
+					'label' => __('Settings', 'event_espresso'),
+					'order' => 40
+				),
+				'metaboxes'     => array('_messages_settings_metaboxes'),
+				'help_tabs'     => array(
+					'messages_settings_help_tab'               => array(
+						'title'    => __('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings'
+					),
+					'messages_settings_message_types_help_tab' => array(
+						'title'    => __('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types'
+					),
+					'messages_settings_messengers_help_tab'    => array(
+						'title'    => __('Activating / Deactivating Messengers', 'event_espresso'),
+						'filename' => 'messages_settings_messengers'
+					),
+				),
+				'help_tour'     => array('Messages_Settings_Help_Tour'),
+				'require_nonce' => false
+			)
+		);
+	}
+    
+    
+	protected function _add_screen_options()
+	{
+		//todo
+	}
+    
+    
+	protected function _add_screen_options_global_mtps()
+	{
+		/**
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
+		 */
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = __('Global Message Templates', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+    
+    
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = __('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
+    
+    
+	//none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
+    
+	public function admin_init()
+	{
+	}
+    
+	public function admin_notices()
+	{
+	}
+    
+	public function admin_footer_scripts()
+	{
+	}
+    
+    
+	public function messages_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+	}
+    
+    
+	public function messengers_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+	}
+    
+    
+	public function message_types_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+	}
+    
+    
+	public function messages_overview_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+	}
+    
+    
+	public function message_templates_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+	}
+    
+    
+	public function edit_message_template_help_tab()
+	{
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title',
+				'event_espresso') . '" />';
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview',
+				'event_espresso') . '" />';
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields',
+				'event_espresso') . '" />';
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox',
+				'event_espresso') . '" />';
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox',
+				'event_espresso') . '" />';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+			$args);
+	}
+    
+    
+	public function message_template_shortcodes_help_tab()
+	{
+		$this->_set_shortcodes();
+		$args['shortcodes'] = $this->_shortcodes;
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+			$args);
+	}
     
     
-    public function preview_message_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
-    }
+	public function preview_message_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+	}
     
-    
-    public function settings_help_tab()
-    {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
-                'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
-                'event_espresso') . '" />';
-        $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
-        $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
-    }
+    
+	public function settings_help_tab()
+	{
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab',
+				'event_espresso') . '" />';
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab',
+				'event_espresso') . '" />';
+		$args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>';
+		$args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+	}
     
     
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_ee_msg');
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_ee_msg');
         
-        wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
-            array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
-        wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
-            array('ee-dialog'), EVENT_ESPRESSO_VERSION);
-    }
+		wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+			array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true);
+		wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+			array('ee-dialog'), EVENT_ESPRESSO_VERSION);
+	}
     
     
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('ee-msg-list-table-js');
-    }
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('ee-msg-list-table-js');
+	}
     
     
-    public function wp_editor_css($mce_css)
-    {
-        //if we're on the edit_message_template route
-        if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
-            $message_type_name = $this->_active_message_type_name;
+	public function wp_editor_css($mce_css)
+	{
+		//if we're on the edit_message_template route
+		if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
+			$message_type_name = $this->_active_message_type_name;
             
-            //we're going to REPLACE the existing mce css
-            //we need to get the css file location from the active messenger
-            $mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true,
-                'wpeditor', $this->_variation);
-        }
+			//we're going to REPLACE the existing mce css
+			//we need to get the css file location from the active messenger
+			$mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true,
+				'wpeditor', $this->_variation);
+		}
         
-        return $mce_css;
-    }
+		return $mce_css;
+	}
     
     
-    public function load_scripts_styles_edit_message_template()
-    {
+	public function load_scripts_styles_edit_message_template()
+	{
         
-        $this->_set_shortcodes();
+		$this->_set_shortcodes();
         
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
-            __('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
-                'event_espresso'),
-            $this->_message_template_group->messenger_obj()->label['singular'],
-            $this->_message_template_group->message_type_obj()->label['singular']
-        );
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
-            'event_espresso');
+		EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+			__('Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
+				'event_espresso'),
+			$this->_message_template_group->messenger_obj()->label['singular'],
+			$this->_message_template_group->message_type_obj()->label['singular']
+		);
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
+			'event_espresso');
         
-        wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
-            EVENT_ESPRESSO_VERSION);
+		wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'),
+			EVENT_ESPRESSO_VERSION);
         
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee_msgs_edit_js');
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee_msgs_edit_js');
         
-        //add in special css for tiny_mce
-        add_filter('mce_css', array($this, 'wp_editor_css'));
-    }
+		//add in special css for tiny_mce
+		add_filter('mce_css', array($this, 'wp_editor_css'));
+	}
     
     
-    public function load_scripts_styles_display_preview_message()
-    {
+	public function load_scripts_styles_display_preview_message()
+	{
         
-        $this->_set_message_template_group();
+		$this->_set_message_template_group();
         
-        if (isset($this->_req_data['messenger'])) {
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        }
+		if (isset($this->_req_data['messenger'])) {
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+		}
         
-        $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
+		$message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
         
         
-        wp_enqueue_style('espresso_preview_css',
-            $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview',
-                $this->_variation));
-    }
+		wp_enqueue_style('espresso_preview_css',
+			$this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview',
+				$this->_variation));
+	}
     
     
-    public function load_scripts_styles_settings()
-    {
-        wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('ee-text-links');
-        wp_enqueue_style('ee-message-settings');
+	public function load_scripts_styles_settings()
+	{
+		wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('ee-text-links');
+		wp_enqueue_style('ee-message-settings');
         
-        wp_enqueue_script('ee-messages-settings');
-    }
+		wp_enqueue_script('ee-messages-settings');
+	}
     
     
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => __('In Use', 'event_espresso'),
-                'count'       => 0,
-            )
-        );
-    }
+	/**
+	 * set views array for List Table
+	 */
+	public function _set_list_table_views_global_mtps()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'        => 'in_use',
+				'label'       => __('In Use', 'event_espresso'),
+				'count'       => 0,
+			)
+		);
+	}
 
 
-    /**
-     * Set views array for the Custom Template List Table
-     */
-    public function _set_list_table_views_custom_mtps()
-    {
-        $this->_set_list_table_views_global_mtps();
-        $this->_views['in_use']['bulk_action'] = array(
-                'trash_message_template' => esc_html__('Move to Trash', 'event_espresso')
-        );
-    }
-    
-    
-    /**
-     * set views array for message queue list table
-     */
-    public function _set_list_table_views_default()
-    {
-        EE_Registry::instance()->load_helper('Template');
-        
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message',
-            'message_list_table_bulk_actions')
-            ? array(
-                'generate_now'          => __('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => __('Queue for Resending', 'event_espresso'),
-                'send_now'              => __('Send Now', 'event_espresso')
-            )
-            : array();
-        
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages',
-            'message_list_table_bulk_actions')
-            ? array('delete_ee_messages' => __('Delete Messages', 'event_espresso'))
-            : array();
-        
-        
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => __('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action)
-            )
-        );
-        
-        
-        foreach (EEM_Message::instance()->all_statuses() as $status) {
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
-                continue;
-            }
-            $status_bulk_actions = $common_bulk_actions;
-            //unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
-                switch ($status) {
-                    case EEM_Message::status_idle:
-                    case EEM_Message::status_resend:
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
-                        break;
+	/**
+	 * Set views array for the Custom Template List Table
+	 */
+	public function _set_list_table_views_custom_mtps()
+	{
+		$this->_set_list_table_views_global_mtps();
+		$this->_views['in_use']['bulk_action'] = array(
+				'trash_message_template' => esc_html__('Move to Trash', 'event_espresso')
+		);
+	}
+    
+    
+	/**
+	 * set views array for message queue list table
+	 */
+	public function _set_list_table_views_default()
+	{
+		EE_Registry::instance()->load_helper('Template');
+        
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message',
+			'message_list_table_bulk_actions')
+			? array(
+				'generate_now'          => __('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => __('Queue for Resending', 'event_espresso'),
+				'send_now'              => __('Send Now', 'event_espresso')
+			)
+			: array();
+        
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages',
+			'message_list_table_bulk_actions')
+			? array('delete_ee_messages' => __('Delete Messages', 'event_espresso'))
+			: array();
+        
+        
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => __('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action)
+			)
+		);
+        
+        
+		foreach (EEM_Message::instance()->all_statuses() as $status) {
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
+				continue;
+			}
+			$status_bulk_actions = $common_bulk_actions;
+			//unset bulk actions not applying to status
+			if (! empty($status_bulk_actions)) {
+				switch ($status) {
+					case EEM_Message::status_idle:
+					case EEM_Message::status_resend:
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
+						break;
                     
-                    case EEM_Message::status_failed:
-                    case EEM_Message::status_debug_only:
-                    case EEM_Message::status_messenger_executing:
-                        $status_bulk_actions = array();
-                        break;
+					case EEM_Message::status_failed:
+					case EEM_Message::status_debug_only:
+					case EEM_Message::status_messenger_executing:
+						$status_bulk_actions = array();
+						break;
                     
-                    case EEM_Message::status_incomplete:
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
-                        break;
+					case EEM_Message::status_incomplete:
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
+						break;
                     
-                    case EEM_Message::status_retry:
-                    case EEM_Message::status_sent:
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
-                        break;
-                }
-            }
+					case EEM_Message::status_retry:
+					case EEM_Message::status_sent:
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
+						break;
+				}
+			}
 
-            //skip adding messenger executing status to views because it will be included with the Failed view.
-            if ( $status === EEM_Message::status_messenger_executing ) {
-                continue;
-            }
+			//skip adding messenger executing status to views because it will be included with the Failed view.
+			if ( $status === EEM_Message::status_messenger_executing ) {
+				continue;
+			}
             
-            $this->_views[strtolower($status)] = array(
-                'slug'        => strtolower($status),
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
-                'count'       => 0,
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action)
-            );
-        }
-    }
-    
-    
-    protected function _ee_default_messages_overview_list_table()
-    {
-        $this->_admin_page_title = __('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-    
-    
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label                   = __('Message Activity', 'event_espresso');
-        $this->_template_args['per_column']        = 6;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-    
-    
-    protected function _message_legend_items()
-    {
-        
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
-        $action_items       = array();
-        
-        foreach ($action_css_classes as $action_item => $action_details) {
-            if ($action_item === 'see_notifications_for') {
-                continue;
-            }
-            $action_items[$action_item] = array(
-                'class' => $action_details['css_class'],
-                'desc'  => $action_details['label']
-            );
-        }
-        
-        /** @type array $status_items status legend setup */
-        $status_items = array(
-            'sent_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
-            ),
-            'idle_status'       => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
-            ),
-            'failed_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
-            ),
-            'messenger_executing_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
-                'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
-            ),
-            'resend_status'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
-            ),
-            'incomplete_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
-            ),
-            'retry_status'      => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
-            )
-        );
-        if (EEM_Message::debug()) {
-            $status_items['debug_only_status'] = array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
-            );
-        }
-        
-        return array_merge($action_items, $status_items);
-    }
-    
-    
-    protected function _custom_mtps_preview()
-    {
-        $this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
-                'event_espresso') . '" />';
-        $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                'event_espresso') . '</strong>';
-        $this->display_admin_caf_preview_page('custom_message_types', false);
-    }
-    
-    
-    /**
-     * get_message_templates
-     * This gets all the message templates for listing on the overview list.
-     *
-     * @access public
-     *
-     * @param int    $perpage the amount of templates groups to show per page
-     * @param string $type    the current _view we're getting templates for
-     * @param bool   $count   return count?
-     * @param bool   $all     disregard any paging info (get all data);
-     * @param bool   $global  whether to return just global (true) or custom templates (false)
-     *
-     * @return array
-     */
-    public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true)
-    {
-        
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
-        $orderby                    = $this->_req_data['orderby'];
-        
-        $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
-        
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
-        $per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage;
-        
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $all ? null : array($offset, $per_page);
-        
-        
-        //options will match what is in the _views array property
-        switch ($type) {
+			$this->_views[strtolower($status)] = array(
+				'slug'        => strtolower($status),
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
+				'count'       => 0,
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action)
+			);
+		}
+	}
+    
+    
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = __('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+    
+    
+	protected function _message_queue_list_table()
+	{
+		$this->_search_btn_label                   = __('Message Activity', 'event_espresso');
+		$this->_template_args['per_column']        = 6;
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
+		$this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+    
+    
+	protected function _message_legend_items()
+	{
+        
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
+		$action_items       = array();
+        
+		foreach ($action_css_classes as $action_item => $action_details) {
+			if ($action_item === 'see_notifications_for') {
+				continue;
+			}
+			$action_items[$action_item] = array(
+				'class' => $action_details['css_class'],
+				'desc'  => $action_details['label']
+			);
+		}
+        
+		/** @type array $status_items status legend setup */
+		$status_items = array(
+			'sent_status'       => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence')
+			),
+			'idle_status'       => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence')
+			),
+			'failed_status'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence')
+			),
+			'messenger_executing_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+				'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence')
+			),
+			'resend_status'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence')
+			),
+			'incomplete_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence')
+			),
+			'retry_status'      => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence')
+			)
+		);
+		if (EEM_Message::debug()) {
+			$status_items['debug_only_status'] = array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence')
+			);
+		}
+        
+		return array_merge($action_items, $status_items);
+	}
+    
+    
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title              = __('Custom Message Templates (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot',
+				'event_espresso') . '" />';
+		$this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+				'event_espresso') . '</strong>';
+		$this->display_admin_caf_preview_page('custom_message_types', false);
+	}
+    
+    
+	/**
+	 * get_message_templates
+	 * This gets all the message templates for listing on the overview list.
+	 *
+	 * @access public
+	 *
+	 * @param int    $perpage the amount of templates groups to show per page
+	 * @param string $type    the current _view we're getting templates for
+	 * @param bool   $count   return count?
+	 * @param bool   $all     disregard any paging info (get all data);
+	 * @param bool   $global  whether to return just global (true) or custom templates (false)
+	 *
+	 * @return array
+	 */
+	public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true)
+	{
+        
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		$this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
+		$orderby                    = $this->_req_data['orderby'];
+        
+		$order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
+        
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1;
+		$per_page     = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage;
+        
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $all ? null : array($offset, $per_page);
+        
+        
+		//options will match what is in the _views array property
+		switch ($type) {
             
-            case 'in_use':
-                $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
-                break;
+			case 'in_use':
+				$templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
+				break;
             
-            default:
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
+			default:
+				$templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
             
-        }
-        
-        return $templates;
-    }
-    
-    
-    /**
-     * filters etc might need a list of installed message_types
-     * @return array an array of message type objects
-     */
-    public function get_installed_message_types()
-    {
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
-        $installed               = array();
-        
-        foreach ($installed_message_types as $message_type) {
-            $installed[$message_type->name] = $message_type;
-        }
-        
-        return $installed;
-    }
-    
-    
-    /**
-     * _add_message_template
-     *
-     * This is used when creating a custom template. All Custom Templates start based off another template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param string $GRP_ID
-     *
-     * @throws EE_error
-     */
-    protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
-    {
-        //set values override any request data
-        $message_type = ! empty($message_type) ? $message_type : '';
-        $message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type;
-        
-        $messenger = ! empty($messenger) ? $messenger : '';
-        $messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger;
-        
-        $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
-        
-        //we need messenger and message type.  They should be coming from the event editor. If not here then return error
-        if (empty($message_type) || empty($messenger)) {
-            throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
-                'event_espresso'));
-        }
-        
-        //we need the GRP_ID for the template being used as the base for the new template
-        if (empty($GRP_ID)) {
-            throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                'event_espresso'));
-        }
-        
-        //let's just make sure the template gets generated!
-        
-        //we need to reassign some variables for what the insert is expecting
-        $this->_req_data['MTP_messenger']    = $messenger;
-        $this->_req_data['MTP_message_type'] = $message_type;
-        $this->_req_data['GRP_ID']           = $GRP_ID;
-        $this->_insert_or_update_message_template(true);
-    }
-    
-    
-    /**
-     * public wrapper for the _add_message_template method
-     *
-     * @param string $message_type     message type slug
-     * @param string $messenger        messenger slug
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
-     *                                 off of.
-     */
-    public function add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
-    }
-    
-    
-    /**
-     * _edit_message_template
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $template_fields = '';
-        $sidebar_fields  = '';
-        //we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates.
-        add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
-        
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
-            ? absint($this->_req_data['id'])
-            : false;
-        
-        $this->_set_shortcodes(); //this also sets the _message_template property.
-        $message_template_group = $this->_message_template_group;
-        $c_label                = $message_template_group->context_label();
-        $c_config               = $message_template_group->contexts_config();
-        
-        reset($c_config);
-        $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
-            ? strtolower($this->_req_data['context'])
-            : key($c_config);
-        
-        
-        if (empty($GRP_ID)) {
-            $action = 'insert_message_template';
-            //$button_both = false;
-            //$button_text = array( __( 'Save','event_espresso') );
-            //$button_actions = array('something_different');
-            //$referrer = false;
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        } else {
-            $action = 'update_message_template';
-            //$button_both = true;
-            //$button_text = array();
-            //$button_actions = array();
-            //$referrer = $this->_admin_base_url;
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        }
-        
-        //set active messenger for this view
-        $this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
-            $message_template_group->messenger()
-        );
-        $this->_active_message_type_name = $message_template_group->message_type();
-        
-        
-        //Do we have any validation errors?
-        $validators = $this->_get_transient();
-        $v_fields   = ! empty($validators) ? array_keys($validators) : array();
-        
-        
-        //we need to assemble the title from Various details
-        $context_label = sprintf(
-            __('(%s %s)', 'event_espresso'),
-            $c_config[$context]['label'],
-            ucwords($c_label['label'])
-        );
-        
-        $title = sprintf(
-            __(' %s %s Template %s', 'event_espresso'),
-            ucwords($message_template_group->messenger_obj()->label['singular']),
-            ucwords($message_template_group->message_type_obj()->label['singular']),
-            $context_label
-        );
-        
-        $this->_template_args['GRP_ID']           = $GRP_ID;
-        $this->_template_args['message_template'] = $message_template_group;
-        $this->_template_args['is_extra_fields']  = false;
-        
-        
-        //let's get EEH_MSG_Template so we can get template form fields
-        $template_field_structure = EEH_MSG_Template::get_fields(
-            $message_template_group->messenger(),
-            $message_template_group->message_type()
-        );
-        
-        if ( ! $template_field_structure) {
-            $template_field_structure = false;
-            $template_fields          = __('There was an error in assembling the fields for this display (you should see an error message)',
-                'event_espresso');
-        }
-        
-        
-        $message_templates = $message_template_group->context_templates();
-        
-        
-        //if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array.
-        if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
-            foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[$context][$reference_field]);
-            }
-        }
-        
-        //let's loop through the template_field_structure and actually assemble the input fields!
-        if ( ! empty($template_field_structure)) {
-            foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
-                //if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them.
-                if ($template_field == 'extra') {
-                    $this->_template_args['is_extra_fields'] = true;
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[$context][$reference_field];
-                        $content          = $message_template instanceof EE_Message_Template
-                            ? $message_template->get('MTP_content')
-                            : '';
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
-                            //let's verify if we need this extra field via the shortcodes parameter.
-                            $continue = false;
-                            if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
-                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
-                                        $continue = true;
-                                    }
-                                }
-                                if ($continue) {
-                                    continue;
-                                }
-                            }
+		}
+        
+		return $templates;
+	}
+    
+    
+	/**
+	 * filters etc might need a list of installed message_types
+	 * @return array an array of message type objects
+	 */
+	public function get_installed_message_types()
+	{
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
+		$installed               = array();
+        
+		foreach ($installed_message_types as $message_type) {
+			$installed[$message_type->name] = $message_type;
+		}
+        
+		return $installed;
+	}
+    
+    
+	/**
+	 * _add_message_template
+	 *
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param string $GRP_ID
+	 *
+	 * @throws EE_error
+	 */
+	protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
+	{
+		//set values override any request data
+		$message_type = ! empty($message_type) ? $message_type : '';
+		$message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type;
+        
+		$messenger = ! empty($messenger) ? $messenger : '';
+		$messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger;
+        
+		$GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
+        
+		//we need messenger and message type.  They should be coming from the event editor. If not here then return error
+		if (empty($message_type) || empty($messenger)) {
+			throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
+				'event_espresso'));
+		}
+        
+		//we need the GRP_ID for the template being used as the base for the new template
+		if (empty($GRP_ID)) {
+			throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+				'event_espresso'));
+		}
+        
+		//let's just make sure the template gets generated!
+        
+		//we need to reassign some variables for what the insert is expecting
+		$this->_req_data['MTP_messenger']    = $messenger;
+		$this->_req_data['MTP_message_type'] = $message_type;
+		$this->_req_data['GRP_ID']           = $GRP_ID;
+		$this->_insert_or_update_message_template(true);
+	}
+    
+    
+	/**
+	 * public wrapper for the _add_message_template method
+	 *
+	 * @param string $message_type     message type slug
+	 * @param string $messenger        messenger slug
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
+	 *                                 off of.
+	 */
+	public function add_message_template($message_type, $messenger, $GRP_ID)
+	{
+		$this->_add_message_template($message_type, $messenger, $GRP_ID);
+	}
+    
+    
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$template_fields = '';
+		$sidebar_fields  = '';
+		//we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates.
+		add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
+        
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
+			? absint($this->_req_data['id'])
+			: false;
+        
+		$this->_set_shortcodes(); //this also sets the _message_template property.
+		$message_template_group = $this->_message_template_group;
+		$c_label                = $message_template_group->context_label();
+		$c_config               = $message_template_group->contexts_config();
+        
+		reset($c_config);
+		$context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
+			? strtolower($this->_req_data['context'])
+			: key($c_config);
+        
+        
+		if (empty($GRP_ID)) {
+			$action = 'insert_message_template';
+			//$button_both = false;
+			//$button_text = array( __( 'Save','event_espresso') );
+			//$button_actions = array('something_different');
+			//$referrer = false;
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		} else {
+			$action = 'update_message_template';
+			//$button_both = true;
+			//$button_text = array();
+			//$button_actions = array();
+			//$referrer = $this->_admin_base_url;
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		}
+        
+		//set active messenger for this view
+		$this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
+			$message_template_group->messenger()
+		);
+		$this->_active_message_type_name = $message_template_group->message_type();
+        
+        
+		//Do we have any validation errors?
+		$validators = $this->_get_transient();
+		$v_fields   = ! empty($validators) ? array_keys($validators) : array();
+        
+        
+		//we need to assemble the title from Various details
+		$context_label = sprintf(
+			__('(%s %s)', 'event_espresso'),
+			$c_config[$context]['label'],
+			ucwords($c_label['label'])
+		);
+        
+		$title = sprintf(
+			__(' %s %s Template %s', 'event_espresso'),
+			ucwords($message_template_group->messenger_obj()->label['singular']),
+			ucwords($message_template_group->message_type_obj()->label['singular']),
+			$context_label
+		);
+        
+		$this->_template_args['GRP_ID']           = $GRP_ID;
+		$this->_template_args['message_template'] = $message_template_group;
+		$this->_template_args['is_extra_fields']  = false;
+        
+        
+		//let's get EEH_MSG_Template so we can get template form fields
+		$template_field_structure = EEH_MSG_Template::get_fields(
+			$message_template_group->messenger(),
+			$message_template_group->message_type()
+		);
+        
+		if ( ! $template_field_structure) {
+			$template_field_structure = false;
+			$template_fields          = __('There was an error in assembling the fields for this display (you should see an error message)',
+				'event_espresso');
+		}
+        
+        
+		$message_templates = $message_template_group->context_templates();
+        
+        
+		//if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array.
+		if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
+			foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
+				unset($template_field_structure[$context][$reference_field]);
+			}
+		}
+        
+		//let's loop through the template_field_structure and actually assemble the input fields!
+		if ( ! empty($template_field_structure)) {
+			foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
+				//if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them.
+				if ($template_field == 'extra') {
+					$this->_template_args['is_extra_fields'] = true;
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
+						$message_template = $message_templates[$context][$reference_field];
+						$content          = $message_template instanceof EE_Message_Template
+							? $message_template->get('MTP_content')
+							: '';
+						foreach ($new_fields_array as $extra_field => $extra_array) {
+							//let's verify if we need this extra field via the shortcodes parameter.
+							$continue = false;
+							if (isset($extra_array['shortcodes_required'])) {
+								foreach ((array)$extra_array['shortcodes_required'] as $shortcode) {
+									if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
+										$continue = true;
+									}
+								}
+								if ($continue) {
+									continue;
+								}
+							}
                             
-                            $field_id                                = $reference_field . '-' . $extra_field . '-content';
-                            $template_form_fields[$field_id]         = $extra_array;
-                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
-                            $css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
+							$field_id                                = $reference_field . '-' . $extra_field . '-content';
+							$template_form_fields[$field_id]         = $extra_array;
+							$template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']';
+							$css_class                               = isset($extra_array['css_class']) ? $extra_array['css_class'] : '';
                             
-                            $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
-                                                                            && in_array($extra_field, $v_fields)
-                                                                            &&
-                                                                            (
-                                                                                is_array($validators[$extra_field])
-                                                                                && isset($validators[$extra_field]['msg'])
-                                                                            )
-                                ? 'validate-error ' . $css_class
-                                : $css_class;
+							$template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
+																			&& in_array($extra_field, $v_fields)
+																			&&
+																			(
+																				is_array($validators[$extra_field])
+																				&& isset($validators[$extra_field]['msg'])
+																			)
+								? 'validate-error ' . $css_class
+								: $css_class;
                             
-                            $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
-                                ? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8"))
-                                : '';
+							$template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field])
+								? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8"))
+								: '';
                             
-                            //do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value'];
+							//do we have a validation error?  if we do then let's use that value instead
+							$template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value'];
                             
                             
-                            $template_form_fields[$field_id]['db-col'] = 'MTP_content';
+							$template_form_fields[$field_id]['db-col'] = 'MTP_content';
                             
-                            //shortcode selector
-                            $field_name_to_use                                 = $extra_field == 'main' ? 'content' : $extra_field;
-                            $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
-                                $field_name_to_use,
-                                $field_id
-                            );
+							//shortcode selector
+							$field_name_to_use                                 = $extra_field == 'main' ? 'content' : $extra_field;
+							$template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
+								$field_name_to_use,
+								$field_id
+							);
                             
-                            if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') {
-                                //we want to decode the entities
-                                $template_form_fields[$field_id]['value'] = stripslashes(
-                                    html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8")
-                                );
+							if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') {
+								//we want to decode the entities
+								$template_form_fields[$field_id]['value'] = stripslashes(
+									html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8")
+								);
                                 
-                            }/**/
-                        }
-                        $templatefield_MTP_id          = $reference_field . '-MTP_ID';
-                        $templatefield_templatename_id = $reference_field . '-name';
+							}/**/
+						}
+						$templatefield_MTP_id          = $reference_field . '-MTP_ID';
+						$templatefield_templatename_id = $reference_field . '-name';
                         
-                        $template_form_fields[$templatefield_MTP_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'int',
-                            'required'   => false,
-                            'validation' => false,
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
-                            'css_class'  => '',
-                            'format'     => '%d',
-                            'db-col'     => 'MTP_ID'
-                        );
+						$template_form_fields[$templatefield_MTP_id] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'int',
+							'required'   => false,
+							'validation' => false,
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
+							'css_class'  => '',
+							'format'     => '%d',
+							'db-col'     => 'MTP_ID'
+						);
                         
-                        $template_form_fields[$templatefield_templatename_id] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'string',
-                            'required'   => false,
-                            'validation' => true,
-                            'value'      => $reference_field,
-                            'css_class'  => '',
-                            'format'     => '%s',
-                            'db-col'     => 'MTP_template_field'
-                        );
-                    }
-                    continue; //skip the next stuff, we got the necessary fields here for this dataset.
-                } else {
-                    $field_id                                 = $template_field . '-content';
-                    $template_form_fields[$field_id]          = $field_setup_array;
-                    $template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
-                    $message_template                         = isset($message_templates[$context][$template_field])
-                        ? $message_templates[$context][$template_field]
-                        : null;
-                    $template_form_fields[$field_id]['value'] = ! empty($message_templates)
-                                                                && is_array($message_templates[$context])
-                                                                && $message_template instanceof EE_Message_Template
-                        ? $message_template->get('MTP_content')
-                        : '';
+						$template_form_fields[$templatefield_templatename_id] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'string',
+							'required'   => false,
+							'validation' => true,
+							'value'      => $reference_field,
+							'css_class'  => '',
+							'format'     => '%s',
+							'db-col'     => 'MTP_template_field'
+						);
+					}
+					continue; //skip the next stuff, we got the necessary fields here for this dataset.
+				} else {
+					$field_id                                 = $template_field . '-content';
+					$template_form_fields[$field_id]          = $field_setup_array;
+					$template_form_fields[$field_id]['name']  = 'MTP_template_fields[' . $template_field . '][content]';
+					$message_template                         = isset($message_templates[$context][$template_field])
+						? $message_templates[$context][$template_field]
+						: null;
+					$template_form_fields[$field_id]['value'] = ! empty($message_templates)
+																&& is_array($message_templates[$context])
+																&& $message_template instanceof EE_Message_Template
+						? $message_template->get('MTP_content')
+						: '';
                     
-                    //do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[$field_id]['value'] = isset($validators[$template_field])
-                        ? $validators[$template_field]['value']
-                        : $template_form_fields[$field_id]['value'];
+					//do we have a validator error for this field?  if we do then we'll use that value instead
+					$template_form_fields[$field_id]['value'] = isset($validators[$template_field])
+						? $validators[$template_field]['value']
+						: $template_form_fields[$field_id]['value'];
                     
                     
-                    $template_form_fields[$field_id]['db-col']    = 'MTP_content';
-                    $css_class                                    = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : '';
-                    $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
-                                                                    && in_array($template_field, $v_fields)
-                                                                    && isset($validators[$template_field]['msg'])
-                        ? 'validate-error ' . $css_class
-                        : $css_class;
+					$template_form_fields[$field_id]['db-col']    = 'MTP_content';
+					$css_class                                    = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : '';
+					$template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
+																	&& in_array($template_field, $v_fields)
+																	&& isset($validators[$template_field]['msg'])
+						? 'validate-error ' . $css_class
+						: $css_class;
                     
-                    //shortcode selector
-                    $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
-                        $template_field, $field_id
-                    );
-                }
+					//shortcode selector
+					$template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
+						$template_field, $field_id
+					);
+				}
                 
-                //k took care of content field(s) now let's take care of others.
+				//k took care of content field(s) now let's take care of others.
                 
-                $templatefield_MTP_id                = $template_field . '-MTP_ID';
-                $templatefield_field_templatename_id = $template_field . '-name';
+				$templatefield_MTP_id                = $template_field . '-MTP_ID';
+				$templatefield_field_templatename_id = $template_field . '-name';
                 
-                //foreach template field there are actually two form fields created
-                $template_form_fields[$templatefield_MTP_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'int',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
-                    'css_class'  => '',
-                    'format'     => '%d',
-                    'db-col'     => 'MTP_ID'
-                );
+				//foreach template field there are actually two form fields created
+				$template_form_fields[$templatefield_MTP_id] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'int',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
+					'css_class'  => '',
+					'format'     => '%d',
+					'db-col'     => 'MTP_ID'
+				);
                 
-                $template_form_fields[$templatefield_field_templatename_id] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'string',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $template_field,
-                    'css_class'  => '',
-                    'format'     => '%s',
-                    'db-col'     => 'MTP_template_field'
-                );
+				$template_form_fields[$templatefield_field_templatename_id] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'string',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $template_field,
+					'css_class'  => '',
+					'format'     => '%s',
+					'db-col'     => 'MTP_template_field'
+				);
                 
-            }
+			}
             
-            //add other fields
-            $template_form_fields['ee-msg-current-context'] = array(
-                'name'       => 'MTP_context',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $context,
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_context'
-            );
+			//add other fields
+			$template_form_fields['ee-msg-current-context'] = array(
+				'name'       => 'MTP_context',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $context,
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_context'
+			);
             
-            $template_form_fields['ee-msg-grp-id'] = array(
-                'name'       => 'GRP_ID',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $GRP_ID,
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'GRP_ID'
-            );
+			$template_form_fields['ee-msg-grp-id'] = array(
+				'name'       => 'GRP_ID',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $GRP_ID,
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'GRP_ID'
+			);
             
-            $template_form_fields['ee-msg-messenger'] = array(
-                'name'       => 'MTP_messenger',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->messenger(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_messenger'
-            );
+			$template_form_fields['ee-msg-messenger'] = array(
+				'name'       => 'MTP_messenger',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->messenger(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_messenger'
+			);
             
-            $template_form_fields['ee-msg-message-type'] = array(
-                'name'       => 'MTP_message_type',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->message_type(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_message_type'
-            );
+			$template_form_fields['ee-msg-message-type'] = array(
+				'name'       => 'MTP_message_type',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->message_type(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_message_type'
+			);
             
-            $sidebar_form_fields['ee-msg-is-global'] = array(
-                'name'       => 'MTP_is_global',
-                'label'      => __('Global Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_global'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_global'
-            );
+			$sidebar_form_fields['ee-msg-is-global'] = array(
+				'name'       => 'MTP_is_global',
+				'label'      => __('Global Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_global'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_global'
+			);
             
-            $sidebar_form_fields['ee-msg-is-override'] = array(
-                'name'       => 'MTP_is_override',
-                'label'      => __('Override all custom', 'event_espresso'),
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_override'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_override'
-            );
+			$sidebar_form_fields['ee-msg-is-override'] = array(
+				'name'       => 'MTP_is_override',
+				'label'      => __('Override all custom', 'event_espresso'),
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_override'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_override'
+			);
             
-            $sidebar_form_fields['ee-msg-is-active'] = array(
-                'name'       => 'MTP_is_active',
-                'label'      => __('Active Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->is_active(),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_active'
-            );
+			$sidebar_form_fields['ee-msg-is-active'] = array(
+				'name'       => 'MTP_is_active',
+				'label'      => __('Active Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->is_active(),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_active'
+			);
             
-            $sidebar_form_fields['ee-msg-deleted'] = array(
-                'name'       => 'MTP_deleted',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_deleted'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_deleted'
-            );
-            $sidebar_form_fields['ee-msg-author']  = array(
-                'name'       => 'MTP_user_id',
-                'label'      => __('Author', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => false,
-                'value'      => $message_template_group->user(),
-                'format'     => '%d',
-                'db-col'     => 'MTP_user_id'
-            );
+			$sidebar_form_fields['ee-msg-deleted'] = array(
+				'name'       => 'MTP_deleted',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_deleted'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_deleted'
+			);
+			$sidebar_form_fields['ee-msg-author']  = array(
+				'name'       => 'MTP_user_id',
+				'label'      => __('Author', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => false,
+				'value'      => $message_template_group->user(),
+				'format'     => '%d',
+				'db-col'     => 'MTP_user_id'
+			);
             
-            $sidebar_form_fields['ee-msg-route'] = array(
-                'name'  => 'action',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => $action
-            );
+			$sidebar_form_fields['ee-msg-route'] = array(
+				'name'  => 'action',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => $action
+			);
             
-            $sidebar_form_fields['ee-msg-id']        = array(
-                'name'  => 'id',
-                'input' => 'hidden',
-                'type'  => 'int',
-                'value' => $GRP_ID
-            );
-            $sidebar_form_fields['ee-msg-evt-nonce'] = array(
-                'name'  => $action . '_nonce',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce')
-            );
+			$sidebar_form_fields['ee-msg-id']        = array(
+				'name'  => 'id',
+				'input' => 'hidden',
+				'type'  => 'int',
+				'value' => $GRP_ID
+			);
+			$sidebar_form_fields['ee-msg-evt-nonce'] = array(
+				'name'  => $action . '_nonce',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => wp_create_nonce($action . '_nonce')
+			);
             
-            if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
-                $sidebar_form_fields['ee-msg-template-switch'] = array(
-                    'name'  => 'template_switch',
-                    'input' => 'hidden',
-                    'type'  => 'int',
-                    'value' => 1
-                );
-            }
+			if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
+				$sidebar_form_fields['ee-msg-template-switch'] = array(
+					'name'  => 'template_switch',
+					'input' => 'hidden',
+					'type'  => 'int',
+					'value' => 1
+				);
+			}
             
             
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
-            $sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
+			$sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
             
             
-        } //end if ( !empty($template_field_structure) )
+		} //end if ( !empty($template_field_structure) )
         
-        //set extra content for publish box
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
-        $this->_set_publish_post_box_vars(
-            'id',
-            $GRP_ID,
-            false,
-            add_query_arg(
-                array('action' => 'global_mtps'),
-                $this->_admin_base_url
-            )
-        );
-        
-        //add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
-            array(
-                'message_type' => $message_template_group->message_type(),
-                'messenger'    => $message_template_group->messenger(),
-                'context'      => $context,
-                'GRP_ID'       => $GRP_ID,
-                'action'       => 'preview_message'
-            ),
-            $this->_admin_base_url
-        );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
-                'event_espresso') . '</a>';
-        
-        
-        //setup context switcher
-        $context_switcher_args = array(
-            'page'    => 'espresso_messages',
-            'action'  => 'edit_message_template',
-            'id'      => $GRP_ID,
-            'context' => $context,
-            'extra'   => $preview_button
-        );
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
-        
-        
-        //main box
-        $this->_template_args['template_fields']                         = $template_fields;
-        $this->_template_args['sidebar_box_id']                          = 'details';
-        $this->_template_args['action']                                  = $action;
-        $this->_template_args['context']                                 = $context;
-        $this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
-        $this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link();
-        
-        
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
-        
-        $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
-        
-        //send along EE_Message_Template_Group object for further template use.
-        $this->_template_args['MTP'] = $message_template_group;
-        
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        
-        
-        //finally, let's set the admin_page title
-        $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
-        
-        
-        //we need to take care of setting the shortcodes property for use elsewhere.
-        $this->_set_shortcodes();
-        
-        
-        //final template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-    
-    
-    public function filter_tinymce_init($mceInit, $editor_id)
-    {
-        return $mceInit;
-    }
-    
-    
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
-    
-    public function _add_form_element_before()
-    {
-        return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
-    }
-    
-    public function _add_form_element_after()
-    {
-        return '</form>';
-    }
-    
-    
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @since 4.5.0
-     *
-     */
-    public function switch_template_pack()
-    {
-        $GRP_ID        = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
-        
-        //verify we have needed values.
-        if (empty($GRP_ID) || empty($template_pack)) {
-            $this->_template_args['error'] = true;
-            EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            //get template, set the new template_pack and then reset to default
-            /** @type EE_Message_Template_Group $message_template_group */
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		//set extra content for publish box
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
+		$this->_set_publish_post_box_vars(
+			'id',
+			$GRP_ID,
+			false,
+			add_query_arg(
+				array('action' => 'global_mtps'),
+				$this->_admin_base_url
+			)
+		);
+        
+		//add preview button
+		$preview_url    = parent::add_query_args_and_nonce(
+			array(
+				'message_type' => $message_template_group->message_type(),
+				'messenger'    => $message_template_group->messenger(),
+				'context'      => $context,
+				'GRP_ID'       => $GRP_ID,
+				'action'       => 'preview_message'
+			),
+			$this->_admin_base_url
+		);
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview',
+				'event_espresso') . '</a>';
+        
+        
+		//setup context switcher
+		$context_switcher_args = array(
+			'page'    => 'espresso_messages',
+			'action'  => 'edit_message_template',
+			'id'      => $GRP_ID,
+			'context' => $context,
+			'extra'   => $preview_button
+		);
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
+        
+        
+		//main box
+		$this->_template_args['template_fields']                         = $template_fields;
+		$this->_template_args['sidebar_box_id']                          = 'details';
+		$this->_template_args['action']                                  = $action;
+		$this->_template_args['context']                                 = $context;
+		$this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
+		$this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link();
+        
+        
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
+		$this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
+        
+		$this->_template_path = $this->_template_args['GRP_ID']
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+        
+		//send along EE_Message_Template_Group object for further template use.
+		$this->_template_args['MTP'] = $message_template_group;
+        
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+        
+        
+		//finally, let's set the admin_page title
+		$this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
+        
+        
+		//we need to take care of setting the shortcodes property for use elsewhere.
+		$this->_set_shortcodes();
+        
+        
+		//final template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+    
+    
+	public function filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
+    
+    
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
+    
+	public function _add_form_element_before()
+	{
+		return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">';
+	}
+    
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
+    
+    
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	public function switch_template_pack()
+	{
+		$GRP_ID        = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		$template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
+        
+		//verify we have needed values.
+		if (empty($GRP_ID) || empty($template_pack)) {
+			$this->_template_args['error'] = true;
+			EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__);
+		} else {
+			//get template, set the new template_pack and then reset to default
+			/** @type EE_Message_Template_Group $message_template_group */
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
             
-            $message_template_group->set_template_pack_name($template_pack);
-            $this->_req_data['msgr'] = $message_template_group->messenger();
-            $this->_req_data['mt']   = $message_template_group->message_type();
+			$message_template_group->set_template_pack_name($template_pack);
+			$this->_req_data['msgr'] = $message_template_group->messenger();
+			$this->_req_data['mt']   = $message_template_group->message_type();
             
-            $query_args = $this->_reset_to_default_template();
+			$query_args = $this->_reset_to_default_template();
             
-            if (empty($query_args['id'])) {
-                EE_Error::add_error(
-                    __(
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
-                        'event_espresso'
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $this->_template_args['error'] = true;
-            } else {
-                $template_label       = $message_template_group->get_template_pack()->label;
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
-                EE_Error::add_success(
-                    sprintf(
-                        __(
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
-                            'event_espresso'
-                        ),
-                        $template_label,
-                        $template_pack_labels->template_pack
-                    )
-                );
-                //generate the redirect url for js.
-                $url                                          = self::add_query_args_and_nonce($query_args,
-                    $this->_admin_base_url);
-                $this->_template_args['data']['redirect_url'] = $url;
-                $this->_template_args['success']              = true;
-            }
+			if (empty($query_args['id'])) {
+				EE_Error::add_error(
+					__(
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
+						'event_espresso'
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$this->_template_args['error'] = true;
+			} else {
+				$template_label       = $message_template_group->get_template_pack()->label;
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
+				EE_Error::add_success(
+					sprintf(
+						__(
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
+							'event_espresso'
+						),
+						$template_label,
+						$template_pack_labels->template_pack
+					)
+				);
+				//generate the redirect url for js.
+				$url                                          = self::add_query_args_and_nonce($query_args,
+					$this->_admin_base_url);
+				$this->_template_args['data']['redirect_url'] = $url;
+				$this->_template_args['success']              = true;
+			}
             
-            $this->_return_json();
+			$this->_return_json();
             
-        }
-    }
-    
-    
-    /**
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
-     * they want.
-     *
-     * @access protected
-     * @return array|null
-     */
-    protected function _reset_to_default_template()
-    {
-        
-        $templates = array();
-        $GRP_ID    = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        //we need to make sure we've got the info we need.
-        if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                __(
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        // all templates will be reset to whatever the defaults are
-        // for the global template matching the messenger and message type.
-        $success = ! empty($GRP_ID) ? true : false;
-        
-        if ($success) {
+		}
+	}
+    
+    
+	/**
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
+	 * they want.
+	 *
+	 * @access protected
+	 * @return array|null
+	 */
+	protected function _reset_to_default_template()
+	{
+        
+		$templates = array();
+		$GRP_ID    = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		//we need to make sure we've got the info we need.
+		if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				__(
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		// all templates will be reset to whatever the defaults are
+		// for the global template matching the messenger and message type.
+		$success = ! empty($GRP_ID) ? true : false;
+        
+		if ($success) {
             
-            //let's first determine if the incoming template is a global template,
-            // if it isn't then we need to get the global template matching messenger and message type.
-            //$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+			//let's first determine if the incoming template is a global template,
+			// if it isn't then we need to get the global template matching messenger and message type.
+			//$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
             
             
-            //note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
+			//note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
             
-            if ($success) {
-                // if successfully deleted, lets generate the new ones.
-                // Note. We set GLOBAL to true, because resets on ANY template
-                // will use the related global template defaults for regeneration.
-                // This means that if a custom template is reset it resets to whatever the related global template is.
-                // HOWEVER, we DO keep the template pack and template variation set
-                // for the current custom template when resetting.
-                $templates = $this->_generate_new_templates(
-                    $this->_req_data['msgr'],
-                    $this->_req_data['mt'],
-                    $GRP_ID,
-                    true
-                );
-            }
+			if ($success) {
+				// if successfully deleted, lets generate the new ones.
+				// Note. We set GLOBAL to true, because resets on ANY template
+				// will use the related global template defaults for regeneration.
+				// This means that if a custom template is reset it resets to whatever the related global template is.
+				// HOWEVER, we DO keep the template pack and template variation set
+				// for the current custom template when resetting.
+				$templates = $this->_generate_new_templates(
+					$this->_req_data['msgr'],
+					$this->_req_data['mt'],
+					$GRP_ID,
+					true
+				);
+			}
             
-        }
-        
-        //any error messages?
-        if ( ! $success) {
-            EE_Error::add_error(
-                __('Something went wrong with deleting existing templates. Unable to reset to default',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        //all good, let's add a success message!
-        if ($success && ! empty($templates)) {
-            $templates = $templates[0]; //the info for the template we generated is the first element in the returned array.
-            EE_Error::overwrite_success();
-            EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
-        }
-        
-        
-        $query_args = array(
-            'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
-            'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
-            'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps'
-        );
-        
-        //if called via ajax then we return query args otherwise redirect
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            return $query_args;
-        } else {
-            $this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+        
+		//any error messages?
+		if ( ! $success) {
+			EE_Error::add_error(
+				__('Something went wrong with deleting existing templates. Unable to reset to default',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		//all good, let's add a success message!
+		if ($success && ! empty($templates)) {
+			$templates = $templates[0]; //the info for the template we generated is the first element in the returned array.
+			EE_Error::overwrite_success();
+			EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
+		}
+        
+        
+		$query_args = array(
+			'id'      => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null,
+			'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null,
+			'action'  => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps'
+		);
+        
+		//if called via ajax then we return query args otherwise redirect
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			return $query_args;
+		} else {
+			$this->_redirect_after_action(false, '', '', $query_args, true);
             
-            return null;
-        }
-    }
-    
-    
-    /**
-     * Retrieve and set the message preview for display.
-     *
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
-     *
-     * @return string
-     */
-    public function _preview_message($send = false)
-    {
-        //first make sure we've got the necessary parameters
-        if (
-        ! isset(
-            $this->_req_data['message_type'],
-            $this->_req_data['messenger'],
-            $this->_req_data['messenger'],
-            $this->_req_data['GRP_ID']
-        )
-        ) {
-            EE_Error::add_error(
-                __('Missing necessary parameters for displaying preview', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        
-        EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
-        
-        
-        //get the preview!
-        $preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'],
-            $this->_req_data['messenger'], $send);
-        
-        if ($send) {
-            return $preview;
-        }
-        
-        //let's add a button to go back to the edit view
-        $query_args             = array(
-            'id'      => $this->_req_data['GRP_ID'],
-            'context' => $this->_req_data['context'],
-            'action'  => 'edit_message_template'
-        );
-        $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
-                'event_espresso') . '</a>';
-        $message_types          = $this->get_installed_message_types();
-        $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        $active_messenger_label = $active_messenger instanceof EE_messenger
-            ? ucwords($active_messenger->label['singular'])
-            : esc_html__('Unknown Messenger', 'event_espresso');
-        //let's provide a helpful title for context
-        $preview_title = sprintf(
-            __('Viewing Preview for %s %s Message Template', 'event_espresso'),
-            $active_messenger_label,
-            ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
-        );
-        //setup display of preview.
-        $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
-        $this->_template_args['data']['force_json'] = true;
-        
-        return '';
-    }
-    
-    
-    /**
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
-     * gets called automatically.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    protected function _display_preview_message()
-    {
-        $this->display_admin_page_with_no_sidebar();
-    }
-    
-    
-    /**
-     * registers metaboxes that should show up on the "edit_message_template" page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _register_edit_meta_boxes()
-    {
-        add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'),
-            array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default');
-        add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'),
-            $this->_current_screen->id, 'side', 'high');
-        add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'),
-            $this->_current_screen->id, 'side', 'high');
-    }
-    
-    
-    /**
-     * metabox content for all template pack and variation selection.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    public function template_pack_meta_box()
-    {
-        $this->_set_message_template_group();
-        
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
-        
-        $tp_select_values = array();
-        
-        foreach ($tp_collection as $tp) {
-            //only include template packs that support this messenger and message type!
-            $supports = $tp->get_supports();
-            if (
-                ! isset($supports[$this->_message_template_group->messenger()])
-                || ! in_array(
-                    $this->_message_template_group->message_type(),
-                    $supports[$this->_message_template_group->messenger()]
-                )
-            ) {
-                //not supported
-                continue;
-            }
+			return null;
+		}
+	}
+    
+    
+	/**
+	 * Retrieve and set the message preview for display.
+	 *
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
+	 *
+	 * @return string
+	 */
+	public function _preview_message($send = false)
+	{
+		//first make sure we've got the necessary parameters
+		if (
+		! isset(
+			$this->_req_data['message_type'],
+			$this->_req_data['messenger'],
+			$this->_req_data['messenger'],
+			$this->_req_data['GRP_ID']
+		)
+		) {
+			EE_Error::add_error(
+				__('Missing necessary parameters for displaying preview', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+        
+		EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
+        
+        
+		//get the preview!
+		$preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'],
+			$this->_req_data['messenger'], $send);
+        
+		if ($send) {
+			return $preview;
+		}
+        
+		//let's add a button to go back to the edit view
+		$query_args             = array(
+			'id'      => $this->_req_data['GRP_ID'],
+			'context' => $this->_req_data['context'],
+			'action'  => 'edit_message_template'
+		);
+		$go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		$preview_button         = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit',
+				'event_espresso') . '</a>';
+		$message_types          = $this->get_installed_message_types();
+		$active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+		$active_messenger_label = $active_messenger instanceof EE_messenger
+			? ucwords($active_messenger->label['singular'])
+			: esc_html__('Unknown Messenger', 'event_espresso');
+		//let's provide a helpful title for context
+		$preview_title = sprintf(
+			__('Viewing Preview for %s %s Message Template', 'event_espresso'),
+			$active_messenger_label,
+			ucwords($message_types[$this->_req_data['message_type']]->label['singular'])
+		);
+		//setup display of preview.
+		$this->_admin_page_title                    = $preview_title;
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview);
+		$this->_template_args['data']['force_json'] = true;
+        
+		return '';
+	}
+    
+    
+	/**
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
+	 * gets called automatically.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	protected function _display_preview_message()
+	{
+		$this->display_admin_page_with_no_sidebar();
+	}
+    
+    
+	/**
+	 * registers metaboxes that should show up on the "edit_message_template" page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _register_edit_meta_boxes()
+	{
+		add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'),
+			array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default');
+		add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'),
+			$this->_current_screen->id, 'side', 'high');
+		add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'),
+			$this->_current_screen->id, 'side', 'high');
+	}
+    
+    
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	public function template_pack_meta_box()
+	{
+		$this->_set_message_template_group();
+        
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
+        
+		$tp_select_values = array();
+        
+		foreach ($tp_collection as $tp) {
+			//only include template packs that support this messenger and message type!
+			$supports = $tp->get_supports();
+			if (
+				! isset($supports[$this->_message_template_group->messenger()])
+				|| ! in_array(
+					$this->_message_template_group->message_type(),
+					$supports[$this->_message_template_group->messenger()]
+				)
+			) {
+				//not supported
+				continue;
+			}
             
-            $tp_select_values[] = array(
-                'text' => $tp->label,
-                'id'   => $tp->dbref
-            );
-        }
-        
-        //if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack.  This still allows for the odd template pack to override.
-        if (empty($tp_select_values)) {
-            $tp_select_values[] = array(
-                'text' => __('Default', 'event_espresso'),
-                'id'   => 'default'
-            );
-        }
-        
-        //setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
-            $this->_message_template_group->messenger(),
-            $this->_message_template_group->message_type()
-        );
-        $variations_select_values = array();
-        foreach ($variations as $variation => $label) {
-            $variations_select_values[] = array(
-                'text' => $label,
-                'id'   => $variation
-            );
-        }
-        
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
-        
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
-            'MTP_template_pack',
-            $tp_select_values,
-            $this->_message_template_group->get_template_pack_name()
-        );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
-            'MTP_template_variation',
-            $variations_select_values,
-            $this->_message_template_group->get_template_pack_variation()
-        );
-        $template_args['template_pack_label']            = $template_pack_labels->template_pack;
-        $template_args['template_variation_label']       = $template_pack_labels->template_variation;
-        $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
-        
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
-        
-        EEH_Template::display_template($template, $template_args);
-    }
-    
-    
-    /**
-     * This meta box holds any extra actions related to Message Templates
-     * For now, this includes Resetting templates to defaults and sending a test email.
-     *
-     * @access  public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function extra_actions_meta_box()
-    {
-        $template_form_fields = array();
-        
-        $extra_args = array(
-            'msgr'   => $this->_message_template_group->messenger(),
-            'mt'     => $this->_message_template_group->message_type(),
-            'GRP_ID' => $this->_message_template_group->GRP_ID()
-        );
-        //first we need to see if there are any fields
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
-        
-        if ( ! empty($fields)) {
-            //yup there be fields
-            foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
-                $default  = isset($config['default']) ? $config['default'] : '';
-                $default  = isset($config['value']) ? $config['value'] : $default;
+			$tp_select_values[] = array(
+				'text' => $tp->label,
+				'id'   => $tp->dbref
+			);
+		}
+        
+		//if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack.  This still allows for the odd template pack to override.
+		if (empty($tp_select_values)) {
+			$tp_select_values[] = array(
+				'text' => __('Default', 'event_espresso'),
+				'id'   => 'default'
+			);
+		}
+        
+		//setup variation select values for the currently selected template.
+		$variations               = $this->_message_template_group->get_template_pack()->get_variations(
+			$this->_message_template_group->messenger(),
+			$this->_message_template_group->message_type()
+		);
+		$variations_select_values = array();
+		foreach ($variations as $variation => $label) {
+			$variations_select_values[] = array(
+				'text' => $label,
+				'id'   => $variation
+			);
+		}
+        
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
+        
+		$template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+			'MTP_template_pack',
+			$tp_select_values,
+			$this->_message_template_group->get_template_pack_name()
+		);
+		$template_args['variations_selector']            = EEH_Form_Fields::select_input(
+			'MTP_template_variation',
+			$variations_select_values,
+			$this->_message_template_group->get_template_pack_variation()
+		);
+		$template_args['template_pack_label']            = $template_pack_labels->template_pack;
+		$template_args['template_variation_label']       = $template_pack_labels->template_variation;
+		$template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
+        
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+        
+		EEH_Template::display_template($template, $template_args);
+	}
+    
+    
+	/**
+	 * This meta box holds any extra actions related to Message Templates
+	 * For now, this includes Resetting templates to defaults and sending a test email.
+	 *
+	 * @access  public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function extra_actions_meta_box()
+	{
+		$template_form_fields = array();
+        
+		$extra_args = array(
+			'msgr'   => $this->_message_template_group->messenger(),
+			'mt'     => $this->_message_template_group->message_type(),
+			'GRP_ID' => $this->_message_template_group->GRP_ID()
+		);
+		//first we need to see if there are any fields
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
+        
+		if ( ! empty($fields)) {
+			//yup there be fields
+			foreach ($fields as $field => $config) {
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
+				$default  = isset($config['default']) ? $config['default'] : '';
+				$default  = isset($config['value']) ? $config['value'] : $default;
                 
-                // if type is hidden and the value is empty
-                // something may have gone wrong so let's correct with the defaults
-                $fix              = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field])
-                    ? $default
-                    : '';
-                $existing[$field] = isset($existing[$field]) && empty($fix)
-                    ? $existing[$field]
-                    : $fix;
+				// if type is hidden and the value is empty
+				// something may have gone wrong so let's correct with the defaults
+				$fix              = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field])
+					? $default
+					: '';
+				$existing[$field] = isset($existing[$field]) && empty($fix)
+					? $existing[$field]
+					: $fix;
                 
-                $template_form_fields[$field_id] = array(
-                    'name'       => 'test_settings_fld[' . $field . ']',
-                    'label'      => $config['label'],
-                    'input'      => $config['input'],
-                    'type'       => $config['type'],
-                    'required'   => $config['required'],
-                    'validation' => $config['validation'],
-                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
-                    'css_class'  => $config['css_class'],
-                    'options'    => isset($config['options']) ? $config['options'] : array(),
-                    'default'    => $default,
-                    'format'     => $config['format']
-                );
-            }
-        }
-        
-        $test_settings_fields = ! empty($template_form_fields)
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
-            : '';
-        
-        $test_settings_html = '';
-        //print out $test_settings_fields
-        if ( ! empty($test_settings_fields)) {
-            echo $test_settings_fields;
-            $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
-            $test_settings_html .= 'name="test_button" value="';
-            $test_settings_html .= __('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-        
-        //and button
-        $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $test_settings_html .= $this->get_action_link_or_button(
-            'reset_to_default',
-            'reset',
-            $extra_args,
-            'button-primary reset-default-button'
-        );
-        $test_settings_html .= '</div><div style="clear:both"></div>';
-        echo $test_settings_html;
-    }
-    
-    
-    /**
-     * This returns the shortcode selector skeleton for a given context and field.
-     *
-     * @since 4.9.rc.000
-     *
-     * @param string $field           The name of the field retrieving shortcodes for.
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
-     *
-     * @return string
-     */
-    protected function _get_shortcode_selector($field, $linked_input_id)
-    {
-        $template_args = array(
-            'shortcodes'      => $this->_get_shortcodes(array($field), true),
-            'fieldname'       => $field,
-            'linked_input_id' => $linked_input_id
-        );
-        
-        return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
-            $template_args, true);
-    }
-    
-    
-    /**
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
-     * page)
-     *
-     * @access public
-     * @return void
-     */
-    public function shortcode_meta_box()
-    {
-        $shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set
-        //$messenger = $this->_message_template_group->messenger_obj();
-        //now let's set the content depending on the status of the shortcodes array
-        if (empty($shortcodes)) {
-            $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            echo $content;
-        } else {
-            //$alt = 0;
-            ?>
+				$template_form_fields[$field_id] = array(
+					'name'       => 'test_settings_fld[' . $field . ']',
+					'label'      => $config['label'],
+					'input'      => $config['input'],
+					'type'       => $config['type'],
+					'required'   => $config['required'],
+					'validation' => $config['validation'],
+					'value'      => isset($existing[$field]) ? $existing[$field] : $default,
+					'css_class'  => $config['css_class'],
+					'options'    => isset($config['options']) ? $config['options'] : array(),
+					'default'    => $default,
+					'format'     => $config['format']
+				);
+			}
+		}
+        
+		$test_settings_fields = ! empty($template_form_fields)
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
+			: '';
+        
+		$test_settings_html = '';
+		//print out $test_settings_fields
+		if ( ! empty($test_settings_fields)) {
+			echo $test_settings_fields;
+			$test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
+			$test_settings_html .= 'name="test_button" value="';
+			$test_settings_html .= __('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+        
+		//and button
+		$test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>';
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$test_settings_html .= $this->get_action_link_or_button(
+			'reset_to_default',
+			'reset',
+			$extra_args,
+			'button-primary reset-default-button'
+		);
+		$test_settings_html .= '</div><div style="clear:both"></div>';
+		echo $test_settings_html;
+	}
+    
+    
+	/**
+	 * This returns the shortcode selector skeleton for a given context and field.
+	 *
+	 * @since 4.9.rc.000
+	 *
+	 * @param string $field           The name of the field retrieving shortcodes for.
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
+	 *
+	 * @return string
+	 */
+	protected function _get_shortcode_selector($field, $linked_input_id)
+	{
+		$template_args = array(
+			'shortcodes'      => $this->_get_shortcodes(array($field), true),
+			'fieldname'       => $field,
+			'linked_input_id' => $linked_input_id
+		);
+        
+		return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+			$template_args, true);
+	}
+    
+    
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function shortcode_meta_box()
+	{
+		$shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set
+		//$messenger = $this->_message_template_group->messenger_obj();
+		//now let's set the content depending on the status of the shortcodes array
+		if (empty($shortcodes)) {
+			$content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>';
+			echo $content;
+		} else {
+			//$alt = 0;
+			?>
             <div
                 style="float:right; margin-top:10px"><?php echo $this->_get_help_tab_link('message_template_shortcodes'); ?></div>
             <p class="small-text"><?php printf(__('You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
-                    'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p>
+					'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p>
             <?php
-        }
-        
-        
-    }
-    
-    
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_shortcodes()
-    {
-        
-        //no need to run this if the property is already set
-        if ( ! empty($this->_shortcodes)) {
-            return;
-        }
-        
-        $this->_shortcodes = $this->_get_shortcodes();
-    }
-    
-    
-    /**
-     * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
-     * property)
-     *
-     * @access  protected
-     *
-     * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
-     *                         for. Defaults to all (for the given context)
-     * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
-     *
-     * @return array          Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
-     *                        true just an array of shortcode/label pairs.
-     */
-    protected function _get_shortcodes($fields = array(), $merged = true)
-    {
-        $this->_set_message_template_group();
-        
-        //we need the messenger and message template to retrieve the valid shortcodes array.
-        $GRP_ID  = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false;
-        $context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config());
-        
-        return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
-    }
-    
-    
-    /**
-     * This sets the _message_template property (containing the called message_template object)
-     *
-     * @access protected
-     * @return  void
-     */
-    protected function _set_message_template_group()
-    {
-        
-        if ( ! empty($this->_message_template_group)) {
-            return;
-        } //get out if this is already set.
-        
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
-        
-        //let's get the message templates
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        if (empty($GRP_ID)) {
-            $this->_message_template_group = $MTP->create_default_object();
-        } else {
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
-        }
-        
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
-        $this->_variation     = $this->_message_template_group->get_template_pack_variation();
-        
-    }
-    
-    
-    /**
-     * sets up a context switcher for edit forms
-     *
-     * @access  protected
-     *
-     * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
-     * @param array                      $args                  various things the context switcher needs.
-     *
-     */
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
-    {
-        $context_details = $template_group_object->contexts_config();
-        $context_label   = $template_group_object->context_label();
-        ob_start();
-        ?>
+		}
+        
+        
+	}
+    
+    
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_shortcodes()
+	{
+        
+		//no need to run this if the property is already set
+		if ( ! empty($this->_shortcodes)) {
+			return;
+		}
+        
+		$this->_shortcodes = $this->_get_shortcodes();
+	}
+    
+    
+	/**
+	 * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
+	 * property)
+	 *
+	 * @access  protected
+	 *
+	 * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
+	 *                         for. Defaults to all (for the given context)
+	 * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
+	 *
+	 * @return array          Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
+	 *                        true just an array of shortcode/label pairs.
+	 */
+	protected function _get_shortcodes($fields = array(), $merged = true)
+	{
+		$this->_set_message_template_group();
+        
+		//we need the messenger and message template to retrieve the valid shortcodes array.
+		$GRP_ID  = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false;
+		$context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config());
+        
+		return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
+	}
+    
+    
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return  void
+	 */
+	protected function _set_message_template_group()
+	{
+        
+		if ( ! empty($this->_message_template_group)) {
+			return;
+		} //get out if this is already set.
+        
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
+        
+		//let's get the message templates
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		if (empty($GRP_ID)) {
+			$this->_message_template_group = $MTP->create_default_object();
+		} else {
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
+		}
+        
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
+		$this->_variation     = $this->_message_template_group->get_template_pack_variation();
+        
+	}
+    
+    
+	/**
+	 * sets up a context switcher for edit forms
+	 *
+	 * @access  protected
+	 *
+	 * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
+	 * @param array                      $args                  various things the context switcher needs.
+	 *
+	 */
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
+	{
+		$context_details = $template_group_object->contexts_config();
+		$context_label   = $template_group_object->context_label();
+		ob_start();
+		?>
         <div class="ee-msg-switcher-container">
             <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm">
                 <?php
-                foreach ($args as $name => $value) {
-                    if ($name == 'context' || empty($value) || $name == 'extra') {
-                        continue;
-                    }
-                    ?>
+				foreach ($args as $name => $value) {
+					if ($name == 'context' || empty($value) || $name == 'extra') {
+						continue;
+					}
+					?>
                     <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/>
                     <?php
-                }
-                //setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                ?>
+				}
+				//setup nonce_url
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+				?>
                 <select name="context">
                     <?php
-                    $context_templates = $template_group_object->context_templates();
-                    if (is_array($context_templates)) :
-                        foreach ($context_templates as $context => $template_fields) :
-                            $checked = ($context == $args['context']) ? 'selected="selected"' : '';
-                            ?>
+					$context_templates = $template_group_object->context_templates();
+					if (is_array($context_templates)) :
+						foreach ($context_templates as $context => $template_fields) :
+							$checked = ($context == $args['context']) ? 'selected="selected"' : '';
+							?>
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
                                 <?php echo $context_details[$context]['label']; ?>
                             </option>
@@ -2245,1584 +2245,1584 @@ 
             <?php echo $args['extra']; ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php
-        $output = ob_get_contents();
-        ob_clean();
-        $this->_context_switcher = $output;
-    }
-    
-    
-    /**
-     * utility for sanitizing new values coming in.
-     * Note: this is only used when updating a context.
-     *
-     * @access protected
-     *
-     * @param int $index This helps us know which template field to select from the request array.
-     *
-     * @return array
-     */
-    protected function _set_message_template_column_values($index)
-    {
-        if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
-            foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
-                $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
-            }
-        } /*else {
+		$output = ob_get_contents();
+		ob_clean();
+		$this->_context_switcher = $output;
+	}
+    
+    
+	/**
+	 * utility for sanitizing new values coming in.
+	 * Note: this is only used when updating a context.
+	 *
+	 * @access protected
+	 *
+	 * @param int $index This helps us know which template field to select from the request array.
+	 *
+	 * @return array
+	 */
+	protected function _set_message_template_column_values($index)
+	{
+		if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) {
+			foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) {
+				$this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value;
+			}
+		} /*else {
 			$this->_req_data['MTP_template_fields'][$index]['content'] = $this->_req_data['MTP_template_fields'][$index]['content'];
 		}*/
         
         
-        $set_column_values = array(
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
-            'GRP_ID'             => absint($this->_req_data['GRP_ID']),
-            'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
-            'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
-            'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
-            'MTP_context'        => strtolower($this->_req_data['MTP_context']),
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
-            'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
-                ? absint($this->_req_data['MTP_is_global'])
-                : 0,
-            'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
-                ? absint($this->_req_data['MTP_is_override'])
-                : 0,
-            'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
-            'MTP_is_active'      => absint($this->_req_data['MTP_is_active'])
-        );
-        
-        
-        return $set_column_values;
-    }
-    
-    
-    protected function _insert_or_update_message_template($new = false)
-    {
-        
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success  = 0;
-        $override = false;
-        
-        //setup notices description
-        $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
-        
-        //need the message type and messenger objects to be able to use the labels for the notices
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
-        $messenger_label  = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : '';
-        
-        $message_type_slug   = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : '';
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
-        
-        $message_type_label = $message_type_object instanceof EE_message_type
-            ? ucwords($message_type_object->label['singular'])
-            : '';
-        
-        $context_slug = ! empty($this->_req_data['MTP_context'])
-            ? $this->_req_data['MTP_context']
-            : '';
-        $context      = ucwords(str_replace('_', ' ', $context_slug));
-        
-        $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
-        $item_desc .= 'Message Template';
-        $query_args  = array();
-        $edit_array  = array();
-        $action_desc = '';
-        
-        //if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit.
-        if ($new) {
-            $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
-                if (empty($edit_array)) {
-                    $success = 0;
-                } else {
-                    $success    = 1;
-                    $edit_array = $edit_array[0];
-                    $query_args = array(
-                        'id'      => $edit_array['GRP_ID'],
-                        'context' => $edit_array['MTP_context'],
-                        'action'  => 'edit_message_template'
-                    );
-                }
-            }
-            $action_desc = 'created';
-        } else {
-            $MTPG = EEM_Message_Template_Group::instance();
-            $MTP  = EEM_Message_Template::instance();
+		$set_column_values = array(
+			'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']),
+			'GRP_ID'             => absint($this->_req_data['GRP_ID']),
+			'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
+			'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
+			'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
+			'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']),
+			'MTP_context'        => strtolower($this->_req_data['MTP_context']),
+			'MTP_content'        => $this->_req_data['MTP_template_fields'][$index]['content'],
+			'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
+				? absint($this->_req_data['MTP_is_global'])
+				: 0,
+			'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
+				? absint($this->_req_data['MTP_is_override'])
+				: 0,
+			'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
+			'MTP_is_active'      => absint($this->_req_data['MTP_is_active'])
+		);
+        
+        
+		return $set_column_values;
+	}
+    
+    
+	protected function _insert_or_update_message_template($new = false)
+	{
+        
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success  = 0;
+		$override = false;
+        
+		//setup notices description
+		$messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
+        
+		//need the message type and messenger objects to be able to use the labels for the notices
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
+		$messenger_label  = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : '';
+        
+		$message_type_slug   = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : '';
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
+        
+		$message_type_label = $message_type_object instanceof EE_message_type
+			? ucwords($message_type_object->label['singular'])
+			: '';
+        
+		$context_slug = ! empty($this->_req_data['MTP_context'])
+			? $this->_req_data['MTP_context']
+			: '';
+		$context      = ucwords(str_replace('_', ' ', $context_slug));
+        
+		$item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : '';
+		$item_desc .= 'Message Template';
+		$query_args  = array();
+		$edit_array  = array();
+		$action_desc = '';
+        
+		//if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit.
+		if ($new) {
+			$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
+				if (empty($edit_array)) {
+					$success = 0;
+				} else {
+					$success    = 1;
+					$edit_array = $edit_array[0];
+					$query_args = array(
+						'id'      => $edit_array['GRP_ID'],
+						'context' => $edit_array['MTP_context'],
+						'action'  => 'edit_message_template'
+					);
+				}
+			}
+			$action_desc = 'created';
+		} else {
+			$MTPG = EEM_Message_Template_Group::instance();
+			$MTP  = EEM_Message_Template::instance();
             
             
-            //run update for each template field in displayed context
-            if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
-                EE_Error::add_error(
-                    __('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                $success = 0;
+			//run update for each template field in displayed context
+			if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
+				EE_Error::add_error(
+					__('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				$success = 0;
                 
-            } else {
-                //first validate all fields!
-                $validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug,
-                    $message_type_slug);
+			} else {
+				//first validate all fields!
+				$validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug,
+					$message_type_slug);
                 
-                //if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.  WE need to make sure there is no actual error messages in validates.
-                if (is_array($validates) && ! empty($validates)) {
-                    //add the transient so when the form loads we know which fields to highlight
-                    $this->_add_transient('edit_message_template', $validates);
+				//if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.  WE need to make sure there is no actual error messages in validates.
+				if (is_array($validates) && ! empty($validates)) {
+					//add the transient so when the form loads we know which fields to highlight
+					$this->_add_transient('edit_message_template', $validates);
                     
-                    $success = 0;
+					$success = 0;
                     
-                    //setup notices
-                    foreach ($validates as $field => $error) {
-                        if (isset($error['msg'])) {
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-                        }
-                    }
+					//setup notices
+					foreach ($validates as $field => $error) {
+						if (isset($error['msg'])) {
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+						}
+					}
                     
-                } else {
-                    $set_column_values = array();
-                    foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
+				} else {
+					$set_column_values = array();
+					foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
+						$set_column_values = $this->_set_message_template_column_values($template_field);
                         
-                        $where_cols_n_values = array(
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID']
-                        );
+						$where_cols_n_values = array(
+							'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID']
+						);
                         
-                        $message_template_fields = array(
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
-                            'MTP_context'        => $set_column_values['MTP_context'],
-                            'MTP_content'        => $set_column_values['MTP_content']
-                        );
-                        if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
-                            if ($updated === false) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        __('%s field was NOT updated for some reason', 'event_espresso'),
-                                        $template_field
-                                    ),
-                                    __FILE__, __FUNCTION__, __LINE__
-                                );
-                            } else {
-                                $success = 1;
-                            }
-                        }
-                        $action_desc = 'updated';
-                    }
+						$message_template_fields = array(
+							'GRP_ID'             => $set_column_values['GRP_ID'],
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
+							'MTP_context'        => $set_column_values['MTP_context'],
+							'MTP_content'        => $set_column_values['MTP_content']
+						);
+						if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
+							if ($updated === false) {
+								EE_Error::add_error(
+									sprintf(
+										__('%s field was NOT updated for some reason', 'event_espresso'),
+										$template_field
+									),
+									__FILE__, __FUNCTION__, __LINE__
+								);
+							} else {
+								$success = 1;
+							}
+						}
+						$action_desc = 'updated';
+					}
                     
-                    //we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
-                    $mtpg_fields = array(
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
-                        'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
-                            : '',
-                        'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
-                            : ''
-                    );
+					//we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
+					$mtpg_fields = array(
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
+						'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
+							: '',
+						'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
+							: ''
+					);
                     
-                    $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
-                    $updated    = $MTPG->update($mtpg_fields, array($mtpg_where));
+					$mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
+					$updated    = $MTPG->update($mtpg_fields, array($mtpg_where));
                     
-                    if ($updated === false) {
-                        EE_Error::add_error(
-                            sprintf(
-                                __('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'),
-                                $set_column_values['GRP_ID']
-                            ),
-                            __FILE__, __FUNCTION__, __LINE__
-                        );
-                    } else {
-                        //k now we need to ensure the template_pack and template_variation fields are set.
-                        $template_pack = ! empty($this->_req_data['MTP_template_pack'])
-                            ? $this->_req_data['MTP_template_pack']
-                            : 'default';
+					if ($updated === false) {
+						EE_Error::add_error(
+							sprintf(
+								__('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'),
+								$set_column_values['GRP_ID']
+							),
+							__FILE__, __FUNCTION__, __LINE__
+						);
+					} else {
+						//k now we need to ensure the template_pack and template_variation fields are set.
+						$template_pack = ! empty($this->_req_data['MTP_template_pack'])
+							? $this->_req_data['MTP_template_pack']
+							: 'default';
                         
-                        $template_variation = ! empty($this->_req_data['MTP_template_variation'])
-                            ? $this->_req_data['MTP_template_variation']
-                            : 'default';
+						$template_variation = ! empty($this->_req_data['MTP_template_variation'])
+							? $this->_req_data['MTP_template_variation']
+							: 'default';
                         
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
-                            $mtpg_obj->set_template_pack_name($template_pack);
-                            $mtpg_obj->set_template_pack_variation($template_variation);
-                        }
-                        $success = 1;
-                    }
-                }
-            }
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
+							$mtpg_obj->set_template_pack_name($template_pack);
+							$mtpg_obj->set_template_pack_variation($template_variation);
+						}
+						$success = 1;
+					}
+				}
+			}
             
-        }
-        
-        //we return things differently if doing ajax
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_template_args['success'] = $success;
-            $this->_template_args['error']   = ! $success ? true : false;
-            $this->_template_args['content'] = '';
-            $this->_template_args['data']    = array(
-                'grpID'        => $edit_array['GRP_ID'],
-                'templateName' => $edit_array['template_name']
-            );
-            if ($success) {
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
-                    'event_espresso'));
-            }
+		}
+        
+		//we return things differently if doing ajax
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_template_args['success'] = $success;
+			$this->_template_args['error']   = ! $success ? true : false;
+			$this->_template_args['content'] = '';
+			$this->_template_args['data']    = array(
+				'grpID'        => $edit_array['GRP_ID'],
+				'templateName' => $edit_array['template_name']
+			);
+			if ($success) {
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
+					'event_espresso'));
+			}
             
-            $this->_return_json();
-        }
-        
-        
-        //was a test send triggered?
-        if (isset($this->_req_data['test_button'])) {
-            EE_Error::overwrite_success();
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
-            $override = true;
-        }
-        
-        if (empty($query_args)) {
-            $query_args = array(
-                'id'      => $this->_req_data['GRP_ID'],
-                'context' => $context_slug,
-                'action'  => 'edit_message_template'
-            );
-        }
-        
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
-    }
-    
-    
-    /**
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
-     *
-     * @param  string $context      what context being tested
-     * @param  string $messenger    messenger being tested
-     * @param  string $message_type message type being tested
-     *
-     */
-    protected function _do_test_send($context, $messenger, $message_type)
-    {
-        //set things up for preview
-        $this->_req_data['messenger']    = $messenger;
-        $this->_req_data['message_type'] = $message_type;
-        $this->_req_data['context']      = $context;
-        $this->_req_data['GRP_ID']       = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
-        $active_messenger                = $this->_message_resource_manager->get_active_messenger($messenger);
-        
-        //let's save any existing fields that might be required by the messenger
-        if (
-            isset($this->_req_data['test_settings_fld'])
-            && $active_messenger instanceof EE_messenger
-            && apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
-                true,
-                $this->_req_data['test_settings_fld'],
-                $active_messenger
-            )
-        ) {
-            $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
-        }
-        
-        $success = $this->_preview_message(true);
-        
-        if ($success) {
-            EE_Error::add_success(__('Test message sent', 'event_espresso'));
-        } else {
-            EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__,
-                __LINE__);
-        }
-    }
-    
-    
-    /**
-     * _generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     *
-     * @param  string $messenger     the messenger we are generating templates for
-     * @param array   $message_types array of message types that the templates are generated for.
-     * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
-     *                               indicate the message_template_group being used as the base.
-     *
-     * @param bool    $global
-     *
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
-     *                               encountering problems.
-     * @throws \EE_Error
-     */
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        
-        //if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates.
-        if (empty($message_types)) {
-            return true;
-        }
-        
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
-    }
-    
-    
-    /**
-     * [_trash_or_restore_message_template]
-     *
-     * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
-     * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
-     *                        an individual context (FALSE).
-     *
-     * @return void
-     */
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $MTP = EEM_Message_Template_Group::instance();
-        
-        $success = 1;
-        
-        //incoming GRP_IDs
-        if ($all) {
-            //Checkboxes
-            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                //if array has more than one element then success message should be plural.
-                //todo: what about nonce?
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			$this->_return_json();
+		}
+        
+        
+		//was a test send triggered?
+		if (isset($this->_req_data['test_button'])) {
+			EE_Error::overwrite_success();
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
+			$override = true;
+		}
+        
+		if (empty($query_args)) {
+			$query_args = array(
+				'id'      => $this->_req_data['GRP_ID'],
+				'context' => $context_slug,
+				'action'  => 'edit_message_template'
+			);
+		}
+        
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
+	}
+    
+    
+	/**
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
+	 *
+	 * @param  string $context      what context being tested
+	 * @param  string $messenger    messenger being tested
+	 * @param  string $message_type message type being tested
+	 *
+	 */
+	protected function _do_test_send($context, $messenger, $message_type)
+	{
+		//set things up for preview
+		$this->_req_data['messenger']    = $messenger;
+		$this->_req_data['message_type'] = $message_type;
+		$this->_req_data['context']      = $context;
+		$this->_req_data['GRP_ID']       = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
+		$active_messenger                = $this->_message_resource_manager->get_active_messenger($messenger);
+        
+		//let's save any existing fields that might be required by the messenger
+		if (
+			isset($this->_req_data['test_settings_fld'])
+			&& $active_messenger instanceof EE_messenger
+			&& apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
+				true,
+				$this->_req_data['test_settings_fld'],
+				$active_messenger
+			)
+		) {
+			$active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
+		}
+        
+		$success = $this->_preview_message(true);
+        
+		if ($success) {
+			EE_Error::add_success(__('Test message sent', 'event_espresso'));
+		} else {
+			EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__,
+				__LINE__);
+		}
+	}
+    
+    
+	/**
+	 * _generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 *
+	 * @param  string $messenger     the messenger we are generating templates for
+	 * @param array   $message_types array of message types that the templates are generated for.
+	 * @param int     $GRP_ID        If this is a custom template being generated then a GRP_ID needs to be included to
+	 *                               indicate the message_template_group being used as the base.
+	 *
+	 * @param bool    $global
+	 *
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
+	 *                               encountering problems.
+	 * @throws \EE_Error
+	 */
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+        
+		//if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates.
+		if (empty($message_types)) {
+			return true;
+		}
+        
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
+	}
+    
+    
+	/**
+	 * [_trash_or_restore_message_template]
+	 *
+	 * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
+	 * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
+	 *                        an individual context (FALSE).
+	 *
+	 * @return void
+	 */
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$MTP = EEM_Message_Template_Group::instance();
+        
+		$success = 1;
+        
+		//incoming GRP_IDs
+		if ($all) {
+			//Checkboxes
+			if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				//if array has more than one element then success message should be plural.
+				//todo: what about nonce?
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
                 
-                //cycle through checkboxes
-                while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if ( ! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                //grab single GRP_ID and handle
-                $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
-                if ( ! empty($GRP_ID)) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if ( ! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                } else {
-                    $success = 0;
-                }
-            }
+				//cycle through checkboxes
+				while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if ( ! $trashed_or_restored) {
+						$success = 0;
+					}
+				}
+			} else {
+				//grab single GRP_ID and handle
+				$GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
+				if ( ! empty($GRP_ID)) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if ( ! $trashed_or_restored) {
+						$success = 0;
+					}
+				} else {
+					$success = 0;
+				}
+			}
             
-        }
+		}
         
-        $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
+		$action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso');
         
-        $action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc;
+		$action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc;
         
-        $item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success,
-            'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
+		$item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success,
+			'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
         
-        $item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success,
-            'event_espresso') : $item_desc;
+		$item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success,
+			'event_espresso') : $item_desc;
         
-        $this->_redirect_after_action($success, $item_desc, $action_desc, array());
+		$this->_redirect_after_action($success, $item_desc, $action_desc, array());
         
-    }
+	}
     
     
-    /**
-     * [_delete_message_template]
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
-     * @return void
-     */
-    protected function _delete_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 * @return void
+	 */
+	protected function _delete_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         
-        //checkboxes
-        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            //if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+		//checkboxes
+		if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			//if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             
-            //cycle through bulk action checkboxes
-            while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                $success = $this->_delete_mtp_permanently($GRP_ID);
-            }
-        } else {
-            //grab single grp_id and delete
-            $GRP_ID  = absint($this->_req_data['id']);
-            $success = $this->_delete_mtp_permanently($GRP_ID);
-        }
-        
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
-        
-    }
-    
-    
-    /**
-     * helper for permanently deleting a mtP group and all related message_templates
-     *
-     * @param  int  $GRP_ID        The group being deleted
-     * @param  bool $include_group whether to delete the Message Template Group as well.
-     *
-     * @return bool        boolean to indicate the success of the deletes or not.
-     */
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
-    {
-        $success = 1;
-        $MTPG    = EEM_Message_Template_Group::instance();
-        //first let's GET this group
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
-        //then delete permanently all the related Message Templates
-        $deleted = $MTG->delete_related_permanently('Message_Template');
-        
-        if ($deleted === 0) {
-            $success = 0;
-        }
-        
-        //now delete permanently this particular group
-        
-        if ($include_group && ! $MTG->delete_permanently()) {
-            $success = 0;
-        }
-        
-        return $success;
-    }
-    
-    
-    /**
-     *    _learn_more_about_message_templates_link
-     * @access protected
-     * @return string
-     */
-    protected function _learn_more_about_message_templates_link()
-    {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
-            'event_espresso') . '</a>';
-    }
-    
-    
-    /**
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
-     * ajax and other routes.
-     * @return void
-     */
-    protected function _settings()
-    {
-        
-        
-        $this->_set_m_mt_settings();
-        
-        $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        //let's setup the messenger tabs
-        $this->_template_args['admin_page_header']         = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'],
-            'messenger_links', '|', $selected_messenger);
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
-        $this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
-        
-        $this->display_admin_page_with_sidebar();
-        
-    }
-    
-    
-    /**
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_m_mt_settings()
-    {
-        //first if this is already set then lets get out no need to regenerate data.
-        if ( ! empty($this->_m_mt_settings)) {
-            return;
-        }
-        
-        //$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        //get all installed messengers and message_types
-        /** @type EE_messenger[] $messengers */
-        $messengers = $this->_message_resource_manager->installed_messengers();
-        /** @type EE_message_type[] $message_types */
-        $message_types = $this->_message_resource_manager->installed_message_types();
-        
-        
-        //assemble the array for the _tab_text_links helper
-        
-        foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '',
-                'href'  => $messenger->name,
-                'title' => __('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger
-            );
+			//cycle through bulk action checkboxes
+			while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+				$success = $this->_delete_mtp_permanently($GRP_ID);
+			}
+		} else {
+			//grab single grp_id and delete
+			$GRP_ID  = absint($this->_req_data['id']);
+			$success = $this->_delete_mtp_permanently($GRP_ID);
+		}
+        
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
+        
+	}
+    
+    
+	/**
+	 * helper for permanently deleting a mtP group and all related message_templates
+	 *
+	 * @param  int  $GRP_ID        The group being deleted
+	 * @param  bool $include_group whether to delete the Message Template Group as well.
+	 *
+	 * @return bool        boolean to indicate the success of the deletes or not.
+	 */
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
+	{
+		$success = 1;
+		$MTPG    = EEM_Message_Template_Group::instance();
+		//first let's GET this group
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
+		//then delete permanently all the related Message Templates
+		$deleted = $MTG->delete_related_permanently('Message_Template');
+        
+		if ($deleted === 0) {
+			$success = 0;
+		}
+        
+		//now delete permanently this particular group
+        
+		if ($include_group && ! $MTG->delete_permanently()) {
+			$success = 0;
+		}
+        
+		return $success;
+	}
+    
+    
+	/**
+	 *    _learn_more_about_message_templates_link
+	 * @access protected
+	 * @return string
+	 */
+	protected function _learn_more_about_message_templates_link()
+	{
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works',
+			'event_espresso') . '</a>';
+	}
+    
+    
+	/**
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
+	 * ajax and other routes.
+	 * @return void
+	 */
+	protected function _settings()
+	{
+        
+        
+		$this->_set_m_mt_settings();
+        
+		$selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		//let's setup the messenger tabs
+		$this->_template_args['admin_page_header']         = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'],
+			'messenger_links', '|', $selected_messenger);
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
+		$this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
+        
+		$this->display_admin_page_with_sidebar();
+        
+	}
+    
+    
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_m_mt_settings()
+	{
+		//first if this is already set then lets get out no need to regenerate data.
+		if ( ! empty($this->_m_mt_settings)) {
+			return;
+		}
+        
+		//$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		//get all installed messengers and message_types
+		/** @type EE_messenger[] $messengers */
+		$messengers = $this->_message_resource_manager->installed_messengers();
+		/** @type EE_message_type[] $message_types */
+		$message_types = $this->_message_resource_manager->installed_message_types();
+        
+        
+		//assemble the array for the _tab_text_links helper
+        
+		foreach ($messengers as $messenger) {
+			$this->_m_mt_settings['messenger_tabs'][$messenger->name] = array(
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '',
+				'href'  => $messenger->name,
+				'title' => __('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger
+			);
             
             
-            $message_types_for_messenger = $messenger->get_valid_message_types();
+			$message_types_for_messenger = $messenger->get_valid_message_types();
             
-            foreach ($message_types as $message_type) {
-                //first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox.
-                if ( ! in_array($message_type->name, $message_types_for_messenger)) {
-                    continue;
-                }
+			foreach ($message_types as $message_type) {
+				//first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox.
+				if ( ! in_array($message_type->name, $message_types_for_messenger)) {
+					continue;
+				}
                 
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name,
-                    $message_type->name) ? 'active' : 'inactive';
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name,
+					$message_type->name) ? 'active' : 'inactive';
                 
-                $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
-                    'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
-                    'title'    => $a_or_i == 'active'
-                        ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : __('Drag this message type to the messenger to activate', 'event_espresso'),
-                    'content'  => $a_or_i == 'active'
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
-                        : $this->_message_type_settings_content($message_type, $messenger),
-                    'slug'     => $message_type->name,
-                    'active'   => $a_or_i == 'active' ? true : false,
-                    'obj'      => $message_type
-                );
-            }
-        }
-    }
-    
-    
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param  object  $message_type The message type object
-     * @param  object  $messenger    The messenger object
-     * @param  boolean $active       Whether the message type is active or not
-     *
-     * @return string                html output for the content
-     */
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
-    {
-        //get message type fields
-        $fields                                         = $message_type->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-        
-        if ( ! empty($fields) && $active) {
+				$this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array(
+					'label'    => ucwords($message_type->label['singular']),
+					'class'    => 'message-type-' . $a_or_i,
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+					'title'    => $a_or_i == 'active'
+						? __('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: __('Drag this message type to the messenger to activate', 'event_espresso'),
+					'content'  => $a_or_i == 'active'
+						? $this->_message_type_settings_content($message_type, $messenger, true)
+						: $this->_message_type_settings_content($message_type, $messenger),
+					'slug'     => $message_type->name,
+					'active'   => $a_or_i == 'active' ? true : false,
+					'obj'      => $message_type
+				);
+			}
+		}
+	}
+    
+    
+	/**
+	 * This just prepares the content for the message type settings
+	 *
+	 * @param  object  $message_type The message type object
+	 * @param  object  $messenger    The messenger object
+	 * @param  boolean $active       Whether the message type is active or not
+	 *
+	 * @return string                html output for the content
+	 */
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
+	{
+		//get message type fields
+		$fields                                         = $message_type->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+        
+		if ( ! empty($fields) && $active) {
             
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
             
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[$field_id] = array(
-                    'name'       => 'message_type_settings[' . $fldname . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
-                    'options'    => isset($fldprops['options']) ? $fldprops['options'] : array(),
-                    'default'    => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
-                    'css_class'  => 'no-drag',
-                    'format'     => $fldprops['format']
-                );
-            }
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                       = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+				$template_form_field[$field_id] = array(
+					'name'       => 'message_type_settings[' . $fldname . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
+					'options'    => isset($fldprops['options']) ? $fldprops['options'] : array(),
+					'default'    => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'],
+					'css_class'  => 'no-drag',
+					'format'     => $fldprops['format']
+				);
+			}
             
             
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field,
-                'string', 'ee_mt_activate_form') : '';
-        }
-        
-        $settings_template_args['description'] = $message_type->description;
-        //we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'message_type_settings[messenger]'    => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name
-            ),
-            'message_type_settings[message_type]' => array(
-                'type'  => 'hidden',
-                'value' => $message_type->name
-            ),
-            'type'                                => array(
-                'type'  => 'hidden',
-                'value' => 'message_type'
-            )
-        );
-        
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'],
-            'array');
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
-        
-        
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
-        $content  = EEH_Template::display_template($template, $settings_template_args, true);
-        
-        return $content;
-    }
-    
-    
-    /**
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _messages_settings_metaboxes()
-    {
-        $this->_set_m_mt_settings();
-        $m_boxes         = $mt_boxes = array();
-        $m_template_args = $mt_template_args = array();
-        
-        $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
-        
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
-                $hide_on_message  = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
-                $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
-                //messenger meta boxes
-                $active                                 = $selected_messenger == $messenger ? true : false;
-                $active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
-                    ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
-                    : '';
-                $m_boxes[$messenger . '_a_box']         = sprintf(
-                    __('%s Settings', 'event_espresso'),
-                    $tab_array['label']
-                );
-                $m_template_args[$messenger . '_a_box'] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        : '',
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active
-                );
-                // message type meta boxes
-                // (which is really just the inactive container for each messenger
-                // showing inactive message types for that messenger)
-                $mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
-                $mt_template_args[$messenger . '_i_box'] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
-                        : '',
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'hide_off_message'       => $hide_off_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active
-                );
-            }
-        }
-        
-        
-        //register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
-        foreach ($m_boxes as $box => $label) {
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
-            $msgr          = str_replace('_a_box', '', $box);
-            add_meta_box(
-                'espresso_' . $msgr . '_settings',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template($metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"], true);
-                },
-                $this->_current_screen->id,
-                'normal',
-                'high',
-                $callback_args
-            );
-        }
-        
-        //register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
-        foreach ($mt_boxes as $box => $label) {
-            $callback_args = array(
-                'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[$box]
-            );
-            $mt            = str_replace('_i_box', '', $box);
-            add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template($metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"], true);
-                },
-                $this->_current_screen->id,
-                'side',
-                'high',
-                $callback_args
-            );
-        }
-        
-        //register metabox for global messages settings but only when on the main site.  On single site installs this will
-        //always result in the metabox showing, on multisite installs the metabox will only show on the main site.
-        if (is_main_site()) {
-            add_meta_box(
-                'espresso_global_message_settings',
-                __('Global Message Settings', 'event_espresso'),
-                array($this, 'global_messages_settings_metabox_content'),
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                array()
-            );
-        }
-        
-    }
-    
-    
-    /**
-     *  This generates the content for the global messages settings metabox.
-     * @return string
-     */
-    public function global_messages_settings_metabox_content()
-    {
-        $form = $this->_generate_global_settings_form();
-        echo $form->form_open(
-                $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
-                'POST'
-            )
-             . $form->get_html()
-             . $form->form_close();
-    }
-    
-    
-    /**
-     * This generates and returns the form object for the global messages settings.
-     * @return EE_Form_Section_Proper
-     */
-    protected function _generate_global_settings_form()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'global_messages_settings',
-                'html_id'         => 'global_messages_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
-                    array(
-                        'do_messages_on_same_request' => new EE_Select_Input(
-                            array(
-                                true  => esc_html__("On the same request", "event_espresso"),
-                                false => esc_html__("On a separate request", "event_espresso")
-                            ),
-                            array(
-                                'default'         => $network_config->do_messages_on_same_request,
-                                'html_label_text' => esc_html__('Generate and send all messages:', 'event_espresso'),
-                                'html_help_text'  => esc_html__('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
-                                    'event_espresso'),
-                            )
-                        ),
-                        'delete_threshold' => new EE_Select_Input(
-                            array(
-                                0 => esc_html__('Forever', 'event_espresso'),
-                                3 => esc_html__('3 Months', 'event_espresso'),
-                                6 => esc_html__('6 Months', 'event_espresso'),
-                                9 => esc_html__('9 Months', 'event_espresso'),
-                                12 => esc_html__('12 Months', 'event_espresso'),
-                                24 => esc_html__('24 Months', 'event_espresso'),
-                                36 => esc_html__('36 Months', 'event_espresso')
-                            ),
-                            array(
-                                'default' => EE_Registry::instance()->CFG->messages->delete_threshold,
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
-                                'html_help_text' => esc_html__('You can control how long a record of processed messages is kept 
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field,
+				'string', 'ee_mt_activate_form') : '';
+		}
+        
+		$settings_template_args['description'] = $message_type->description;
+		//we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'message_type_settings[messenger]'    => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name
+			),
+			'message_type_settings[message_type]' => array(
+				'type'  => 'hidden',
+				'value' => $message_type->name
+			),
+			'type'                                => array(
+				'type'  => 'hidden',
+				'value' => 'message_type'
+			)
+		);
+        
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'],
+			'array');
+		$settings_template_args['show_form']     = empty($settings_template_args['template_form_fields']) ? ' hidden' : '';
+        
+        
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+		$content  = EEH_Template::display_template($template, $settings_template_args, true);
+        
+		return $content;
+	}
+    
+    
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _messages_settings_metaboxes()
+	{
+		$this->_set_m_mt_settings();
+		$m_boxes         = $mt_boxes = array();
+		$m_template_args = $mt_template_args = array();
+        
+		$selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email';
+        
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
+				$hide_on_message  = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
+				$hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
+				//messenger meta boxes
+				$active                                 = $selected_messenger == $messenger ? true : false;
+				$active_mt_tabs                         = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
+					? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
+					: '';
+				$m_boxes[$messenger . '_a_box']         = sprintf(
+					__('%s Settings', 'event_espresso'),
+					$tab_array['label']
+				);
+				$m_template_args[$messenger . '_a_box'] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						: '',
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'messenger'              => $messenger,
+					'active'                 => $active
+				);
+				// message type meta boxes
+				// (which is really just the inactive container for each messenger
+				// showing inactive message types for that messenger)
+				$mt_boxes[$messenger . '_i_box']         = __('Inactive Message Types', 'event_espresso');
+				$mt_template_args[$messenger . '_i_box'] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
+						: '',
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'hide_off_message'       => $hide_off_message,
+					'messenger'              => $messenger,
+					'active'                 => $active
+				);
+			}
+		}
+        
+        
+		//register messenger metaboxes
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+		foreach ($m_boxes as $box => $label) {
+			$callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]);
+			$msgr          = str_replace('_a_box', '', $box);
+			add_meta_box(
+				'espresso_' . $msgr . '_settings',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template($metabox["args"]["template_path"],
+						$metabox["args"]["template_args"], true);
+				},
+				$this->_current_screen->id,
+				'normal',
+				'high',
+				$callback_args
+			);
+		}
+        
+		//register message type metaboxes
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+		foreach ($mt_boxes as $box => $label) {
+			$callback_args = array(
+				'template_path' => $mt_template_path,
+				'template_args' => $mt_template_args[$box]
+			);
+			$mt            = str_replace('_i_box', '', $box);
+			add_meta_box(
+				'espresso_' . $mt . '_inactive_mts',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template($metabox["args"]["template_path"],
+						$metabox["args"]["template_args"], true);
+				},
+				$this->_current_screen->id,
+				'side',
+				'high',
+				$callback_args
+			);
+		}
+        
+		//register metabox for global messages settings but only when on the main site.  On single site installs this will
+		//always result in the metabox showing, on multisite installs the metabox will only show on the main site.
+		if (is_main_site()) {
+			add_meta_box(
+				'espresso_global_message_settings',
+				__('Global Message Settings', 'event_espresso'),
+				array($this, 'global_messages_settings_metabox_content'),
+				$this->_current_screen->id,
+				'normal',
+				'low',
+				array()
+			);
+		}
+        
+	}
+    
+    
+	/**
+	 *  This generates the content for the global messages settings metabox.
+	 * @return string
+	 */
+	public function global_messages_settings_metabox_content()
+	{
+		$form = $this->_generate_global_settings_form();
+		echo $form->form_open(
+				$this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
+				'POST'
+			)
+			 . $form->get_html()
+			 . $form->form_close();
+	}
+    
+    
+	/**
+	 * This generates and returns the form object for the global messages settings.
+	 * @return EE_Form_Section_Proper
+	 */
+	protected function _generate_global_settings_form()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+        
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'global_messages_settings',
+				'html_id'         => 'global_messages_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
+					array(
+						'do_messages_on_same_request' => new EE_Select_Input(
+							array(
+								true  => esc_html__("On the same request", "event_espresso"),
+								false => esc_html__("On a separate request", "event_espresso")
+							),
+							array(
+								'default'         => $network_config->do_messages_on_same_request,
+								'html_label_text' => esc_html__('Generate and send all messages:', 'event_espresso'),
+								'html_help_text'  => esc_html__('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
+									'event_espresso'),
+							)
+						),
+						'delete_threshold' => new EE_Select_Input(
+							array(
+								0 => esc_html__('Forever', 'event_espresso'),
+								3 => esc_html__('3 Months', 'event_espresso'),
+								6 => esc_html__('6 Months', 'event_espresso'),
+								9 => esc_html__('9 Months', 'event_espresso'),
+								12 => esc_html__('12 Months', 'event_espresso'),
+								24 => esc_html__('24 Months', 'event_espresso'),
+								36 => esc_html__('36 Months', 'event_espresso')
+							),
+							array(
+								'default' => EE_Registry::instance()->CFG->messages->delete_threshold,
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
+								'html_help_text' => esc_html__('You can control how long a record of processed messages is kept 
                                                     via this option.', 'event_espresso'),
-                            )
-                        ),
-                        'update_settings'             => new EE_Submit_Input(
-                            array(
-                                'default'         => esc_html__('Update', 'event_espresso'),
-                                'html_label_text' => '&nbsp'
-                            )
-                        )
-                    )
-                )
-            )
-        );
-    }
-    
-    
-    /**
-     * This handles updating the global settings set on the admin page.
-     * @throws \EE_Error
-     */
-    protected function _update_global_settings()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        $messages_config = EE_Registry::instance()->CFG->messages;
-        $form           = $this->_generate_global_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
-                    if (method_exists($network_config, $setter)) {
-                        $network_config->{$setter}($value);
-                    } else if (
-                        property_exists($network_config, $property)
-                        && $network_config->{$property} !== $value
-                    ) {
-                        $network_config->{$property} = $value;
-                    } else if (
-                        property_exists($messages_config, $property)
-                        && $messages_config->{$property} !== $value
-                    ) {
-                        $messages_config->{$property} = $value;
-                    }
-                }
-                //only update if the form submission was valid!
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
-    }
-    
-    
-    /**
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
-     *
-     * @param  array $tab_array This is an array of message type tab details used to generate the tabs
-     *
-     * @return string            html formatted tabs
-     */
-    protected function _get_mt_tabs($tab_array)
-    {
-        $tab_array = (array)$tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
-        $tabs      = '';
-        
-        foreach ($tab_array as $tab) {
-            $tabs .= EEH_Template::display_template($template, $tab, true);
-        }
-        
-        return $tabs;
-    }
-    
-    
-    /**
-     * This prepares the content of the messenger meta box admin settings
-     *
-     * @param  EE_messenger $messenger The messenger we're setting up content for
-     *
-     * @return string            html formatted content
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
-        
-        $fields                                         = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-        
-        //is $messenger active?
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
-        
-        
-        if ( ! empty($fields)) {
+							)
+						),
+						'update_settings'             => new EE_Submit_Input(
+							array(
+								'default'         => esc_html__('Update', 'event_espresso'),
+								'html_label_text' => '&nbsp'
+							)
+						)
+					)
+				)
+			)
+		);
+	}
+    
+    
+	/**
+	 * This handles updating the global settings set on the admin page.
+	 * @throws \EE_Error
+	 */
+	protected function _update_global_settings()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+		$messages_config = EE_Registry::instance()->CFG->messages;
+		$form           = $this->_generate_global_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				foreach ($valid_data as $property => $value) {
+					$setter = 'set_' . $property;
+					if (method_exists($network_config, $setter)) {
+						$network_config->{$setter}($value);
+					} else if (
+						property_exists($network_config, $property)
+						&& $network_config->{$property} !== $value
+					) {
+						$network_config->{$property} = $value;
+					} else if (
+						property_exists($messages_config, $property)
+						&& $messages_config->{$property} !== $value
+					) {
+						$messages_config->{$property} = $value;
+					}
+				}
+				//only update if the form submission was valid!
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
+	}
+    
+    
+	/**
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
+	 *
+	 * @param  array $tab_array This is an array of message type tab details used to generate the tabs
+	 *
+	 * @return string            html formatted tabs
+	 */
+	protected function _get_mt_tabs($tab_array)
+	{
+		$tab_array = (array)$tab_array;
+		$template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+		$tabs      = '';
+        
+		foreach ($tab_array as $tab) {
+			$tabs .= EEH_Template::display_template($template, $tab, true);
+		}
+        
+		return $tabs;
+	}
+    
+    
+	/**
+	 * This prepares the content of the messenger meta box admin settings
+	 *
+	 * @param  EE_messenger $messenger The messenger we're setting up content for
+	 *
+	 * @return string            html formatted content
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
+        
+		$fields                                         = $messenger->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+        
+		//is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        
+        
+		if ( ! empty($fields)) {
             
-            $existing_settings = $messenger->get_existing_admin_settings();
+			$existing_settings = $messenger->get_existing_admin_settings();
             
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                       = $messenger->name . '-' . $fldname;
-                $template_form_field[$field_id] = array(
-                    'name'       => 'messenger_settings[' . $field_id . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[$field_id])
-                        ? $existing_settings[$field_id]
-                        : $fldprops['default'],
-                    'css_class'  => '',
-                    'format'     => $fldprops['format']
-                );
-            }
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                       = $messenger->name . '-' . $fldname;
+				$template_form_field[$field_id] = array(
+					'name'       => 'messenger_settings[' . $field_id . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[$field_id])
+						? $existing_settings[$field_id]
+						: $fldprops['default'],
+					'css_class'  => '',
+					'format'     => $fldprops['format']
+				);
+			}
             
             
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
-                : '';
-        }
-        
-        //we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'messenger_settings[messenger]' => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name
-            ),
-            'type'                          => array(
-                'type'  => 'hidden',
-                'value' => 'messenger'
-            )
-        );
-        
-        //make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
-                    'type'  => 'hidden',
-                    'value' => $mt
-                );
-            }
-        }
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
-        
-        $settings_template_args['messenger']           = $messenger->name;
-        $settings_template_args['description']         = $messenger->description;
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
-        
-        
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name)
-            ? $settings_template_args['show_hide_edit_form']
-            : ' hidden';
-        
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : $settings_template_args['show_hide_edit_form'];
-        
-        
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
-        $settings_template_args['on_off_status'] = $active ? true : false;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
-        $content                                 = EEH_Template::display_template($template, $settings_template_args,
-            true);
-        
-        return $content;
-    }
-    
-    
-    /**
-     * used by ajax on the messages settings page to activate|deactivate the messenger
-     */
-    public function activate_messenger_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        //let's check that we have required data
-        if ( ! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                __('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        //do a nonce check here since we're not arriving via a normal route
-        $nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
-        
-        $this->_verify_nonce($nonce, $nonce_ref);
-        
-        
-        if ( ! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                __(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        //do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-        
-        if ($status != 'off' && $status != 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        
-        if ($success) {
-            //made it here?  Stop dawdling then!!
-            $success = $status == 'off'
-                ? $this->_deactivate_messenger($this->_req_data['messenger'])
-                : $this->_activate_messenger($this->_req_data['messenger']);
-        }
-        
-        $this->_template_args['success'] = $success;
-        
-        //no special instructions so let's just do the json return (which should automatically do all the special stuff).
-        $this->_return_json();
-        
-    }
-    
-    
-    /**
-     * used by ajax from the messages settings page to activate|deactivate a message type
-     *
-     */
-    public function activate_mt_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        
-        //let's make sure we have the necessary data
-        if ( ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(
-                __('Message Type name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        if ( ! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                __('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        if ( ! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                __('Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        
-        //do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-        
-        if ($status != 'activate' && $status != 'deactivate') {
-            EE_Error::add_error(
-                sprintf(
-                    __('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $success = false;
-        }
-        
-        
-        //do a nonce check here since we're not arriving via a normal route
-        $nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
-        
-        $this->_verify_nonce($nonce, $nonce_ref);
-        
-        if ($success) {
-            //made it here? um, what are you waiting for then?
-            $success = $status == 'deactivate'
-                ? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'],
-                    $this->_req_data['message_type'])
-                : $this->_activate_message_type_for_messenger($this->_req_data['messenger'],
-                    $this->_req_data['message_type']);
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-    
-    
-    /**
-     * Takes care of processing activating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     *
-     * @return bool
-     */
-    protected function _activate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array();
-        
-        //ensure is active
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
-        
-        //set response_data for reload
-        foreach ($message_types_to_activate as $message_type_name) {
-            /** @var EE_message_type $message_type */
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
-            if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
-                    $message_type_name)
-                && $message_type instanceof EE_message_type
-            ) {
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
-                if ($message_type->get_admin_settings_fields()) {
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
-                }
-            }
-        }
-        
-        //add success message for activating messenger
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
-        
-    }
-    
-    
-    /**
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     *
-     * @return bool
-     */
-    protected function _deactivate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
-        
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
-    }
-    
-    
-    /**
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
-     * @param string $message_type_name The name of the message type being activated for the messenger
-     *
-     * @return bool
-     */
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
-        
-        //ensure is active
-        $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
-        
-        //set response for load
-        if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
-            $message_type_name)
-        ) {
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
-            if ($message_type_to_activate->get_admin_settings_fields()) {
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
-            }
-        }
-        
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger,
-            $message_type_to_activate);
-    }
-    
-    
-    /**
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
-     *
-     * @return bool
-     */
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
-        
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger,
-            $message_type_to_deactivate);
-    }
-    
-    
-    /**
-     * This just initializes the defaults for activating messenger and message type responses.
-     */
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
-    {
-        $this->_template_args['data']['active_mts'] = array();
-        $this->_template_args['data']['mt_reload']  = array();
-    }
-    
-    
-    /**
-     * Setup appropriate response for activating a messenger and/or message types
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
-        $messenger,
-        EE_Message_Type $message_type = null
-    ) {
-        //if $messenger isn't a valid messenger object then get out.
-        if ( ! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                __('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
+				: '';
+		}
+        
+		//we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'messenger_settings[messenger]' => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name
+			),
+			'type'                          => array(
+				'type'  => 'hidden',
+				'value' => 'messenger'
+			)
+		);
+        
+		//make sure any active message types that are existing are included in the hidden fields
+		if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
+			foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
+				$settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array(
+					'type'  => 'hidden',
+					'value' => $mt
+				);
+			}
+		}
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$active                                  = $this->_message_resource_manager->is_messenger_active($messenger->name);
+        
+		$settings_template_args['messenger']           = $messenger->name;
+		$settings_template_args['description']         = $messenger->description;
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
+        
+        
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name)
+			? $settings_template_args['show_hide_edit_form']
+			: ' hidden';
+        
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: $settings_template_args['show_hide_edit_form'];
+        
+        
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
+		$settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+		$settings_template_args['on_off_status'] = $active ? true : false;
+		$template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+		$content                                 = EEH_Template::display_template($template, $settings_template_args,
+			true);
+        
+		return $content;
+	}
+    
+    
+	/**
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
+	 */
+	public function activate_messenger_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+		//let's check that we have required data
+		if ( ! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		//do a nonce check here since we're not arriving via a normal route
+		$nonce     = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : '';
+		$nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
+        
+		$this->_verify_nonce($nonce, $nonce_ref);
+        
+        
+		if ( ! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		//do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+        
+		if ($status != 'off' && $status != 'on') {
+			EE_Error::add_error(
+				sprintf(
+					__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+        
+		if ($success) {
+			//made it here?  Stop dawdling then!!
+			$success = $status == 'off'
+				? $this->_deactivate_messenger($this->_req_data['messenger'])
+				: $this->_activate_messenger($this->_req_data['messenger']);
+		}
+        
+		$this->_template_args['success'] = $success;
+        
+		//no special instructions so let's just do the json return (which should automatically do all the special stuff).
+		$this->_return_json();
+        
+	}
+    
+    
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 */
+	public function activate_mt_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+        
+		//let's make sure we have the necessary data
+		if ( ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(
+				__('Message Type name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+		if ( ! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+		if ( ! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				__('Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+        
+		//do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+        
+		if ($status != 'activate' && $status != 'deactivate') {
+			EE_Error::add_error(
+				sprintf(
+					__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$success = false;
+		}
+        
+        
+		//do a nonce check here since we're not arriving via a normal route
+		$nonce     = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
+		$nonce_ref = $this->_req_data['message_type'] . '_nonce';
+        
+		$this->_verify_nonce($nonce, $nonce_ref);
+        
+		if ($success) {
+			//made it here? um, what are you waiting for then?
+			$success = $status == 'deactivate'
+				? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'],
+					$this->_req_data['message_type'])
+				: $this->_activate_message_type_for_messenger($this->_req_data['messenger'],
+					$this->_req_data['message_type']);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+    
+    
+	/**
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 *
+	 * @return bool
+	 */
+	protected function _activate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array();
+        
+		//ensure is active
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate);
+        
+		//set response_data for reload
+		foreach ($message_types_to_activate as $message_type_name) {
+			/** @var EE_message_type $message_type */
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
+			if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
+					$message_type_name)
+				&& $message_type instanceof EE_message_type
+			) {
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
+				if ($message_type->get_admin_settings_fields()) {
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
+				}
+			}
+		}
+        
+		//add success message for activating messenger
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
+        
+	}
+    
+    
+	/**
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 *
+	 * @return bool
+	 */
+	protected function _deactivate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
+        
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
+	}
+    
+    
+	/**
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
+	 * @param string $message_type_name The name of the message type being activated for the messenger
+	 *
+	 * @return bool
+	 */
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
+        
+		//ensure is active
+		$this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name);
+        
+		//set response for load
+		if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name,
+			$message_type_name)
+		) {
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
+			if ($message_type_to_activate->get_admin_settings_fields()) {
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
+			}
+		}
+        
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger,
+			$message_type_to_activate);
+	}
+    
+    
+	/**
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
+	 *
+	 * @return bool
+	 */
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
+        
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger,
+			$message_type_to_deactivate);
+	}
+    
+    
+	/**
+	 * This just initializes the defaults for activating messenger and message type responses.
+	 */
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
+	{
+		$this->_template_args['data']['active_mts'] = array();
+		$this->_template_args['data']['mt_reload']  = array();
+	}
+    
+    
+	/**
+	 * Setup appropriate response for activating a messenger and/or message types
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
+		$messenger,
+		EE_Message_Type $message_type = null
+	) {
+		//if $messenger isn't a valid messenger object then get out.
+		if ( ! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				__('The messenger being activated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
             
-            return false;
-        }
-        //activated
-        if ($this->_template_args['data']['active_mts']) {
-            EE_Error::overwrite_success();
-            //activated a message type with the messenger
-            if ($message_type instanceof EE_message_type) {
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s message type has been successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
+			return false;
+		}
+		//activated
+		if ($this->_template_args['data']['active_mts']) {
+			EE_Error::overwrite_success();
+			//activated a message type with the messenger
+			if ($message_type instanceof EE_message_type) {
+				EE_Error::add_success(
+					sprintf(
+						__('%s message type has been successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+				);
                 
-                //if message type was invoice then let's make sure we activate the invoice payment method.
-                if ($message_type->name == 'invoice') {
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-                    if ($pm instanceof EE_Payment_Method) {
-                        EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
-                            'event_espresso'));
-                    }
-                }
-                //just toggles the entire messenger
-            } else {
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s messenger has been successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-            }
+				//if message type was invoice then let's make sure we activate the invoice payment method.
+				if ($message_type->name == 'invoice') {
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+					if ($pm instanceof EE_Payment_Method) {
+						EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
+							'event_espresso'));
+					}
+				}
+				//just toggles the entire messenger
+			} else {
+				EE_Error::add_success(
+					sprintf(
+						__('%s messenger has been successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+			}
             
-            return true;
+			return true;
             
-            //possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
-            //message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
-            //in which case we just give a success message for the messenger being successfully activated.
-        } else {
-            if ( ! $messenger->get_default_message_types()) {
-                //messenger doesn't have any default message types so still a success.
-                EE_Error::add_success(
-                    sprintf(
-                        __('%s messenger was successfully activated.', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
+			//possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
+			//message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
+			//in which case we just give a success message for the messenger being successfully activated.
+		} else {
+			if ( ! $messenger->get_default_message_types()) {
+				//messenger doesn't have any default message types so still a success.
+				EE_Error::add_success(
+					sprintf(
+						__('%s messenger was successfully activated.', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
                 
-                return true;
-            } else {
-                EE_Error::add_error(
-                    $message_type instanceof EE_message_type
-                        ? sprintf(
-                        __('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                        : sprintf(
-                        __('%s messenger was not successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
+				return true;
+			} else {
+				EE_Error::add_error(
+					$message_type instanceof EE_message_type
+						? sprintf(
+						__('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+						: sprintf(
+						__('%s messenger was not successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
                 
-                return false;
-            }
-        }
-    }
-    
-    
-    /**
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     *
-     * @return bool
-     */
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
-        $messenger,
-        EE_message_type $message_type = null
-    ) {
-        EE_Error::overwrite_success();
-        
-        //if $messenger isn't a valid messenger object then get out.
-        if ( ! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                __('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+				return false;
+			}
+		}
+	}
+    
+    
+	/**
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 *
+	 * @return bool
+	 */
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
+		$messenger,
+		EE_message_type $message_type = null
+	) {
+		EE_Error::overwrite_success();
+        
+		//if $messenger isn't a valid messenger object then get out.
+		if ( ! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
             
-            return false;
-        }
-        
-        if ($message_type instanceof EE_message_type) {
-            $message_type_name = $message_type->name;
-            EE_Error::add_success(
-                sprintf(
-                    __('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'),
-                    ucwords($message_type->label['singular']),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        } else {
-            $message_type_name = '';
-            EE_Error::add_success(
-                sprintf(
-                    __('%s messenger has been successfully deactivated.', 'event_espresso'),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        }
-        
-        //if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
-        if ($messenger->name == 'html' || $message_type_name == 'invoice') {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
-            if ($count_updated > 0) {
-                $msg = $message_type_name == 'invoice'
-                    ? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso')
-                    : __('Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso');
-                EE_Error::add_attention($msg);
-            }
-        }
-        
-        return true;
-    }
-    
-    
-    /**
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
-     */
-    public function update_mt_form()
-    {
-        if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__,
-                __LINE__);
-            $this->_return_json();
-        }
-        
-        $message_types = $this->get_installed_message_types();
-        
-        $message_type = $message_types[$this->_req_data['message_type']];
-        $messenger    = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-        
-        $content                         = $this->_message_type_settings_content($message_type, $messenger, true);
-        $this->_template_args['success'] = true;
-        $this->_template_args['content'] = $content;
-        $this->_return_json();
-    }
-    
-    
-    /**
-     * this handles saving the settings for a messenger or message type
-     *
-     */
-    public function save_settings()
-    {
-        if ( ! isset($this->_req_data['type'])) {
-            EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        
-        
-        if ($this->_req_data['type'] == 'messenger') {
-            $settings  = $this->_req_data['messenger_settings']; //this should be an array.
-            $messenger = $settings['messenger'];
-            //let's setup the settings data
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger' :
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_types' :
-                        unset($settings['message_types']);
-                        break;
-                    default :
-                        $settings[$key] = $value;
-                        break;
-                }
-            }
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
-        } else if ($this->_req_data['type'] == 'message_type') {
-            $settings     = $this->_req_data['message_type_settings'];
-            $messenger    = $settings['messenger'];
-            $message_type = $settings['message_type'];
+			return false;
+		}
+        
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					__('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'),
+					ucwords($message_type->label['singular']),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		} else {
+			$message_type_name = '';
+			EE_Error::add_success(
+				sprintf(
+					__('%s messenger has been successfully deactivated.', 'event_espresso'),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		}
+        
+		//if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
+		if ($messenger->name == 'html' || $message_type_name == 'invoice') {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
+			if ($count_updated > 0) {
+				$msg = $message_type_name == 'invoice'
+					? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso')
+					: __('Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso');
+				EE_Error::add_attention($msg);
+			}
+		}
+        
+		return true;
+	}
+    
+    
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 */
+	public function update_mt_form()
+	{
+		if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__,
+				__LINE__);
+			$this->_return_json();
+		}
+        
+		$message_types = $this->get_installed_message_types();
+        
+		$message_type = $message_types[$this->_req_data['message_type']];
+		$messenger    = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+        
+		$content                         = $this->_message_type_settings_content($message_type, $messenger, true);
+		$this->_template_args['success'] = true;
+		$this->_template_args['content'] = $content;
+		$this->_return_json();
+	}
+    
+    
+	/**
+	 * this handles saving the settings for a messenger or message type
+	 *
+	 */
+	public function save_settings()
+	{
+		if ( ! isset($this->_req_data['type'])) {
+			EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+        
+        
+		if ($this->_req_data['type'] == 'messenger') {
+			$settings  = $this->_req_data['messenger_settings']; //this should be an array.
+			$messenger = $settings['messenger'];
+			//let's setup the settings data
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger' :
+						unset($settings['messenger']);
+						break;
+					case 'message_types' :
+						unset($settings['message_types']);
+						break;
+					default :
+						$settings[$key] = $value;
+						break;
+				}
+			}
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
+		} else if ($this->_req_data['type'] == 'message_type') {
+			$settings     = $this->_req_data['message_type_settings'];
+			$messenger    = $settings['messenger'];
+			$message_type = $settings['message_type'];
             
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger' :
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_type' :
-                        unset($settings['message_type']);
-                        break;
-                    default :
-                        $settings[$key] = $value;
-                        break;
-                }
-            }
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger' :
+						unset($settings['messenger']);
+						break;
+					case 'message_type' :
+						unset($settings['message_type']);
+						break;
+					default :
+						$settings[$key] = $value;
+						break;
+				}
+			}
             
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
-        }
-        
-        //okay we should have the data all setup.  Now we just update!
-        $success = $this->_message_resource_manager->update_active_messengers_option();
-        
-        if ($success) {
-            EE_Error::add_success(__('Settings updated', 'event_espresso'));
-        } else {
-            EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-    
-    
-    
-    
-    /**  EE MESSAGE PROCESSING ACTIONS **/
-    
-    
-    /**
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
-     * However, this does not send immediately, it just queues for sending.
-     *
-     * @since 4.9.0
-     */
-    protected function _generate_now()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::generate_now($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
-     * are EEM_Message::status_resend or EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     *
-     */
-    protected function _generate_and_send_now()
-    {
-        $this->_generate_now();
-        $this->_send_now();
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
-     *
-     * @since 4.9.0
-     */
-    protected function _queue_for_resending()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::queue_for_resending($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
-     *
-     * @since 4.9.0
-     */
-    protected function _send_now()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        EED_Messages::send_now($msg_ids);
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-    
-    
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @since 4.9.0
-     */
-    protected function _delete_ee_messages()
-    {
-        $msg_ids       = $this->_get_msg_ids_from_request();
-        $deleted_count = 0;
-        foreach ($msg_ids as $msg_id) {
-            if (EEM_Message::instance()->delete_by_ID($msg_id)) {
-                $deleted_count++;
-            }
-        }
-        if ($deleted_count) {
-            $this->_redirect_after_action(
-                true,
-                _n('message', 'messages', $deleted_count, 'event_espresso'),
-                __('deleted', 'event_espresso')
-            );
-        } else {
-            EE_Error::add_error(
-                _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-    }
-    
-    
-    /**
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _get_msg_ids_from_request()
-    {
-        if ( ! isset($this->_req_data['MSG_ID'])) {
-            return array();
-        }
-        
-        return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']);
-    }
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
+		}
+        
+		//okay we should have the data all setup.  Now we just update!
+		$success = $this->_message_resource_manager->update_active_messengers_option();
+        
+		if ($success) {
+			EE_Error::add_success(__('Settings updated', 'event_espresso'));
+		} else {
+			EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+    
+    
+    
+    
+	/**  EE MESSAGE PROCESSING ACTIONS **/
+    
+    
+	/**
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
+	 * However, this does not send immediately, it just queues for sending.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _generate_now()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::generate_now($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 *
+	 */
+	protected function _generate_and_send_now()
+	{
+		$this->_generate_now();
+		$this->_send_now();
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _queue_for_resending()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::queue_for_resending($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _send_now()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		EED_Messages::send_now($msg_ids);
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+    
+    
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @since 4.9.0
+	 */
+	protected function _delete_ee_messages()
+	{
+		$msg_ids       = $this->_get_msg_ids_from_request();
+		$deleted_count = 0;
+		foreach ($msg_ids as $msg_id) {
+			if (EEM_Message::instance()->delete_by_ID($msg_id)) {
+				$deleted_count++;
+			}
+		}
+		if ($deleted_count) {
+			$this->_redirect_after_action(
+				true,
+				_n('message', 'messages', $deleted_count, 'event_espresso'),
+				__('deleted', 'event_espresso')
+			);
+		} else {
+			EE_Error::add_error(
+				_n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+	}
+    
+    
+	/**
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _get_msg_ids_from_request()
+	{
+		if ( ! isset($this->_req_data['MSG_ID'])) {
+			return array();
+		}
+        
+		return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']);
+	}
     
     
 }

core/domain/DomainBase.php

Indentation +127 added lines, -127 removed lines

@@ -18,132 +18,132 @@
 abstract class DomainBase
 {
 
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var string
-     */
-    private static $plugin_file = '';
-
-    /**
-     * String indicating version for plugin
-     *
-     * @var string
-     */
-    private static $version = '';
-
-    /**
-     * @var string $plugin_basename
-     */
-    private static $plugin_basename = '';
-
-    /**
-     * @var string $plugin_path
-     */
-    private static $plugin_path = '';
-
-    /**
-     * @var string $plugin_url
-     */
-    private static $plugin_url = '';
-
-
-
-    /**
-     * Initializes internal static properties.
-     *
-     * @param string $plugin_file
-     * @param string $version
-     */
-    public static function init($plugin_file, $version)
-    {
-        self::$plugin_file = $plugin_file;
-        self::$version = $version;
-        self::$plugin_basename = plugin_basename($plugin_file);
-        self::$plugin_path = plugin_dir_path($plugin_file);
-        self::$plugin_url = plugin_dir_url($plugin_file);
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginFile()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_file;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginBasename()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_basename;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginPath()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_path;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function pluginUrl()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$plugin_url;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public static function version()
-    {
-        self::verifyInitialized(__METHOD__);
-        return self::$version;
-    }
-
-
-
-    /**
-     * @param string $method
-     * @throws DomainException
-     */
-    private static function verifyInitialized($method)
-    {
-        if (self::$plugin_file === '') {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '%1$s needs to be called before %2$s can return a value.',
-                        'event_espresso'
-                    ),
-                    get_called_class() . '::init()',
-                    "{$method}()"
-                )
-            );
-        }
-    }
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var string
+	 */
+	private static $plugin_file = '';
+
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var string
+	 */
+	private static $version = '';
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private static $plugin_basename = '';
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private static $plugin_path = '';
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private static $plugin_url = '';
+
+
+
+	/**
+	 * Initializes internal static properties.
+	 *
+	 * @param string $plugin_file
+	 * @param string $version
+	 */
+	public static function init($plugin_file, $version)
+	{
+		self::$plugin_file = $plugin_file;
+		self::$version = $version;
+		self::$plugin_basename = plugin_basename($plugin_file);
+		self::$plugin_path = plugin_dir_path($plugin_file);
+		self::$plugin_url = plugin_dir_url($plugin_file);
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginFile()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_file;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginBasename()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_basename;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginPath()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_path;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function pluginUrl()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$plugin_url;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function version()
+	{
+		self::verifyInitialized(__METHOD__);
+		return self::$version;
+	}
+
+
+
+	/**
+	 * @param string $method
+	 * @throws DomainException
+	 */
+	private static function verifyInitialized($method)
+	{
+		if (self::$plugin_file === '') {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'%1$s needs to be called before %2$s can return a value.',
+						'event_espresso'
+					),
+					get_called_class() . '::init()',
+					"{$method}()"
+				)
+			);
+		}
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
                         '%1$s needs to be called before %2$s can return a value.',
                         'event_espresso'
                     ),
-                    get_called_class() . '::init()',
+                    get_called_class().'::init()',
                     "{$method}()"
                 )
             );