eventespresso / event-espresso-core

modules/messages/EED_Messages.module.php

Doc Comments +1 added lines, -1 removed lines

@@ -632,7 +632,7 @@
      * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
      *                   or EEH_MSG_Template::convert_payment_status_to_message_type
      * @param string $payment_status The payment status being matched.
-     * @return bool|string The payment message type slug matching the status or false if no match.
+     * @return string|false The payment message type slug matching the status or false if no match.
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws ReflectionException

Spacing +24 added lines, -24 removed lines

@@ -159,7 +159,7 @@ 
             $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();
+            $error_msg .= '||'.$e->getMessage();
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -242,7 +242,7 @@ 
             $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();
+            $error_msg .= '||'.$e->getMessage();
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -273,7 +273,7 @@ 
         $transient_key = EE_Registry::instance()->REQ->get('key');
 
         //now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
+        if ( ! get_transient($transient_key)) {
             /**
              * trigger error so this gets in the error logs.  This is important because it happens on a non-user
              * request.
@@ -286,7 +286,7 @@ 
 
         if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
 
-            $method = 'batch_' . $cron_type . '_from_queue';
+            $method = 'batch_'.$cron_type.'_from_queue';
             if (method_exists(self::$_MSG_PROCESSOR, $method)) {
                 self::$_MSG_PROCESSOR->$method();
             } else {
@@ -395,9 +395,9 @@ 
             'messages/validators/html',
             'shortcodes',
         );
-        $paths   = array();
+        $paths = array();
         foreach ($dir_ref as $index => $dir) {
-            $paths[$index] = EE_LIBRARIES . $dir;
+            $paths[$index] = EE_LIBRARIES.$dir;
         }
         self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
     }
@@ -416,7 +416,7 @@ 
      */
     protected static function _load_controller()
     {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+        if ( ! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
             EE_Registry::instance()->load_core('Request_Handler');
             self::set_autoloaders();
             self::$_EEMSG                    = EE_Registry::instance()->load_lib('messages');
@@ -500,7 +500,7 @@ 
     public static function maybe_registration(EE_Registration $registration, $extra_details = array())
     {
 
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+        if ( ! self::_verify_registration_notification_send($registration, $extra_details)) {
             //no messages please
             return;
         }
@@ -567,7 +567,7 @@ 
         //	array( '$extra_details' => $extra_details )
         //);
         // currently only using this to send messages for the primary registrant
-        if (! $registration->is_primary_registrant()) {
+        if ( ! $registration->is_primary_registrant()) {
             return false;
         }
         // first we check if we're in admin and not doing front ajax
@@ -580,7 +580,7 @@ 
         } else {
             // frontend request (either regular or via AJAX)
             // TXN is NOT finalized ?
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
+            if ( ! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
                 return false;
             }
             // return visit but nothing changed ???
@@ -670,12 +670,12 @@ 
         }
 
         //make sure any incoming request data is set on the REQ so that it gets picked up later.
-        $req_data = (array)$req_data;
+        $req_data = (array) $req_data;
         foreach ($req_data as $request_key => $request_value) {
             EE_Registry::instance()->REQ->set($request_key, $request_value);
         }
 
-        if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
+        if ( ! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
             return false;
         }
 
@@ -708,13 +708,13 @@ 
         self::_load_controller();
 
         $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
-        if (! $msgID) {
+        if ( ! $msgID) {
             EE_Error::add_error(__('Something went wrong because there is no "MSG_ID" value in the request',
                 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
 
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array)$msgID);
+        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
 
         //setup success message.
         $count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
@@ -819,7 +819,7 @@ 
     public static function send_newsletter_message($registrations, $grp_id)
     {
         //make sure mtp is id and set it in the EE_Request Handler later messages setup.
-        EE_Registry::instance()->REQ->set('GRP_ID', (int)$grp_id);
+        EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
         self::_load_controller();
         self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
     }
@@ -879,14 +879,14 @@ 
             //get the message template group.
             $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
             //if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
+            if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
                 // remove EVT_ID from query params so that global templates get picked up
                 unset($template_query_params['Event.EVT_ID']);
                 //get global template as the fallback
                 $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
             }
             //if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
+            if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
                 return '';
             }
             // generate the URL
@@ -923,7 +923,7 @@ 
     public static function preview_message($type, $context, $messenger, $send = false)
     {
         self::_load_controller();
-        $mtg                     = new EE_Message_To_Generate(
+        $mtg = new EE_Message_To_Generate(
             $messenger,
             $type,
             array(),
@@ -1005,7 +1005,7 @@ 
     public static function generate_now($message_ids)
     {
         self::_load_controller();
-        $messages        = EEM_Message::instance()->get_all(
+        $messages = EEM_Message::instance()->get_all(
             array(
                 0 => array(
                     'MSG_ID' => array('IN', $message_ids),
@@ -1018,7 +1018,7 @@ 
             $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
         }
 
-        if (! $generated_queue instanceof EE_Messages_Queue) {
+        if ( ! $generated_queue instanceof EE_Messages_Queue) {
             EE_Error::add_error(
                 __('The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
                     'event_espresso'),
@@ -1045,7 +1045,7 @@ 
     public static function send_now($message_ids)
     {
         self::_load_controller();
-        $messages   = EEM_Message::instance()->get_all(
+        $messages = EEM_Message::instance()->get_all(
             array(
                 0 => array(
                     'MSG_ID' => array('IN', $message_ids),
@@ -1061,7 +1061,7 @@ 
             $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
         }
 
-        if (! $sent_queue instanceof EE_Messages_Queue) {
+        if ( ! $sent_queue instanceof EE_Messages_Queue) {
             EE_Error::add_error(
                 __('The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
                     'event_espresso'),
@@ -1200,7 +1200,7 @@ 
                 __FILE__, __FUNCTION__, __LINE__
             );
         }
-        return (bool)$queue_count;
+        return (bool) $queue_count;
     }
 
 
@@ -1231,7 +1231,7 @@ 
                 $info['TXN_status']    = $transaction->status_ID();
                 $info['TXN_reg_steps'] = $transaction->reg_steps();
                 if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
+                    $index = 'EE_Transaction: '.$transaction->ID();
                     EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
                 }
             }

Indentation +1233 added lines, -1233 removed lines

@@ -18,1248 +18,1248 @@
 class EED_Messages extends EED_Module
 {
 
-    /**
-     * This holds the EE_messages controller
-     *
-     * @deprecated 4.9.0
-     * @var EE_messages $_EEMSG
-     */
-    protected static $_EEMSG;
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected static $_message_resource_manager;
-
-    /**
-     * This holds the EE_Messages_Processor business class.
-     *
-     * @type EE_Messages_Processor
-     */
-    protected static $_MSG_PROCESSOR;
-
-    /**
-     * holds all the paths for various messages components.
-     * Utilized by autoloader registry
-     *
-     * @var array
-     */
-    protected static $_MSG_PATHS;
-
-
-    /**
-     * This will hold an array of messages template packs that are registered in the messages system.
-     * Format is:
-     * array(
-     *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
-     * )
-     *
-     * @var EE_Messages_Template_Pack[]
-     */
-    protected static $_TMP_PACKS = array();
-
-
-    /**
-     * @return EED_Messages
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *  set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @since 4.5.0
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        //actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'), 10, 2);
-        //filters
-        add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
-        add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
-        //register routes
-        self::_register_routes();
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        //actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            array('EED_Messages', 'payment_reminder'), 10);
-        add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'), 10, 3);
-        add_action('AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-            array('EED_Messages', 'send_newsletter_message'), 10, 2);
-        add_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
-            array('EED_Messages', 'cancelled_registration'), 10);
-        add_action('AHEE__EE_Admin_Page___process_admin_payment_notification',
-            array('EED_Messages', 'process_admin_payment'), 10, 1);
-        //filters
-        add_filter('FHEE__EE_Admin_Page___process_resend_registration__success',
-            array('EED_Messages', 'process_resend'), 10, 2);
-        add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
-        add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
-    }
-
-
-    /**
-     * All the message triggers done by route go in here.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected static function _register_routes()
-    {
-        EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
-        EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
-        EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
-        EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
-        do_action('AHEE__EED_Messages___register_routes');
-    }
-
-
-    /**
-     * This is called when a browser display trigger is executed.
-     * The browser display trigger is typically used when a already generated message is displayed directly in the
-     * browser.
-     *
-     * @since 4.9.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_trigger($WP)
-    {
-        //ensure controller is loaded
-        self::_load_controller();
-        $token = EE_Registry::instance()->REQ->get('token');
-        try {
-            $mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
-            self::$_MSG_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__);
-        }
-    }
-
-
-    /**
-     * This is called when a browser error trigger is executed.
-     * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
-     * message and display it.
-     *
-     * @since 4.9.0
-     * @param $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_error_trigger($WP)
-    {
-        $token = EE_Registry::instance()->REQ->get('token');
-        if ($token) {
-            $message = EEM_Message::instance()->get_one_by_token($token);
-            if ($message instanceof EE_Message) {
-                header('HTTP/1.1 200 OK');
-                $error_msg = nl2br($message->error_message());
-                ?>
+	/**
+	 * This holds the EE_messages controller
+	 *
+	 * @deprecated 4.9.0
+	 * @var EE_messages $_EEMSG
+	 */
+	protected static $_EEMSG;
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected static $_message_resource_manager;
+
+	/**
+	 * This holds the EE_Messages_Processor business class.
+	 *
+	 * @type EE_Messages_Processor
+	 */
+	protected static $_MSG_PROCESSOR;
+
+	/**
+	 * holds all the paths for various messages components.
+	 * Utilized by autoloader registry
+	 *
+	 * @var array
+	 */
+	protected static $_MSG_PATHS;
+
+
+	/**
+	 * This will hold an array of messages template packs that are registered in the messages system.
+	 * Format is:
+	 * array(
+	 *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
+	 * )
+	 *
+	 * @var EE_Messages_Template_Pack[]
+	 */
+	protected static $_TMP_PACKS = array();
+
+
+	/**
+	 * @return EED_Messages
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *  set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @since 4.5.0
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		//actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'), 10, 2);
+		//filters
+		add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
+		add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
+		//register routes
+		self::_register_routes();
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		//actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action('AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			array('EED_Messages', 'payment_reminder'), 10);
+		add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'), 10, 3);
+		add_action('AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+			array('EED_Messages', 'send_newsletter_message'), 10, 2);
+		add_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
+			array('EED_Messages', 'cancelled_registration'), 10);
+		add_action('AHEE__EE_Admin_Page___process_admin_payment_notification',
+			array('EED_Messages', 'process_admin_payment'), 10, 1);
+		//filters
+		add_filter('FHEE__EE_Admin_Page___process_resend_registration__success',
+			array('EED_Messages', 'process_resend'), 10, 2);
+		add_filter('FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
+		add_filter('FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'), 10, 4);
+	}
+
+
+	/**
+	 * All the message triggers done by route go in here.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected static function _register_routes()
+	{
+		EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
+		EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
+		EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
+		EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
+		do_action('AHEE__EED_Messages___register_routes');
+	}
+
+
+	/**
+	 * This is called when a browser display trigger is executed.
+	 * The browser display trigger is typically used when a already generated message is displayed directly in the
+	 * browser.
+	 *
+	 * @since 4.9.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_trigger($WP)
+	{
+		//ensure controller is loaded
+		self::_load_controller();
+		$token = EE_Registry::instance()->REQ->get('token');
+		try {
+			$mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
+			self::$_MSG_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__);
+		}
+	}
+
+
+	/**
+	 * This is called when a browser error trigger is executed.
+	 * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
+	 * message and display it.
+	 *
+	 * @since 4.9.0
+	 * @param $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_error_trigger($WP)
+	{
+		$token = EE_Registry::instance()->REQ->get('token');
+		if ($token) {
+			$message = EEM_Message::instance()->get_one_by_token($token);
+			if ($message instanceof EE_Message) {
+				header('HTTP/1.1 200 OK');
+				$error_msg = nl2br($message->error_message());
+				?>
                 <!DOCTYPE html>
                 <html>
                 <head></head>
                 <body>
                 <?php echo empty($error_msg)
-                    ? esc_html__('Unfortunately, we were unable to capture the error message for this message.',
-                        'event_espresso')
-                    : wp_kses(
-                        $error_msg,
-                        array(
-                            'a'      => array(
-                                'href'  => array(),
-                                'title' => array(),
-                            ),
-                            'span'   => array(),
-                            'div'    => array(),
-                            'p'      => array(),
-                            'strong' => array(),
-                            'em'     => array(),
-                            'br'     => array(),
-                        )
-                    ); ?>
+					? esc_html__('Unfortunately, we were unable to capture the error message for this message.',
+						'event_espresso')
+					: wp_kses(
+						$error_msg,
+						array(
+							'a'      => array(
+								'href'  => array(),
+								'title' => array(),
+							),
+							'span'   => array(),
+							'div'    => array(),
+							'p'      => array(),
+							'strong' => array(),
+							'em'     => array(),
+							'br'     => array(),
+						)
+					); ?>
                 </body>
                 </html>
                 <?php
-                exit;
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *  This runs when the msg_url_trigger route has initiated.
-     *
-     * @since 4.5.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function run($WP)
-    {
-        //ensure controller is loaded
-        self::_load_controller();
-        // attempt to process message
-        try {
-            /** @type EE_Message_To_Generate_From_Request $message_to_generate */
-            $message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-            self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
-        } 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__);
-        }
-    }
-
-
-    /**
-     * This is triggered by the 'msg_cron_trigger' route.
-     *
-     * @param WP $WP
-     */
-    public function execute_batch_request($WP)
-    {
-        $this->run_cron();
-        header('HTTP/1.1 200 OK');
-        exit();
-    }
-
-
-    /**
-     * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
-     * request.
-     */
-    public function run_cron()
-    {
-        self::_load_controller();
-        //get required vars
-        $cron_type     = EE_Registry::instance()->REQ->get('type');
-        $transient_key = EE_Registry::instance()->REQ->get('key');
-
-        //now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
-            /**
-             * trigger error so this gets in the error logs.  This is important because it happens on a non-user
-             * request.
-             */
-            trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
-        }
-
-        //if made it here, lets' delete the transient to keep the db clean
-        delete_transient($transient_key);
-
-        if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
-
-            $method = 'batch_' . $cron_type . '_from_queue';
-            if (method_exists(self::$_MSG_PROCESSOR, $method)) {
-                self::$_MSG_PROCESSOR->$method();
-            } else {
-                //no matching task
-                /**
-                 * trigger error so this gets in the error logs.  This is important because it happens on a non user
-                 * request.
-                 */
-                trigger_error(esc_attr(sprintf(__('There is no task corresponding to this route %s', 'event_espresso'),
-                    $cron_type)));
-            }
-        }
-
-        do_action('FHEE__EED_Messages__run_cron__end');
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
-     * the default template pack is returned.
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
-     * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
-     *                                   in generating the Pack class name).
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($template_pack_name);
-    }
-
-
-    /**
-     * Retrieves an array of all template packs.
-     * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
-     * @return EE_Messages_Template_Pack[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_packs()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-
-        //for backward compat, let's make sure this returns in the same format as originally.
-        $template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
-        $template_pack_collection->rewind();
-        $template_packs = array();
-        while ($template_pack_collection->valid()) {
-            $template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
-            $template_pack_collection->next();
-        }
-        return $template_packs;
-    }
-
-
-    /**
-     * This simply makes sure the autoloaders are registered for the EE_messages system.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function set_autoloaders()
-    {
-        if (empty(self::$_MSG_PATHS)) {
-            self::_set_messages_paths();
-            foreach (self::$_MSG_PATHS as $path) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
-            }
-            // add aliases
-            EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
-            EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
-        }
-    }
-
-
-    /**
-     * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
-     * for use by the Messages Autoloaders
-     *
-     * @since 4.5.0
-     * @return void.
-     */
-    protected static function _set_messages_paths()
-    {
-        $dir_ref = array(
-            'messages/message_type',
-            'messages/messenger',
-            'messages/defaults',
-            'messages/defaults/email',
-            'messages/data_class',
-            'messages/validators',
-            'messages/validators/email',
-            'messages/validators/html',
-            'shortcodes',
-        );
-        $paths   = array();
-        foreach ($dir_ref as $index => $dir) {
-            $paths[$index] = EE_LIBRARIES . $dir;
-        }
-        self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
-    }
-
-
-    /**
-     * Takes care of loading dependencies
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _load_controller()
-    {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
-            EE_Registry::instance()->load_core('Request_Handler');
-            self::set_autoloaders();
-            self::$_EEMSG                    = EE_Registry::instance()->load_lib('messages');
-            self::$_MSG_PROCESSOR            = EE_Registry::instance()->load_lib('Messages_Processor');
-            self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function payment_reminder(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
-    }
-
-
-    /**
-     * Any messages triggers for after successful gateway payments should go in here.
-     *
-     * @param EE_Transaction $transaction object
-     * @param EE_Payment     $payment     object
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function payment(EE_Transaction $transaction, EE_Payment $payment)
-    {
-        self::_load_controller();
-        $data = array($transaction, $payment);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-        //if payment amount is less than 0 then switch to payment_refund message type.
-        $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function cancelled_registration(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
-    }
-
-
-
-    /**
-     * Trigger for Registration messages
-     * Note that what registration message type is sent depends on what the reg status is for the registrations on the
-     * incoming transaction.
-     *
-     * @param EE_Registration $registration
-     * @param array           $extra_details
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public static function maybe_registration(EE_Registration $registration, $extra_details = array())
-    {
-
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
-            //no messages please
-            return;
-        }
-
-        // get all non-trashed registrations so we make sure we send messages for the right status.
-        $all_registrations = $registration->transaction()->registrations(
-            array(
-                array('REG_deleted' => false),
-                'order_by' => array(
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC'
-                )
-            )
-        );
-        //cached array of statuses so we only trigger messages once per status.
-        $statuses_sent = array();
-        self::_load_controller();
-        $mtgs = array();
-
-        //loop through registrations and trigger messages once per status.
-        foreach ($all_registrations as $reg) {
-
-            //already triggered?
-            if (in_array($reg->status_ID(), $statuses_sent)) {
-                continue;
-            }
-
-            $message_type    = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
-            $mtgs            = array_merge(
-                    $mtgs,
-                    self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                            $message_type,
-                            array($registration->transaction(), null, $reg->status_ID())
-                    )
-            );
-            $statuses_sent[] = $reg->status_ID();
-        }
-
-        if (count($statuses_sent) > 1) {
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    'registration_summary',
-                    array($registration->transaction(), null)
-                )
-            );
-        }
-
-        //batch queue and initiate request
-        self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
-        self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-    }
-
-
-    /**
-     * This is a helper method used to very whether a registration notification should be sent or
-     * not.  Prevents duplicate notifications going out for registration context notifications.
-     *
-     * @param EE_Registration $registration  [description]
-     * @param array           $extra_details [description]
-     * @return bool          true = send away, false = nope halt the presses.
-     */
-    protected static function _verify_registration_notification_send(
-        EE_Registration $registration,
-        $extra_details = array()
-    ) {
-        //self::log(
-        //	__CLASS__, __FUNCTION__, __LINE__,
-        //	$registration->transaction(),
-        //	array( '$extra_details' => $extra_details )
-        //);
-        // currently only using this to send messages for the primary registrant
-        if (! $registration->is_primary_registrant()) {
-            return false;
-        }
-        // first we check if we're in admin and not doing front ajax
-        if (is_admin() && ! EE_FRONT_AJAX) {
-            //make sure appropriate admin params are set for sending messages
-            if (empty($_REQUEST['txn_reg_status_change']['send_notifications']) || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])) {
-                //no messages sent please.
-                return false;
-            }
-        } else {
-            // frontend request (either regular or via AJAX)
-            // TXN is NOT finalized ?
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
-                return false;
-            }
-            // return visit but nothing changed ???
-            if (
-                isset($extra_details['revisit'], $extra_details['status_updates']) &&
-                $extra_details['revisit'] && ! $extra_details['status_updates']
-            ) {
-                return false;
-            }
-            // NOT sending messages && reg status is something other than "Not-Approved"
-            if (
-                ! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
-                $registration->status_ID() !== EEM_Registration::status_id_not_approved
-            ) {
-                return false;
-            }
-        }
-        // release the kraken
-        return true;
-    }
-
-
-    /**
-     * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
-     * status id.
-     *
-     * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
-     *                    or EEH_MSG_Template::convert_reg_status_to_message_type
-     * @param string $reg_status
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_reg_status_array($reg_status = '')
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            ? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            : EEH_MSG_Template::reg_status_to_message_type_array();
-    }
-
-
-    /**
-     * Simply returns the payment message type for the given payment status.
-     *
-     * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
-     *                   or EEH_MSG_Template::convert_payment_status_to_message_type
-     * @param string $payment_status The payment status being matched.
-     * @return bool|string The payment message type slug matching the status or false if no match.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_payment_message_type($payment_status)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            ? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            : false;
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @access public
-     * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function process_resend($req_data)
-    {
-        self::_load_controller();
-
-        //if $msgID in this request then skip to the new resend_message
-        if (EE_Registry::instance()->REQ->get('MSG_ID')) {
-            return self::resend_message();
-        }
-
-        //make sure any incoming request data is set on the REQ so that it gets picked up later.
-        $req_data = (array)$req_data;
-        foreach ($req_data as $request_key => $request_value) {
-            EE_Registry::instance()->REQ->set($request_key, $request_value);
-        }
-
-        if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
-            return false;
-        }
-
-        try {
-            self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
-            self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Error::add_success(
-            __('Messages have been successfully queued for generation and sending.', 'event_espresso')
-        );
-        return true; //everything got queued.
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function resend_message()
-    {
-        self::_load_controller();
-
-        $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
-        if (! $msgID) {
-            EE_Error::add_error(__('Something went wrong because there is no "MSG_ID" value in the request',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array)$msgID);
-
-        //setup success message.
-        $count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-        EE_Error::add_success(sprintf(
-            _n(
-                'There was %d message queued for resending.',
-                'There were %d messages queued for resending.',
-                $count_ready_for_resend,
-                'event_espresso'
-            ),
-            $count_ready_for_resend
-        ));
-        return true;
-    }
-
-
-    /**
-     * Message triggers for manual payment applied by admin
-     *
-     * @param  EE_Payment $payment EE_payment object
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function process_admin_payment(EE_Payment $payment)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        //we need to get the transaction object
-        $transaction = $payment->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $data         = array($transaction, $payment);
-            $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-
-            //if payment amount is less than 0 then switch to payment_refund message type.
-            $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-
-            //if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
-            $message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved ? false : $message_type;
-
-            self::_load_controller();
-
-            self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-
-            //get count of queued for generation
-            $count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(array(
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-            ));
-
-            if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
-                add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                return true;
-            } else {
-                $count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::instance()->stati_indicating_failed_sending());
-                /**
-                 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
-                 * IMMEDIATE generation.
-                 */
-                if ($count_failed > 0) {
-                    EE_Error::add_error(sprintf(
-                        _n(
-                            'The payment notification generation failed.',
-                            '%d payment notifications failed being sent.',
-                            $count_failed,
-                            'event_espresso'
-                        ),
-                        $count_failed
-                    ), __FILE__, __FUNCTION__, __LINE__);
-
-                    return false;
-                } else {
-                    add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                    return true;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                'Unable to generate the payment notification because the given value for the transaction is invalid.',
-                'event_espresso'
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
-     *
-     * @since   4.3.0
-     * @param  EE_Registration[] $registrations an array of EE_Registration objects
-     * @param  int               $grp_id        a specific message template group id.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_newsletter_message($registrations, $grp_id)
-    {
-        //make sure mtp is id and set it in the EE_Request Handler later messages setup.
-        EE_Registry::instance()->REQ->set('GRP_ID', (int)$grp_id);
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
-     *
-     * @since   4.3.0
-     * @param    string          $registration_message_trigger_url
-     * @param    EE_Registration $registration
-     * @param string             $messenger
-     * @param string             $message_type
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function registration_message_trigger_url(
-        $registration_message_trigger_url,
-        EE_Registration $registration,
-        $messenger = 'html',
-        $message_type = 'invoice'
-    ) {
-        // whitelist $messenger
-        switch ($messenger) {
-            case 'pdf' :
-                $sending_messenger    = 'pdf';
-                $generating_messenger = 'html';
-                break;
-            case 'html' :
-            default :
-                $sending_messenger    = 'html';
-                $generating_messenger = 'html';
-                break;
-        }
-        // whitelist $message_type
-        switch ($message_type) {
-            case 'receipt' :
-                $message_type = 'receipt';
-                break;
-            case 'invoice' :
-            default :
-                $message_type = 'invoice';
-                break;
-        }
-        // verify that both the messenger AND the message type are active
-        if (EEH_MSG_Template::is_messenger_active($sending_messenger) && EEH_MSG_Template::is_mt_active($message_type)) {
-            //need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
-            $template_query_params = array(
-                'MTP_is_active'    => true,
-                'MTP_messenger'    => $generating_messenger,
-                'MTP_message_type' => $message_type,
-                'Event.EVT_ID'     => $registration->event_ID(),
-            );
-            //get the message template group.
-            $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            //if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                // remove EVT_ID from query params so that global templates get picked up
-                unset($template_query_params['Event.EVT_ID']);
-                //get global template as the fallback
-                $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            }
-            //if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                return '';
-            }
-            // generate the URL
-            $registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
-                $sending_messenger,
-                $generating_messenger,
-                'purchaser',
-                $message_type,
-                $registration,
-                $msg_template_group->ID(),
-                $registration->transaction_ID()
-            );
-
-        }
-        return $registration_message_trigger_url;
-    }
-
-
-    /**
-     * Use to generate and return a message preview!
-     *
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return bool|string The body of the message or if send is requested, sends.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function preview_message($type, $context, $messenger, $send = false)
-    {
-        self::_load_controller();
-        $mtg                     = new EE_Message_To_Generate(
-            $messenger,
-            $type,
-            array(),
-            $context,
-            true
-        );
-        $generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
-        if ($generated_preview_queue instanceof EE_Messages_Queue) {
-            //loop through all content for the preview and remove any persisted records.
-            $content = '';
-            foreach ($generated_preview_queue->get_message_repository() as $message) {
-                $content = $message->content();
-                if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
-                    $message->delete();
-                }
-            }
-            return $content;
-        } else {
-            return $generated_preview_queue;
-        }
-    }
-
-
-    /**
-     * This is a method that allows for sending a message using a messenger matching the string given and the provided
-     * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
-     * content found in the EE_Message objects in the queue.
-     *
-     * @since 4.9.0
-     * @param string            $messenger            a string matching a valid active messenger in the system
-     * @param string            $message_type         Although it seems contrary to the name of the method, a message
-     *                                                type name is still required to send along the message type to the
-     *                                                messenger because this is used for determining what specific
-     *                                                variations might be loaded for the generated message.
-     * @param EE_Messages_Queue $queue
-     * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
-     *                                                aggregate EE_Message object.
-     * @return bool success or fail.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function send_message_with_messenger_only(
-        $messenger,
-        $message_type,
-        EE_Messages_Queue $queue,
-        $custom_subject = ''
-    ) {
-        self::_load_controller();
-        /** @type EE_Message_To_Generate_From_Queue $message_to_generate */
-        $message_to_generate = EE_Registry::instance()->load_lib(
-            'Message_To_Generate_From_Queue',
-            array(
-                $messenger,
-                $message_type,
-                $queue,
-                $custom_subject,
-            )
-        );
-        return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
-    }
-
-
-    /**
-     * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of message ids
-     * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
-     *                           messages.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_now($message_ids)
-    {
-        self::_load_controller();
-        $messages        = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => EEM_Message::status_incomplete,
-                ),
-            )
-        );
-        $generated_queue = false;
-        if ($messages) {
-            $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
-        }
-
-        if (! $generated_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __('The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return $generated_queue;
-    }
-
-
-    /**
-     * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
-     * EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     * @param $message_ids
-     * @return bool|EE_Messages_Queue false if no messages sent.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_now($message_ids)
-    {
-        self::_load_controller();
-        $messages   = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
-                    ),
-                ),
-            )
-        );
-        $sent_queue = false;
-        if ($messages) {
-            $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
-        }
-
-        if (! $sent_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __('The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        } else {
-            //can count how many sent by using the messages in the queue
-            $sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
-            if ($sent_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully sent.',
-                            'There were %d messages successfully sent.',
-                            $sent_count,
-                            'event_espresso'
-                        ),
-                        $sent_count
-                    )
-                );
-            } else {
-                EE_Error::overwrite_errors();
-                EE_Error::add_error(
-                    __('No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
+				exit;
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *  This runs when the msg_url_trigger route has initiated.
+	 *
+	 * @since 4.5.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function run($WP)
+	{
+		//ensure controller is loaded
+		self::_load_controller();
+		// attempt to process message
+		try {
+			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
+			$message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+			self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
+		} 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__);
+		}
+	}
+
+
+	/**
+	 * This is triggered by the 'msg_cron_trigger' route.
+	 *
+	 * @param WP $WP
+	 */
+	public function execute_batch_request($WP)
+	{
+		$this->run_cron();
+		header('HTTP/1.1 200 OK');
+		exit();
+	}
+
+
+	/**
+	 * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
+	 * request.
+	 */
+	public function run_cron()
+	{
+		self::_load_controller();
+		//get required vars
+		$cron_type     = EE_Registry::instance()->REQ->get('type');
+		$transient_key = EE_Registry::instance()->REQ->get('key');
+
+		//now let's verify transient, if not valid exit immediately
+		if (! get_transient($transient_key)) {
+			/**
+			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user
+			 * request.
+			 */
+			trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
+		}
+
+		//if made it here, lets' delete the transient to keep the db clean
+		delete_transient($transient_key);
+
+		if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
+
+			$method = 'batch_' . $cron_type . '_from_queue';
+			if (method_exists(self::$_MSG_PROCESSOR, $method)) {
+				self::$_MSG_PROCESSOR->$method();
+			} else {
+				//no matching task
+				/**
+				 * trigger error so this gets in the error logs.  This is important because it happens on a non user
+				 * request.
+				 */
+				trigger_error(esc_attr(sprintf(__('There is no task corresponding to this route %s', 'event_espresso'),
+					$cron_type)));
+			}
+		}
+
+		do_action('FHEE__EED_Messages__run_cron__end');
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
+	 * the default template pack is returned.
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
+	 * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
+	 *                                   in generating the Pack class name).
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($template_pack_name);
+	}
+
+
+	/**
+	 * Retrieves an array of all template packs.
+	 * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
+	 * @return EE_Messages_Template_Pack[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_packs()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+
+		//for backward compat, let's make sure this returns in the same format as originally.
+		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
+		$template_pack_collection->rewind();
+		$template_packs = array();
+		while ($template_pack_collection->valid()) {
+			$template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
+			$template_pack_collection->next();
+		}
+		return $template_packs;
+	}
+
+
+	/**
+	 * This simply makes sure the autoloaders are registered for the EE_messages system.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function set_autoloaders()
+	{
+		if (empty(self::$_MSG_PATHS)) {
+			self::_set_messages_paths();
+			foreach (self::$_MSG_PATHS as $path) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
+			}
+			// add aliases
+			EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
+			EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
+		}
+	}
+
+
+	/**
+	 * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
+	 * for use by the Messages Autoloaders
+	 *
+	 * @since 4.5.0
+	 * @return void.
+	 */
+	protected static function _set_messages_paths()
+	{
+		$dir_ref = array(
+			'messages/message_type',
+			'messages/messenger',
+			'messages/defaults',
+			'messages/defaults/email',
+			'messages/data_class',
+			'messages/validators',
+			'messages/validators/email',
+			'messages/validators/html',
+			'shortcodes',
+		);
+		$paths   = array();
+		foreach ($dir_ref as $index => $dir) {
+			$paths[$index] = EE_LIBRARIES . $dir;
+		}
+		self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
+	}
+
+
+	/**
+	 * Takes care of loading dependencies
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _load_controller()
+	{
+		if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+			EE_Registry::instance()->load_core('Request_Handler');
+			self::set_autoloaders();
+			self::$_EEMSG                    = EE_Registry::instance()->load_lib('messages');
+			self::$_MSG_PROCESSOR            = EE_Registry::instance()->load_lib('Messages_Processor');
+			self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function payment_reminder(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
+	}
+
+
+	/**
+	 * Any messages triggers for after successful gateway payments should go in here.
+	 *
+	 * @param EE_Transaction $transaction object
+	 * @param EE_Payment     $payment     object
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function payment(EE_Transaction $transaction, EE_Payment $payment)
+	{
+		self::_load_controller();
+		$data = array($transaction, $payment);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+		//if payment amount is less than 0 then switch to payment_refund message type.
+		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function cancelled_registration(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
+	}
+
+
+
+	/**
+	 * Trigger for Registration messages
+	 * Note that what registration message type is sent depends on what the reg status is for the registrations on the
+	 * incoming transaction.
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $extra_details
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public static function maybe_registration(EE_Registration $registration, $extra_details = array())
+	{
+
+		if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+			//no messages please
+			return;
+		}
+
+		// get all non-trashed registrations so we make sure we send messages for the right status.
+		$all_registrations = $registration->transaction()->registrations(
+			array(
+				array('REG_deleted' => false),
+				'order_by' => array(
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC'
+				)
+			)
+		);
+		//cached array of statuses so we only trigger messages once per status.
+		$statuses_sent = array();
+		self::_load_controller();
+		$mtgs = array();
+
+		//loop through registrations and trigger messages once per status.
+		foreach ($all_registrations as $reg) {
+
+			//already triggered?
+			if (in_array($reg->status_ID(), $statuses_sent)) {
+				continue;
+			}
+
+			$message_type    = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
+			$mtgs            = array_merge(
+					$mtgs,
+					self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+							$message_type,
+							array($registration->transaction(), null, $reg->status_ID())
+					)
+			);
+			$statuses_sent[] = $reg->status_ID();
+		}
+
+		if (count($statuses_sent) > 1) {
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					'registration_summary',
+					array($registration->transaction(), null)
+				)
+			);
+		}
+
+		//batch queue and initiate request
+		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
+		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+	}
+
+
+	/**
+	 * This is a helper method used to very whether a registration notification should be sent or
+	 * not.  Prevents duplicate notifications going out for registration context notifications.
+	 *
+	 * @param EE_Registration $registration  [description]
+	 * @param array           $extra_details [description]
+	 * @return bool          true = send away, false = nope halt the presses.
+	 */
+	protected static function _verify_registration_notification_send(
+		EE_Registration $registration,
+		$extra_details = array()
+	) {
+		//self::log(
+		//	__CLASS__, __FUNCTION__, __LINE__,
+		//	$registration->transaction(),
+		//	array( '$extra_details' => $extra_details )
+		//);
+		// currently only using this to send messages for the primary registrant
+		if (! $registration->is_primary_registrant()) {
+			return false;
+		}
+		// first we check if we're in admin and not doing front ajax
+		if (is_admin() && ! EE_FRONT_AJAX) {
+			//make sure appropriate admin params are set for sending messages
+			if (empty($_REQUEST['txn_reg_status_change']['send_notifications']) || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])) {
+				//no messages sent please.
+				return false;
+			}
+		} else {
+			// frontend request (either regular or via AJAX)
+			// TXN is NOT finalized ?
+			if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
+				return false;
+			}
+			// return visit but nothing changed ???
+			if (
+				isset($extra_details['revisit'], $extra_details['status_updates']) &&
+				$extra_details['revisit'] && ! $extra_details['status_updates']
+			) {
+				return false;
+			}
+			// NOT sending messages && reg status is something other than "Not-Approved"
+			if (
+				! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
+				$registration->status_ID() !== EEM_Registration::status_id_not_approved
+			) {
+				return false;
+			}
+		}
+		// release the kraken
+		return true;
+	}
+
+
+	/**
+	 * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
+	 * status id.
+	 *
+	 * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
+	 *                    or EEH_MSG_Template::convert_reg_status_to_message_type
+	 * @param string $reg_status
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_reg_status_array($reg_status = '')
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			: EEH_MSG_Template::reg_status_to_message_type_array();
+	}
+
+
+	/**
+	 * Simply returns the payment message type for the given payment status.
+	 *
+	 * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
+	 *                   or EEH_MSG_Template::convert_payment_status_to_message_type
+	 * @param string $payment_status The payment status being matched.
+	 * @return bool|string The payment message type slug matching the status or false if no match.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_payment_message_type($payment_status)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			: false;
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @access public
+	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function process_resend($req_data)
+	{
+		self::_load_controller();
+
+		//if $msgID in this request then skip to the new resend_message
+		if (EE_Registry::instance()->REQ->get('MSG_ID')) {
+			return self::resend_message();
+		}
+
+		//make sure any incoming request data is set on the REQ so that it gets picked up later.
+		$req_data = (array)$req_data;
+		foreach ($req_data as $request_key => $request_value) {
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
+		}
+
+		if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request()) {
+			return false;
+		}
+
+		try {
+			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
+			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Error::add_success(
+			__('Messages have been successfully queued for generation and sending.', 'event_espresso')
+		);
+		return true; //everything got queued.
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function resend_message()
+	{
+		self::_load_controller();
+
+		$msgID = EE_Registry::instance()->REQ->get('MSG_ID');
+		if (! $msgID) {
+			EE_Error::add_error(__('Something went wrong because there is no "MSG_ID" value in the request',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array)$msgID);
+
+		//setup success message.
+		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+		EE_Error::add_success(sprintf(
+			_n(
+				'There was %d message queued for resending.',
+				'There were %d messages queued for resending.',
+				$count_ready_for_resend,
+				'event_espresso'
+			),
+			$count_ready_for_resend
+		));
+		return true;
+	}
+
+
+	/**
+	 * Message triggers for manual payment applied by admin
+	 *
+	 * @param  EE_Payment $payment EE_payment object
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function process_admin_payment(EE_Payment $payment)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		//we need to get the transaction object
+		$transaction = $payment->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$data         = array($transaction, $payment);
+			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+
+			//if payment amount is less than 0 then switch to payment_refund message type.
+			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+
+			//if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
+			$message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved ? false : $message_type;
+
+			self::_load_controller();
+
+			self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+
+			//get count of queued for generation
+			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(array(
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+			));
+
+			if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
+				add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+				return true;
+			} else {
+				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::instance()->stati_indicating_failed_sending());
+				/**
+				 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
+				 * IMMEDIATE generation.
+				 */
+				if ($count_failed > 0) {
+					EE_Error::add_error(sprintf(
+						_n(
+							'The payment notification generation failed.',
+							'%d payment notifications failed being sent.',
+							$count_failed,
+							'event_espresso'
+						),
+						$count_failed
+					), __FILE__, __FUNCTION__, __LINE__);
+
+					return false;
+				} else {
+					add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+					return true;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				'Unable to generate the payment notification because the given value for the transaction is invalid.',
+				'event_espresso'
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
+	 *
+	 * @since   4.3.0
+	 * @param  EE_Registration[] $registrations an array of EE_Registration objects
+	 * @param  int               $grp_id        a specific message template group id.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_newsletter_message($registrations, $grp_id)
+	{
+		//make sure mtp is id and set it in the EE_Request Handler later messages setup.
+		EE_Registry::instance()->REQ->set('GRP_ID', (int)$grp_id);
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
+	 *
+	 * @since   4.3.0
+	 * @param    string          $registration_message_trigger_url
+	 * @param    EE_Registration $registration
+	 * @param string             $messenger
+	 * @param string             $message_type
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function registration_message_trigger_url(
+		$registration_message_trigger_url,
+		EE_Registration $registration,
+		$messenger = 'html',
+		$message_type = 'invoice'
+	) {
+		// whitelist $messenger
+		switch ($messenger) {
+			case 'pdf' :
+				$sending_messenger    = 'pdf';
+				$generating_messenger = 'html';
+				break;
+			case 'html' :
+			default :
+				$sending_messenger    = 'html';
+				$generating_messenger = 'html';
+				break;
+		}
+		// whitelist $message_type
+		switch ($message_type) {
+			case 'receipt' :
+				$message_type = 'receipt';
+				break;
+			case 'invoice' :
+			default :
+				$message_type = 'invoice';
+				break;
+		}
+		// verify that both the messenger AND the message type are active
+		if (EEH_MSG_Template::is_messenger_active($sending_messenger) && EEH_MSG_Template::is_mt_active($message_type)) {
+			//need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
+			$template_query_params = array(
+				'MTP_is_active'    => true,
+				'MTP_messenger'    => $generating_messenger,
+				'MTP_message_type' => $message_type,
+				'Event.EVT_ID'     => $registration->event_ID(),
+			);
+			//get the message template group.
+			$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			//if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				// remove EVT_ID from query params so that global templates get picked up
+				unset($template_query_params['Event.EVT_ID']);
+				//get global template as the fallback
+				$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			}
+			//if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				return '';
+			}
+			// generate the URL
+			$registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
+				$sending_messenger,
+				$generating_messenger,
+				'purchaser',
+				$message_type,
+				$registration,
+				$msg_template_group->ID(),
+				$registration->transaction_ID()
+			);
+
+		}
+		return $registration_message_trigger_url;
+	}
+
+
+	/**
+	 * Use to generate and return a message preview!
+	 *
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return bool|string The body of the message or if send is requested, sends.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function preview_message($type, $context, $messenger, $send = false)
+	{
+		self::_load_controller();
+		$mtg                     = new EE_Message_To_Generate(
+			$messenger,
+			$type,
+			array(),
+			$context,
+			true
+		);
+		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
+		if ($generated_preview_queue instanceof EE_Messages_Queue) {
+			//loop through all content for the preview and remove any persisted records.
+			$content = '';
+			foreach ($generated_preview_queue->get_message_repository() as $message) {
+				$content = $message->content();
+				if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
+					$message->delete();
+				}
+			}
+			return $content;
+		} else {
+			return $generated_preview_queue;
+		}
+	}
+
+
+	/**
+	 * This is a method that allows for sending a message using a messenger matching the string given and the provided
+	 * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
+	 * content found in the EE_Message objects in the queue.
+	 *
+	 * @since 4.9.0
+	 * @param string            $messenger            a string matching a valid active messenger in the system
+	 * @param string            $message_type         Although it seems contrary to the name of the method, a message
+	 *                                                type name is still required to send along the message type to the
+	 *                                                messenger because this is used for determining what specific
+	 *                                                variations might be loaded for the generated message.
+	 * @param EE_Messages_Queue $queue
+	 * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
+	 *                                                aggregate EE_Message object.
+	 * @return bool success or fail.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function send_message_with_messenger_only(
+		$messenger,
+		$message_type,
+		EE_Messages_Queue $queue,
+		$custom_subject = ''
+	) {
+		self::_load_controller();
+		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
+		$message_to_generate = EE_Registry::instance()->load_lib(
+			'Message_To_Generate_From_Queue',
+			array(
+				$messenger,
+				$message_type,
+				$queue,
+				$custom_subject,
+			)
+		);
+		return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
+	}
+
+
+	/**
+	 * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of message ids
+	 * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
+	 *                           messages.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_now($message_ids)
+	{
+		self::_load_controller();
+		$messages        = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => EEM_Message::status_incomplete,
+				),
+			)
+		);
+		$generated_queue = false;
+		if ($messages) {
+			$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
+		}
+
+		if (! $generated_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__('The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return $generated_queue;
+	}
+
+
+	/**
+	 * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
+	 * EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 * @param $message_ids
+	 * @return bool|EE_Messages_Queue false if no messages sent.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_now($message_ids)
+	{
+		self::_load_controller();
+		$messages   = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
+					),
+				),
+			)
+		);
+		$sent_queue = false;
+		if ($messages) {
+			$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
+		}
+
+		if (! $sent_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__('The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		} else {
+			//can count how many sent by using the messages in the queue
+			$sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
+			if ($sent_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'There was %d message successfully sent.',
+							'There were %d messages successfully sent.',
+							$sent_count,
+							'event_espresso'
+						),
+						$sent_count
+					)
+				);
+			} else {
+				EE_Error::overwrite_errors();
+				EE_Error::add_error(
+					__('No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
 					If there was an error, you can look at the messages in the message activity list table for any error messages.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        }
-        return $sent_queue;
-    }
-
-
-    /**
-     * Generate and send immediately from the given $message_ids
-     *
-     * @param array $message_ids EE_Message entity ids.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_and_send_now(array $message_ids)
-    {
-        $generated_queue = self::generate_now($message_ids);
-        //now let's just trigger sending immediately from this queue.
-        $messages_sent = $generated_queue->execute();
-        if ($messages_sent) {
-            EE_Error::add_success(
-                esc_html(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully generated and sent.',
-                            'There were %d messages successfully generated and sent.',
-                            $messages_sent,
-                            'event_espresso'
-                        ),
-                        $messages_sent
-                    )
-                )
-            );
-            //errors would be added via the generate_now method.
-        }
-    }
-
-
-    /**
-     * This will queue the incoming message ids for resending.
-     * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of EE_Message IDs
-     * @return bool true means messages were successfully queued for resending, false means none were queued for
-     *                           resending.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function queue_for_resending($message_ids)
-    {
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
-
-        //get queue and count
-        $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-
-        if (
-            $queue_count > 0
-        ) {
-            EE_Error::add_success(
-                sprintf(
-                    _n(
-                        '%d message successfully queued for resending.',
-                        '%d messages successfully queued for resending.',
-                        $queue_count,
-                        'event_espresso'
-                    ),
-                    $queue_count
-                )
-            );
-            /**
-             * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
-             */
-        } elseif (
-            apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
-            if ($queue_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            '%d message successfully sent.',
-                            '%d messages successfully sent.',
-                            $queue_count,
-                            'event_espresso'
-                        ),
-                        $queue_count
-                    )
-                );
-            } else {
-                EE_Error::add_error(
-                    __('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                        'event_espresso'),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                __('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                    'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return (bool)$queue_count;
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string          $class
-     * @param string          $func
-     * @param string          $line
-     * @param \EE_Transaction $transaction
-     * @param array           $info
-     * @param bool            $display_request
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    protected static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        EE_Transaction $transaction,
-        $info = array(),
-        $display_request = false
-    ) {
-        if (defined('EE_DEBUG') && EE_DEBUG) {
-            if ($transaction instanceof EE_Transaction) {
-                // don't serialize objects
-                $info                  = EEH_Debug_Tools::strip_objects($info);
-                $info['TXN_status']    = $transaction->status_ID();
-                $info['TXN_reg_steps'] = $transaction->reg_steps();
-                if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
-                }
-            }
-        }
-
-    }
-
-
-    /**
-     *  Resets all the static properties in this class when called.
-     */
-    public static function reset()
-    {
-        self::$_EEMSG                    = null;
-        self::$_message_resource_manager = null;
-        self::$_MSG_PROCESSOR            = null;
-        self::$_MSG_PATHS                = null;
-        self::$_TMP_PACKS                = array();
-    }
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		}
+		return $sent_queue;
+	}
+
+
+	/**
+	 * Generate and send immediately from the given $message_ids
+	 *
+	 * @param array $message_ids EE_Message entity ids.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_and_send_now(array $message_ids)
+	{
+		$generated_queue = self::generate_now($message_ids);
+		//now let's just trigger sending immediately from this queue.
+		$messages_sent = $generated_queue->execute();
+		if ($messages_sent) {
+			EE_Error::add_success(
+				esc_html(
+					sprintf(
+						_n(
+							'There was %d message successfully generated and sent.',
+							'There were %d messages successfully generated and sent.',
+							$messages_sent,
+							'event_espresso'
+						),
+						$messages_sent
+					)
+				)
+			);
+			//errors would be added via the generate_now method.
+		}
+	}
+
+
+	/**
+	 * This will queue the incoming message ids for resending.
+	 * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of EE_Message IDs
+	 * @return bool true means messages were successfully queued for resending, false means none were queued for
+	 *                           resending.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function queue_for_resending($message_ids)
+	{
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
+
+		//get queue and count
+		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+
+		if (
+			$queue_count > 0
+		) {
+			EE_Error::add_success(
+				sprintf(
+					_n(
+						'%d message successfully queued for resending.',
+						'%d messages successfully queued for resending.',
+						$queue_count,
+						'event_espresso'
+					),
+					$queue_count
+				)
+			);
+			/**
+			 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
+			 */
+		} elseif (
+			apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
+			if ($queue_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'%d message successfully sent.',
+							'%d messages successfully sent.',
+							$queue_count,
+							'event_espresso'
+						),
+						$queue_count
+					)
+				);
+			} else {
+				EE_Error::add_error(
+					__('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+						'event_espresso'),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				__('No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+					'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return (bool)$queue_count;
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string          $class
+	 * @param string          $func
+	 * @param string          $line
+	 * @param \EE_Transaction $transaction
+	 * @param array           $info
+	 * @param bool            $display_request
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	protected static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		EE_Transaction $transaction,
+		$info = array(),
+		$display_request = false
+	) {
+		if (defined('EE_DEBUG') && EE_DEBUG) {
+			if ($transaction instanceof EE_Transaction) {
+				// don't serialize objects
+				$info                  = EEH_Debug_Tools::strip_objects($info);
+				$info['TXN_status']    = $transaction->status_ID();
+				$info['TXN_reg_steps'] = $transaction->reg_steps();
+				if ($transaction->ID()) {
+					$index = 'EE_Transaction: ' . $transaction->ID();
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
+				}
+			}
+		}
+
+	}
+
+
+	/**
+	 *  Resets all the static properties in this class when called.
+	 */
+	public static function reset()
+	{
+		self::$_EEMSG                    = null;
+		self::$_message_resource_manager = null;
+		self::$_MSG_PROCESSOR            = null;
+		self::$_MSG_PATHS                = null;
+		self::$_TMP_PACKS                = array();
+	}
 
 }
 // End of file EED_Messages.module.php

admin_pages/messages/Messages_Admin_Page.core.php

Indentation +4060 added lines, -4060 removed lines

@@ -5,7 +5,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -23,2559 +23,2559 @@ 
 class Messages_Admin_Page extends EE_Admin_Page
 {
     
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
     
-    /**
-     * @type string $_active_message_type_name
-     */
-    protected $_active_message_type_name = '';
+	/**
+	 * @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();
+	/**
+	 * @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();
+	/**
+	 * @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 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;
+	/**
+	 * 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
-     * @throws EE_Error
-     */
-    public function __construct($routing = true)
-    {
-        //make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 */
+	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       = esc_html__('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();
-    }
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MSG_PG_SLUG;
+		$this->page_label       = esc_html__('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
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    '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 %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_messengers_select_input()'
-            ),
-            '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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'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 %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_messengers_select_input()'
+			),
+			'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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    '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 %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_message_types_select_input()'
-            ),
-            '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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'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 %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_message_types_select_input()'
+			),
+			'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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    '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 %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
-            ),
-            '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;
-    }
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'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 %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
+			),
+			'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
-     * @throws EE_Error
-     */
-    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' => esc_html__('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 messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	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' => esc_html__('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
-     * @throws EE_Error
-     */
-    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' => esc_html__('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 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
+	 * @throws EE_Error
+	 */
+	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' => esc_html__('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
-     * @throws EE_Error
-     */
-    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' => esc_html__('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();
-    }
+	/**
+	 * 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
+	 * @throws EE_Error
+	 */
+	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' => esc_html__('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'));
-        add_action('wp_ajax_toggle_context_template', array($this, 'toggle_context_template'));
-    }
+	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'));
+		add_action('wp_ajax_toggle_context_template', array($this, 'toggle_context_template'));
+	}
     
     
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = array(
-            'buttons'    => array(
-                'add'    => esc_html__('Add New Message Template', 'event_espresso'),
-                'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
-                'delete' => esc_html__('Delete Message Template', 'event_espresso')
-            ),
-            'publishbox' => esc_html__('Update Actions', 'event_espresso')
-        );
-    }
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = array(
+			'buttons'    => array(
+				'add'    => esc_html__('Add New Message Template', 'event_espresso'),
+				'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
+				'delete' => esc_html__('Delete Message Template', 'event_espresso')
+			),
+			'publishbox' => esc_html__('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_messages',
-                'noheader'   => true
-            ),
-            'delete_ee_messages'               => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $msg_id
-            )
-        );
-    }
+	/**
+	 *        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_messages',
+				'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' => esc_html__('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' => esc_html__('Default Message Templates', 'event_espresso'),
-                    'order' => 20
-                ),
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => array(
-                    'messages_overview_help_tab'                                => array(
-                        'title'    => esc_html__('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview'
-                    ),
-                    'messages_overview_messages_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings'
-                    ),
-                    'messages_overview_messages_filters_help_tab'               => array(
-                        'title'    => esc_html__('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters'
-                    ),
-                    'messages_overview_messages_views_help_tab'                 => array(
-                        'title'    => esc_html__('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views'
-                    ),
-                    'message_overview_message_types_help_tab'                   => array(
-                        'title'    => esc_html__('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types'
-                    ),
-                    'messages_overview_messengers_help_tab'                     => array(
-                        'title'    => esc_html__('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ),
-                ),
-                'help_tour'     => array('Messages_Overview_Help_Tour'),
-                'require_nonce' => false
-            ),
-            'custom_mtps'              => array(
-                'nav'           => array(
-                    'label' => esc_html__('Custom Message Templates', 'event_espresso'),
-                    'order' => 30
-                ),
-                'help_tabs'     => array(),
-                'help_tour'     => array(),
-                'require_nonce' => false
-            ),
-            'add_new_message_template' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false
-                ),
-                'require_nonce' => false
-            ),
-            'edit_message_template'    => array(
-                'labels'        => array(
-                    'buttons'    => array(
-                        'reset' => esc_html__('Reset Templates'),
-                    ),
-                    'publishbox' => esc_html__('Update Actions', 'event_espresso')
-                ),
-                'nav'           => array(
-                    'label'      => esc_html__('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'    => esc_html__('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab'
-                    ),
-                    'message_templates_help_tab'  => array(
-                        'title'    => esc_html__('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates'
-                    ),
-                    'message_template_shortcodes' => array(
-                        'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab'
-                    ),
-                    'message_preview_help_tab'    => array(
-                        'title'    => esc_html__('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview'
-                    ),
-                    'messages_overview_other_help_tab'                          => array(
-                        'title'    => esc_html__('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ),
-                ),
-                'require_nonce' => false
-            ),
-            'display_preview_message'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Message Preview', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false
-                ),
-                'help_tabs'     => array(
-                    'preview_message' => array(
-                        'title'    => esc_html__('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab'
-                    )
-                ),
-                'require_nonce' => false
-            ),
-            'settings'                 => array(
-                'nav'           => array(
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'order' => 40
-                ),
-                'metaboxes'     => array('_messages_settings_metaboxes'),
-                'help_tabs'     => array(
-                    'messages_settings_help_tab'               => array(
-                        'title'    => esc_html__('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings'
-                    ),
-                    'messages_settings_message_types_help_tab' => array(
-                        'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types'
-                    ),
-                    'messages_settings_messengers_help_tab'    => array(
-                        'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers'
-                    ),
-                ),
-                'help_tour'     => array('Messages_Settings_Help_Tour'),
-                'require_nonce' => false
-            )
-        );
-    }
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                  => array(
+				'nav'           => array(
+					'label' => esc_html__('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' => esc_html__('Default Message Templates', 'event_espresso'),
+					'order' => 20
+				),
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => array(
+					'messages_overview_help_tab'                                => array(
+						'title'    => esc_html__('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview'
+					),
+					'messages_overview_messages_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings'
+					),
+					'messages_overview_messages_filters_help_tab'               => array(
+						'title'    => esc_html__('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters'
+					),
+					'messages_overview_messages_views_help_tab'                 => array(
+						'title'    => esc_html__('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views'
+					),
+					'message_overview_message_types_help_tab'                   => array(
+						'title'    => esc_html__('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types'
+					),
+					'messages_overview_messengers_help_tab'                     => array(
+						'title'    => esc_html__('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					),
+				),
+				'help_tour'     => array('Messages_Overview_Help_Tour'),
+				'require_nonce' => false
+			),
+			'custom_mtps'              => array(
+				'nav'           => array(
+					'label' => esc_html__('Custom Message Templates', 'event_espresso'),
+					'order' => 30
+				),
+				'help_tabs'     => array(),
+				'help_tour'     => array(),
+				'require_nonce' => false
+			),
+			'add_new_message_template' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false
+				),
+				'require_nonce' => false
+			),
+			'edit_message_template'    => array(
+				'labels'        => array(
+					'buttons'    => array(
+						'reset' => esc_html__('Reset Templates'),
+					),
+					'publishbox' => esc_html__('Update Actions', 'event_espresso')
+				),
+				'nav'           => array(
+					'label'      => esc_html__('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'    => esc_html__('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab'
+					),
+					'message_templates_help_tab'  => array(
+						'title'    => esc_html__('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates'
+					),
+					'message_template_shortcodes' => array(
+						'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab'
+					),
+					'message_preview_help_tab'    => array(
+						'title'    => esc_html__('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview'
+					),
+					'messages_overview_other_help_tab'                          => array(
+						'title'    => esc_html__('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					),
+				),
+				'require_nonce' => false
+			),
+			'display_preview_message'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Message Preview', 'event_espresso'),
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false
+				),
+				'help_tabs'     => array(
+					'preview_message' => array(
+						'title'    => esc_html__('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab'
+					)
+				),
+				'require_nonce' => false
+			),
+			'settings'                 => array(
+				'nav'           => array(
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'order' => 40
+				),
+				'metaboxes'     => array('_messages_settings_metaboxes'),
+				'help_tabs'     => array(
+					'messages_settings_help_tab'               => array(
+						'title'    => esc_html__('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings'
+					),
+					'messages_settings_message_types_help_tab' => array(
+						'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types'
+					),
+					'messages_settings_messengers_help_tab'    => array(
+						'title'    => esc_html__('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()
+	{
+		//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 = esc_html__('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
+	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 = esc_html__('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 = esc_html__('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
     
     
-    //none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
+	//none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
     
-    public function admin_init()
-    {
-    }
+	public function admin_init()
+	{
+	}
     
-    public function admin_notices()
-    {
-    }
+	public function admin_notices()
+	{
+	}
     
-    public function admin_footer_scripts()
-    {
-    }
+	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 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 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 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 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 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 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 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 class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox" checked="checked">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        $args['img4'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        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 class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox" checked="checked">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		$args['img4'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		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');
-        
-        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()
+	{
+		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);
+	}
     
     
-    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);
-        }
-        
-        return $mce_css;
-    }
+			//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;
+	}
     
     
-    public function load_scripts_styles_edit_message_template()
-    {
-        
-        $this->_set_shortcodes();
-        
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
-            esc_html__(
-                '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'] = esc_html__(
-            '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['server_error'] = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        
-        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');
-        
-        //add in special css for tiny_mce
-        add_filter('mce_css', array($this, 'wp_editor_css'));
-    }
+	public function load_scripts_styles_edit_message_template()
+	{
+        
+		$this->_set_shortcodes();
+        
+		EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+			esc_html__(
+				'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'] = esc_html__(
+			'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['server_error'] = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+        
+		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');
+        
+		//add in special css for tiny_mce
+		add_filter('mce_css', array($this, 'wp_editor_css'));
+	}
     
     
-    public function load_scripts_styles_display_preview_message()
-    {
-        
-        $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']
-            );
-        }
-        
-        $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
-            )
-        );
-    }
+	public function load_scripts_styles_display_preview_message()
+	{
+        
+		$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']
+			);
+		}
+        
+		$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
+			)
+		);
+	}
     
     
-    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');
-    }
+	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');
+	}
     
     
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'        => 'in_use',
-                'label'       => esc_html__('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'       => esc_html__('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 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
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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'          => esc_html__('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
-                'send_now'              => esc_html__('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' => esc_html__('Delete Messages', 'event_espresso'))
-            : array();
-        
-        
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('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 message queue list table
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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'          => esc_html__('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
+				'send_now'              => esc_html__('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' => esc_html__('Delete Messages', 'event_espresso'))
+			: array();
+        
+        
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('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)
-            );
-        }
-    }
+			$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 = esc_html__('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
     
     
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label                   = esc_html__('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_queue_list_table()
+	{
+		$this->_search_btn_label                   = esc_html__('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 _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              = esc_html__('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>'
-            . esc_html__(
-                '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>';
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title              = esc_html__('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>'
+			. esc_html__(
+				'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);
-    }
+		$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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
-            default:
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
-        }
-        
-        return $templates;
-    }
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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;
+			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;
-    }
+	/**
+	 * 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(
-                esc_html__(
-                    '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(
-                esc_html__(
-                    '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);
-    }
+	/**
+	 * _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(
+				esc_html__(
+					'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(
+				esc_html__(
+					'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.
-     * @throws EE_error
-     */
-    public function add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
-    }
+	/**
+	 * 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.
+	 * @throws EE_error
+	 */
+	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
-     * @throws InvalidIdentifierException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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';
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        } else {
-            $action = 'update_message_template';
-            $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(
-            esc_html__('(%s %s)', 'event_espresso'),
-            $c_config[$context]['label'],
-            ucwords($c_label['label'])
-        );
-        
-        $title = sprintf(
-            esc_html__(' %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          = esc_html__(
-                '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;
-                                }
-                            }
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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';
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		} else {
+			$action = 'update_message_template';
+			$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(
+			esc_html__('(%s %s)', 'event_espresso'),
+			$c_config[$context]['label'],
+			ucwords($c_label['label'])
+		);
+        
+		$title = sprintf(
+			esc_html__(' %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          = esc_html__(
+				'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, true)
-                                &&
-                                (
-                                    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, true)
+								&&
+								(
+									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, true)
-                                                                    && 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, true)
+																	&& 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'      => esc_html__('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'      => esc_html__('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'      => esc_html__('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'      => esc_html__('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'      => esc_html__('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'      => esc_html__('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'      => esc_html__('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'      => esc_html__('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) )
-        
-        //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">'
-                          . esc_html__('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_active_context_element(
-            $message_template_group,
-            $context,
-            $context_label
-        );
-        $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();
-    }
+		} //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">'
+						  . esc_html__('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_active_context_element(
+			$message_template_group,
+			$context,
+			$context_label
+		);
+		$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 filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
     
     
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
 
 
-    /**
-     * Adds the activation/deactivation toggle for the message template context.
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @param string                    $context
-     * @param string                    $context_label
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    protected function add_active_context_element(
-        EE_Message_Template_Group $message_template_group,
-        $context,
-        $context_label
-    ) {
-        $template_args = array(
-            'context' => $context,
-            'nonce' => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
-            'is_active' => $message_template_group->is_context_active($context),
-            'on_off_action' => $message_template_group->is_context_active($context)
-                ? 'context-off'
-                : 'context-on',
-            'context_label' => str_replace(array('(', ')'), '', $context_label),
-            'message_template_group_id' => $message_template_group->ID()
-        );
-        return EEH_Template::display_template(
-          EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
-          $template_args,
-          true
-        );
-    }
+	/**
+	 * Adds the activation/deactivation toggle for the message template context.
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @param string                    $context
+	 * @param string                    $context_label
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	protected function add_active_context_element(
+		EE_Message_Template_Group $message_template_group,
+		$context,
+		$context_label
+	) {
+		$template_args = array(
+			'context' => $context,
+			'nonce' => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
+			'is_active' => $message_template_group->is_context_active($context),
+			'on_off_action' => $message_template_group->is_context_active($context)
+				? 'context-off'
+				: 'context-on',
+			'context_label' => str_replace(array('(', ')'), '', $context_label),
+			'message_template_group_id' => $message_template_group->ID()
+		);
+		return EEH_Template::display_template(
+		  EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
+		  $template_args,
+		  true
+		);
+	}
 
 
-    /**
-     * Ajax callback for `toggle_context_template` ajax action.
-     * Handles toggling the message context on or off.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_context_template()
-    {
-        $success = true;
-        //check for required data
-        if (!isset(
-            $this->_req_data['message_template_group_id'],
-            $this->_req_data['context'],
-            $this->_req_data['status']
-        )) {
-            EE_Error::add_error(
-                esc_html__('Required data for doing this action is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
+	/**
+	 * Ajax callback for `toggle_context_template` ajax action.
+	 * Handles toggling the message context on or off.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_context_template()
+	{
+		$success = true;
+		//check for required data
+		if (!isset(
+			$this->_req_data['message_template_group_id'],
+			$this->_req_data['context'],
+			$this->_req_data['status']
+		)) {
+			EE_Error::add_error(
+				esc_html__('Required data for doing this action is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
 
-        $nonce = isset($this->_req_data['toggle_context_nonce'])
-            ? sanitize_text_field($this->_req_data['toggle_context_nonce'])
-            : '';
-        $nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        $status = $this->_req_data['status'];
-        if ($status !== 'off' && $status !=='on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-            $this->_req_data['message_template_group_id']
-        );
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['message_template_group_id'],
-                    'EE_Message_Template_Group'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            $success = $status === 'off'
-                ? $message_template_group->deactivate_context($this->_req_data['context'])
-                : $message_template_group->activate_context($this->_req_data['context']);
-        }
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
+		$nonce = isset($this->_req_data['toggle_context_nonce'])
+			? sanitize_text_field($this->_req_data['toggle_context_nonce'])
+			: '';
+		$nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		$status = $this->_req_data['status'];
+		if ($status !== 'off' && $status !=='on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+			$this->_req_data['message_template_group_id']
+		);
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
+						'event_espresso'
+					),
+					$this->_req_data['message_template_group_id'],
+					'EE_Message_Template_Group'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			$success = $status === 'off'
+				? $message_template_group->deactivate_context($this->_req_data['context'])
+				: $message_template_group->activate_context($this->_req_data['context']);
+		}
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
 
 
     
-    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_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>';
-    }
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
 
 
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    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(
-                esc_html__('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);
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	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(
+				esc_html__('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(
-                    esc_html__(
-                        '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(
-                        esc_html__(
-                            '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(
+					esc_html__(
+						'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(
+						esc_html__(
+							'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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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(
-                esc_html__(
-                    '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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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(
+				esc_html__(
+					'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(
-                esc_html__('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)) {
-            //the info for the template we generated is the first element in the returned array
-            // $templates = $templates[0];
-            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(
+				esc_html__('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)) {
+			//the info for the template we generated is the first element in the returned array
+			// $templates = $templates[0];
+			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;
-        }
-    }
+			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
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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(
-                esc_html__('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">'
-                                  . esc_html__('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(
-            esc_html__('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 '';
-    }
+	/**
+	 * 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
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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(
+				esc_html__('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">'
+								  . esc_html__('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(
+			esc_html__('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();
-    }
+	/**
+	 * 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',
-            esc_html__('Valid Shortcodes', 'event_espresso'),
-            array($this, 'shortcode_meta_box'),
-            $this->_current_screen->id,
-            'side',
-            'default');
-        add_meta_box(
-            'mtp_extra_actions',
-            esc_html__('Extra Actions', 'event_espresso'),
-            array($this, 'extra_actions_meta_box'),
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-        add_meta_box(
-            'mtp_templates',
-            esc_html__('Template Styles', 'event_espresso'),
-            array($this, 'template_pack_meta_box'),
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
+	/**
+	 * 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',
+			esc_html__('Valid Shortcodes', 'event_espresso'),
+			array($this, 'shortcode_meta_box'),
+			$this->_current_screen->id,
+			'side',
+			'default');
+		add_meta_box(
+			'mtp_extra_actions',
+			esc_html__('Extra Actions', 'event_espresso'),
+			array($this, 'extra_actions_meta_box'),
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+		add_meta_box(
+			'mtp_templates',
+			esc_html__('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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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()],
-                    true
-                )
-            ) {
-                //not supported
-                continue;
-            }
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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()],
+					true
+				)
+			) {
+				//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' => esc_html__('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);
-    }
+			$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' => esc_html__('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;
+	/**
+	 * 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 .= esc_html__('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-        
-        //and button
-        $test_settings_html .= '<p>'
-                               . esc_html__('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;
-    }
+				$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 .= esc_html__('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+        
+		//and button
+		$test_settings_html .= '<p>'
+							   . esc_html__('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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 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
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            echo $content;
-        } else {
-            //$alt = 0;
-            ?>
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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>' . esc_html__('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(
-                    esc_html__(
-                        '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>
+					esc_html__(
+						'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>
             <?php
-        }
+		}
         
         
-    }
+	}
 
 
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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();
-    }
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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();
-    }
+	/**
+	 * 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.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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();
-        
-    }
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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.
-     * @throws EE_Error
-     */
-    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();
-        ?>
+	/**
+	 * 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.
+	 * @throws EE_Error
+	 */
+	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>
@@ -2588,1838 +2588,1838 @@ 
             <?php echo $args['extra']; ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php
