eventespresso / event-espresso-core

core/libraries/form_sections/strategies/validation/EE_Email_Validation_Strategy.strategy.php

Indentation +59 added lines, -59 removed lines

@@ -18,72 +18,72 @@
 {
 
 
-    /**
-     * @param string               $validation_error_message
-     */
-    public function __construct($validation_error_message = '')
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso');
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param string               $validation_error_message
+	 */
+	public function __construct($validation_error_message = '')
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso');
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * just checks the field isn't blank
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if ($normalized_value && ! $this->_validate_email($normalized_value)) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
-        }
-        return true;
-    }
+	/**
+	 * just checks the field isn't blank
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if ($normalized_value && ! $this->_validate_email($normalized_value)) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
+		}
+		return true;
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message()));
+	}
 
 
 
-    /**
-     * Validate an email address.
-     * Provide email address (raw input)
-     *
-     * @param $email
-     * @return bool of whether the email is valid or not
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Validation_Error
-     */
-    private function _validate_email($email)
-    {
-        try {
-            EmailAddressFactory::create($email);
-        } catch (EmailValidationException $e) {
-            throw new EE_Validation_Error(
-                $e->getMessage(),
-                'invalid_email',
-                $this->_input,
-                $e
-            );
-        }
-        return true;
-    }
+	/**
+	 * Validate an email address.
+	 * Provide email address (raw input)
+	 *
+	 * @param $email
+	 * @return bool of whether the email is valid or not
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Validation_Error
+	 */
+	private function _validate_email($email)
+	{
+		try {
+			EmailAddressFactory::create($email);
+		} catch (EmailValidationException $e) {
+			throw new EE_Validation_Error(
+				$e->getMessage(),
+				'invalid_email',
+				$this->_input,
+				$e
+			);
+		}
+		return true;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      */
     public function __construct($validation_error_message = '')
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso');
         }
         parent::__construct($validation_error_message);

core/domain/services/factories/EmailAddressFactory.php

Indentation +15 added lines, -15 removed lines

@@ -23,21 +23,21 @@
 class EmailAddressFactory implements FactoryInterface
 {
 
-    /**
-     * @param string $email_address
-     * @return EmailAddress
-     * @throws EmailValidationException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function create($email_address)
-    {
-        return LoaderFactory::getLoader()->getNew(
-            'EventEspresso\core\domain\values\EmailAddress',
-            array($email_address)
-        );
-    }
+	/**
+	 * @param string $email_address
+	 * @return EmailAddress
+	 * @throws EmailValidationException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function create($email_address)
+	{
+		return LoaderFactory::getLoader()->getNew(
+			'EventEspresso\core\domain\values\EmailAddress',
+			array($email_address)
+		);
+	}
 
 }
 // Location: core/domain/services/factories/EmailAddressFactory.php

core/EE_Load_Espresso_Core.core.php

Spacing +12 added lines, -12 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\services\loaders\LoaderFactory;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -51,7 +51,7 @@ 
      */
     public function __construct()
     {
-        espresso_load_required('EventEspresso\core\Factory', EE_CORE . 'Factory.php');
+        espresso_load_required('EventEspresso\core\Factory', EE_CORE.'Factory.php');
     }
 
 
@@ -105,9 +105,9 @@ 
         $this->_load_class_tools();
         // load interfaces
         espresso_load_required('EEI_Payment_Method_Interfaces',
-            EE_LIBRARIES . 'payment_methods' . DS . 'EEI_Payment_Method_Interfaces.php');
+            EE_LIBRARIES.'payment_methods'.DS.'EEI_Payment_Method_Interfaces.php');
         // deprecated functions
-        espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
+        espresso_load_required('EE_Deprecated', EE_CORE.'EE_Deprecated.core.php');
         // WP cron jobs
         $loader->getShared('EE_Cron_Tasks');
         $loader->getShared('EE_Request_Handler');
@@ -143,7 +143,7 @@ 
      */
     public function dependency_map()
     {
-        if (! $this->dependency_map instanceof EE_Dependency_Map) {
+        if ( ! $this->dependency_map instanceof EE_Dependency_Map) {
             throw new EE_Error(
                 sprintf(
                     __('Invalid EE_Dependency_Map: "%1$s"', 'event_espresso'),
@@ -162,7 +162,7 @@ 
      */
     public function registry()
     {
-        if (! $this->registry instanceof EE_Registry) {
+        if ( ! $this->registry instanceof EE_Registry) {
             throw new EE_Error(
                 sprintf(
                     __('Invalid EE_Registry: "%1$s"', 'event_espresso'),
@@ -180,14 +180,14 @@ 
      */
     private function _load_dependency_map()
     {
-        if (! is_readable(EE_CORE . 'EE_Dependency_Map.core.php')) {
+        if ( ! is_readable(EE_CORE.'EE_Dependency_Map.core.php')) {
             EE_Error::add_error(
                 __('The EE_Dependency_Map core class could not be loaded.', 'event_espresso'),
                 __FILE__, __FUNCTION__, __LINE__
             );
             wp_die(EE_Error::get_notices());
         }
-        require_once(EE_CORE . 'EE_Dependency_Map.core.php');
+        require_once(EE_CORE.'EE_Dependency_Map.core.php');
         return EE_Dependency_Map::instance($this->request, $this->response);
     }
 
@@ -198,14 +198,14 @@ 
      */
     private function _load_registry()
     {
-        if (! is_readable(EE_CORE . 'EE_Registry.core.php')) {
+        if ( ! is_readable(EE_CORE.'EE_Registry.core.php')) {
             EE_Error::add_error(
                 __('The EE_Registry core class could not be loaded.', 'event_espresso'),
                 __FILE__, __FUNCTION__, __LINE__
             );
             wp_die(EE_Error::get_notices());
         }
-        require_once(EE_CORE . 'EE_Registry.core.php');
+        require_once(EE_CORE.'EE_Registry.core.php');
         return EE_Registry::instance($this->dependency_map);
     }
 
@@ -216,13 +216,13 @@ 
      */
     private function _load_class_tools()
     {
-        if (! is_readable(EE_HELPERS . 'EEH_Class_Tools.helper.php')) {
+        if ( ! is_readable(EE_HELPERS.'EEH_Class_Tools.helper.php')) {
             EE_Error::add_error(
                 __('The EEH_Class_Tools helper could not be loaded.', 'event_espresso'),
                 __FILE__, __FUNCTION__, __LINE__
             );
         }
-        require_once(EE_HELPERS . 'EEH_Class_Tools.helper.php');
+        require_once(EE_HELPERS.'EEH_Class_Tools.helper.php');
     }
 
 

Indentation +201 added lines, -201 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,206 +24,206 @@ 
 class EE_Load_Espresso_Core implements EEI_Request_Decorator, EEI_Request_Stack_Core_App
 {
 
-    /**
-     * @var EE_Request $request
-     */
-    protected $request;
-
-    /**
-     * @var EE_Response $response
-     */
-    protected $response;
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-
-
-    /**
-     * EE_Load_Espresso_Core constructor
-     */
-    public function __construct()
-    {
-        espresso_load_required('EventEspresso\core\Factory', EE_CORE . 'Factory.php');
-    }
-
-
-
-    /**
-     * handle
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Response
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        $this->request = $request;
-        $this->response = $response;
-        // info about how to load classes required by other classes
-        $this->dependency_map = $this->_load_dependency_map();
-        // central repository for classes
-        $this->registry = $this->_load_registry();
-        do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
-        $loader = LoaderFactory::getLoader($this->registry);
-        $this->dependency_map->setLoader($loader);
-        // build DI container
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-        // $OpenCoffeeShop->addRecipes();
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-        // workarounds for PHP < 5.3
-        $this->_load_class_tools();
-        // load interfaces
-        espresso_load_required('EEI_Payment_Method_Interfaces',
-            EE_LIBRARIES . 'payment_methods' . DS . 'EEI_Payment_Method_Interfaces.php');
-        // deprecated functions
-        espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
-        // WP cron jobs
-        $loader->getShared('EE_Cron_Tasks');
-        $loader->getShared('EE_Request_Handler');
-        $loader->getShared('EE_System');
-        return $this->response;
-    }
-
-
-
-    /**
-     * @return EE_Request
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-
-    /**
-     * @return EE_Response
-     */
-    public function response()
-    {
-        return $this->response;
-    }
-
-
-
-    /**
-     * @return EE_Dependency_Map
-     * @throws EE_Error
-     */
-    public function dependency_map()
-    {
-        if (! $this->dependency_map instanceof EE_Dependency_Map) {
-            throw new EE_Error(
-                sprintf(
-                    __('Invalid EE_Dependency_Map: "%1$s"', 'event_espresso'),
-                    print_r($this->dependency_map, true)
-                )
-            );
-        }
-        return $this->dependency_map;
-    }
-
-
-
-    /**
-     * @return EE_Registry
-     * @throws EE_Error
-     */
-    public function registry()
-    {
-        if (! $this->registry instanceof EE_Registry) {
-            throw new EE_Error(
-                sprintf(
-                    __('Invalid EE_Registry: "%1$s"', 'event_espresso'),
-                    print_r($this->registry, true)
-                )
-            );
-        }
-        return $this->registry;
-    }
-
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    private function _load_dependency_map()
-    {
-        if (! is_readable(EE_CORE . 'EE_Dependency_Map.core.php')) {
-            EE_Error::add_error(
-                __('The EE_Dependency_Map core class could not be loaded.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            wp_die(EE_Error::get_notices());
-        }
-        require_once(EE_CORE . 'EE_Dependency_Map.core.php');
-        return EE_Dependency_Map::instance($this->request, $this->response);
-    }
-
-
-
-    /**
-     * @return EE_Registry
-     */
-    private function _load_registry()
-    {
-        if (! is_readable(EE_CORE . 'EE_Registry.core.php')) {
-            EE_Error::add_error(
-                __('The EE_Registry core class could not be loaded.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            wp_die(EE_Error::get_notices());
-        }
-        require_once(EE_CORE . 'EE_Registry.core.php');
-        return EE_Registry::instance($this->dependency_map);
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function _load_class_tools()
-    {
-        if (! is_readable(EE_HELPERS . 'EEH_Class_Tools.helper.php')) {
-            EE_Error::add_error(
-                __('The EEH_Class_Tools helper could not be loaded.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        require_once(EE_HELPERS . 'EEH_Class_Tools.helper.php');
-    }
-
-
-
-    /**
-     * called after the request stack has been fully processed
-     * if any of the middleware apps has requested the plugin be deactivated, then we do that now
-     *
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     */
-    public function handle_response(EE_Request $request, EE_Response $response)
-    {
-        if ($response->plugin_deactivated()) {
-            espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
-        }
-    }
+	/**
+	 * @var EE_Request $request
+	 */
+	protected $request;
+
+	/**
+	 * @var EE_Response $response
+	 */
+	protected $response;
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+
+
+	/**
+	 * EE_Load_Espresso_Core constructor
+	 */
+	public function __construct()
+	{
+		espresso_load_required('EventEspresso\core\Factory', EE_CORE . 'Factory.php');
+	}
+
+
+
+	/**
+	 * handle
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Response
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		$this->request = $request;
+		$this->response = $response;
+		// info about how to load classes required by other classes
+		$this->dependency_map = $this->_load_dependency_map();
+		// central repository for classes
+		$this->registry = $this->_load_registry();
+		do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
+		$loader = LoaderFactory::getLoader($this->registry);
+		$this->dependency_map->setLoader($loader);
+		// build DI container
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+		// $OpenCoffeeShop->addRecipes();
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+		// workarounds for PHP < 5.3
+		$this->_load_class_tools();
+		// load interfaces
+		espresso_load_required('EEI_Payment_Method_Interfaces',
+			EE_LIBRARIES . 'payment_methods' . DS . 'EEI_Payment_Method_Interfaces.php');
+		// deprecated functions
+		espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
+		// WP cron jobs
+		$loader->getShared('EE_Cron_Tasks');
+		$loader->getShared('EE_Request_Handler');
+		$loader->getShared('EE_System');
+		return $this->response;
+	}
+
+
+
+	/**
+	 * @return EE_Request
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+
+	/**
+	 * @return EE_Response
+	 */
+	public function response()
+	{
+		return $this->response;
+	}
+
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 * @throws EE_Error
+	 */
+	public function dependency_map()
+	{
+		if (! $this->dependency_map instanceof EE_Dependency_Map) {
+			throw new EE_Error(
+				sprintf(
+					__('Invalid EE_Dependency_Map: "%1$s"', 'event_espresso'),
+					print_r($this->dependency_map, true)
+				)
+			);
+		}
+		return $this->dependency_map;
+	}
+
+
+
+	/**
+	 * @return EE_Registry
+	 * @throws EE_Error
+	 */
+	public function registry()
+	{
+		if (! $this->registry instanceof EE_Registry) {
+			throw new EE_Error(
+				sprintf(
+					__('Invalid EE_Registry: "%1$s"', 'event_espresso'),
+					print_r($this->registry, true)
+				)
+			);
+		}
+		return $this->registry;
+	}
+
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	private function _load_dependency_map()
+	{
+		if (! is_readable(EE_CORE . 'EE_Dependency_Map.core.php')) {
+			EE_Error::add_error(
+				__('The EE_Dependency_Map core class could not be loaded.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			wp_die(EE_Error::get_notices());
+		}
+		require_once(EE_CORE . 'EE_Dependency_Map.core.php');
+		return EE_Dependency_Map::instance($this->request, $this->response);
+	}
+
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	private function _load_registry()
+	{
+		if (! is_readable(EE_CORE . 'EE_Registry.core.php')) {
+			EE_Error::add_error(
+				__('The EE_Registry core class could not be loaded.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			wp_die(EE_Error::get_notices());
+		}
+		require_once(EE_CORE . 'EE_Registry.core.php');
+		return EE_Registry::instance($this->dependency_map);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function _load_class_tools()
+	{
+		if (! is_readable(EE_HELPERS . 'EEH_Class_Tools.helper.php')) {
+			EE_Error::add_error(
+				__('The EEH_Class_Tools helper could not be loaded.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		require_once(EE_HELPERS . 'EEH_Class_Tools.helper.php');
+	}
+
+
+
+	/**
+	 * called after the request stack has been fully processed
+	 * if any of the middleware apps has requested the plugin be deactivated, then we do that now
+	 *
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 */
+	public function handle_response(EE_Request $request, EE_Response $response)
+	{
+		if ($response->plugin_deactivated()) {
+			espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
+		}
+	}
 
 
 

core/db_models/EEM_Transaction.model.php

Indentation +363 added lines, -363 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_Base.model.php');
 
@@ -17,193 +17,193 @@ 
 class EEM_Transaction extends EEM_Base
 {
 
-    // private instance of the Transaction object
-    protected static $_instance;
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
-     * but payment is pending. This is the state for transactions where payment is promised
-     * from an offline gateway.
-     */
-    //	const open_status_code = 'TPN';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
-     * either due to a technical reason (server or computer crash during registration),
-     *  or some other reason that prevent the collection of any useful contact information from any of the registrants
-     */
-    const failed_status_code = 'TFL';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
-     * either due to a technical reason (server or computer crash during registration),
-     * or due to an abandoned cart after registrant chose not to complete the registration process
-     * HOWEVER...
-     * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
-     * registrant
-     */
-    const abandoned_status_code = 'TAB';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
-     * meaning that monies are still owing: TXN_paid < TXN_total
-     */
-    const incomplete_status_code = 'TIN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
-     * meaning that NO monies are owing: TXN_paid == TXN_total
-     */
-    const complete_status_code = 'TCM';
-
-    /**
-     *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
-     *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
-     */
-    const overpaid_status_code = 'TOP';
-
-
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     *
-     * @return EEM_Transaction
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Transaction', 'event_espresso');
-        $this->plural_item   = __('Transactions', 'event_espresso');
-
-        $this->_tables                 = array(
-            'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
-        );
-        $this->_fields                 = array(
-            'TransactionTable' => array(
-                'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
-                'TXN_timestamp'    => new EE_Datetime_Field('TXN_timestamp',
-                    __('date when transaction was created', 'event_espresso'), false, EE_Datetime_Field::now,
-                    $timezone),
-                'TXN_total'        => new EE_Money_Field('TXN_total',
-                    __('Total value of Transaction', 'event_espresso'), false, 0),
-                'TXN_paid'         => new EE_Money_Field('TXN_paid',
-                    __('Amount paid towards transaction to date', 'event_espresso'), false, 0),
-                'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
-                    false, EEM_Transaction::failed_status_code, 'Status'),
-                'TXN_session_data' => new EE_Serialized_Text_Field('TXN_session_data',
-                    __('Serialized session data', 'event_espresso'), true, ''),
-                'TXN_hash_salt'    => new EE_Plain_Text_Field('TXN_hash_salt',
-                    __('Transaction Hash Salt', 'event_espresso'), true, ''),
-                'PMD_ID'           => new EE_Foreign_Key_Int_Field('PMD_ID',
-                    __("Last Used Payment Method", 'event_espresso'), true, null, 'Payment_Method'),
-                'TXN_reg_steps'    => new EE_Serialized_Text_Field('TXN_reg_steps',
-                    __('Registration Steps', 'event_espresso'), false, array()),
-            )
-        );
-        $this->_model_relations        = array(
-            'Registration'   => new EE_Has_Many_Relation(),
-            'Payment'        => new EE_Has_Many_Relation(),
-            'Status'         => new EE_Belongs_To_Relation(),
-            'Line_Item'      => new EE_Has_Many_Relation(false),
-            //you can delete a transaction without needing to delete its line items
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-            'Message'        => new EE_Has_Many_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-
-    }
-
-
-    /**
-     *    txn_status_array
-     * get list of transaction statuses
-     *
-     * @access public
-     * @return array
-     */
-    public static function txn_status_array()
-    {
-        return apply_filters(
-            'FHEE__EEM_Transaction__txn_status_array',
-            array(
-                EEM_Transaction::overpaid_status_code,
-                EEM_Transaction::complete_status_code,
-                EEM_Transaction::incomplete_status_code,
-                EEM_Transaction::abandoned_status_code,
-                EEM_Transaction::failed_status_code,
-            )
-        );
-    }
-
-    /**
-     *        get the revenue per day  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @return \stdClass[]
-     */
-    public function get_revenue_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query('TXN_timestamp', date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s', 'UTC');
-
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
-
-        return $this->_get_all_wpdb_results(
-            array(
-                array(
-                    'TXN_timestamp' => array('>=', $sql_date)
-                ),
-                'group_by' => 'txnDate',
-                'order_by' => array('TXN_timestamp' => 'ASC')
-            ),
-            OBJECT,
-            array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
-            )
-        );
-    }
-
-
-    /**
-     *        get the revenue per event  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @throws \EE_Error
-     * @return mixed
-     */
-    public function get_revenue_per_event_report($period = '-1 month')
-    {
-        global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
-        $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
-        $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
-        $approved_payment_status    = EEM_Payment::status_id_approved;
-        $extra_event_on_join        = '';
-        //exclude events not authored by user if permissions in effect
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
-        }
-
-        return $wpdb->get_results(
-            "SELECT
+	// private instance of the Transaction object
+	protected static $_instance;
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
+	 * but payment is pending. This is the state for transactions where payment is promised
+	 * from an offline gateway.
+	 */
+	//	const open_status_code = 'TPN';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
+	 * either due to a technical reason (server or computer crash during registration),
+	 *  or some other reason that prevent the collection of any useful contact information from any of the registrants
+	 */
+	const failed_status_code = 'TFL';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
+	 * either due to a technical reason (server or computer crash during registration),
+	 * or due to an abandoned cart after registrant chose not to complete the registration process
+	 * HOWEVER...
+	 * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
+	 * registrant
+	 */
+	const abandoned_status_code = 'TAB';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
+	 * meaning that monies are still owing: TXN_paid < TXN_total
+	 */
+	const incomplete_status_code = 'TIN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
+	 * meaning that NO monies are owing: TXN_paid == TXN_total
+	 */
+	const complete_status_code = 'TCM';
+
+	/**
+	 *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
+	 *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
+	 */
+	const overpaid_status_code = 'TOP';
+
+
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 *
+	 * @return EEM_Transaction
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Transaction', 'event_espresso');
+		$this->plural_item   = __('Transactions', 'event_espresso');
+
+		$this->_tables                 = array(
+			'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
+		);
+		$this->_fields                 = array(
+			'TransactionTable' => array(
+				'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
+				'TXN_timestamp'    => new EE_Datetime_Field('TXN_timestamp',
+					__('date when transaction was created', 'event_espresso'), false, EE_Datetime_Field::now,
+					$timezone),
+				'TXN_total'        => new EE_Money_Field('TXN_total',
+					__('Total value of Transaction', 'event_espresso'), false, 0),
+				'TXN_paid'         => new EE_Money_Field('TXN_paid',
+					__('Amount paid towards transaction to date', 'event_espresso'), false, 0),
+				'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
+					false, EEM_Transaction::failed_status_code, 'Status'),
+				'TXN_session_data' => new EE_Serialized_Text_Field('TXN_session_data',
+					__('Serialized session data', 'event_espresso'), true, ''),
+				'TXN_hash_salt'    => new EE_Plain_Text_Field('TXN_hash_salt',
+					__('Transaction Hash Salt', 'event_espresso'), true, ''),
+				'PMD_ID'           => new EE_Foreign_Key_Int_Field('PMD_ID',
+					__("Last Used Payment Method", 'event_espresso'), true, null, 'Payment_Method'),
+				'TXN_reg_steps'    => new EE_Serialized_Text_Field('TXN_reg_steps',
+					__('Registration Steps', 'event_espresso'), false, array()),
+			)
+		);
+		$this->_model_relations        = array(
+			'Registration'   => new EE_Has_Many_Relation(),
+			'Payment'        => new EE_Has_Many_Relation(),
+			'Status'         => new EE_Belongs_To_Relation(),
+			'Line_Item'      => new EE_Has_Many_Relation(false),
+			//you can delete a transaction without needing to delete its line items
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+			'Message'        => new EE_Has_Many_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+
+	}
+
+
+	/**
+	 *    txn_status_array
+	 * get list of transaction statuses
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function txn_status_array()
+	{
+		return apply_filters(
+			'FHEE__EEM_Transaction__txn_status_array',
+			array(
+				EEM_Transaction::overpaid_status_code,
+				EEM_Transaction::complete_status_code,
+				EEM_Transaction::incomplete_status_code,
+				EEM_Transaction::abandoned_status_code,
+				EEM_Transaction::failed_status_code,
+			)
+		);
+	}
+
+	/**
+	 *        get the revenue per day  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @return \stdClass[]
+	 */
+	public function get_revenue_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query('TXN_timestamp', date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s', 'UTC');
+
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
+
+		return $this->_get_all_wpdb_results(
+			array(
+				array(
+					'TXN_timestamp' => array('>=', $sql_date)
+				),
+				'group_by' => 'txnDate',
+				'order_by' => array('TXN_timestamp' => 'ASC')
+			),
+			OBJECT,
+			array(
+				'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
+			)
+		);
+	}
+
+
+	/**
+	 *        get the revenue per event  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @throws \EE_Error
+	 * @return mixed
+	 */
+	public function get_revenue_per_event_report($period = '-1 month')
+	{
+		global $wpdb;
+		$transaction_table          = $wpdb->prefix . 'esp_transaction';
+		$registration_table         = $wpdb->prefix . 'esp_registration';
+		$registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+		$event_table                = $wpdb->posts;
+		$payment_table              = $wpdb->prefix . 'esp_payment';
+		$sql_date                   = date('Y-m-d H:i:s', strtotime($period));
+		$approved_payment_status    = EEM_Payment::status_id_approved;
+		$extra_event_on_join        = '';
+		//exclude events not authored by user if permissions in effect
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+		}
+
+		return $wpdb->get_results(
+			"SELECT
 			Transaction_Event.event_name AS event_name,
 			SUM(Transaction_Event.paid) AS revenue
 			FROM
@@ -230,185 +230,185 @@ 
 					$extra_event_on_join
 				) AS Transaction_Event
 			GROUP BY event_name",
-            OBJECT
-        );
-    }
-
-
-    /**
-     * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
-     * $_REQUEST global variable. Either way, tries to find the current transaction (through
-     * the registration pointed to by reg_url_link), if not returns null
-     *
-     * @param string $reg_url_link
-     *
-     * @return EE_Transaction
-     */
-    public function get_transaction_from_reg_url_link($reg_url_link = '')
-    {
-        return $this->get_one(array(
-            array(
-                'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get('e_reg_url_link',
-                    '')
-            )
-        ));
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * (or fetch the EE_Transaction from its ID)
-     *
-     * @deprecated
-     *
-     * @param EE_Transaction|int $transaction_obj_or_id
-     * @param boolean            $save_txn whether or not to save the transaction during this function call
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->ensure_is_obj($transaction_obj_or_id)
-        );
-    }
-
-    /**
-     * Deletes "junk" transactions that were probably added by bots. There might be TONS
-     * of these, so we are very careful to NOT select (which the models do even when deleting),
-     * and so we only use wpdb directly and only do minimal joins.
-     * Transactions are considered "junk" if they're failed for longer than a week.
-     * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
-     * it, it's probably not junk (regardless of what status it has).
-     * The downside to this approach is that is addons are listening for object deletions
-     * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
-     * to catch these types of deletions.
-     *
-     * @global WPDB $wpdb
-     * @return mixed
-     */
-    public function delete_junk_transactions()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $deleted             = false;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone'
-            , WEEK_IN_SECONDS
-        );
-
-
-        /**
-         * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
-         * Useful for plugins that want to exclude transactions matching certain query parameters.
-         * The query parameters should be in the format accepted by the EEM_Base model queries.
-         */
-        $ids_query = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
-            array(
-                0 => array(
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
-                    'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
-                )
-            ),
-            $time_to_leave_alone
-        );
-
-
-        /**
-         * This filter is for when code needs to filter the list of transaction ids that represent transactions
-         * about to be deleted based on some other criteria that isn't easily done via the query args filter.
-         */
-        $txn_ids = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
-            EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
-            $time_to_leave_alone
-        );
-        //now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
-            // first, make sure these TXN's are removed the "ee_locked_transactions" array
-            EEM_Transaction::unset_locked_transactions($txn_ids);
-            // let's get deletin'...
-            // Why no wpdb->prepare?  Because the data is trusted.
-            // We got the ids from the original query to get them FROM
-            // the db (which is sanitized) so no need to prepare them again.
-            $query   = '
+			OBJECT
+		);
+	}
+
+
+	/**
+	 * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
+	 * $_REQUEST global variable. Either way, tries to find the current transaction (through
+	 * the registration pointed to by reg_url_link), if not returns null
+	 *
+	 * @param string $reg_url_link
+	 *
+	 * @return EE_Transaction
+	 */
+	public function get_transaction_from_reg_url_link($reg_url_link = '')
+	{
+		return $this->get_one(array(
+			array(
+				'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get('e_reg_url_link',
+					'')
+			)
+		));
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * (or fetch the EE_Transaction from its ID)
+	 *
+	 * @deprecated
+	 *
+	 * @param EE_Transaction|int $transaction_obj_or_id
+	 * @param boolean            $save_txn whether or not to save the transaction during this function call
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->ensure_is_obj($transaction_obj_or_id)
+		);
+	}
+
+	/**
+	 * Deletes "junk" transactions that were probably added by bots. There might be TONS
+	 * of these, so we are very careful to NOT select (which the models do even when deleting),
+	 * and so we only use wpdb directly and only do minimal joins.
+	 * Transactions are considered "junk" if they're failed for longer than a week.
+	 * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
+	 * it, it's probably not junk (regardless of what status it has).
+	 * The downside to this approach is that is addons are listening for object deletions
+	 * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
+	 * to catch these types of deletions.
+	 *
+	 * @global WPDB $wpdb
+	 * @return mixed
+	 */
+	public function delete_junk_transactions()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$deleted             = false;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone'
+			, WEEK_IN_SECONDS
+		);
+
+
+		/**
+		 * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
+		 * Useful for plugins that want to exclude transactions matching certain query parameters.
+		 * The query parameters should be in the format accepted by the EEM_Base model queries.
+		 */
+		$ids_query = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
+			array(
+				0 => array(
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+					'Payment.PAY_ID' => array( 'IS NULL' ),
+					'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
+				)
+			),
+			$time_to_leave_alone
+		);
+
+
+		/**
+		 * This filter is for when code needs to filter the list of transaction ids that represent transactions
+		 * about to be deleted based on some other criteria that isn't easily done via the query args filter.
+		 */
+		$txn_ids = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
+			EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
+			$time_to_leave_alone
+		);
+		//now that we have the ids to delete
+		if (! empty($txn_ids) && is_array($txn_ids)) {
+			// first, make sure these TXN's are removed the "ee_locked_transactions" array
+			EEM_Transaction::unset_locked_transactions($txn_ids);
+			// let's get deletin'...
+			// Why no wpdb->prepare?  Because the data is trusted.
+			// We got the ids from the original query to get them FROM
+			// the db (which is sanitized) so no need to prepare them again.
+			$query   = '
 				DELETE
 				FROM ' . $this->table() . '
 				WHERE
 					TXN_ID IN ( ' . implode(",", $txn_ids) . ')';
-            $deleted = $wpdb->query($query);
-        }
-        if ($deleted) {
-            /**
-             * Allows code to do something after the transactions have been deleted.
-             */
-            do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
-        }
-
-        return $deleted;
-    }
-
-
-    /**
-     * @param array $transaction_IDs
-     *
-     * @return bool
-     */
-    public static function unset_locked_transactions(array $transaction_IDs)
-    {
-        $locked_transactions = get_option('ee_locked_transactions', array());
-        $update              = false;
-        foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[$TXN_ID])) {
-                unset($locked_transactions[$TXN_ID]);
-                $update = true;
-            }
-        }
-        if ($update) {
-            update_option('ee_locked_transactions', $locked_transactions);
-        }
-
-        return $update;
-    }
-
-
-
-    /**
-     * returns an array of EE_Transaction objects whose timestamp is less than
-     * the current time minus the session lifespan, which defaults to 60 minutes
-     *
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws \EE_Error
-     */
-    public function get_transactions_in_progress()
-    {
-        return $this->get_all(
-            array(
-                array(
-                    'TXN_timestamp' => array(
-                        '>',
-                        time() - EE_Registry::instance()->SSN->lifespan()
-                    ),
-                    'STS_ID' => array(
-                        '!=',
-                        EEM_Transaction::complete_status_code
-                    ),
-                )
-            )
-        );
-    }
+			$deleted = $wpdb->query($query);
+		}
+		if ($deleted) {
+			/**
+			 * Allows code to do something after the transactions have been deleted.
+			 */
+			do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
+		}
+
+		return $deleted;
+	}
+
+
+	/**
+	 * @param array $transaction_IDs
+	 *
+	 * @return bool
+	 */
+	public static function unset_locked_transactions(array $transaction_IDs)
+	{
+		$locked_transactions = get_option('ee_locked_transactions', array());
+		$update              = false;
+		foreach ($transaction_IDs as $TXN_ID) {
+			if (isset($locked_transactions[$TXN_ID])) {
+				unset($locked_transactions[$TXN_ID]);
+				$update = true;
+			}
+		}
+		if ($update) {
+			update_option('ee_locked_transactions', $locked_transactions);
+		}
+
+		return $update;
+	}
+
+
+
+	/**
+	 * returns an array of EE_Transaction objects whose timestamp is less than
+	 * the current time minus the session lifespan, which defaults to 60 minutes
+	 *
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws \EE_Error
+	 */
+	public function get_transactions_in_progress()
+	{
+		return $this->get_all(
+			array(
+				array(
+					'TXN_timestamp' => array(
+						'>',
+						time() - EE_Registry::instance()->SSN->lifespan()
+					),
+					'STS_ID' => array(
+						'!=',
+						EEM_Transaction::complete_status_code
+					),
+				)
+			)
+		);
+	}
 
 
 }

Spacing +14 added lines, -14 removed lines

@@ -3,7 +3,7 @@ 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 /**
  *
@@ -107,7 +107,7 @@ 
                     __('Registration Steps', 'event_espresso'), false, array()),
             )
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Registration'   => new EE_Has_Many_Relation(),
             'Payment'        => new EE_Has_Many_Relation(),
             'Status'         => new EE_Belongs_To_Relation(),
@@ -169,7 +169,7 @@ 
             ),
             OBJECT,
             array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'txnDate' => array('DATE('.$query_interval.')', '%s'),
                 'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
             )
         );
@@ -189,17 +189,17 @@ 
     public function get_revenue_per_event_report($period = '-1 month')
     {
         global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+        $transaction_table          = $wpdb->prefix.'esp_transaction';
+        $registration_table         = $wpdb->prefix.'esp_registration';
+        $registration_payment_table = $wpdb->prefix.'esp_registration_payment';
         $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
+        $payment_table              = $wpdb->prefix.'esp_payment';
         $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
         $approved_payment_status    = EEM_Payment::status_id_approved;
         $extra_event_on_join        = '';
         //exclude events not authored by user if permissions in effect
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+            $extra_event_on_join = ' AND Event.post_author = '.get_current_user_id();
         }
 
         return $wpdb->get_results(
@@ -270,7 +270,7 @@ 
     public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'),
             '4.6.0'
@@ -318,7 +318,7 @@ 
             array(
                 0 => array(
                     'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
+                    'Payment.PAY_ID' => array('IS NULL'),
                     'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
                 )
             ),
@@ -336,18 +336,18 @@ 
             $time_to_leave_alone
         );
         //now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
+        if ( ! empty($txn_ids) && is_array($txn_ids)) {
             // first, make sure these TXN's are removed the "ee_locked_transactions" array
             EEM_Transaction::unset_locked_transactions($txn_ids);
             // let's get deletin'...
             // Why no wpdb->prepare?  Because the data is trusted.
             // We got the ids from the original query to get them FROM
             // the db (which is sanitized) so no need to prepare them again.
-            $query   = '
+            $query = '
 				DELETE
-				FROM ' . $this->table() . '
+				FROM ' . $this->table().'
 				WHERE
-					TXN_ID IN ( ' . implode(",", $txn_ids) . ')';
+					TXN_ID IN ( ' . implode(",", $txn_ids).')';
             $deleted = $wpdb->query($query);
         }
         if ($deleted) {

core/db_models/EEM_Answer.model.php

Indentation +8 added lines, -8 removed lines

@@ -125,14 +125,14 @@
 	public function get_attendee_property_answer_value( EE_Registration $registration, $question_system_id = NULL, $pretty_answer = FALSE ){
 		$field_name = NULL;
 		$value = NULL;
-                //backward compat: we still want to find the question's ID
-                if( is_numeric( $question_system_id ) ) {
-                    //find this question's QST_system value
-                    $question_id = $question_system_id;
-                    $question_system_id = EEM_Question::instance()->get_var( array( array( 'QST_ID' => $question_system_id ) ), 'QST_system' );
-                } else {
-                    $question_id = (int) EEM_Question::instance()->get_var( array( array( 'QST_system' => $question_system_id ) ), 'QST_ID' );
-                }
+				//backward compat: we still want to find the question's ID
+				if( is_numeric( $question_system_id ) ) {
+					//find this question's QST_system value
+					$question_id = $question_system_id;
+					$question_system_id = EEM_Question::instance()->get_var( array( array( 'QST_ID' => $question_system_id ) ), 'QST_system' );
+				} else {
+					$question_id = (int) EEM_Question::instance()->get_var( array( array( 'QST_system' => $question_system_id ) ), 'QST_ID' );
+				}
 		//only bother checking if the registration has an attendee
 		if( $registration->attendee() instanceof EE_Attendee ) {
 			$field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question( $question_system_id );

Spacing +35 added lines, -35 removed lines

@@ -51,18 +51,18 @@ 
 	/**
 	 * 	constructor
 	 */
-	protected function __construct( $timezone = NULL ){
-		$this->singular_item = __('Answer','event_espresso');
-		$this->plural_item = __('Answers','event_espresso');
+	protected function __construct($timezone = NULL) {
+		$this->singular_item = __('Answer', 'event_espresso');
+		$this->plural_item = __('Answers', 'event_espresso');
 		$this->_tables = array(
 			'Answer'=> new EE_Primary_Table('esp_answer', 'ANS_ID')
 		);
 		$this->_fields = array(
 			'Answer'=>array(
-				'ANS_ID'=> new EE_Primary_Key_Int_Field('ANS_ID', __('Answer ID','event_espresso')),
-				'REG_ID'=>new EE_Foreign_Key_Int_Field('REG_ID', __('Registration ID','event_espresso'), false, 0, 'Registration'),
-				'QST_ID'=>new EE_Foreign_Key_Int_Field('QST_ID', __('Question ID','event_espresso'), false, 0, 'Question'),
-				'ANS_value'=>new EE_Maybe_Serialized_Simple_HTML_Field('ANS_value', __('Answer Value','event_espresso'), false, '')
+				'ANS_ID'=> new EE_Primary_Key_Int_Field('ANS_ID', __('Answer ID', 'event_espresso')),
+				'REG_ID'=>new EE_Foreign_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso'), false, 0, 'Registration'),
+				'QST_ID'=>new EE_Foreign_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso'), false, 0, 'Question'),
+				'ANS_value'=>new EE_Maybe_Serialized_Simple_HTML_Field('ANS_value', __('Answer Value', 'event_espresso'), false, '')
 			));
 		$this->_model_relations = array(
 			'Registration'=>new EE_Belongs_To_Relation(),
@@ -70,7 +70,7 @@ 
 		);
 		$this->_model_chain_to_wp_user = 'Registration.Event';
 		$this->_caps_slug = 'registrations';
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -83,19 +83,19 @@ 
 	 * @param boolean $pretty_answer whether to call 'pretty_value' or just 'value'
 	 * @return string
 	 */
-	public function get_answer_value_to_question( EE_Registration $registration, $question_id = NULL,$pretty_answer = FALSE ){
-		$value = $this->get_attendee_property_answer_value( $registration, $question_id, $pretty_answer );
-		if (  $value === NULL ){
-			$answer_obj = $this->get_registration_question_answer_object( $registration, $question_id);
-			if( $answer_obj instanceof EE_Answer ){
-				if($pretty_answer){
+	public function get_answer_value_to_question(EE_Registration $registration, $question_id = NULL, $pretty_answer = FALSE) {
+		$value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
+		if ($value === NULL) {
+			$answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
+			if ($answer_obj instanceof EE_Answer) {
+				if ($pretty_answer) {
 					$value = $answer_obj->pretty_value();
-				}else{
+				} else {
 					$value = $answer_obj->value();
 				}
 			}
 		}
-		return apply_filters( 'FHEE__EEM_Answer__get_answer_value_to_question__answer_value', $value, $registration, $question_id );
+		return apply_filters('FHEE__EEM_Answer__get_answer_value_to_question__answer_value', $value, $registration, $question_id);
 	}
 
 
@@ -106,9 +106,9 @@ 
 	 * @param int $question_id
 	 * @return EE_Answer
 	 */
-	public function get_registration_question_answer_object( EE_Registration $registration, $question_id = NULL){
-		$answer_obj = $this->get_one( array( array( 'QST_ID'=>$question_id, 'REG_ID'=>$registration->ID() )));
-		return apply_filters( 'FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj', $answer_obj, $registration, $question_id );
+	public function get_registration_question_answer_object(EE_Registration $registration, $question_id = NULL) {
+		$answer_obj = $this->get_one(array(array('QST_ID'=>$question_id, 'REG_ID'=>$registration->ID())));
+		return apply_filters('FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj', $answer_obj, $registration, $question_id);
 	}
 
 
@@ -122,39 +122,39 @@ 
 	 * @return string|null (if the registration has no attendee, or the question_system_id is not a QST_ID or QST_system for
 	 * a question corresponding to an attendee field, returns null)
 	 */
-	public function get_attendee_property_answer_value( EE_Registration $registration, $question_system_id = NULL, $pretty_answer = FALSE ){
+	public function get_attendee_property_answer_value(EE_Registration $registration, $question_system_id = NULL, $pretty_answer = FALSE) {
 		$field_name = NULL;
 		$value = NULL;
                 //backward compat: we still want to find the question's ID
-                if( is_numeric( $question_system_id ) ) {
+                if (is_numeric($question_system_id)) {
                     //find this question's QST_system value
                     $question_id = $question_system_id;
-                    $question_system_id = EEM_Question::instance()->get_var( array( array( 'QST_ID' => $question_system_id ) ), 'QST_system' );
+                    $question_system_id = EEM_Question::instance()->get_var(array(array('QST_ID' => $question_system_id)), 'QST_system');
                 } else {
-                    $question_id = (int) EEM_Question::instance()->get_var( array( array( 'QST_system' => $question_system_id ) ), 'QST_ID' );
+                    $question_id = (int) EEM_Question::instance()->get_var(array(array('QST_system' => $question_system_id)), 'QST_ID');
                 }
 		//only bother checking if the registration has an attendee
-		if( $registration->attendee() instanceof EE_Attendee ) {
-			$field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question( $question_system_id );
-			if( $field_name ) {
-				if( $pretty_answer ) {
-					if( $field_name === 'STA_ID' ) {
+		if ($registration->attendee() instanceof EE_Attendee) {
+			$field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
+			if ($field_name) {
+				if ($pretty_answer) {
+					if ($field_name === 'STA_ID') {
 						$state = $registration->attendee()->state_obj();
-						$value = $state instanceof EE_State ? $state->name() : sprintf( __('Unknown State (%s)', 'event_espresso'), $registration->attendee()->state_ID() );
-					} else if($field_name === 'CNT_ISO') {
+						$value = $state instanceof EE_State ? $state->name() : sprintf(__('Unknown State (%s)', 'event_espresso'), $registration->attendee()->state_ID());
+					} else if ($field_name === 'CNT_ISO') {
 						$country = $registration->attendee()->country_obj();
-						$value = $country instanceof EE_Country ? $country->name() : sprintf(__('Unknown Country (%s)', "event_espresso"),$registration->attendee()->country_ID());
+						$value = $country instanceof EE_Country ? $country->name() : sprintf(__('Unknown Country (%s)', "event_espresso"), $registration->attendee()->country_ID());
 					} else {
-						$value = $registration->attendee()->get_pretty( $field_name );
+						$value = $registration->attendee()->get_pretty($field_name);
 					}
 					//if field name is blank, leave the value as null too
-				}else{
-					$value = $registration->attendee()->get( $field_name );
+				} else {
+					$value = $registration->attendee()->get($field_name);
 				}
 			}
 			//if no field was found, leave value blank
 		}
-		return apply_filters( 'FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value', $value, $registration, $question_id, $question_system_id );
+		return apply_filters('FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value', $value, $registration, $question_id, $question_system_id);
 	}
 
 

core/services/collections/CollectionInterface.php

Indentation +14 added lines, -14 removed lines

@@ -113,12 +113,12 @@ 
 	public function previous();
 
 		/**
-	 * Returns the index of a given object, or false if not found
-	 *
-	 * @see http://stackoverflow.com/a/8736013
-	 * @param $object
-	 * @return boolean|int|string
-	 */
+		 * Returns the index of a given object, or false if not found
+		 *
+		 * @see http://stackoverflow.com/a/8736013
+		 * @param $object
+		 * @return boolean|int|string
+		 */
 	public function indexOf( $object );
 
 
@@ -160,17 +160,17 @@ 
 
 
 
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll();
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll();
 
 
 
-    /**
-     * unsets and detaches ALL objects from the Collection
-     */
-    public function trashAndDetachAll();
+	/**
+	 * unsets and detaches ALL objects from the Collection
+	 */
+	public function trashAndDetachAll();
 
 }
 // End of file CollectionInterface.php

core/services/collections/Collection.php

Indentation +28 added lines, -29 removed lines

@@ -83,7 +83,6 @@ 
 
 	 /**
 	  * setIdentifier
-
 	  * Sets the data associated with an object in the Collection
 	  * if no $identifier is supplied, then the spl_object_hash() is used
 	  *
@@ -352,34 +351,34 @@ 
 
 
 
-     /**
-      * detaches ALL objects from the Collection
-      */
-     public function detachAll()
-     {
-         $this->rewind();
-         while ($this->valid()) {
-             $object = $this->current();
-             $this->next();
-             $this->detach($object);
-         }
-     }
-
-
-
-     /**
-      * unsets and detaches ALL objects from the Collection
-      */
-     public function trashAndDetachAll()
-     {
-         $this->rewind();
-         while ($this->valid()) {
-             $object = $this->current();
-             $this->next();
-             $this->detach($object);
-             unset($object);
-         }
-     }
+	 /**
+	  * detaches ALL objects from the Collection
+	  */
+	 public function detachAll()
+	 {
+		 $this->rewind();
+		 while ($this->valid()) {
+			 $object = $this->current();
+			 $this->next();
+			 $this->detach($object);
+		 }
+	 }
+
+
+
+	 /**
+	  * unsets and detaches ALL objects from the Collection
+	  */
+	 public function trashAndDetachAll()
+	 {
+		 $this->rewind();
+		 while ($this->valid()) {
+			 $object = $this->current();
+			 $this->next();
+			 $this->detach($object);
+			 unset($object);
+		 }
+	 }
 
 
 

core/services/loaders/LoaderFactory.php

Indentation +28 added lines, -28 removed lines

@@ -79,37 +79,37 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
 
-    /**
-     * @param mixed $generator      provided during  very first instantiation in
-     *                              EE_Load_Espresso_Core::handle_request()
-     *                              otherwise can be left null
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function getLoader($generator = null)
-    {
-        if (! LoaderFactory::$loader instanceof LoaderInterface) {
-            $generator = $generator !== null ? $generator : EE_Registry::instance();
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection('')
-                )
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param mixed $generator      provided during  very first instantiation in
+	 *                              EE_Load_Espresso_Core::handle_request()
+	 *                              otherwise can be left null
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function getLoader($generator = null)
+	{
+		if (! LoaderFactory::$loader instanceof LoaderInterface) {
+			$generator = $generator !== null ? $generator : EE_Registry::instance();
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection('')
+				)
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      */
     public static function getLoader($generator = null)
     {
-        if (! LoaderFactory::$loader instanceof LoaderInterface) {
+        if ( ! LoaderFactory::$loader instanceof LoaderInterface) {
             $generator = $generator !== null ? $generator : EE_Registry::instance();
             $core_loader = new CoreLoader($generator);
             LoaderFactory::$loader = new Loader(

modules/messages/EED_Messages.module.php

Indentation +1080 added lines, -1080 removed lines

@@ -13,1095 +13,1095 @@
 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
-     */
-    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
-     */
-    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
+	 */
+	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
+	 */
+	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
-     * @return    void
-     */
-    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
-     */
-    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[]
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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 object
-     * @param  EE_Payment     object
-     * @return void
-     */
-    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
-     */
-    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
-     */
-    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 registrations so we make sure we send messages for the right status.
-        $all_registrations = $registration->transaction()->registrations();
-
-        //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
-     */
-    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 string|bool The payment message type slug matching the status or false if no match.
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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) {
-            $content = $generated_preview_queue->get_message_repository()->current()->content();
-            //if the current message was persisted to the db (which will happen with any extra fields on a message) then
-            //let's delete it because we don't need previews cluttering up the db.
-            if ($generated_preview_queue->get_message_repository()->current()->ID() > 0
-                && $generated_preview_queue->get_message_repository()->current()->STS_ID() !== EEM_Message::status_failed
-            ) {
-                $generated_preview_queue->get_message_repository()->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.
-     */
-    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.
-     */
-    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.
-     */
-    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
+	 * @return    void
+	 */
+	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
+	 */
+	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[]
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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 object
+	 * @param  EE_Payment     object
+	 * @return void
+	 */
+	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
+	 */
+	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
+	 */
+	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 registrations so we make sure we send messages for the right status.
+		$all_registrations = $registration->transaction()->registrations();
+
+		//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
+	 */
+	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 string|bool The payment message type slug matching the status or false if no match.
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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) {
+			$content = $generated_preview_queue->get_message_repository()->current()->content();
+			//if the current message was persisted to the db (which will happen with any extra fields on a message) then
+			//let's delete it because we don't need previews cluttering up the db.
+			if ($generated_preview_queue->get_message_repository()->current()->ID() > 0
+				&& $generated_preview_queue->get_message_repository()->current()->STS_ID() !== EEM_Message::status_failed
+			) {
+				$generated_preview_queue->get_message_repository()->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.
+	 */
+	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.
+	 */
+	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.
+	 */
+	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;
-    }
-
-
-    /**
-     * 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.
-     */
-    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
-     */
-    protected static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        EE_Transaction $transaction,
-        $info = array(),
-        $display_request = false
-    ) {
-        if (WP_DEBUG && false) {
-            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;
+	}
+
+
+	/**
+	 * 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.
+	 */
+	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
+	 */
+	protected static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		EE_Transaction $transaction,
+		$info = array(),
+		$display_request = false
+	) {
+		if (WP_DEBUG && false) {
+			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