-        $output = ob_get_contents();
-        ob_clean();
-        $this->_context_switcher = $output;
-    }
+		$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;
-            }
-        }
-        
-        
-        $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;
-    }
+	/**
+	 * 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;
+			}
+		}
+        
+        
+		$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();
+	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(
-                    esc_html__(
-                        '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(
+					esc_html__(
+						'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(
-                                        esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
-                                        $template_field
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                            } else {
-                                $success = 1;
-                            }
-                        } else {
-                            //only do this logic if we don't have a MTP_ID for this field
-                            if (empty($this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'])) {
-                                //this has already been through the template field validator and sanitized, so it will be
-                                //safe to insert this field.  Why insert?  This typically happens when we introduce a new
-                                //message template field in a messenger/message type and existing users don't have the
-                                //default setup for it.
-                                //@link https://events.codebasehq.com/projects/event-espresso/tickets/9465
-                                $updated = $MTP->insert($message_template_fields);
-                                if (! $updated || is_wp_error($updated)) {
-                                    EE_Error::add_error(
-                                        sprintf(
-                                            esc_html__('%s field could not be updated.', 'event_espresso'),
-                                            $template_field
-                                        ),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    $success = 0;
-                                } 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(
+										esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
+										$template_field
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+							} else {
+								$success = 1;
+							}
+						} else {
+							//only do this logic if we don't have a MTP_ID for this field
+							if (empty($this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'])) {
+								//this has already been through the template field validator and sanitized, so it will be
+								//safe to insert this field.  Why insert?  This typically happens when we introduce a new
+								//message template field in a messenger/message type and existing users don't have the
+								//default setup for it.
+								//@link https://events.codebasehq.com/projects/event-espresso/tickets/9465
+								$updated = $MTP->insert($message_template_fields);
+								if (! $updated || is_wp_error($updated)) {
+									EE_Error::add_error(
+										sprintf(
+											esc_html__('%s field could not be updated.', 'event_espresso'),
+											$template_field
+										),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									$success = 0;
+								} 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(
-                                esc_html__(
-                                    '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(
+								esc_html__(
+									'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(
-                    esc_html__(
-                        '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(
+					esc_html__(
+						'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);
-    }
+			$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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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(
-                esc_html__('The test message was not sent', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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(
+				esc_html__('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);
-    }
+	/**
+	 * _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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
+	/**
+	 * [_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
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
         
-        $action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched') : $action_desc;
+		$action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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;
             
-            //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());
-        
-    }
+			//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.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
-    }
+	/**
+	 * 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.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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;" >'
-               . esc_html__('learn more about how message templates works', 'event_espresso')
-               . '</a>';
-    }
+	/**
+	 *    _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;" >'
+			   . esc_html__('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
-     * @throws DomainException
-     */
-    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();
-        
-    }
+	/**
+	 * 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
+	 * @throws DomainException
+	 */
+	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
-     * @throws DomainException
-     */
-    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;
-        }
-        
-        //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' => esc_html__('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger
-            );
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	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;
+		}
+        
+		//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' => esc_html__('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, true)) {
-                    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, true)) {
+					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'
-                        ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : esc_html__('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',
-                    'obj'      => $message_type
-                );
-            }
-        }
-    }
+				$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'
+						? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: esc_html__('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',
+					'obj'      => $message_type
+				);
+			}
+		}
+	}
 
 
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param  EE_message_type  $message_type The message type object
-     * @param  EE_messenger  $messenger    The messenger object
-     * @param  boolean $active       Whether the message type is active or not
-     * @return string html output for the content
-     * @throws DomainException
-     */
-    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 just prepares the content for the message type settings
+	 *
+	 * @param  EE_message_type  $message_type The message type object
+	 * @param  EE_messenger  $messenger    The messenger object
+	 * @param  boolean $active       Whether the message type is active or not
+	 * @return string html output for the content
+	 * @throws DomainException
+	 */
+	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;
-    }
+			$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
-     * @throws DomainException
-     */
-    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;
-                $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(
-                    esc_html__('%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']         = esc_html__('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',
-                esc_html__('Global Message Settings', 'event_espresso'),
-                array($this, 'global_messages_settings_metabox_content'),
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                array()
-            );
-        }
-        
-    }
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	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;
+				$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(
+					esc_html__('%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']         = esc_html__('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',
+				esc_html__('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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 the content for the global messages settings metabox.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 generates and returns the form object for the global messages settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    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 handles updating the global settings set on the admin page.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	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
-     * @throws DomainException
-     */
-    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 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
+	 * @throws DomainException
+	 */
+	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
-     * @throws DomainException
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
+	/**
+	 * 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
+	 * @throws DomainException
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
         
-        $fields                                         = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
+		$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);
+		//is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
         
         
-        if ( ! empty($fields)) {
+		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;
-    }
+			$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
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    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(
-                esc_html__('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(
-                esc_html__(
-                    '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(
-                    esc_html__('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 on the messages settings page to activate|deactivate the messenger
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	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(
+				esc_html__('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(
+				esc_html__(
+					'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(
+					esc_html__('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
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    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(
-                esc_html__('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(
-                esc_html__('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(
-                esc_html__('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(
-                    esc_html__('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();
-    }
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	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(
+				esc_html__('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(
+				esc_html__('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(
+				esc_html__('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(
+					esc_html__('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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 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
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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);
-    }
+	/**
+	 * 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
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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();
-    }
+	/**
+	 * 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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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(
-                esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+	/**
+	 * 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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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(
+				esc_html__('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(
-                        esc_html__('%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(
+						esc_html__('%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(
-                            esc_html__(
-                                '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(
-                        esc_html__('%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(
+							esc_html__(
+								'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(
+						esc_html__('%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(
-                        esc_html__('%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(
+						esc_html__('%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(
-                        esc_html__('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                        : sprintf(
-                        esc_html__('%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(
+						esc_html__('%s message type was not successfully activated with the %s messenger', 'event_espresso'),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+						: sprintf(
+						esc_html__('%s messenger was not successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
                 
-                return false;
-            }
-        }
-    }
+				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
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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(
-                esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
+	/**
+	 * 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
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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(
+				esc_html__('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(
-                    esc_html__('%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(
-                    esc_html__('%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'
-                    ? esc_html__(
-                        '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'
-                    )
-                    : esc_html__(
-                        '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;
-    }
+			return false;
+		}
+        
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('%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(
+					esc_html__('%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'
+					? esc_html__(
+						'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'
+					)
+					: esc_html__(
+						'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)
-     *
-     * @throws DomainException
-     */
-    public function update_mt_form()
-    {
-        if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(
-                esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
-                __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();
-    }
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 *
+	 * @throws DomainException
+	 */
+	public function update_mt_form()
+	{
+		if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(
+				esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
+				__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(
-                esc_html__(
-                    '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') {
-            //this should be an array.
-            $settings  = $this->_req_data['messenger_settings'];
-            $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);
-        } elseif ($this->_req_data['type'] === 'message_type') {
-            $settings     = $this->_req_data['message_type_settings'];
-            $messenger    = $settings['messenger'];
-            $message_type = $settings['message_type'];
+	/**
+	 * 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(
+				esc_html__(
+					'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') {
+			//this should be an array.
+			$settings  = $this->_req_data['messenger_settings'];
+			$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);
+		} elseif ($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(
-                esc_html__(
-                    'Settings did not get updated',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
+			$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(
+				esc_html__(
+					'Settings did not get updated',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+        
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
     
     
     
     
-    /**  EE MESSAGE PROCESSING ACTIONS **/
+	/**  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
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _generate_now()
-    {
-        EED_Messages::generate_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
+	/**
+	 * 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
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _generate_now()
+	{
+		EED_Messages::generate_now($this->_get_msg_ids_from_request());
+		$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
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _generate_and_send_now()
-    {
-        EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
-        $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
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _generate_and_send_now()
+	{
+		EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
+		$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
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _queue_for_resending()
-    {
-        EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
-        $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
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _queue_for_resending()
+	{
+		EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
+		$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
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _send_now()
-    {
-        EED_Messages::send_now($this->_get_msg_ids_from_request());
-        $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
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _send_now()
+	{
+		EED_Messages::send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
 
 
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @since 4.9.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    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'),
-                esc_html__('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);
-        }
-    }
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @since 4.9.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	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'),
+				esc_html__('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 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/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Spacing +29 added lines, -29 removed lines

@@ -274,7 +274,7 @@ 
                    && isset($this->_extra_data['data'])
                    && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
             : $payment;
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return '';
         }
         switch ($shortcode) {
@@ -289,16 +289,16 @@ 
                 break;
             case '[INVOICE_LINK]':
                 $invoice_url = $transaction->invoice_url();
-                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com': $invoice_url;
+                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
                 return sprintf(
                     esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
+                    '<a href="'.$invoice_url.'">',
                     '</a>'
                 );
                 break;
             case '[INVOICE_URL]':
                 $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com': $invoice_url;
+                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
                 break;
             case '[INVOICE_LOGO_URL]':
                 return $this->_get_invoice_logo();
@@ -320,7 +320,7 @@ 
                 break;
             case '[TOTAL_COST]':
                 $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total): '';
+                return ! empty($total) ? EEH_Template::format_currency($total) : '';
                 break;
             case '[PAYMENT_STATUS]':
                 $status = $transaction->pretty_status();
@@ -366,7 +366,7 @@ 
                 return $this->_data->total_ticket_count;
                 break;
             case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+                require_once EE_CORE.'admin/EE_Admin_Page.core.php';
                 $query_args = array(
                     'page'   => 'espresso_transactions',
                     'action' => 'view_transaction',
@@ -378,7 +378,7 @@ 
             case '[RECEIPT_URL]':
                 //get primary_registration
                 $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
+                if ( ! $reg instanceof EE_Registration) {
                     return '';
                 }
                 return $reg->receipt_url();
@@ -462,7 +462,7 @@ 
      */
     private function _get_payment_gateway($transaction)
     {
-        if ($transaction instanceof EE_Transaction){
+        if ($transaction instanceof EE_Transaction) {
             $pm = $transaction->payment_method();
         } else {
             $pm = null;
@@ -497,7 +497,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         //image tags have been requested.
@@ -508,7 +508,7 @@ 
         } else {
             $image_width = $image_size[0];
         }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+        return '<img class="logo screen" src="'.$invoice_logo_url.'" width="'.$image_width.'" alt="logo" />';
     }
 
 
@@ -545,7 +545,7 @@ 
      */
     private function _get_invoice_payment_method()
     {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+        if ( ! $this->_invoice_pm instanceof EE_Payment_Method) {
             $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
             $transaction = ! $transaction instanceof EE_Transaction
                            && is_array($this->_extra_data)
@@ -613,7 +613,7 @@ 
         $attrs = $this->_get_shortcode_attrs($shortcode);
         //prefix?
         $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
+        return $prefix.$payee_tax_number;
     }
 
 
@@ -637,16 +637,16 @@ 
         }
         if (empty($payee_address)) {
             $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
+            $payee_address = $organization->get_pretty('address_1').'<br>';
             $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
+                ? $organization->get_pretty('address_2').'<br>'
                 : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
+            $payee_address .= $organization->get_pretty('city').'<br>';
             //state
             $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
             $payee_address .= $state instanceof EE_State ? $state->name() : '';
             //Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+            $payee_address .= ! empty($organization->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : '';
             $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
         }
         return $payee_address;
@@ -682,7 +682,7 @@ 
     {
         $reg = $this->_data->primary_reg_obj;
         $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
+        if ( ! $reg instanceof EE_Registration || empty($message_type)) {
             return '';
         }
         $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
@@ -690,13 +690,13 @@ 
             ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
         $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
         $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
+        if ( ! $button) {
             return $switch_to_url;
         }
-        if (! empty($switch_to_url)) {
+        if ( ! empty($switch_to_url)) {
             return '
-	<form method="post" action="' . $switch_to_url . '" >
-		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
+	<form method="post" action="' . $switch_to_url.'" >
+		<input class="print_button" type="submit" value="' . $switch_to_label.'" />
 	</form>
 			';
         }
@@ -714,7 +714,7 @@ 
     private function _get_subtotal($tax = false)
     {
         $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
+        if ( ! $grand_total instanceof EE_Line_Item) {
             return 0;
         }
         return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
@@ -741,11 +741,11 @@ 
             $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
             $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
             $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+            $opening_tag = ! empty($container_tag) ? '<'.$container_tag : '';
+            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="'.$class.'"' : $opening_tag;
             $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+            $closing_tag = ! empty($container_tag) ? '</'.$container_tag.'>' : '';
+            $content = $opening_tag.sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>').$closing_tag;
             //we need to re run this string through the parser to catch any shortcodes that are in it.
             $owing_content = $this->_shortcode_helper->parse_message_template(
                 $content,
@@ -779,7 +779,7 @@ 
         }
         $attrs = $this->_get_shortcode_attrs($shortcode);
         $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int)$attrs['days_until_due'] : 30;
+        $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
         $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
             : esc_html__('Payment in full due by: ', 'event_espresso');
         $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
@@ -787,7 +787,7 @@ 
         try {
             if ($transaction_created instanceof DateTime) {
                 $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
+                    new DateInterval('P'.$days_until_due.'D')
                 )->format($format);
             } else {
                 throw new Exception();
@@ -799,7 +799,7 @@ 
                 'event_espresso'
             );
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 
 }

Indentation +776 added lines, -776 removed lines

@@ -21,785 +21,785 @@
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
-     */
-    protected $_invoice_pm;
-
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
-            '[PAYMENT_URL]'                     => esc_html__(
-                'This is a link to make a payment for the event',
-                'event_espresso'
-            ),
-            '[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
-                'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
-                'event_espresso'
-            )
-               . '<ul>'
-               . '<li>'
-               . sprintf(
-                   esc_html__(
-                       '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
-                       'event_espresso'
-                   ),
-                   '<strong>',
-                   '</strong>'
-               )
-               . '</li>'
-               . '<li>'
-               . sprintf(
-                   esc_html__(
-                       '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
-                       'event_espresso'
-                   ),
-                   '<strong>',
-                   '</strong>'
-               )
-               . '</li>'
-               . '<li>'
-               . sprintf(
-                   esc_html__(
-                       '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
-                       'event_espresso'
-                   ),
-                   '<strong>',
-                   '</strong>'
-               )
-               . '</li>'
-               . '</ul>',
-            '[PAYMENT_DUE_DATE_*]'              => esc_html__(
-                'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
-                'event_espresso'
-            )
-               . '<ul>'
-               . '<li>'
-               . sprintf(
-                   esc_html__(
-                       '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
-                       'event_espresso'
-                   ),
-                   '<strong>',
-                   '</strong>'
-               )
-               . '</li>'
-               . '<li>'
-               . sprintf(
-                   esc_html__(
-                       '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
-                       'event_espresso'
-                   ),
-                   '<strong>',
-                   '</strong>'
-               )
-               . '</li>'
-               . '<li>'
-               . sprintf(
-                   esc_html__(
-                       '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
-                       'event_espresso'
-                   ),
-                   '<strong>',
-                   '</strong>'
-               )
-               . '</li>',
-            '[INVOICE_LINK]'                    => esc_html__(
-                'This is a full html link to the invoice',
-                'event_espresso'
-            ),
-            '[INVOICE_URL]'                     => esc_html__(
-                'This is just the url for the invoice',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO_URL]'                => esc_html__(
-                'This returns the url for the logo uploaded via the invoice settings page.',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO]'                    => esc_html__(
-                'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_NAME]'              => esc_html__(
-                'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
-                'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
-                'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_EMAIL]'             => esc_html__(
-                'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
-                esc_html__(
-                    'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
-            '[TXN_STATUS]'                      => esc_html__(
-                'The transaction status for the transaction.',
-                'event_espresso'
-            ),
-            '[TXN_STATUS_ID]'                   => esc_html__(
-                'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
-                'event_espresso'
-            ),
-            '[PAYMENT_STATUS]'                  => esc_html__(
-                'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
-                'event_espresso'
-            ),
-            '[PAYMENT_GATEWAY]'                 => esc_html__(
-                'The payment gateway used for the transaction',
-                'event_espresso'
-            ),
-            '[AMOUNT_PAID]'                     => esc_html__(
-                'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
-                'event_espresso'
-            ),
-            '[LAST_AMOUNT_PAID]'                => esc_html__(
-                'This is the last payment or refund made on the transaction related to the message being generated.',
-                'event_espresso'
-            ),
-            '[TOTAL_AMOUNT_PAID]'               => esc_html__(
-                'This parses to the total amount paid over all payments',
-                'event_espresso'
-            ),
-            '[TOTAL_OWING]'                     => esc_html__(
-                'The total owing on a transaction with no attributes.',
-                'event_espresso'
-            ),
-            '[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
-            '[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
-            '[OWING_STATUS_MESSAGE_*]'          => esc_html__(
-                'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
-                'event_espresso'
-            )
-               . '<p></ul>'
-               . '<li><strong>still_owing</strong>:'
-               . esc_html__(
-                   'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
-                   'event_espresso'
-               )
-               . sprintf(
-                   esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                   '<a href="[PAYMENT_URL]" class="noPrint">',
-                   '</a>'
-               )
-               . '</li>'
-               .
-               '<li><strong>none_owing</strong>:'
-               . esc_html__(
-                   'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
-                   'event_espresso'
-               )
-               . '</li></ul></p>',
-            '[TXN_TOTAL_TICKETS]'               => esc_html__(
-                'The total number of all tickets purchased in a transaction',
-                'event_espresso'
-            ),
-            '[TKT_QTY_PURCHASED]'               => sprintf(
-                esc_html__(
-                    'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-            '[TRANSACTION_ADMIN_URL]'           => esc_html__(
-                'The url to the admin page for this transaction',
-                'event_espresso'
-            ),
-            '[RECEIPT_URL]'                     => esc_html__(
-                'This parses to the generated url for retrieving the receipt for the transaction',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
-                'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
-                esc_html__(
-                    'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
-                    'event_espresso'
-                ),
-                '<code>[INVOICE_RECEIPT_SWITCHER_URL]',
-                '</code>'
-            ),
-            '[LAST_PAYMENT_TRANSACTION_ID]' => esc_html__(
-                'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _parser($shortcode)
-    {
-        //attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
-        // _extra_data for the transaction.
-        $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-        $transaction = ! $transaction instanceof EE_Transaction
-                       && is_array($this->_extra_data)
-                       && isset($this->_extra_data['data'])
-                       && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                            ? $this->_extra_data['data']->txn
-                            : $transaction;
-        //payment
-        $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
-        $payment = ! $payment instanceof EE_Payment
-                   && is_array($this->_extra_data)
-                   && isset($this->_extra_data['data'])
-                   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
-            : $payment;
-        if (! $transaction instanceof EE_Transaction) {
-            return '';
-        }
-        switch ($shortcode) {
-            case '[TXN_ID]':
-                return $transaction->ID();
-                break;
-            case '[PAYMENT_URL]':
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url)
-                    ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-                break;
-            case '[INVOICE_LINK]':
-                $invoice_url = $transaction->invoice_url();
-                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com': $invoice_url;
-                return sprintf(
-                    esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
-                    '</a>'
-                );
-                break;
-            case '[INVOICE_URL]':
-                $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com': $invoice_url;
-                break;
-            case '[INVOICE_LOGO_URL]':
-                return $this->_get_invoice_logo();
-                break;
-            case '[INVOICE_LOGO]':
-                return $this->_get_invoice_logo(true);
-                break;
-            case '[INVOICE_PAYEE_NAME]':
-                return $this->_get_invoice_payee_name();
-                break;
-            case '[INVOICE_PAYEE_ADDRESS]':
-                return $this->_get_invoice_payee_address();
-                break;
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]':
-                return $this->_get_invoice_payment_instructions();
-                break;
-            case '[INVOICE_PAYEE_EMAIL]':
-                return $this->_get_invoice_payee_email();
-                break;
-            case '[TOTAL_COST]':
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total): '';
-                break;
-            case '[PAYMENT_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break; /**/
-            // note the [payment_status] shortcode is kind of misleading because payment status might be different
-            // from txn status so I'm adding this here for clarity.
-            case '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break;
-            case '[TXN_STATUS_ID]':
-                return $transaction->status_ID();
-                break;
-            case '[PAYMENT_GATEWAY]':
-                return $this->_get_payment_gateway($transaction);
-                break;
-            case '[AMOUNT_PAID]':
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-                break;
-            case '[LAST_AMOUNT_PAID]':
-                $last_payment = $transaction->last_payment();
-                return $last_payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($last_payment->amount())
-                    : EEH_Template::format_currency(0);
-            case '[TOTAL_AMOUNT_PAID]':
-                return EEH_Template::format_currency($transaction->paid());
-                break;
-            case '[TOTAL_OWING]':
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-                break;
-            case '[TXN_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal());
-                break;
-            case '[TXN_TAX_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-                break;
-            case '[TKT_QTY_PURCHASED]':
-            case '[TXN_TOTAL_TICKETS]':
-                return $this->_data->total_ticket_count;
-                break;
-            case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = array(
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                );
-                $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-                return $url;
-                break;
-            case '[RECEIPT_URL]':
-                //get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                return $reg->receipt_url();
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_URL]':
-                return $this->_get_invoice_receipt_switcher(false);
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
-                return $this->_get_invoice_receipt_switcher();
-                break;
-            case '[LAST_PAYMENT_TRANSACTION_ID]':
-                $id = '';
-                $payment = $payment instanceof EE_Payment && $payment->ID() !== 0
-                    ? $payment
-                    : $transaction->last_payment();
-                if ($payment instanceof EE_Payment) {
-                    $id = $payment->txn_id_chq_nmbr();
-                }
-                return $id;
-                break;
-        }
-        if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
-            return $this->_get_custom_total_owing($shortcode);
-        }
-        if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
-            return $this->_get_invoice_payee_tax_number($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
-            return $this->_get_payment_link_if_needed($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
-            return $this->_get_payment_due_date($shortcode, $transaction);
-        }
-        return '';
-    }
-
-
-    /**
-     * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_custom_total_owing($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        //ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $owing_content = ! empty($attrs['still_owing'])
-                ? $attrs['still_owing']
-                : sprintf(
-                    esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">',
-                    '</a>'
-                );
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $owing_content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    private function _get_payment_gateway($transaction)
-    {
-        if ($transaction instanceof EE_Transaction){
-            $pm = $transaction->payment_method();
-        } else {
-            $pm = null;
-        }
-        return $pm instanceof EE_Payment_Method ? $pm->name() : '';
-    }
-
-
-    /**
-     * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
-     * not present then the organization logo is used if its found (set on the organization settings page).
-     *
-     * @since 4.5.0
-     * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
-     * @return string url or html
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_logo($img_tags = false)
-    {
-        $invoice_logo_url = '';
-        //try to get the invoice payment method's logo for this transaction image first
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
-        }
-        if (empty($invoice_logo_url)) {
-            $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
-        }
-        if (empty($invoice_logo_url)) {
-            return '';
-        }
-        if (! $img_tags) {
-            return $invoice_logo_url;
-        }
-        //image tags have been requested.
-        $image_size = getimagesize($invoice_logo_url);
-        //if image is wider than 300px, set the width to 300
-        if ($image_size[0] > 300) {
-            $image_width = 300;
-        } else {
-            $image_width = $image_size[0];
-        }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_name()
-    {
-        $payee_name = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_name = $pm->get_extra_meta('pdf_payee_name', true);
-        }
-        $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
-        return $payee_name;
-    }
-
-
-    /**
-     * gets the default invoice payment method, but has a filter so it can be overridden
-     *
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_method()
-    {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
-            $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-            $transaction = ! $transaction instanceof EE_Transaction
-                           && is_array($this->_extra_data)
-                           && isset($this->_extra_data['data'])
-                           && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->txn : $transaction;
-            //get the invoice payment method, and remember it for the next call too
-            $this->_invoice_pm = apply_filters(
-                'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
-                EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
-                $transaction
-            );
-        }
-        return $this->_invoice_pm;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee email shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_email()
-    {
-        $payee_email = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_email = $pm->get_extra_meta('pdf_payee_email', true);
-        }
-        $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : $payee_email;
-        return $payee_email;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee tax number shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_tax_number($shortcode)
-    {
-        $payee_tax_number = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
-        }
-        $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
-            : $payee_tax_number;
-        if (empty($payee_tax_number)) {
-            return '';
-        }
-        //any attributes?
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        //prefix?
-        $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee address shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_address()
-    {
-        $payee_address = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_address = $pm->get_extra_meta('pdf_payee_address', true);
-        }
-        if (empty($payee_address)) {
-            $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
-            $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
-                : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
-            //state
-            $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $payee_address .= $state instanceof EE_State ? $state->name() : '';
-            //Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
-            $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
-        }
-        return $payee_address;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_instructions()
-    {
-        $instructions = null;
-        $pm = $this->_get_invoice_payment_method();
-        return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
-    }
-
-
-    /**
-     * get invoice/receipt switch button or url.
-     *
-     * @param bool $button true (default) returns the html for a button, false just returns the url.
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_invoice_receipt_switcher($button = true)
-    {
-        $reg = $this->_data->primary_reg_obj;
-        $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
-            return '';
-        }
-        $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
-        $switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
-            ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
-        $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
-        $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
-            return $switch_to_url;
-        }
-        if (! empty($switch_to_url)) {
-            return '
+	/**
+	 * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
+	 */
+	protected $_invoice_pm;
+
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
+			'[PAYMENT_URL]'                     => esc_html__(
+				'This is a link to make a payment for the event',
+				'event_espresso'
+			),
+			'[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
+				'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
+				'event_espresso'
+			)
+			   . '<ul>'
+			   . '<li>'
+			   . sprintf(
+				   esc_html__(
+					   '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
+					   'event_espresso'
+				   ),
+				   '<strong>',
+				   '</strong>'
+			   )
+			   . '</li>'
+			   . '<li>'
+			   . sprintf(
+				   esc_html__(
+					   '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
+					   'event_espresso'
+				   ),
+				   '<strong>',
+				   '</strong>'
+			   )
+			   . '</li>'
+			   . '<li>'
+			   . sprintf(
+				   esc_html__(
+					   '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
+					   'event_espresso'
+				   ),
+				   '<strong>',
+				   '</strong>'
+			   )
+			   . '</li>'
+			   . '</ul>',
+			'[PAYMENT_DUE_DATE_*]'              => esc_html__(
+				'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
+				'event_espresso'
+			)
+			   . '<ul>'
+			   . '<li>'
+			   . sprintf(
+				   esc_html__(
+					   '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
+					   'event_espresso'
+				   ),
+				   '<strong>',
+				   '</strong>'
+			   )
+			   . '</li>'
+			   . '<li>'
+			   . sprintf(
+				   esc_html__(
+					   '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
+					   'event_espresso'
+				   ),
+				   '<strong>',
+				   '</strong>'
+			   )
+			   . '</li>'
+			   . '<li>'
+			   . sprintf(
+				   esc_html__(
+					   '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
+					   'event_espresso'
+				   ),
+				   '<strong>',
+				   '</strong>'
+			   )
+			   . '</li>',
+			'[INVOICE_LINK]'                    => esc_html__(
+				'This is a full html link to the invoice',
+				'event_espresso'
+			),
+			'[INVOICE_URL]'                     => esc_html__(
+				'This is just the url for the invoice',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO_URL]'                => esc_html__(
+				'This returns the url for the logo uploaded via the invoice settings page.',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO]'                    => esc_html__(
+				'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_NAME]'              => esc_html__(
+				'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
+				'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
+				'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_EMAIL]'             => esc_html__(
+				'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
+				esc_html__(
+					'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
+			'[TXN_STATUS]'                      => esc_html__(
+				'The transaction status for the transaction.',
+				'event_espresso'
+			),
+			'[TXN_STATUS_ID]'                   => esc_html__(
+				'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
+				'event_espresso'
+			),
+			'[PAYMENT_STATUS]'                  => esc_html__(
+				'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
+				'event_espresso'
+			),
+			'[PAYMENT_GATEWAY]'                 => esc_html__(
+				'The payment gateway used for the transaction',
+				'event_espresso'
+			),
+			'[AMOUNT_PAID]'                     => esc_html__(
+				'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
+				'event_espresso'
+			),
+			'[LAST_AMOUNT_PAID]'                => esc_html__(
+				'This is the last payment or refund made on the transaction related to the message being generated.',
+				'event_espresso'
+			),
+			'[TOTAL_AMOUNT_PAID]'               => esc_html__(
+				'This parses to the total amount paid over all payments',
+				'event_espresso'
+			),
+			'[TOTAL_OWING]'                     => esc_html__(
+				'The total owing on a transaction with no attributes.',
+				'event_espresso'
+			),
+			'[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
+			'[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
+			'[OWING_STATUS_MESSAGE_*]'          => esc_html__(
+				'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
+				'event_espresso'
+			)
+			   . '<p></ul>'
+			   . '<li><strong>still_owing</strong>:'
+			   . esc_html__(
+				   'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
+				   'event_espresso'
+			   )
+			   . sprintf(
+				   esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+				   '<a href="[PAYMENT_URL]" class="noPrint">',
+				   '</a>'
+			   )
+			   . '</li>'
+			   .
+			   '<li><strong>none_owing</strong>:'
+			   . esc_html__(
+				   'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
+				   'event_espresso'
+			   )
+			   . '</li></ul></p>',
+			'[TXN_TOTAL_TICKETS]'               => esc_html__(
+				'The total number of all tickets purchased in a transaction',
+				'event_espresso'
+			),
+			'[TKT_QTY_PURCHASED]'               => sprintf(
+				esc_html__(
+					'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+			'[TRANSACTION_ADMIN_URL]'           => esc_html__(
+				'The url to the admin page for this transaction',
+				'event_espresso'
+			),
+			'[RECEIPT_URL]'                     => esc_html__(
+				'This parses to the generated url for retrieving the receipt for the transaction',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
+				'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
+				esc_html__(
+					'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
+					'event_espresso'
+				),
+				'<code>[INVOICE_RECEIPT_SWITCHER_URL]',
+				'</code>'
+			),
+			'[LAST_PAYMENT_TRANSACTION_ID]' => esc_html__(
+				'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _parser($shortcode)
+	{
+		//attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
+		// _extra_data for the transaction.
+		$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+		$transaction = ! $transaction instanceof EE_Transaction
+					   && is_array($this->_extra_data)
+					   && isset($this->_extra_data['data'])
+					   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+							? $this->_extra_data['data']->txn
+							: $transaction;
+		//payment
+		$payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
+		$payment = ! $payment instanceof EE_Payment
+				   && is_array($this->_extra_data)
+				   && isset($this->_extra_data['data'])
+				   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
+			: $payment;
+		if (! $transaction instanceof EE_Transaction) {
+			return '';
+		}
+		switch ($shortcode) {
+			case '[TXN_ID]':
+				return $transaction->ID();
+				break;
+			case '[PAYMENT_URL]':
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url)
+					? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+				break;
+			case '[INVOICE_LINK]':
+				$invoice_url = $transaction->invoice_url();
+				$invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com': $invoice_url;
+				return sprintf(
+					esc_html__('%sClick here for Invoice%s', 'event_espresso'),
+					'<a href="' . $invoice_url . '">',
+					'</a>'
+				);
+				break;
+			case '[INVOICE_URL]':
+				$invoice_url = $transaction->invoice_url();
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com': $invoice_url;
+				break;
+			case '[INVOICE_LOGO_URL]':
+				return $this->_get_invoice_logo();
+				break;
+			case '[INVOICE_LOGO]':
+				return $this->_get_invoice_logo(true);
+				break;
+			case '[INVOICE_PAYEE_NAME]':
+				return $this->_get_invoice_payee_name();
+				break;
+			case '[INVOICE_PAYEE_ADDRESS]':
+				return $this->_get_invoice_payee_address();
+				break;
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]':
+				return $this->_get_invoice_payment_instructions();
+				break;
+			case '[INVOICE_PAYEE_EMAIL]':
+				return $this->_get_invoice_payee_email();
+				break;
+			case '[TOTAL_COST]':
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total): '';
+				break;
+			case '[PAYMENT_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break; /**/
+			// note the [payment_status] shortcode is kind of misleading because payment status might be different
+			// from txn status so I'm adding this here for clarity.
+			case '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break;
+			case '[TXN_STATUS_ID]':
+				return $transaction->status_ID();
+				break;
+			case '[PAYMENT_GATEWAY]':
+				return $this->_get_payment_gateway($transaction);
+				break;
+			case '[AMOUNT_PAID]':
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+				break;
+			case '[LAST_AMOUNT_PAID]':
+				$last_payment = $transaction->last_payment();
+				return $last_payment instanceof EE_Payment
+					? EEH_Template::format_currency($last_payment->amount())
+					: EEH_Template::format_currency(0);
+			case '[TOTAL_AMOUNT_PAID]':
+				return EEH_Template::format_currency($transaction->paid());
+				break;
+			case '[TOTAL_OWING]':
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+				break;
+			case '[TXN_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal());
+				break;
+			case '[TXN_TAX_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+				break;
+			case '[TKT_QTY_PURCHASED]':
+			case '[TXN_TOTAL_TICKETS]':
+				return $this->_data->total_ticket_count;
+				break;
+			case '[TRANSACTION_ADMIN_URL]':
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = array(
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				);
+				$url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+				return $url;
+				break;
+			case '[RECEIPT_URL]':
+				//get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				return $reg->receipt_url();
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_URL]':
+				return $this->_get_invoice_receipt_switcher(false);
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
+				return $this->_get_invoice_receipt_switcher();
+				break;
+			case '[LAST_PAYMENT_TRANSACTION_ID]':
+				$id = '';
+				$payment = $payment instanceof EE_Payment && $payment->ID() !== 0
+					? $payment
+					: $transaction->last_payment();
+				if ($payment instanceof EE_Payment) {
+					$id = $payment->txn_id_chq_nmbr();
+				}
+				return $id;
+				break;
+		}
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
+			return $this->_get_custom_total_owing($shortcode);
+		}
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
+			return $this->_get_payment_link_if_needed($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
+		}
+		return '';
+	}
+
+
+	/**
+	 * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_custom_total_owing($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		//ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$owing_content = ! empty($attrs['still_owing'])
+				? $attrs['still_owing']
+				: sprintf(
+					esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">',
+					'</a>'
+				);
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$owing_content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			$owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _get_payment_gateway($transaction)
+	{
+		if ($transaction instanceof EE_Transaction){
+			$pm = $transaction->payment_method();
+		} else {
+			$pm = null;
+		}
+		return $pm instanceof EE_Payment_Method ? $pm->name() : '';
+	}
+
+
+	/**
+	 * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
+	 * not present then the organization logo is used if its found (set on the organization settings page).
+	 *
+	 * @since 4.5.0
+	 * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
+	 * @return string url or html
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_logo($img_tags = false)
+	{
+		$invoice_logo_url = '';
+		//try to get the invoice payment method's logo for this transaction image first
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
+		}
+		if (empty($invoice_logo_url)) {
+			$invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
+		}
+		if (empty($invoice_logo_url)) {
+			return '';
+		}
+		if (! $img_tags) {
+			return $invoice_logo_url;
+		}
+		//image tags have been requested.
+		$image_size = getimagesize($invoice_logo_url);
+		//if image is wider than 300px, set the width to 300
+		if ($image_size[0] > 300) {
+			$image_width = 300;
+		} else {
+			$image_width = $image_size[0];
+		}
+		return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_name()
+	{
+		$payee_name = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_name = $pm->get_extra_meta('pdf_payee_name', true);
+		}
+		$payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
+		return $payee_name;
+	}
+
+
+	/**
+	 * gets the default invoice payment method, but has a filter so it can be overridden
+	 *
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_method()
+	{
+		if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+			$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+			$transaction = ! $transaction instanceof EE_Transaction
+						   && is_array($this->_extra_data)
+						   && isset($this->_extra_data['data'])
+						   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->txn : $transaction;
+			//get the invoice payment method, and remember it for the next call too
+			$this->_invoice_pm = apply_filters(
+				'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
+				EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
+				$transaction
+			);
+		}
+		return $this->_invoice_pm;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee email shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_email()
+	{
+		$payee_email = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_email = $pm->get_extra_meta('pdf_payee_email', true);
+		}
+		$payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: $payee_email;
+		return $payee_email;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee tax number shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_tax_number($shortcode)
+	{
+		$payee_tax_number = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
+		}
+		$payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
+			: $payee_tax_number;
+		if (empty($payee_tax_number)) {
+			return '';
+		}
+		//any attributes?
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		//prefix?
+		$prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
+		return $prefix . $payee_tax_number;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee address shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_address()
+	{
+		$payee_address = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_address = $pm->get_extra_meta('pdf_payee_address', true);
+		}
+		if (empty($payee_address)) {
+			$organization = EE_Registry::instance()->CFG->organization;
+			$payee_address = $organization->get_pretty('address_1') . '<br>';
+			$payee_address .= ! empty($organization->address_2)
+				? $organization->get_pretty('address_2') . '<br>'
+				: '';
+			$payee_address .= $organization->get_pretty('city') . '<br>';
+			//state
+			$state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$payee_address .= $state instanceof EE_State ? $state->name() : '';
+			//Country
+			$payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+			$payee_address .= ! empty($organization->zip) ? $organization->zip : '';
+		}
+		return $payee_address;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_instructions()
+	{
+		$instructions = null;
+		$pm = $this->_get_invoice_payment_method();
+		return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
+	}
+
+
+	/**
+	 * get invoice/receipt switch button or url.
+	 *
+	 * @param bool $button true (default) returns the html for a button, false just returns the url.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_invoice_receipt_switcher($button = true)
+	{
+		$reg = $this->_data->primary_reg_obj;
+		$message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
+		if (! $reg instanceof EE_Registration || empty($message_type)) {
+			return '';
+		}
+		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
+		$switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
+			? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
+		$switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
+		$switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
+		if (! $button) {
+			return $switch_to_url;
+		}
+		if (! empty($switch_to_url)) {
+			return '
 	<form method="post" action="' . $switch_to_url . '" >
 		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
 	</form>
 			';
-        }
-        return '';
-    }
-
-
-    /**
-     * This returns a subtotal.
-     *
-     * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
-     * @return int
-     * @throws EE_Error
-     */
-    private function _get_subtotal($tax = false)
-    {
-        $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
-            return 0;
-        }
-        return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
-    }
-
-
-    /**
-     * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
-     *
-     * @since 4.7.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_payment_link_if_needed($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        //ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
-            $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
-            $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
-            $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
-            //we need to re run this string through the parser to catch any shortcodes that are in it.
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            return '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
-     *
-     * @since 4.8.28.rc.011
-     * @param string         $shortcode The shortcode being parsed.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
-    {
-        //if transaction is paid in full then we can just return an empty string
-        if ($transaction->remaining() === 0) {
-            return '';
-        }
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int)$attrs['days_until_due'] : 30;
-        $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
-            : esc_html__('Payment in full due by: ', 'event_espresso');
-        $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
-        //setup date due:
-        try {
-            if ($transaction_created instanceof DateTime) {
-                $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
-                )->format($format);
-            } else {
-                throw new Exception();
-            }
-        } catch (Exception $e) {
-            //format was likely invalid.
-            $date_due = esc_html__(
-                'Unable to calculate date due, likely the format string is invalid.',
-                'event_espresso'
-            );
-        }
-        return $prefix_text . $date_due;
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * This returns a subtotal.
+	 *
+	 * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function _get_subtotal($tax = false)
+	{
+		$grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
+		if (! $grand_total instanceof EE_Line_Item) {
+			return 0;
+		}
+		return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
+	}
+
+
+	/**
+	 * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
+	 *
+	 * @since 4.7.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_payment_link_if_needed($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		//ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$class = isset($attrs['class']) ? $attrs['class'] : 'callout';
+			$custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
+			$container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
+			$opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
+			$opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+			$opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
+			$closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
+			$content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+			//we need to re run this string through the parser to catch any shortcodes that are in it.
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			return '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
+	 *
+	 * @since 4.8.28.rc.011
+	 * @param string         $shortcode The shortcode being parsed.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
+	{
+		//if transaction is paid in full then we can just return an empty string
+		if ($transaction->remaining() === 0) {
+			return '';
+		}
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		$format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
+		$days_until_due = isset($attrs['days_until_due']) ? (int)$attrs['days_until_due'] : 30;
+		$prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
+			: esc_html__('Payment in full due by: ', 'event_espresso');
+		$transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
+		//setup date due:
+		try {
+			if ($transaction_created instanceof DateTime) {
+				$date_due = $transaction_created->add(
+					new DateInterval('P' . $days_until_due . 'D')
+				)->format($format);
+			} else {
+				throw new Exception();
+			}
+		} catch (Exception $e) {
+			//format was likely invalid.
+			$date_due = esc_html__(
+				'Unable to calculate date due, likely the format string is invalid.',
+				'event_espresso'
+			);
+		}
+		return $prefix_text . $date_due;
+	}
 
 }

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,8 +20,8 @@
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
      * @param $string
-     * @param $start
-     * @param $length
+     * @param integer $start
+     * @param integer $length
      * @return bool|string
      */
     function mb_strcut($string, $start, $length = null)

Indentation +599 added lines, -599 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -16,608 +16,608 @@ 
  */
 //Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $order_description = mb_strcut($this->_format_order_description($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            //EE will blow up if you change this
-            'BUTTONSOURCE'                   => 'EventEspresso_SP',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
-                        $this->_format_line_item_name($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut(
-                        $this->_format_line_item_desc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
-                    // Item Number.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
-                    // Item quantity.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
-                    // Digital item is sold.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
-                // Cost of individual item.
-                $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
-                // Item quantity.
-                $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
-                // Digital item is sold.
-                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $this->_format_partial_payment_line_item_name($payment),
-                0,
-                127
-            );
-            // Item description.
-            $token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $this->_format_partial_payment_line_item_desc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
-            // Item Number.
-            $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $token_request_dtls['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
-            $token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            //  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                    //EE will blow up if you change this
-                    'BUTTONSOURCE'                   => 'EventEspresso_SP',
-                );
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION'   => '204.0',
-            'USER'      => urlencode($this->_api_username),
-            'PWD'       => urlencode($this->_api_password),
-            'SIGNATURE' => urlencode($this->_api_signature),
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array["L_ERRORCODE{$n}"])) {
-            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
-                ? $data_array["L_ERRORCODE{$n}"]
-                : '';
-            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
-                ? $data_array["L_SEVERITYCODE{$n}"]
-                : '';
-            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
-                ? $data_array["L_SHORTMESSAGE{$n}"]
-                : '';
-            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
-                ? $data_array["L_LONGMESSAGE{$n}"]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+		);
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$order_description = mb_strcut($this->_format_order_description($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			//EE will blow up if you change this
+			'BUTTONSOURCE'                   => 'EventEspresso_SP',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+						$this->_format_line_item_name($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut(
+						$this->_format_line_item_desc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
+					// Item Number.
+					$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+					// Item quantity.
+					$token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
+					// Digital item is sold.
+					$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
+				// Cost of individual item.
+				$token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+				// Item quantity.
+				$token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
+				// Digital item is sold.
+				$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$this->_format_partial_payment_line_item_name($payment),
+				0,
+				127
+			);
+			// Item description.
+			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$this->_format_partial_payment_line_item_desc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
+			// Item Number.
+			$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$token_request_dtls['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
+			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			//  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+					//EE will blow up if you change this
+					'BUTTONSOURCE'                   => 'EventEspresso_SP',
+				);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION'   => '204.0',
+			'USER'      => urlencode($this->_api_username),
+			'PWD'       => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature),
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array["L_ERRORCODE{$n}"])) {
+			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+				? $data_array["L_ERRORCODE{$n}"]
+				: '';
+			$l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+				? $data_array["L_SEVERITYCODE{$n}"]
+				: '';
+			$l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+				? $data_array["L_SHORTMESSAGE{$n}"]
+				: '';
+			$l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+				? $data_array["L_LONGMESSAGE{$n}"]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 
 }
 // End of file EEG_Paypal_Express.gateway.php

Spacing +29 added lines, -29 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -15,7 +15,7 @@ 
  * ----------------------------------------------
  */
 //Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
@@ -145,7 +145,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Error. No associated payment was found.',
@@ -156,7 +156,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',
@@ -209,25 +209,25 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+                    $token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                         $this->_format_line_item_name($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut(
+                    $token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut(
                         $this->_format_line_item_desc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
+                    $token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($unit_price);
                     // Item Number.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+                    $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
+                    $token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+                    $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->total();
                     ++$item_num;
                 }
@@ -245,7 +245,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+                $token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                     esc_html__(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -254,17 +254,17 @@ 
                     127
                 );
                 // Item description.
-                $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
+                $token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
+                $token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency(
                     $itemized_sum_diff_from_txn_total
                 );
                 // Item Number.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+                $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
+                $token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -307,13 +307,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -338,7 +338,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -369,7 +369,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     esc_html__(
                         'Could not process this payment because it has no associated transaction.',
@@ -382,7 +382,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+            if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
                 $payment->set_status($this->_pay_model->failed_status());
                 return $payment;
             }
@@ -429,7 +429,7 @@ 
                         : '';
                     $payment->set_extra_accntng($primary_registration_code);
                     $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
+                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
                         : 0);
                     $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
                         ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
@@ -506,7 +506,7 @@ 
             'SIGNATURE' => urlencode($this->_api_signature),
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -520,7 +520,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -540,7 +540,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if (
@@ -609,10 +609,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 );
             } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE'] .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }

espresso.php

Indentation +192 added lines, -192 removed lines

@@ -38,217 +38,217 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.49.rc.000');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.49.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            static $error_handling_loaded = false;
-            if ($error_handling_loaded) {
-                return;
-            }
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
-                \EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once EE_CORE . 'EE_Error.core.php';
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-            $error_handling_loaded = true;
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			static $error_handling_loaded = false;
+			if ($error_handling_loaded) {
+				return;
+			}
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
+				\EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once EE_CORE . 'EE_Error.core.php';
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+			$error_handling_loaded = true;
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            if (is_readable($full_path_to_file)) {
-                require_once $full_path_to_file;
-            } else {
-                throw new \EE_Error (
-                    sprintf(
-                        esc_html__(
-                            'The %s class file could not be located or is not readable due to file permissions.',
-                            'event_espresso'
-                        ),
-                        $classname
-                    )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			if (is_readable($full_path_to_file)) {
+				require_once $full_path_to_file;
+			} else {
+				throw new \EE_Error (
+					sprintf(
+						esc_html__(
+							'The %s class file could not be located or is not readable due to file permissions.',
+							'event_espresso'
+						),
+						$classname
+					)
+				);
+			}
+		}
 
-        /**
-         * @since 4.9.27
-         * @throws \EE_Error
-         * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-         * @throws \EventEspresso\core\exceptions\InvalidEntityException
-         * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-         * @throws \EventEspresso\core\exceptions\InvalidClassException
-         * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
-         * @throws \OutOfBoundsException
-         */
-        function bootstrap_espresso()
-        {
-            require_once __DIR__ . '/core/espresso_definitions.php';
-            try {
-                espresso_load_error_handling();
-                espresso_load_required(
-                    'EEH_Base',
-                    EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_Array',
-                    EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
-                );
-                // instantiate and configure PSR4 autoloader
-                espresso_load_required(
-                    'Psr4Autoloader',
-                    EE_CORE . 'Psr4Autoloader.php'
-                );
-                espresso_load_required(
-                    'EE_Psr4AutoloaderInit',
-                    EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
-                );
-                $AutoloaderInit = new EE_Psr4AutoloaderInit();
-                $AutoloaderInit->initializeAutoloader();
-                espresso_load_required(
-                    'EE_Request',
-                    EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
-                );
-                espresso_load_required(
-                    'EE_Response',
-                    EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
-                );
-                espresso_load_required(
-                    'EE_Bootstrap',
-                    EE_CORE . 'EE_Bootstrap.core.php'
-                );
-                // bootstrap EE and the request stack
-                new EE_Bootstrap(
-                    new EE_Request($_GET, $_POST, $_COOKIE),
-                    new EE_Response()
-                );
-            } catch (Exception $e) {
-                require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
-                new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
-            }
-        }
-        bootstrap_espresso();
-    }
+		/**
+		 * @since 4.9.27
+		 * @throws \EE_Error
+		 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+		 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+		 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+		 * @throws \EventEspresso\core\exceptions\InvalidClassException
+		 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
+		 * @throws \OutOfBoundsException
+		 */
+		function bootstrap_espresso()
+		{
+			require_once __DIR__ . '/core/espresso_definitions.php';
+			try {
+				espresso_load_error_handling();
+				espresso_load_required(
+					'EEH_Base',
+					EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
+				);
+				espresso_load_required(
+					'EEH_Array',
+					EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
+				);
+				// instantiate and configure PSR4 autoloader
+				espresso_load_required(
+					'Psr4Autoloader',
+					EE_CORE . 'Psr4Autoloader.php'
+				);
+				espresso_load_required(
+					'EE_Psr4AutoloaderInit',
+					EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
+				);
+				$AutoloaderInit = new EE_Psr4AutoloaderInit();
+				$AutoloaderInit->initializeAutoloader();
+				espresso_load_required(
+					'EE_Request',
+					EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
+				);
+				espresso_load_required(
+					'EE_Response',
+					EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
+				);
+				espresso_load_required(
+					'EE_Bootstrap',
+					EE_CORE . 'EE_Bootstrap.core.php'
+				);
+				// bootstrap EE and the request stack
+				new EE_Bootstrap(
+					new EE_Request($_GET, $_POST, $_COOKIE),
+					new EE_Response()
+				);
+			} catch (Exception $e) {
+				require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
+				new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
+			}
+		}
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/EE_PUE.core.php

Indentation +420 added lines, -420 removed lines

@@ -17,247 +17,247 @@ 
 {
 
 
-    /**
-     *    class constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
+	/**
+	 *    class constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
 //		throw new EE_Error('error');
 
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-
-        //wp have no MONTH_IN_SECONDS constant.  So we approximate our own assuming all months are 4 weeks long.
-        if (! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', WEEK_IN_SECONDS * 4);
-        }
-
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            $this->_uxip_hooks();
-        }
-
-
-        $ueip_optin        = EE_Registry::instance()->CFG->core->ee_ueip_optin;
-        $ueip_has_notified = EE_Registry::instance()->CFG->core->ee_ueip_has_notified;
-
-        //has optin been selected for data collection?
-        $espresso_data_optin = ! empty($ueip_optin) ? $ueip_optin : null;
-
-        if (empty($ueip_has_notified)
-            && EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            add_action('admin_notices', array($this, 'espresso_data_collection_optin_notice'), 10);
-            add_action('admin_enqueue_scripts', array($this, 'espresso_data_collection_enqueue_scripts'), 10);
-            add_action('wp_ajax_espresso_data_optin', array($this, 'espresso_data_optin_ajax_handler'), 10);
-            update_option('ee_ueip_optin', 'yes');
-            $espresso_data_optin = 'yes';
-        }
-
-        //let's prepare extra stats
-        $extra_stats = array();
-
-        //only collect extra stats if the plugin user has opted in and transient is expired.
-        if (! empty($espresso_data_optin) && $espresso_data_optin == 'yes') {
-            if (false === ($transient = get_transient('ee_extra_data'))
-                && EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
-            ) {
-
-                $current_site = is_multisite() ? get_current_site() : null;
-                $site_pre     = ! is_main_site() && ! empty($current_site)
-                    ? trim(
-                        preg_replace('/\b\w\S\w\b/', '', $current_site->domain),
-                        '.'
-                    ) . '_'
-                    : '';
-
-
-                //active gateways
-                $active_gateways = get_option('event_espresso_active_gateways');
-                if (! empty($active_gateways)) {
-                    foreach ((array)$active_gateways as $gateway => $ignore) {
-                        $extra_stats[$site_pre . $gateway . '_gateway_active'] = 1;
-                    }
-                }
-
-                if (is_multisite() && is_main_site()) {
-                    $extra_stats['is_multisite'] = true;
-                }
-
-                //what is the current active theme?
-                $active_theme = get_option('uxip_ee_active_theme');
-                if (! empty($active_theme)) {
-                    $extra_stats[$site_pre . 'active_theme'] = $active_theme;
-                }
-
-                //event info regarding an all event count and all "active" event count
-                $all_events_count = get_option('uxip_ee4_all_events_count');
-                if (! empty($all_events_count)) {
-                    $extra_stats[$site_pre . 'ee4_all_events_count'] = $all_events_count;
-                }
-                $active_events_count = get_option('uxip_ee4_active_events_count');
-                if (! empty($active_events_count)) {
-                    $extra_stats[$site_pre . 'ee4_active_events_count'] = $active_events_count;
-                }
-
-                //datetime stuff
-                $dtt_count = get_option('uxip_ee_all_dtts_count');
-                if (! empty($dtt_count)) {
-                    $extra_stats[$site_pre . 'all_dtts_count'] = $dtt_count;
-                }
-
-                $dtt_sold = get_option('uxip_ee_dtt_sold');
-                if (! empty($dtt_sold)) {
-                    $extra_stats[$site_pre . 'dtt_sold'] = $dtt_sold;
-                }
-
-                //ticket stuff
-                $all_tkt_count = get_option('uxip_ee_all_tkt_count');
-                if (! empty($all_tkt_count)) {
-                    $extra_stats[$site_pre . 'all_tkt_count'] = $all_tkt_count;
-                }
-
-                $free_tkt_count = get_option('uxip_ee_free_tkt_count');
-                if (! empty($free_tkt_count)) {
-                    $extra_stats[$site_pre . 'free_tkt_count'] = $free_tkt_count;
-                }
-
-                $paid_tkt_count = get_option('uxip_ee_paid_tkt_count');
-                if (! empty($paid_tkt_count)) {
-                    $extra_stats[$site_pre . 'paid_tkt_count'] = $paid_tkt_count;
-                }
-
-                $tkt_sold = get_option('uxip_ee_tkt_sold');
-                if (! empty($tkt_sold)) {
-                    $extra_stats[$site_pre . 'tkt_sold'] = $tkt_sold;
-                }
-
-                //phpversion checking
-                $extra_stats['phpversion'] = function_exists('phpversion') ? phpversion() : 'unknown';
-
-                //set transient
-                set_transient('ee_extra_data', $extra_stats, WEEK_IN_SECONDS);
-            }
-        }
-
-
-        // PUE Auto Upgrades stuff
-        if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { //include the file
-            require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
-
-            $api_key         = isset(EE_Registry::instance()->NET_CFG->core->site_license_key)
-                ? EE_Registry::instance()->NET_CFG->core->site_license_key
-                : '';
-            //this needs to be the host server where plugin update engine is installed. Note, if you leave this blank
-            // then it is assumed the WordPress repo will be used and we'll just check there.
-            $host_server_url = 'https://eventespresso.com';
-
-            //Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
-            //  So it's important that you use a key for the version type that is unique and not found in another key.
-            //For example:
-            //$plugin_slug['premium']['p'] = 'some-premium-slug';
-            //$plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
-            //The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
-            // so doing something like:
-            //$plugin_slug['premium']['p'] = 'some-premium-slug';
-            //$plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
-            //..WOULD work!
-            $plugin_slug = array(
-                'free'       => array('decaf' => 'event-espresso-core-decaf'),
-                'premium'    => array('p' => 'event-espresso-core-reg'),
-                'prerelease' => array('beta' => 'event-espresso-core-pr'),
-            );
-
-
-            //$options needs to be an array with the included keys as listed.
-            $options = array(
-                //	'optionName' => '', //(optional) - used as the reference for saving update information in the
-                // clients options table.  Will be automatically set if left blank.
-                'apikey'                => $api_key,
-                //(required), you will need to obtain the apikey that the client gets from your site and
-                // then saves in their sites options table (see 'getting an api-key' below)
-                'lang_domain'           => 'event_espresso',
-                //(optional) - put here whatever reference you are using for the localization of your plugin (if it's
-                // localized).  That way strings in this file will be included in the translation for your plugin.
-                'checkPeriod'           => '24',
-                //(optional) - use this parameter to indicate how often you want the client's install to ping your
-                // server for update checks.  The integer indicates hours.  If you don't include this parameter it will
-                // default to 12 hours.
-                'option_key'            => 'site_license_key',
-                //this is what is used to reference the api_key in your plugin options.  PUE uses this to trigger
-                // updating your information message whenever this option_key is modified.
-                'options_page_slug'     => 'espresso_general_settings',
-                'plugin_basename'       => EE_PLUGIN_BASENAME,
-                'use_wp_update'         => true,
-                //if TRUE then you want FREE versions of the plugin to be updated from WP
-                'extra_stats'           => $extra_stats,
-                'turn_on_notices_saved' => true,
-            );
-            //initiate the class and start the plugin update engine!
-            new PluginUpdateEngineChecker($host_server_url, $plugin_slug, $options);
-        }
-    }
-
-
-    /**
-     * The purpose of this function is to display information about Event Espresso data collection
-     * and a optin selection for extra data collecting by users.
-     *
-     * @param bool $extra
-     * @return string html.
-     */
-    public static function espresso_data_collection_optin_text($extra = true)
-    {
-        if (! $extra) {
-            echo '<h2 class="ee-admin-settings-hdr" '
-                 . (! $extra ? 'id="UXIP_settings"' : '')
-                 . '>'
-                 . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
-                 . EEH_Template::get_help_tab_link('organization_logo_info')
-                 . '</h2>';
-            printf(
-                esc_html__(
-                    '%sPlease help us make Event Espresso better and vote for your favorite features.%s The %sUser eXperience Improvement Program (UXIP)%s, has been created so when you use Event Espresso you are voting for the features and settings that are important to you. The UXIP helps us understand how you use our products and services, track problems and in what context. If you opt-out of the UXIP you essentially elect for us to disregard how you use Event Espresso as we build new features and make changes. Participation in the program is completely voluntary but it is enabled by default. The end results of the UXIP are software improvements to better meet your needs. The data we collect will never be sold, traded, or misused in any way. %sPlease see our %sPrivacy Policy%s for more information.',
-                    'event_espresso'
-                ),
-                '<p><em>',
-                '</em></p>',
-                '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
-                '</a>',
-                '<br><br>',
-                '<a href="https://eventespresso.com/about/privacy-policy/" target="_blank">',
-                '</a>'
-            );
-        } else {
-            $settings_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'default'),
-                admin_url('admin.php?page=espresso_general_settings')
-            );
-            $settings_url .= '#UXIP_settings';
-            printf(
-                esc_html__(
-                    'The Event Espresso UXIP feature is active on your site. For %smore info%s and to opt-out %sclick here%s.',
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
-                '</a>',
-                '<a href="' . $settings_url . '" target="_blank">',
-                '</a>'
-            );
-        }
-    }
-
-
-    public function espresso_data_collection_optin_notice()
-    {
-        $ueip_has_notified = EE_Registry::instance()->CFG->core->ee_ueip_has_notified;
-        if ($ueip_has_notified) {
-            return;
-        }
-        // $settings_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action' => 'default'),
-        // admin_url( 'admin.php?page=espresso_general_settings') );
-        // $settings_url = $settings_url . '#UXIP_settings';
-        ?>
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+
+		//wp have no MONTH_IN_SECONDS constant.  So we approximate our own assuming all months are 4 weeks long.
+		if (! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', WEEK_IN_SECONDS * 4);
+		}
+
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			$this->_uxip_hooks();
+		}
+
+
+		$ueip_optin        = EE_Registry::instance()->CFG->core->ee_ueip_optin;
+		$ueip_has_notified = EE_Registry::instance()->CFG->core->ee_ueip_has_notified;
+
+		//has optin been selected for data collection?
+		$espresso_data_optin = ! empty($ueip_optin) ? $ueip_optin : null;
+
+		if (empty($ueip_has_notified)
+			&& EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			add_action('admin_notices', array($this, 'espresso_data_collection_optin_notice'), 10);
+			add_action('admin_enqueue_scripts', array($this, 'espresso_data_collection_enqueue_scripts'), 10);
+			add_action('wp_ajax_espresso_data_optin', array($this, 'espresso_data_optin_ajax_handler'), 10);
+			update_option('ee_ueip_optin', 'yes');
+			$espresso_data_optin = 'yes';
+		}
+
+		//let's prepare extra stats
+		$extra_stats = array();
+
+		//only collect extra stats if the plugin user has opted in and transient is expired.
+		if (! empty($espresso_data_optin) && $espresso_data_optin == 'yes') {
+			if (false === ($transient = get_transient('ee_extra_data'))
+				&& EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
+			) {
+
+				$current_site = is_multisite() ? get_current_site() : null;
+				$site_pre     = ! is_main_site() && ! empty($current_site)
+					? trim(
+						preg_replace('/\b\w\S\w\b/', '', $current_site->domain),
+						'.'
+					) . '_'
+					: '';
+
+
+				//active gateways
+				$active_gateways = get_option('event_espresso_active_gateways');
+				if (! empty($active_gateways)) {
+					foreach ((array)$active_gateways as $gateway => $ignore) {
+						$extra_stats[$site_pre . $gateway . '_gateway_active'] = 1;
+					}
+				}
+
+				if (is_multisite() && is_main_site()) {
+					$extra_stats['is_multisite'] = true;
+				}
+
+				//what is the current active theme?
+				$active_theme = get_option('uxip_ee_active_theme');
+				if (! empty($active_theme)) {
+					$extra_stats[$site_pre . 'active_theme'] = $active_theme;
+				}
+
+				//event info regarding an all event count and all "active" event count
+				$all_events_count = get_option('uxip_ee4_all_events_count');
+				if (! empty($all_events_count)) {
+					$extra_stats[$site_pre . 'ee4_all_events_count'] = $all_events_count;
+				}
+				$active_events_count = get_option('uxip_ee4_active_events_count');
+				if (! empty($active_events_count)) {
+					$extra_stats[$site_pre . 'ee4_active_events_count'] = $active_events_count;
+				}
+
+				//datetime stuff
+				$dtt_count = get_option('uxip_ee_all_dtts_count');
+				if (! empty($dtt_count)) {
+					$extra_stats[$site_pre . 'all_dtts_count'] = $dtt_count;
+				}
+
+				$dtt_sold = get_option('uxip_ee_dtt_sold');
+				if (! empty($dtt_sold)) {
+					$extra_stats[$site_pre . 'dtt_sold'] = $dtt_sold;
+				}
+
+				//ticket stuff
+				$all_tkt_count = get_option('uxip_ee_all_tkt_count');
+				if (! empty($all_tkt_count)) {
+					$extra_stats[$site_pre . 'all_tkt_count'] = $all_tkt_count;
+				}
+
+				$free_tkt_count = get_option('uxip_ee_free_tkt_count');
+				if (! empty($free_tkt_count)) {
+					$extra_stats[$site_pre . 'free_tkt_count'] = $free_tkt_count;
+				}
+
+				$paid_tkt_count = get_option('uxip_ee_paid_tkt_count');
+				if (! empty($paid_tkt_count)) {
+					$extra_stats[$site_pre . 'paid_tkt_count'] = $paid_tkt_count;
+				}
+
+				$tkt_sold = get_option('uxip_ee_tkt_sold');
+				if (! empty($tkt_sold)) {
+					$extra_stats[$site_pre . 'tkt_sold'] = $tkt_sold;
+				}
+
+				//phpversion checking
+				$extra_stats['phpversion'] = function_exists('phpversion') ? phpversion() : 'unknown';
+
+				//set transient
+				set_transient('ee_extra_data', $extra_stats, WEEK_IN_SECONDS);
+			}
+		}
+
+
+		// PUE Auto Upgrades stuff
+		if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { //include the file
+			require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
+
+			$api_key         = isset(EE_Registry::instance()->NET_CFG->core->site_license_key)
+				? EE_Registry::instance()->NET_CFG->core->site_license_key
+				: '';
+			//this needs to be the host server where plugin update engine is installed. Note, if you leave this blank
+			// then it is assumed the WordPress repo will be used and we'll just check there.
+			$host_server_url = 'https://eventespresso.com';
+
+			//Note: PUE uses a simple preg_match to determine what type is currently installed based on version number.
+			//  So it's important that you use a key for the version type that is unique and not found in another key.
+			//For example:
+			//$plugin_slug['premium']['p'] = 'some-premium-slug';
+			//$plugin_slug['prerelease']['pr'] = 'some-pre-release-slug';
+			//The above would not work because "p" is found in both keys for the version type. ( i.e 1.0.p vs 1.0.pr )
+			// so doing something like:
+			//$plugin_slug['premium']['p'] = 'some-premium-slug';
+			//$plugin_slug['prerelease']['b'] = 'some-pre-release-slug';
+			//..WOULD work!
+			$plugin_slug = array(
+				'free'       => array('decaf' => 'event-espresso-core-decaf'),
+				'premium'    => array('p' => 'event-espresso-core-reg'),
+				'prerelease' => array('beta' => 'event-espresso-core-pr'),
+			);
+
+
+			//$options needs to be an array with the included keys as listed.
+			$options = array(
+				//	'optionName' => '', //(optional) - used as the reference for saving update information in the
+				// clients options table.  Will be automatically set if left blank.
+				'apikey'                => $api_key,
+				//(required), you will need to obtain the apikey that the client gets from your site and
+				// then saves in their sites options table (see 'getting an api-key' below)
+				'lang_domain'           => 'event_espresso',
+				//(optional) - put here whatever reference you are using for the localization of your plugin (if it's
+				// localized).  That way strings in this file will be included in the translation for your plugin.
+				'checkPeriod'           => '24',
+				//(optional) - use this parameter to indicate how often you want the client's install to ping your
+				// server for update checks.  The integer indicates hours.  If you don't include this parameter it will
+				// default to 12 hours.
+				'option_key'            => 'site_license_key',
+				//this is what is used to reference the api_key in your plugin options.  PUE uses this to trigger
+				// updating your information message whenever this option_key is modified.
+				'options_page_slug'     => 'espresso_general_settings',
+				'plugin_basename'       => EE_PLUGIN_BASENAME,
+				'use_wp_update'         => true,
+				//if TRUE then you want FREE versions of the plugin to be updated from WP
+				'extra_stats'           => $extra_stats,
+				'turn_on_notices_saved' => true,
+			);
+			//initiate the class and start the plugin update engine!
+			new PluginUpdateEngineChecker($host_server_url, $plugin_slug, $options);
+		}
+	}
+
+
+	/**
+	 * The purpose of this function is to display information about Event Espresso data collection
+	 * and a optin selection for extra data collecting by users.
+	 *
+	 * @param bool $extra
+	 * @return string html.
+	 */
+	public static function espresso_data_collection_optin_text($extra = true)
+	{
+		if (! $extra) {
+			echo '<h2 class="ee-admin-settings-hdr" '
+				 . (! $extra ? 'id="UXIP_settings"' : '')
+				 . '>'
+				 . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
+				 . EEH_Template::get_help_tab_link('organization_logo_info')
+				 . '</h2>';
+			printf(
+				esc_html__(
+					'%sPlease help us make Event Espresso better and vote for your favorite features.%s The %sUser eXperience Improvement Program (UXIP)%s, has been created so when you use Event Espresso you are voting for the features and settings that are important to you. The UXIP helps us understand how you use our products and services, track problems and in what context. If you opt-out of the UXIP you essentially elect for us to disregard how you use Event Espresso as we build new features and make changes. Participation in the program is completely voluntary but it is enabled by default. The end results of the UXIP are software improvements to better meet your needs. The data we collect will never be sold, traded, or misused in any way. %sPlease see our %sPrivacy Policy%s for more information.',
+					'event_espresso'
+				),
+				'<p><em>',
+				'</em></p>',
+				'<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
+				'</a>',
+				'<br><br>',
+				'<a href="https://eventespresso.com/about/privacy-policy/" target="_blank">',
+				'</a>'
+			);
+		} else {
+			$settings_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'default'),
+				admin_url('admin.php?page=espresso_general_settings')
+			);
+			$settings_url .= '#UXIP_settings';
+			printf(
+				esc_html__(
+					'The Event Espresso UXIP feature is active on your site. For %smore info%s and to opt-out %sclick here%s.',
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
+				'</a>',
+				'<a href="' . $settings_url . '" target="_blank">',
+				'</a>'
+			);
+		}
+	}
+
+
+	public function espresso_data_collection_optin_notice()
+	{
+		$ueip_has_notified = EE_Registry::instance()->CFG->core->ee_ueip_has_notified;
+		if ($ueip_has_notified) {
+			return;
+		}
+		// $settings_url = EE_Admin_Page::add_query_args_and_nonce( array( 'action' => 'default'),
+		// admin_url( 'admin.php?page=espresso_general_settings') );
+		// $settings_url = $settings_url . '#UXIP_settings';
+		?>
         <div class="updated data-collect-optin" id="espresso-data-collect-optin-container">
             <div id="data-collect-optin-options-container">
                 <span class="dashicons dashicons-admin-site"></span>
@@ -270,186 +270,186 @@ 
             </div>
         </div>
         <?php
-    }
-
-
-    /**
-     * enqueue scripts/styles needed for data collection optin
-     *
-     * @return void
-     */
-    public function espresso_data_collection_enqueue_scripts()
-    {
-        wp_register_script(
-            'ee-data-optin-js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style(
-            'ee-data-optin-css',
-            EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-
-        wp_enqueue_script('ee-data-optin-js');
-        wp_enqueue_style('ee-data-optin-css');
-    }
-
-
-    /**
-     * This just handles the setting of the selected option for data optin via ajax
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function espresso_data_optin_ajax_handler()
-    {
-
-        //verify nonce
-        if (isset($_POST['nonce']) && ! wp_verify_nonce($_POST['nonce'], 'ee-data-optin')) {
-            exit();
-        }
-
-        //update_option('ee_ueip_optin', $ueip_optin);
-        EE_Registry::instance()->CFG->core->ee_ueip_has_notified = 1;
-        EE_Registry::instance()->CFG->update_espresso_config(false, false);
-        exit();
-    }
-
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     */
-    public static function is_update_available($basename = '')
-    {
-
-        $basename = ! empty($basename) ? $basename : EE_PLUGIN_BASENAME;
-
-        $update = false;
-
-        // should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
-        $folder = DS . dirname($basename);
-
-        $plugins = get_plugins($folder);
-        $current = get_site_transient('update_plugins');
-
-        foreach ((array)$plugins as $plugin_file => $plugin_data) {
-            if (isset($current->response['plugin_file'])) {
-                $update = true;
-            }
-        }
-
-        //it's possible that there is an update but an invalid site-license-key is in use
-        if (get_site_option('pue_json_error_' . $basename)) {
-            $update = true;
-        }
-
-        return $update;
-    }
-
-
-    /**
-     * UXIP TRACKING *******
-     */
-
-
-    /**
-     * This method contains all the hooks into EE for gathering stats that will be reported with the PUE uxip system
-     *
-     * @public
-     * @return void
-     */
-    public function _uxip_hooks()
-    {
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            add_action('admin_init', array($this, 'track_active_theme'));
-            add_action('admin_init', array($this, 'track_event_info'));
-        }
-    }
-
-
-    public function track_active_theme()
-    {
-        //we only check this once a month.
-        if (false === ($transient = get_transient('ee_active_theme_check'))) {
-            $theme = wp_get_theme();
-            update_option('uxip_ee_active_theme', $theme->get('Name'));
-            set_transient('ee_active_theme_check', 1, MONTH_IN_SECONDS);
-        }
-    }
-
-
-    public function track_event_info()
-    {
-        //we only check this once every couple weeks.
-        if (false === ($transient = get_transient('ee4_event_info_check'))) {
-            //first let's get the number for ALL events
-            /** @var EEM_Event $EVT */
-            $EVT   = EE_Registry::instance()->load_model('Event');
-            $DTT   = EE_Registry::instance()->load_model('Datetime');
-            $TKT   = EE_Registry::instance()->load_model('Ticket');
-            $count = $EVT->count();
-            if ($count > 0) {
-                update_option('uxip_ee4_all_events_count', $count);
-            }
-
-            //next let's just get the number of ACTIVE events
-            $count_active = $EVT->get_active_events(array(), true);
-            if ($count_active > 0) {
-                update_option('uxip_ee4_active_events_count', $count_active);
-            }
-
-            //datetimes!
-            $dtt_count = $DTT->count();
-            if ($dtt_count > 0) {
-                update_option('uxip_ee_all_dtts_count', $dtt_count);
-            }
-
-
-            //dttsold
-            $dtt_sold = $DTT->sum(array(), 'DTT_sold');
-            if ($dtt_sold > 0) {
-                update_option('uxip_ee_dtt_sold', $dtt_sold);
-            }
-
-            //allticketcount
-            $all_tkt_count = $TKT->count();
-            if ($all_tkt_count > 0) {
-                update_option('uxip_ee_all_tkt_count', $all_tkt_count);
-            }
-
-            //freetktcount
-            $_where         = array('TKT_price' => 0);
-            $free_tkt_count = $TKT->count(array($_where));
-            if ($free_tkt_count > 0) {
-                update_option('uxip_ee_free_tkt_count', $free_tkt_count);
-            }
-
-            //paidtktcount
-            $_where         = array('TKT_price' => array('>', 0));
-            $paid_tkt_count = $TKT->count(array($_where));
-            if ($paid_tkt_count > 0) {
-                update_option('uxip_ee_paid_tkt_count', $paid_tkt_count);
-            }
-
-            //tktsold
-            $tkt_sold = $TKT->sum(array(), 'TKT_sold');
-            if ($tkt_sold > 0) {
-                update_option('uxip_ee_tkt_sold', $tkt_sold);
-            }
-
-
-            set_transient('ee4_event_info_check', 1, WEEK_IN_SECONDS * 2);
-        }
-    }
+	}
+
+
+	/**
+	 * enqueue scripts/styles needed for data collection optin
+	 *
+	 * @return void
+	 */
+	public function espresso_data_collection_enqueue_scripts()
+	{
+		wp_register_script(
+			'ee-data-optin-js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style(
+			'ee-data-optin-css',
+			EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+
+		wp_enqueue_script('ee-data-optin-js');
+		wp_enqueue_style('ee-data-optin-css');
+	}
+
+
+	/**
+	 * This just handles the setting of the selected option for data optin via ajax
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function espresso_data_optin_ajax_handler()
+	{
+
+		//verify nonce
+		if (isset($_POST['nonce']) && ! wp_verify_nonce($_POST['nonce'], 'ee-data-optin')) {
+			exit();
+		}
+
+		//update_option('ee_ueip_optin', $ueip_optin);
+		EE_Registry::instance()->CFG->core->ee_ueip_has_notified = 1;
+		EE_Registry::instance()->CFG->update_espresso_config(false, false);
+		exit();
+	}
+
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 */
+	public static function is_update_available($basename = '')
+	{
+
+		$basename = ! empty($basename) ? $basename : EE_PLUGIN_BASENAME;
+
+		$update = false;
+
+		// should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
+		$folder = DS . dirname($basename);
+
+		$plugins = get_plugins($folder);
+		$current = get_site_transient('update_plugins');
+
+		foreach ((array)$plugins as $plugin_file => $plugin_data) {
+			if (isset($current->response['plugin_file'])) {
+				$update = true;
+			}
+		}
+
+		//it's possible that there is an update but an invalid site-license-key is in use
+		if (get_site_option('pue_json_error_' . $basename)) {
+			$update = true;
+		}
+
+		return $update;
+	}
+
+
+	/**
+	 * UXIP TRACKING *******
+	 */
+
+
+	/**
+	 * This method contains all the hooks into EE for gathering stats that will be reported with the PUE uxip system
+	 *
+	 * @public
+	 * @return void
+	 */
+	public function _uxip_hooks()
+	{
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			add_action('admin_init', array($this, 'track_active_theme'));
+			add_action('admin_init', array($this, 'track_event_info'));
+		}
+	}
+
+
+	public function track_active_theme()
+	{
+		//we only check this once a month.
+		if (false === ($transient = get_transient('ee_active_theme_check'))) {
+			$theme = wp_get_theme();
+			update_option('uxip_ee_active_theme', $theme->get('Name'));
+			set_transient('ee_active_theme_check', 1, MONTH_IN_SECONDS);
+		}
+	}
+
+
+	public function track_event_info()
+	{
+		//we only check this once every couple weeks.
+		if (false === ($transient = get_transient('ee4_event_info_check'))) {
+			//first let's get the number for ALL events
+			/** @var EEM_Event $EVT */
+			$EVT   = EE_Registry::instance()->load_model('Event');
+			$DTT   = EE_Registry::instance()->load_model('Datetime');
+			$TKT   = EE_Registry::instance()->load_model('Ticket');
+			$count = $EVT->count();
+			if ($count > 0) {
+				update_option('uxip_ee4_all_events_count', $count);
+			}
+
+			//next let's just get the number of ACTIVE events
+			$count_active = $EVT->get_active_events(array(), true);
+			if ($count_active > 0) {
+				update_option('uxip_ee4_active_events_count', $count_active);
+			}
+
+			//datetimes!
+			$dtt_count = $DTT->count();
+			if ($dtt_count > 0) {
+				update_option('uxip_ee_all_dtts_count', $dtt_count);
+			}
+
+
+			//dttsold
+			$dtt_sold = $DTT->sum(array(), 'DTT_sold');
+			if ($dtt_sold > 0) {
+				update_option('uxip_ee_dtt_sold', $dtt_sold);
+			}
+
+			//allticketcount
+			$all_tkt_count = $TKT->count();
+			if ($all_tkt_count > 0) {
+				update_option('uxip_ee_all_tkt_count', $all_tkt_count);
+			}
+
+			//freetktcount
+			$_where         = array('TKT_price' => 0);
+			$free_tkt_count = $TKT->count(array($_where));
+			if ($free_tkt_count > 0) {
+				update_option('uxip_ee_free_tkt_count', $free_tkt_count);
+			}
+
+			//paidtktcount
+			$_where         = array('TKT_price' => array('>', 0));
+			$paid_tkt_count = $TKT->count(array($_where));
+			if ($paid_tkt_count > 0) {
+				update_option('uxip_ee_paid_tkt_count', $paid_tkt_count);
+			}
+
+			//tktsold
+			$tkt_sold = $TKT->sum(array(), 'TKT_sold');
+			if ($tkt_sold > 0) {
+				update_option('uxip_ee_tkt_sold', $tkt_sold);
+			}
+
+
+			set_transient('ee4_event_info_check', 1, WEEK_IN_SECONDS * 2);
+		}
+	}
 
 }

Spacing +35 added lines, -35 removed lines

@@ -29,7 +29,7 @@ 
         do_action('AHEE_log', __CLASS__, __FUNCTION__);
 
         //wp have no MONTH_IN_SECONDS constant.  So we approximate our own assuming all months are 4 weeks long.
-        if (! defined('MONTH_IN_SECONDS')) {
+        if ( ! defined('MONTH_IN_SECONDS')) {
             define('MONTH_IN_SECONDS', WEEK_IN_SECONDS * 4);
         }
 
@@ -58,7 +58,7 @@ 
         $extra_stats = array();
 
         //only collect extra stats if the plugin user has opted in and transient is expired.
-        if (! empty($espresso_data_optin) && $espresso_data_optin == 'yes') {
+        if ( ! empty($espresso_data_optin) && $espresso_data_optin == 'yes') {
             if (false === ($transient = get_transient('ee_extra_data'))
                 && EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance
             ) {
@@ -68,15 +68,15 @@ 
                     ? trim(
                         preg_replace('/\b\w\S\w\b/', '', $current_site->domain),
                         '.'
-                    ) . '_'
+                    ).'_'
                     : '';
 
 
                 //active gateways
                 $active_gateways = get_option('event_espresso_active_gateways');
-                if (! empty($active_gateways)) {
-                    foreach ((array)$active_gateways as $gateway => $ignore) {
-                        $extra_stats[$site_pre . $gateway . '_gateway_active'] = 1;
+                if ( ! empty($active_gateways)) {
+                    foreach ((array) $active_gateways as $gateway => $ignore) {
+                        $extra_stats[$site_pre.$gateway.'_gateway_active'] = 1;
                     }
                 }
 
@@ -86,50 +86,50 @@ 
 
                 //what is the current active theme?
                 $active_theme = get_option('uxip_ee_active_theme');
-                if (! empty($active_theme)) {
-                    $extra_stats[$site_pre . 'active_theme'] = $active_theme;
+                if ( ! empty($active_theme)) {
+                    $extra_stats[$site_pre.'active_theme'] = $active_theme;
                 }
 
                 //event info regarding an all event count and all "active" event count
                 $all_events_count = get_option('uxip_ee4_all_events_count');
-                if (! empty($all_events_count)) {
-                    $extra_stats[$site_pre . 'ee4_all_events_count'] = $all_events_count;
+                if ( ! empty($all_events_count)) {
+                    $extra_stats[$site_pre.'ee4_all_events_count'] = $all_events_count;
                 }
                 $active_events_count = get_option('uxip_ee4_active_events_count');
-                if (! empty($active_events_count)) {
-                    $extra_stats[$site_pre . 'ee4_active_events_count'] = $active_events_count;
+                if ( ! empty($active_events_count)) {
+                    $extra_stats[$site_pre.'ee4_active_events_count'] = $active_events_count;
                 }
 
                 //datetime stuff
                 $dtt_count = get_option('uxip_ee_all_dtts_count');
-                if (! empty($dtt_count)) {
-                    $extra_stats[$site_pre . 'all_dtts_count'] = $dtt_count;
+                if ( ! empty($dtt_count)) {
+                    $extra_stats[$site_pre.'all_dtts_count'] = $dtt_count;
                 }
 
                 $dtt_sold = get_option('uxip_ee_dtt_sold');
-                if (! empty($dtt_sold)) {
-                    $extra_stats[$site_pre . 'dtt_sold'] = $dtt_sold;
+                if ( ! empty($dtt_sold)) {
+                    $extra_stats[$site_pre.'dtt_sold'] = $dtt_sold;
                 }
 
                 //ticket stuff
                 $all_tkt_count = get_option('uxip_ee_all_tkt_count');
-                if (! empty($all_tkt_count)) {
-                    $extra_stats[$site_pre . 'all_tkt_count'] = $all_tkt_count;
+                if ( ! empty($all_tkt_count)) {
+                    $extra_stats[$site_pre.'all_tkt_count'] = $all_tkt_count;
                 }
 
                 $free_tkt_count = get_option('uxip_ee_free_tkt_count');
-                if (! empty($free_tkt_count)) {
-                    $extra_stats[$site_pre . 'free_tkt_count'] = $free_tkt_count;
+                if ( ! empty($free_tkt_count)) {
+                    $extra_stats[$site_pre.'free_tkt_count'] = $free_tkt_count;
                 }
 
                 $paid_tkt_count = get_option('uxip_ee_paid_tkt_count');
-                if (! empty($paid_tkt_count)) {
-                    $extra_stats[$site_pre . 'paid_tkt_count'] = $paid_tkt_count;
+                if ( ! empty($paid_tkt_count)) {
+                    $extra_stats[$site_pre.'paid_tkt_count'] = $paid_tkt_count;
                 }
 
                 $tkt_sold = get_option('uxip_ee_tkt_sold');
-                if (! empty($tkt_sold)) {
-                    $extra_stats[$site_pre . 'tkt_sold'] = $tkt_sold;
+                if ( ! empty($tkt_sold)) {
+                    $extra_stats[$site_pre.'tkt_sold'] = $tkt_sold;
                 }
 
                 //phpversion checking
@@ -142,10 +142,10 @@ 
 
 
         // PUE Auto Upgrades stuff
-        if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { //include the file
-            require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
+        if (is_readable(EE_THIRD_PARTY.'pue/pue-client.php')) { //include the file
+            require_once(EE_THIRD_PARTY.'pue/pue-client.php');
 
-            $api_key         = isset(EE_Registry::instance()->NET_CFG->core->site_license_key)
+            $api_key = isset(EE_Registry::instance()->NET_CFG->core->site_license_key)
                 ? EE_Registry::instance()->NET_CFG->core->site_license_key
                 : '';
             //this needs to be the host server where plugin update engine is installed. Note, if you leave this blank
@@ -208,9 +208,9 @@ 
      */
     public static function espresso_data_collection_optin_text($extra = true)
     {
-        if (! $extra) {
+        if ( ! $extra) {
             echo '<h2 class="ee-admin-settings-hdr" '
-                 . (! $extra ? 'id="UXIP_settings"' : '')
+                 . ( ! $extra ? 'id="UXIP_settings"' : '')
                  . '>'
                  . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
                  . EEH_Template::get_help_tab_link('organization_logo_info')
@@ -241,7 +241,7 @@ 
                 ),
                 '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
                 '</a>',
-                '<a href="' . $settings_url . '" target="_blank">',
+                '<a href="'.$settings_url.'" target="_blank">',
                 '</a>'
             );
         }
@@ -282,14 +282,14 @@ 
     {
         wp_register_script(
             'ee-data-optin-js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/ee-data-optin.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_style(
             'ee-data-optin-css',
-            EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
+            EE_GLOBAL_ASSETS_URL.'css/ee-data-optin.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
@@ -337,19 +337,19 @@ 
         $update = false;
 
         // should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
-        $folder = DS . dirname($basename);
+        $folder = DS.dirname($basename);
 
         $plugins = get_plugins($folder);
         $current = get_site_transient('update_plugins');
 
-        foreach ((array)$plugins as $plugin_file => $plugin_data) {
+        foreach ((array) $plugins as $plugin_file => $plugin_data) {
             if (isset($current->response['plugin_file'])) {
                 $update = true;
             }
         }
 
         //it's possible that there is an update but an invalid site-license-key is in use
-        if (get_site_option('pue_json_error_' . $basename)) {
+        if (get_site_option('pue_json_error_'.$basename)) {
             $update = true;
         }