eventespresso / event-espresso-core

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.6.2');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.10.15.rc.009');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.10.15.rc.009');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

modules/messages/EED_Messages.module.php

Indentation +1331 added lines, -1331 removed lines

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

Spacing +18 added lines, -18 removed lines

@@ -204,7 +204,7 @@ 
                 'event_espresso'
             );
             // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
+            $error_msg .= '||'.$e->getMessage();
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -290,7 +290,7 @@ 
                 'event_espresso'
             );
             // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
+            $error_msg .= '||'.$e->getMessage();
             EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
         }
     }
@@ -322,7 +322,7 @@ 
         $transient_key = $request->getRequestParam('key');
 
         // now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
+        if ( ! get_transient($transient_key)) {
             /**
              * trigger error so this gets in the error logs.  This is important because it happens on a non-user
              * request.
@@ -334,7 +334,7 @@ 
         delete_transient($transient_key);
 
         if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
-            $method = 'batch_' . $cron_type . '_from_queue';
+            $method = 'batch_'.$cron_type.'_from_queue';
             if (method_exists(self::$_MSG_PROCESSOR, $method)) {
                 self::$_MSG_PROCESSOR->$method();
             } else {
@@ -401,7 +401,7 @@ 
         $template_pack_collection->rewind();
         $template_packs = array();
         while ($template_pack_collection->valid()) {
-            $template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
+            $template_packs[$template_pack_collection->current()->dbref] = $template_pack_collection->current();
             $template_pack_collection->next();
         }
         return $template_packs;
@@ -451,7 +451,7 @@ 
         );
         $paths = array();
         foreach ($dir_ref as $index => $dir) {
-            $paths[ $index ] = EE_LIBRARIES . $dir;
+            $paths[$index] = EE_LIBRARIES.$dir;
         }
         self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
     }
@@ -470,7 +470,7 @@ 
      */
     protected static function _load_controller()
     {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+        if ( ! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
             EE_Registry::instance()->load_core('Request_Handler');
             self::set_autoloaders();
             self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
@@ -511,7 +511,7 @@ 
     public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
     {
         // if there's no payment object, then we cannot do a payment type message!
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             return;
         }
         self::_load_controller();
@@ -558,7 +558,7 @@ 
     public static function maybe_registration(EE_Registration $registration, $extra_details = array())
     {
 
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+        if ( ! self::_verify_registration_notification_send($registration, $extra_details)) {
             // no messages please
             return;
         }
@@ -625,7 +625,7 @@ 
         EE_Registration $registration,
         $extra_details = array()
     ) {
-        if (! $registration->is_primary_registrant()) {
+        if ( ! $registration->is_primary_registrant()) {
             return false;
         }
         $request = self::getRequest();
@@ -633,14 +633,14 @@ 
         if ($request->isAdmin() && ! $request->isFrontAjax()) {
             $status_change = $request->getRequestParam('txn_reg_status_change', [], 'int', true);
             // make sure appropriate admin params are set for sending messages
-            if (! $status_change['send_notifications']) {
+            if ( ! $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) {
+            if ( ! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
                 return false;
             }
             // return visit but nothing changed ???
@@ -771,7 +771,7 @@ 
         self::_load_controller();
 
         $msgID = self::getRequest()->getRequestParam('MSG_ID', 0, 'int');
-        if (! $msgID) {
+        if ( ! $msgID) {
             EE_Error::add_error(
                 esc_html__(
                     'Something went wrong because there is no "MSG_ID" value in the request',
@@ -964,14 +964,14 @@ 
             // get the message template group.
             $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
             // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
+            if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
                 // remove EVT_ID from query params so that global templates get picked up
                 unset($template_query_params['Event.EVT_ID']);
                 // get global template as the fallback
                 $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
             }
             // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
+            if ( ! $msg_template_group instanceof EE_Message_Template_Group) {
                 return '';
             }
             // generate the URL
@@ -1102,7 +1102,7 @@ 
             $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
         }
 
-        if (! $generated_queue instanceof EE_Messages_Queue) {
+        if ( ! $generated_queue instanceof EE_Messages_Queue) {
             EE_Error::add_error(
                 esc_html__(
                     '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.',
@@ -1149,7 +1149,7 @@ 
             $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
         }
 
-        if (! $sent_queue instanceof EE_Messages_Queue) {
+        if ( ! $sent_queue instanceof EE_Messages_Queue) {
             EE_Error::add_error(
                 esc_html__(
                     '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.',
@@ -1337,7 +1337,7 @@ 
                 $info['TXN_status'] = $transaction->status_ID();
                 $info['TXN_reg_steps'] = $transaction->reg_steps();
                 if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
+                    $index = 'EE_Transaction: '.$transaction->ID();
                     EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
                 }
             }

modules/ticket_selector/ProcessTicketSelector.php

Indentation +492 added lines, -492 removed lines

@@ -33,521 +33,521 @@
 class ProcessTicketSelector
 {
 
-    /**
-     * @var EE_Cart $cart
-     */
-    private $cart;
+	/**
+	 * @var EE_Cart $cart
+	 */
+	private $cart;
 
-    /**
-     * @var EE_Core_Config $core_config
-     */
-    private $core_config;
+	/**
+	 * @var EE_Core_Config $core_config
+	 */
+	private $core_config;
 
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
-    /**
-     * @var TicketDatetimeAvailabilityTracker $tracker
-     */
-    private $tracker;
+	/**
+	 * @var TicketDatetimeAvailabilityTracker $tracker
+	 */
+	private $tracker;
 
 
-    /**
-     * ProcessTicketSelector constructor.
-     * NOTE: PLZ use the Loader to instantiate this class if need be
-     * so that all dependencies get injected correctly (which will happen automatically)
-     * Null values for parameters are only for backwards compatibility but will be removed later on.
-     *
-     * @param EE_Core_Config                    $core_config
-     * @param RequestInterface                           $request
-     * @param EE_Session                        $session
-     * @param EEM_Ticket                        $ticket_model
-     * @param TicketDatetimeAvailabilityTracker $tracker
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(
-        EE_Core_Config $core_config = null,
-        RequestInterface $request = null,
-        EE_Session $session = null,
-        EEM_Ticket $ticket_model = null,
-        TicketDatetimeAvailabilityTracker $tracker = null
-    ) {
-        $loader = LoaderFactory::getLoader();
-        $this->core_config = $core_config instanceof EE_Core_Config
-            ? $core_config
-            : $loader->getShared('EE_Core_Config');
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : $loader->getShared('EventEspresso\core\services\request\Request');
-        $this->session = $session instanceof EE_Session
-            ? $session
-            : $loader->getShared('EE_Session');
-        $this->ticket_model = $ticket_model instanceof EEM_Ticket
-            ? $ticket_model
-            : $loader->getShared('EEM_Ticket');
-        $this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
-            ? $tracker
-            : $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
-    }
+	/**
+	 * ProcessTicketSelector constructor.
+	 * NOTE: PLZ use the Loader to instantiate this class if need be
+	 * so that all dependencies get injected correctly (which will happen automatically)
+	 * Null values for parameters are only for backwards compatibility but will be removed later on.
+	 *
+	 * @param EE_Core_Config                    $core_config
+	 * @param RequestInterface                           $request
+	 * @param EE_Session                        $session
+	 * @param EEM_Ticket                        $ticket_model
+	 * @param TicketDatetimeAvailabilityTracker $tracker
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(
+		EE_Core_Config $core_config = null,
+		RequestInterface $request = null,
+		EE_Session $session = null,
+		EEM_Ticket $ticket_model = null,
+		TicketDatetimeAvailabilityTracker $tracker = null
+	) {
+		$loader = LoaderFactory::getLoader();
+		$this->core_config = $core_config instanceof EE_Core_Config
+			? $core_config
+			: $loader->getShared('EE_Core_Config');
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: $loader->getShared('EventEspresso\core\services\request\Request');
+		$this->session = $session instanceof EE_Session
+			? $session
+			: $loader->getShared('EE_Session');
+		$this->ticket_model = $ticket_model instanceof EEM_Ticket
+			? $ticket_model
+			: $loader->getShared('EEM_Ticket');
+		$this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
+			? $tracker
+			: $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
+	}
 
 
-    /**
-     * cancelTicketSelections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
-            return false;
-        }
-        $this->session->clear_session(__CLASS__, __FUNCTION__);
-        if ($this->request->requestParamIsSet('event_id')) {
-            EEH_URL::safeRedirectAndExit(
-                EEH_Event_View::event_link_url(
-                    $this->request->getRequestParam('event_id', 0, 'int')
-                )
-            );
-        }
-        EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
-        );
-        return true;
-    }
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+			return false;
+		}
+		$this->session->clear_session(__CLASS__, __FUNCTION__);
+		if ($this->request->requestParamIsSet('event_id')) {
+			EEH_URL::safeRedirectAndExit(
+				EEH_Event_View::event_link_url(
+					$this->request->getRequestParam('event_id', 0, 'int')
+				)
+			);
+		}
+		EEH_URL::safeRedirectAndExit(
+			site_url('/' . $this->core_config->event_cpt_slug . '/')
+		);
+		return true;
+	}
 
 
-    /**
-     * processTicketSelectorNonce
-     *
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     */
-    private function processTicketSelectorNonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (
-            ! $this->request->isAdmin()
-            && (
-                ! $this->request->requestParamIsSet($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    $this->request->getRequestParam($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 */
+	private function processTicketSelectorNonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (
+			! $this->request->isAdmin()
+			&& (
+				! $this->request->requestParamIsSet($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					$this->request->getRequestParam($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * process_ticket_selections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        if ($this->request->isBot()) {
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
-                    site_url()
-                )
-            );
-        }
-        // do we have an event id?
-        $id = $this->getEventId();
-        // we should really only have 1 registration in the works now
-        // (ie, no MER) so unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            $this->session->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // validate/sanitize/filter data
-        $valid = apply_filters(
-            'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
-            $this->validatePostData($id)
-        );
-        // check total tickets ordered vs max number of attendees that can register
-        if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
-            $this->maxAttendeesViolation($valid);
-        } else {
-            // all data appears to be valid
-            if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
-                return true;
-            }
-        }
-        // die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            EEH_URL::safeRedirectAndExit($valid['return_url']);
-        }
-        if ($id) {
-            EEH_URL::safeRedirectAndExit(get_permalink($id));
-        }
-        echo EE_Error::get_notices(); // already escaped
-        return false;
-    }
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		if ($this->request->isBot()) {
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
+					site_url()
+				)
+			);
+		}
+		// do we have an event id?
+		$id = $this->getEventId();
+		// we should really only have 1 registration in the works now
+		// (ie, no MER) so unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			$this->session->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// validate/sanitize/filter data
+		$valid = apply_filters(
+			'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
+			$this->validatePostData($id)
+		);
+		// check total tickets ordered vs max number of attendees that can register
+		if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
+			$this->maxAttendeesViolation($valid);
+		} else {
+			// all data appears to be valid
+			if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
+				return true;
+			}
+		}
+		// die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			EEH_URL::safeRedirectAndExit($valid['return_url']);
+		}
+		if ($id) {
+			EEH_URL::safeRedirectAndExit(get_permalink($id));
+		}
+		echo EE_Error::get_notices(); // already escaped
+		return false;
+	}
 
 
-    /**
-     * @return int
-     */
-    private function getEventId()
-    {
-        // do we have an event id?
-        if (! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
-            // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // if event id is valid
-        return $this->request->getRequestParam('tkt-slctr-event-id', 0, 'int');
-    }
+	/**
+	 * @return int
+	 */
+	private function getEventId()
+	{
+		// do we have an event id?
+		if (! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
+			// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// if event id is valid
+		return $this->request->getRequestParam('tkt-slctr-event-id', 0, 'int');
+	}
 
 
-    /**
-     * validate_post_data
-     *
-     * @param int $id
-     * @return array
-     */
-    private function validatePostData($id = 0)
-    {
-        if (! $id) {
-            EE_Error::add_error(
-                esc_html__('The event id provided was not valid.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return array();
-        }
-        // start with an empty array()
-        $valid_data = array();
-        // grab valid id
-        $valid_data['id'] = $id;
-        // array of other form names
-        $inputs_to_clean = array(
-            'max_atndz'  => 'tkt-slctr-max-atndz-',
-            'rows'       => 'tkt-slctr-rows-',
-            'qty'        => 'tkt-slctr-qty-',
-            'ticket_id'  => 'tkt-slctr-ticket-id-',
-            'return_url' => 'tkt-slctr-return-url-',
-        );
-        // let's track the total number of tickets ordered.'
-        $valid_data['total_tickets'] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($inputs_to_clean as $what => $input_to_clean) {
-            // check for POST data
-            if ($this->request->requestParamIsSet($input_to_clean . $id)) {
-                switch ($what) {
-                    // integers
-                    case 'event_id':
-                    case 'rows':
-                    case 'max_atndz':
-                        $valid_data[ $what ] = $this->request->getRequestParam($input_to_clean . $id, 0, 'int');
-                        break;
-                    // arrays of integers
-                    case 'qty':
-                        /** @var array $row_qty */
-                        $row_qty = $this->request->getRequestParam($input_to_clean . $id, [], 'int', true);
-                        // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
-                            /** @var string $row_qty */
-                            // get number of rows
-                            $rows = $this->request->getRequestParam('tkt-slctr-rows-' . $id, 1, 'int');
-                            // explode integers by the dash
-                            $row_qty = explode('-', $row_qty);
-                            $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-                            $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-                            $row_qty = array($row => $qty);
-                            for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
-                                }
-                            }
-                        }
-                        ksort($row_qty);
-                        // cycle thru values
-                        foreach ($row_qty as $qty) {
-                            $qty = absint($qty);
-                            // sanitize as integers
-                            $valid_data[ $what ][] = $qty;
-                            $valid_data['total_tickets'] += $qty;
-                        }
-                        break;
-                    // array of integers
-                    case 'ticket_id':
-                        $ticket_ids = (array) $this->request->getRequestParam($input_to_clean . $id, [], 'int', true);
-                        // cycle thru values
-                        foreach ($ticket_ids as $key => $value) {
-                            // allow only integers
-                            $valid_data[ $what ][ $key ] = absint($value);
-                        }
-                        break;
-                    case 'return_url':
-                        // grab and sanitize return-url
-                        $input_value = $this->request->getRequestParam($input_to_clean . $id, '', 'url');
-                        // was the request coming from an iframe ? if so, then:
-                        if (strpos($input_value, 'event_list=iframe')) {
-                            // get anchor fragment
-                            $input_value = explode('#', $input_value);
-                            $input_value = end($input_value);
-                            // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
-                        }
-                        $valid_data[ $what ] = $input_value;
-                        break;
-                }    // end switch $what
-            }
-        }    // end foreach $inputs_to_clean
-        return $valid_data;
-    }
+	/**
+	 * validate_post_data
+	 *
+	 * @param int $id
+	 * @return array
+	 */
+	private function validatePostData($id = 0)
+	{
+		if (! $id) {
+			EE_Error::add_error(
+				esc_html__('The event id provided was not valid.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return array();
+		}
+		// start with an empty array()
+		$valid_data = array();
+		// grab valid id
+		$valid_data['id'] = $id;
+		// array of other form names
+		$inputs_to_clean = array(
+			'max_atndz'  => 'tkt-slctr-max-atndz-',
+			'rows'       => 'tkt-slctr-rows-',
+			'qty'        => 'tkt-slctr-qty-',
+			'ticket_id'  => 'tkt-slctr-ticket-id-',
+			'return_url' => 'tkt-slctr-return-url-',
+		);
+		// let's track the total number of tickets ordered.'
+		$valid_data['total_tickets'] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($inputs_to_clean as $what => $input_to_clean) {
+			// check for POST data
+			if ($this->request->requestParamIsSet($input_to_clean . $id)) {
+				switch ($what) {
+					// integers
+					case 'event_id':
+					case 'rows':
+					case 'max_atndz':
+						$valid_data[ $what ] = $this->request->getRequestParam($input_to_clean . $id, 0, 'int');
+						break;
+					// arrays of integers
+					case 'qty':
+						/** @var array $row_qty */
+						$row_qty = $this->request->getRequestParam($input_to_clean . $id, [], 'int', true);
+						// if qty is coming from a radio button input, then we need to assemble an array of rows
+						if (! is_array($row_qty)) {
+							/** @var string $row_qty */
+							// get number of rows
+							$rows = $this->request->getRequestParam('tkt-slctr-rows-' . $id, 1, 'int');
+							// explode integers by the dash
+							$row_qty = explode('-', $row_qty);
+							$row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+							$qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+							$row_qty = array($row => $qty);
+							for ($x = 1; $x <= $rows; $x++) {
+								if (! isset($row_qty[ $x ])) {
+									$row_qty[ $x ] = 0;
+								}
+							}
+						}
+						ksort($row_qty);
+						// cycle thru values
+						foreach ($row_qty as $qty) {
+							$qty = absint($qty);
+							// sanitize as integers
+							$valid_data[ $what ][] = $qty;
+							$valid_data['total_tickets'] += $qty;
+						}
+						break;
+					// array of integers
+					case 'ticket_id':
+						$ticket_ids = (array) $this->request->getRequestParam($input_to_clean . $id, [], 'int', true);
+						// cycle thru values
+						foreach ($ticket_ids as $key => $value) {
+							// allow only integers
+							$valid_data[ $what ][ $key ] = absint($value);
+						}
+						break;
+					case 'return_url':
+						// grab and sanitize return-url
+						$input_value = $this->request->getRequestParam($input_to_clean . $id, '', 'url');
+						// was the request coming from an iframe ? if so, then:
+						if (strpos($input_value, 'event_list=iframe')) {
+							// get anchor fragment
+							$input_value = explode('#', $input_value);
+							$input_value = end($input_value);
+							// use event list url instead, but append anchor
+							$input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+						}
+						$valid_data[ $what ] = $input_value;
+						break;
+				}    // end switch $what
+			}
+		}    // end foreach $inputs_to_clean
+		return $valid_data;
+	}
 
 
-    /**
-     * @param array $valid
-     */
-    private function maxAttendeesViolation(array $valid)
-    {
-        // ordering too many tickets !!!
-        $total_tickets_string = esc_html(
-            _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            )
-        );
-        $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
-        // dev only message
-        $max_attendees_string = esc_html(
-            _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            )
-        );
-        $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * @param array $valid
+	 */
+	private function maxAttendeesViolation(array $valid)
+	{
+		// ordering too many tickets !!!
+		$total_tickets_string = esc_html(
+			_n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			)
+		);
+		$limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
+		// dev only message
+		$max_attendees_string = esc_html(
+			_n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			)
+		);
+		$limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
+		EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+	}
 
 
-    /**
-     * @param array $valid
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addTicketsToCart(array $valid)
-    {
-        $tickets_added = 0;
-        $tickets_selected = false;
-        if (! empty($valid) && $valid['total_tickets'] > 0) {
-            // load cart using factory because we don't want to do so until actually needed
-            $this->cart = CartFactory::getCart();
-            // if the user is an admin that can edit registrations,
-            // then we'll also allow them to add any tickets, even if they are expired
-            $current_user_is_admin = current_user_can('ee_edit_registrations');
-            // cycle thru the number of data rows sent from the event listing
-            for ($x = 0; $x < $valid['rows']; $x++) {
-                // does this row actually contain a ticket quantity?
-                if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
-                    // YES we have a ticket quantity
-                    $tickets_selected = true;
-                    $valid_ticket = false;
-                    if (isset($valid['ticket_id'][ $x ])) {
-                        // get ticket via the ticket id we put in the form
-                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
-                        if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
-                            $valid_ticket = true;
-                            $tickets_added += $this->addTicketToCart(
-                                $ticket,
-                                $valid['qty'][ $x ]
-                            );
-                        }
-                    }
-                    if ($valid_ticket !== true) {
-                        // nothing added to cart retrieved
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                    'event_espresso'
-                                ),
-                                '<br/>'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    if (EE_Error::has_error()) {
-                        break;
-                    }
-                }
-            }
-        }
-        do_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            $this->cart,
-            $this
-        );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
-            // no ticket quantities were selected
-            EE_Error::add_error(
-                esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $tickets_added;
-    }
+	/**
+	 * @param array $valid
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addTicketsToCart(array $valid)
+	{
+		$tickets_added = 0;
+		$tickets_selected = false;
+		if (! empty($valid) && $valid['total_tickets'] > 0) {
+			// load cart using factory because we don't want to do so until actually needed
+			$this->cart = CartFactory::getCart();
+			// if the user is an admin that can edit registrations,
+			// then we'll also allow them to add any tickets, even if they are expired
+			$current_user_is_admin = current_user_can('ee_edit_registrations');
+			// cycle thru the number of data rows sent from the event listing
+			for ($x = 0; $x < $valid['rows']; $x++) {
+				// does this row actually contain a ticket quantity?
+				if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+					// YES we have a ticket quantity
+					$tickets_selected = true;
+					$valid_ticket = false;
+					if (isset($valid['ticket_id'][ $x ])) {
+						// get ticket via the ticket id we put in the form
+						$ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
+						if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
+							$valid_ticket = true;
+							$tickets_added += $this->addTicketToCart(
+								$ticket,
+								$valid['qty'][ $x ]
+							);
+						}
+					}
+					if ($valid_ticket !== true) {
+						// nothing added to cart retrieved
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+									'event_espresso'
+								),
+								'<br/>'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					if (EE_Error::has_error()) {
+						break;
+					}
+				}
+			}
+		}
+		do_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			$this->cart,
+			$this
+		);
+		if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+			// no ticket quantities were selected
+			EE_Error::add_error(
+				esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $tickets_added;
+	}
 
 
-    /**
-     * adds a ticket to the cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return bool TRUE on success, FALSE on fail
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
-    {
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (
-                ! apply_filters(
-                    'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                    true,
-                    $ticket,
-                    $qty,
-                    $available_spaces
-                )
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
-                $this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        $this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
-        return false;
-    }
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
+	{
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (
+				! apply_filters(
+					'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+					true,
+					$ticket,
+					$qty,
+					$available_spaces
+				)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
+				$this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		$this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
+		return false;
+	}
 
 
-    /**
-     * @param $tickets_added
-     * @return bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    private function processSuccessfulCart($tickets_added)
-    {
-        // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-        if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-            // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
-                $this->cart = CartFactory::getCart();
-            }
-            do_action(
-                'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                $this->cart,
-                $this
-            );
-            $this->cart->recalculate_all_cart_totals();
-            $this->cart->save_cart(false);
-            // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-            // just return TRUE for registrations being made from admin
-            if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-                return true;
-            }
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                    $this->core_config->reg_page_url()
-                )
-            );
-        }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-            // nothing added to cart
-            EE_Error::add_attention(
-                esc_html__('No tickets were added for the event', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
+	/**
+	 * @param $tickets_added
+	 * @return bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	private function processSuccessfulCart($tickets_added)
+	{
+		// exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+		if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+			// make sure cart is loaded
+			if (! $this->cart instanceof EE_Cart) {
+				$this->cart = CartFactory::getCart();
+			}
+			do_action(
+				'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+				$this->cart,
+				$this
+			);
+			$this->cart->recalculate_all_cart_totals();
+			$this->cart->save_cart(false);
+			// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+			// just return TRUE for registrations being made from admin
+			if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+				return true;
+			}
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+					$this->core_config->reg_page_url()
+				)
+			);
+		}
+		if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+			// nothing added to cart
+			EE_Error::add_attention(
+				esc_html__('No tickets were added for the event', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -118,7 +118,7 @@ 
     public function cancelTicketSelections()
     {
         // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+        if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
             return false;
         }
         $this->session->clear_session(__CLASS__, __FUNCTION__);
@@ -130,7 +130,7 @@ 
             );
         }
         EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
+            site_url('/'.$this->core_config->event_cpt_slug.'/')
         );
         return true;
     }
@@ -208,7 +208,7 @@ 
             $this->validatePostData($id)
         );
         // check total tickets ordered vs max number of attendees that can register
-        if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
+        if ( ! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
             $this->maxAttendeesViolation($valid);
         } else {
             // all data appears to be valid
@@ -238,7 +238,7 @@ 
     private function getEventId()
     {
         // do we have an event id?
-        if (! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
+        if ( ! $this->request->requestParamIsSet('tkt-slctr-event-id')) {
             // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
             EE_Error::add_error(
                 sprintf(
@@ -266,7 +266,7 @@ 
      */
     private function validatePostData($id = 0)
     {
-        if (! $id) {
+        if ( ! $id) {
             EE_Error::add_error(
                 esc_html__('The event id provided was not valid.', 'event_espresso'),
                 __FILE__,
@@ -292,31 +292,31 @@ 
         // cycle through $inputs_to_clean array
         foreach ($inputs_to_clean as $what => $input_to_clean) {
             // check for POST data
-            if ($this->request->requestParamIsSet($input_to_clean . $id)) {
+            if ($this->request->requestParamIsSet($input_to_clean.$id)) {
                 switch ($what) {
                     // integers
                     case 'event_id':
                     case 'rows':
                     case 'max_atndz':
-                        $valid_data[ $what ] = $this->request->getRequestParam($input_to_clean . $id, 0, 'int');
+                        $valid_data[$what] = $this->request->getRequestParam($input_to_clean.$id, 0, 'int');
                         break;
                     // arrays of integers
                     case 'qty':
                         /** @var array $row_qty */
-                        $row_qty = $this->request->getRequestParam($input_to_clean . $id, [], 'int', true);
+                        $row_qty = $this->request->getRequestParam($input_to_clean.$id, [], 'int', true);
                         // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
+                        if ( ! is_array($row_qty)) {
                             /** @var string $row_qty */
                             // get number of rows
-                            $rows = $this->request->getRequestParam('tkt-slctr-rows-' . $id, 1, 'int');
+                            $rows = $this->request->getRequestParam('tkt-slctr-rows-'.$id, 1, 'int');
                             // explode integers by the dash
                             $row_qty = explode('-', $row_qty);
                             $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
                             $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
                             $row_qty = array($row => $qty);
                             for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
+                                if ( ! isset($row_qty[$x])) {
+                                    $row_qty[$x] = 0;
                                 }
                             }
                         }
@@ -325,31 +325,31 @@ 
                         foreach ($row_qty as $qty) {
                             $qty = absint($qty);
                             // sanitize as integers
-                            $valid_data[ $what ][] = $qty;
+                            $valid_data[$what][] = $qty;
                             $valid_data['total_tickets'] += $qty;
                         }
                         break;
                     // array of integers
                     case 'ticket_id':
-                        $ticket_ids = (array) $this->request->getRequestParam($input_to_clean . $id, [], 'int', true);
+                        $ticket_ids = (array) $this->request->getRequestParam($input_to_clean.$id, [], 'int', true);
                         // cycle thru values
                         foreach ($ticket_ids as $key => $value) {
                             // allow only integers
-                            $valid_data[ $what ][ $key ] = absint($value);
+                            $valid_data[$what][$key] = absint($value);
                         }
                         break;
                     case 'return_url':
                         // grab and sanitize return-url
-                        $input_value = $this->request->getRequestParam($input_to_clean . $id, '', 'url');
+                        $input_value = $this->request->getRequestParam($input_to_clean.$id, '', 'url');
                         // was the request coming from an iframe ? if so, then:
                         if (strpos($input_value, 'event_list=iframe')) {
                             // get anchor fragment
                             $input_value = explode('#', $input_value);
                             $input_value = end($input_value);
                             // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+                            $input_value = EEH_Event_View::event_archive_url().'#'.$input_value;
                         }
-                        $valid_data[ $what ] = $input_value;
+                        $valid_data[$what] = $input_value;
                         break;
                 }    // end switch $what
             }
@@ -383,7 +383,7 @@ 
             )
         );
         $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+        EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
     }
 
 
@@ -399,7 +399,7 @@ 
     {
         $tickets_added = 0;
         $tickets_selected = false;
-        if (! empty($valid) && $valid['total_tickets'] > 0) {
+        if ( ! empty($valid) && $valid['total_tickets'] > 0) {
             // load cart using factory because we don't want to do so until actually needed
             $this->cart = CartFactory::getCart();
             // if the user is an admin that can edit registrations,
@@ -408,18 +408,18 @@ 
             // cycle thru the number of data rows sent from the event listing
             for ($x = 0; $x < $valid['rows']; $x++) {
                 // does this row actually contain a ticket quantity?
-                if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+                if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
                     // YES we have a ticket quantity
                     $tickets_selected = true;
                     $valid_ticket = false;
-                    if (isset($valid['ticket_id'][ $x ])) {
+                    if (isset($valid['ticket_id'][$x])) {
                         // get ticket via the ticket id we put in the form
-                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
+                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][$x]);
                         if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
                             $valid_ticket = true;
                             $tickets_added += $this->addTicketToCart(
                                 $ticket,
-                                $valid['qty'][ $x ]
+                                $valid['qty'][$x]
                             );
                         }
                     }
@@ -449,7 +449,7 @@ 
             $this->cart,
             $this
         );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+        if ( ! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
             // no ticket quantities were selected
             EE_Error::add_error(
                 esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
@@ -517,7 +517,7 @@ 
         // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
         if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
             // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
+            if ( ! $this->cart instanceof EE_Cart) {
                 $this->cart = CartFactory::getCart();
             }
             do_action(
@@ -539,7 +539,7 @@ 
                 )
             );
         }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+        if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
             // nothing added to cart
             EE_Error::add_attention(
                 esc_html__('No tickets were added for the event', 'event_espresso'),

core/services/request/CurrentPage.php

Indentation +314 added lines, -314 removed lines

@@ -23,318 +23,318 @@
  */
 class CurrentPage
 {
-    /**
-     * @var EE_CPT_Strategy
-     */
-    private $cpt_strategy;
-
-    /**
-     * @var bool
-     */
-    private $initialized;
-
-    /**
-     * @var bool
-     */
-    private $is_espresso_page = false;
-
-    /**
-     * @var int
-     */
-    private $post_id = 0;
-
-    /**
-     * @var string
-     */
-    private $post_name = '';
-
-    /**
-     * @var array
-     */
-    private $post_type = [];
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * CurrentPage constructor.
-     *
-     * @param EE_CPT_Strategy  $cpt_strategy
-     * @param RequestInterface $request
-     */
-    public function __construct(EE_CPT_Strategy $cpt_strategy, RequestInterface $request)
-    {
-        $this->cpt_strategy = $cpt_strategy;
-        $this->request      = $request;
-        $this->initialized  = is_admin();
-        // analyse the incoming WP request
-        add_action('parse_request', [$this, 'parseQueryVars'], 2, 1);
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function parseQueryVars(WP $WP = null)
-    {
-        if ($this->initialized) {
-            return;
-        }
-        // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $WP instanceof WP) {
-            global $WP;
-        }
-        $this->post_id   = $this->getPostId($WP);
-        $this->post_name = $this->getPostName($WP);
-        $this->post_type = $this->getPostType($WP);
-        // true or false ? is this page being used by EE ?
-        $this->setEspressoPage();
-        remove_action('parse_request', [$this, 'parseRequest'], 2);
-        $this->initialized = true;
-    }
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param WP|null $WP
-     * @return string
-     */
-    public function getPermalink(WP $WP = null)
-    {
-        $post_id = $this->post_id ?: $this->getPostId($WP);
-        if ($post_id) {
-            return get_permalink($post_id);
-        }
-        if (! $WP instanceof WP) {
-            global $WP;
-        }
-        if ($WP instanceof WP && $WP->request) {
-            return site_url($WP->request);
-        }
-        return esc_url_raw(site_url($_SERVER['REQUEST_URI']));
-    }
-
-
-    /**
-     * @return array
-     */
-    public function espressoPostType()
-    {
-        return array_filter(
-            $this->post_type,
-            function ($post_type) {
-                return strpos($post_type, 'espresso_') === 0;
-            }
-        );
-    }
-
-
-    /**
-     * pokes and prods the WP object query_vars in an attempt to shake out a page/post ID
-     *
-     * @param WP $WP
-     * @return int
-     */
-    private function getPostId(WP $WP = null)
-    {
-        $post_id = null;
-        if ($WP instanceof WP) {
-            // look for the post ID in the aptly named 'p' query var
-            if (isset($WP->query_vars['p'])) {
-                $post_id = $WP->query_vars['p'];
-            }
-            // not a post? what about a page?
-            if (! $post_id && isset($WP->query_vars['page_id'])) {
-                $post_id = $WP->query_vars['page_id'];
-            }
-            // ok... maybe pretty permalinks are off and the ID is set in the raw request...
-            // but hasn't been processed yet ie: this method is being called too early :\
-            if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
-                $post_id = basename($WP->request);
-            }
-        }
-        // none of the above? ok what about an explicit "post_id" URL parameter?
-        if (! $post_id && $this->request->requestParamIsSet('post_id')) {
-            $post_id = $this->request->getRequestParam('post_id');
-        }
-        return $post_id;
-    }
-
-
-    /**
-     * similar to getPostId() above but attempts to obtain the "name" for the current page/post
-     *
-     * @param WP $WP
-     * @return string
-     */
-    private function getPostName(WP $WP = null)
-    {
-        global $wpdb;
-        $post_name = null;
-        if ($WP instanceof WP) {
-            // if this is a post, then is the post name set?
-            if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
-                $post_name = $WP->query_vars['name'];
-            }
-            // what about the page name?
-            if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
-                $post_name = $WP->query_vars['pagename'];
-            }
-            // this stinks but let's run a query to try and get the post name from the URL
-            // (assuming pretty permalinks are on)
-            if (! $post_name && $WP->request !== null && ! empty($WP->request)) {
-                $possible_post_name = basename($WP->request);
-                if (! is_numeric($possible_post_name)) {
-                    $SQL                = "SELECT ID from {$wpdb->posts}";
-                    $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
-                    $SQL                .= ' AND post_name=%s';
-                    $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
-                    if ($possible_post_name) {
-                        $post_name = $possible_post_name;
-                    }
-                }
-            }
-        }
-        // ug... ok... nothing yet... but do we have a post ID?
-        // if so then... sigh... run a query to get the post name :\
-        if (! $post_name && $this->post_id) {
-            $SQL                = "SELECT post_name from {$wpdb->posts}";
-            $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
-            $SQL                .= ' AND ID=%d';
-            $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->post_id));
-            if ($possible_post_name) {
-                $post_name = $possible_post_name;
-            }
-        }
-        // still nothing? ok what about an explicit 'post_name' URL parameter?
-        if (! $post_name && $this->request->requestParamIsSet('post_name')) {
-            $post_name = $this->request->getRequestParam('post_name');
-        }
-        return $post_name;
-    }
-
-
-    /**
-     * also similar to getPostId() and getPostName() above but not as insane
-     *
-     * @param WP $WP
-     * @return array
-     */
-    private function getPostType(WP $WP = null)
-    {
-        $post_types = [];
-        if ($WP instanceof WP) {
-            $post_types = isset($WP->query_vars['post_type'])
-                ? (array) $WP->query_vars['post_type']
-                : [];
-        }
-        if (empty($post_types) && $this->request->requestParamIsSet('post_type')) {
-            $post_types = $this->request->getRequestParam('post_type', [], 'string', true);
-        }
-        return (array) $post_types;
-    }
-
-
-    /**
-     * if TRUE, then the current page is somehow utilizing EE logic
-     *
-     * @return bool
-     */
-    public function isEspressoPage()
-    {
-        return $this->is_espresso_page;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function postId()
-    {
-        return $this->post_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postName()
-    {
-        return $this->post_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * for manually indicating the current page will utilize EE logic
-     *
-     * @param null|bool $value
-     * @return void
-     */
-    public function setEspressoPage($value = null)
-    {
-        $this->is_espresso_page = $value !== null
-            ? filter_var($value, FILTER_VALIDATE_BOOLEAN)
-            : $this->testForEspressoPage();
-    }
-
-
-    /**
-     * attempts to determine if the current page/post is an EE related page/post
-     * because it utilizes one of our CPT taxonomies, endpoints, or post types
-     *
-     * @return bool
-     */
-    private function testForEspressoPage()
-    {
-        // in case it has already been set
-        if ($this->is_espresso_page) {
-            return true;
-        }
-        global $WP;
-        $espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
-        if (is_array($espresso_CPT_taxonomies)) {
-            foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
-                    return true;
-                }
-            }
-        }
-        // load espresso CPT endpoints
-        $espresso_CPT_endpoints  = $this->cpt_strategy->get_CPT_endpoints();
-        $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        foreach ($this->post_type as $post_type) {
-            // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
-                // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->post_name) {
-                    $espresso_post_type = $this->request->getRequestParam('post_type');
-                    // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    // this essentially sets the post_name to "events" (or whatever EE CPT)
-                    $post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
-                        ? $post_type_CPT_endpoints[ $espresso_post_type ]
-                        : '';
-                    // if the post type matches one of ours then set the post name to the endpoint
-                    if ($post_name) {
-                        $this->post_name = $post_name;
-                    }
-                }
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @var EE_CPT_Strategy
+	 */
+	private $cpt_strategy;
+
+	/**
+	 * @var bool
+	 */
+	private $initialized;
+
+	/**
+	 * @var bool
+	 */
+	private $is_espresso_page = false;
+
+	/**
+	 * @var int
+	 */
+	private $post_id = 0;
+
+	/**
+	 * @var string
+	 */
+	private $post_name = '';
+
+	/**
+	 * @var array
+	 */
+	private $post_type = [];
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * CurrentPage constructor.
+	 *
+	 * @param EE_CPT_Strategy  $cpt_strategy
+	 * @param RequestInterface $request
+	 */
+	public function __construct(EE_CPT_Strategy $cpt_strategy, RequestInterface $request)
+	{
+		$this->cpt_strategy = $cpt_strategy;
+		$this->request      = $request;
+		$this->initialized  = is_admin();
+		// analyse the incoming WP request
+		add_action('parse_request', [$this, 'parseQueryVars'], 2, 1);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function parseQueryVars(WP $WP = null)
+	{
+		if ($this->initialized) {
+			return;
+		}
+		// if somebody forgot to provide us with WP, that's ok because its global
+		if (! $WP instanceof WP) {
+			global $WP;
+		}
+		$this->post_id   = $this->getPostId($WP);
+		$this->post_name = $this->getPostName($WP);
+		$this->post_type = $this->getPostType($WP);
+		// true or false ? is this page being used by EE ?
+		$this->setEspressoPage();
+		remove_action('parse_request', [$this, 'parseRequest'], 2);
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param WP|null $WP
+	 * @return string
+	 */
+	public function getPermalink(WP $WP = null)
+	{
+		$post_id = $this->post_id ?: $this->getPostId($WP);
+		if ($post_id) {
+			return get_permalink($post_id);
+		}
+		if (! $WP instanceof WP) {
+			global $WP;
+		}
+		if ($WP instanceof WP && $WP->request) {
+			return site_url($WP->request);
+		}
+		return esc_url_raw(site_url($_SERVER['REQUEST_URI']));
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function espressoPostType()
+	{
+		return array_filter(
+			$this->post_type,
+			function ($post_type) {
+				return strpos($post_type, 'espresso_') === 0;
+			}
+		);
+	}
+
+
+	/**
+	 * pokes and prods the WP object query_vars in an attempt to shake out a page/post ID
+	 *
+	 * @param WP $WP
+	 * @return int
+	 */
+	private function getPostId(WP $WP = null)
+	{
+		$post_id = null;
+		if ($WP instanceof WP) {
+			// look for the post ID in the aptly named 'p' query var
+			if (isset($WP->query_vars['p'])) {
+				$post_id = $WP->query_vars['p'];
+			}
+			// not a post? what about a page?
+			if (! $post_id && isset($WP->query_vars['page_id'])) {
+				$post_id = $WP->query_vars['page_id'];
+			}
+			// ok... maybe pretty permalinks are off and the ID is set in the raw request...
+			// but hasn't been processed yet ie: this method is being called too early :\
+			if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
+				$post_id = basename($WP->request);
+			}
+		}
+		// none of the above? ok what about an explicit "post_id" URL parameter?
+		if (! $post_id && $this->request->requestParamIsSet('post_id')) {
+			$post_id = $this->request->getRequestParam('post_id');
+		}
+		return $post_id;
+	}
+
+
+	/**
+	 * similar to getPostId() above but attempts to obtain the "name" for the current page/post
+	 *
+	 * @param WP $WP
+	 * @return string
+	 */
+	private function getPostName(WP $WP = null)
+	{
+		global $wpdb;
+		$post_name = null;
+		if ($WP instanceof WP) {
+			// if this is a post, then is the post name set?
+			if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
+				$post_name = $WP->query_vars['name'];
+			}
+			// what about the page name?
+			if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
+				$post_name = $WP->query_vars['pagename'];
+			}
+			// this stinks but let's run a query to try and get the post name from the URL
+			// (assuming pretty permalinks are on)
+			if (! $post_name && $WP->request !== null && ! empty($WP->request)) {
+				$possible_post_name = basename($WP->request);
+				if (! is_numeric($possible_post_name)) {
+					$SQL                = "SELECT ID from {$wpdb->posts}";
+					$SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
+					$SQL                .= ' AND post_name=%s';
+					$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
+					if ($possible_post_name) {
+						$post_name = $possible_post_name;
+					}
+				}
+			}
+		}
+		// ug... ok... nothing yet... but do we have a post ID?
+		// if so then... sigh... run a query to get the post name :\
+		if (! $post_name && $this->post_id) {
+			$SQL                = "SELECT post_name from {$wpdb->posts}";
+			$SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
+			$SQL                .= ' AND ID=%d';
+			$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->post_id));
+			if ($possible_post_name) {
+				$post_name = $possible_post_name;
+			}
+		}
+		// still nothing? ok what about an explicit 'post_name' URL parameter?
+		if (! $post_name && $this->request->requestParamIsSet('post_name')) {
+			$post_name = $this->request->getRequestParam('post_name');
+		}
+		return $post_name;
+	}
+
+
+	/**
+	 * also similar to getPostId() and getPostName() above but not as insane
+	 *
+	 * @param WP $WP
+	 * @return array
+	 */
+	private function getPostType(WP $WP = null)
+	{
+		$post_types = [];
+		if ($WP instanceof WP) {
+			$post_types = isset($WP->query_vars['post_type'])
+				? (array) $WP->query_vars['post_type']
+				: [];
+		}
+		if (empty($post_types) && $this->request->requestParamIsSet('post_type')) {
+			$post_types = $this->request->getRequestParam('post_type', [], 'string', true);
+		}
+		return (array) $post_types;
+	}
+
+
+	/**
+	 * if TRUE, then the current page is somehow utilizing EE logic
+	 *
+	 * @return bool
+	 */
+	public function isEspressoPage()
+	{
+		return $this->is_espresso_page;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function postId()
+	{
+		return $this->post_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postName()
+	{
+		return $this->post_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * for manually indicating the current page will utilize EE logic
+	 *
+	 * @param null|bool $value
+	 * @return void
+	 */
+	public function setEspressoPage($value = null)
+	{
+		$this->is_espresso_page = $value !== null
+			? filter_var($value, FILTER_VALIDATE_BOOLEAN)
+			: $this->testForEspressoPage();
+	}
+
+
+	/**
+	 * attempts to determine if the current page/post is an EE related page/post
+	 * because it utilizes one of our CPT taxonomies, endpoints, or post types
+	 *
+	 * @return bool
+	 */
+	private function testForEspressoPage()
+	{
+		// in case it has already been set
+		if ($this->is_espresso_page) {
+			return true;
+		}
+		global $WP;
+		$espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
+		if (is_array($espresso_CPT_taxonomies)) {
+			foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
+				if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
+					return true;
+				}
+			}
+		}
+		// load espresso CPT endpoints
+		$espresso_CPT_endpoints  = $this->cpt_strategy->get_CPT_endpoints();
+		$post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
+		foreach ($this->post_type as $post_type) {
+			// was a post name passed ?
+			if (isset($post_type_CPT_endpoints[ $post_type ])) {
+				// kk we know this is an espresso page, but is it a specific post ?
+				if (! $this->post_name) {
+					$espresso_post_type = $this->request->getRequestParam('post_type');
+					// there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
+					// this essentially sets the post_name to "events" (or whatever EE CPT)
+					$post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
+						? $post_type_CPT_endpoints[ $espresso_post_type ]
+						: '';
+					// if the post type matches one of ours then set the post name to the endpoint
+					if ($post_name) {
+						$this->post_name = $post_name;
+					}
+				}
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/services/request/RequestParams.php

Indentation +310 added lines, -310 removed lines

@@ -14,314 +14,314 @@
 class RequestParams
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = ! empty($get) ? $get : (array) filter_input_array(INPUT_GET, FILTER_SANITIZE_STRING);
-        $this->post      = ! empty($post) ? $post : (array) filter_input_array(INPUT_POST, FILTER_SANITIZE_STRING);
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return (bool) $this->parameterDrillDown($pattern, false, 'match', 'bool');
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, ['bool', 'key', 'value'], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param mixed  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = 'value',
-        $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = ! empty($get) ? $get : (array) filter_input_array(INPUT_GET, FILTER_SANITIZE_STRING);
+		$this->post      = ! empty($post) ? $post : (array) filter_input_array(INPUT_POST, FILTER_SANITIZE_STRING);
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return (bool) $this->parameterDrillDown($pattern, false, 'match', 'bool');
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, ['bool', 'key', 'value'], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param mixed  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = 'value',
+		$request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }

core/services/request/Request.php

Indentation +478 added lines, -478 removed lines

@@ -17,482 +17,482 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array
-     */
-    protected $cookies;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array
-     */
-    protected $files;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool
-     */
-    protected $is_bot;
-
-    /**
-     * @var RequestParams
-     */
-    protected $request_params;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    protected $request_type;
-
-    /**
-     * @var ServerParams
-     */
-    protected $server_params;
-
-
-    public function __construct(
-        RequestParams $request_params,
-        ServerParams $server_params,
-        array $cookies = [],
-        array $files = []
-    ) {
-        $this->cookies = ! empty($cookies)
-            ? $cookies
-            : filter_input_array(INPUT_COOKIE, FILTER_SANITIZE_STRING);
-        $this->files          = ! empty($files) ? $files : $_FILES;
-        $this->request_params = $request_params;
-        $this->server_params  = $server_params;
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->request_params->getParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->request_params->postParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookies;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server_params->getAllServerParams();
-    }
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null)
-    {
-        return $this->server_params->getServerParam($key, $default);
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $this->server_params->setServerParam($key, $value);
-    }
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return $this->server_params->serverParamIsSet($key);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filesParams()
-    {
-        return $this->files;
-    }
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request_params->requestParams();
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        $this->request_params->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * returns sanitized value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->request_params->requestParamIsSet($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the sanitized value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return $this->request_params->matches($pattern);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParams($keys, $unset_from_global_too);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->server_params->ipAddress();
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     *
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        return $this->server_params->requestUri();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->server_params->userAgent();
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->server_params->setUserAgent($user_agent);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressApi()
-    {
-        return $this->request_type->isWordPressApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressHeartbeat()
-    {
-        return $this->request_type->isWordPressHeartbeat();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
-
-
-    /**
-     * @return RequestTypeContextCheckerInterface
-     */
-    public function getRequestType()
-    {
-        return $this->request_type;
-    }
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array
+	 */
+	protected $cookies;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array
+	 */
+	protected $files;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool
+	 */
+	protected $is_bot;
+
+	/**
+	 * @var RequestParams
+	 */
+	protected $request_params;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	protected $request_type;
+
+	/**
+	 * @var ServerParams
+	 */
+	protected $server_params;
+
+
+	public function __construct(
+		RequestParams $request_params,
+		ServerParams $server_params,
+		array $cookies = [],
+		array $files = []
+	) {
+		$this->cookies = ! empty($cookies)
+			? $cookies
+			: filter_input_array(INPUT_COOKIE, FILTER_SANITIZE_STRING);
+		$this->files          = ! empty($files) ? $files : $_FILES;
+		$this->request_params = $request_params;
+		$this->server_params  = $server_params;
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->request_params->getParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->request_params->postParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookies;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server_params->getAllServerParams();
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null)
+	{
+		return $this->server_params->getServerParam($key, $default);
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$this->server_params->setServerParam($key, $value);
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return $this->server_params->serverParamIsSet($key);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams()
+	{
+		return $this->files;
+	}
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request_params->requestParams();
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		$this->request_params->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * returns sanitized value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->request_params->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the sanitized value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return $this->request_params->matches($pattern);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParams($keys, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->server_params->ipAddress();
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 *
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		return $this->server_params->requestUri();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->server_params->userAgent();
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->server_params->setUserAgent($user_agent);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressApi()
+	{
+		return $this->request_type->isWordPressApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressHeartbeat()
+	{
+		return $this->request_type->isWordPressHeartbeat();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
+
+
+	/**
+	 * @return RequestTypeContextCheckerInterface
+	 */
+	public function getRequestType()
+	{
+		return $this->request_type;
+	}
 }

core/services/request/RequestInterface.php

Indentation +179 added lines, -179 removed lines

@@ -16,185 +16,185 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
 
 
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null);
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value);
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key);
-
-
-    /**
-     * @return array
-     */
-    public function filesParams();
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
-
-
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern);
-
-
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false);
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress();
-
-
-    /**
-     * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false);
-
-
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null);
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value);
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key);
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams();
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
+
+
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = 'string', $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = 'string', $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern);
+
+
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
+
+
+	/**
+	 * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
 }

core/services/request/sanitizers/RequestSanitizer.php

Indentation +43 added lines, -43 removed lines

@@ -4,47 +4,47 @@
 
 class RequestSanitizer
 {
-    /**
-     * Will sanitize the supplied request parameter based on the specified data type
-     *
-     * @param mixed  $param     the supplied request parameter
-     * @param string $type      the specified data type (default: "string")
-     *                          valid values: "bool", "float", "int", "key", "url", or "string"
-     * @param bool   $is_array  if true, then $param will be treated as an array of $type
-     * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
-     * @return array|bool|float|int|string
-     * @since 4.10.14.p
-     */
-    public function clean($param, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        if ($delimiter !== '' && is_string($param)) {
-            $param = explode($delimiter, $param);
-        }
-        // check if we are getting an improperly typed array and correct
-        $is_array = $is_array || is_array($param);
-        if ($is_array) {
-            $values        = [];
-            foreach ($param as $key => $value) {
-                $values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
-            }
-            return $values;
-        }
-        switch ($type) {
-            case 'bool':
-                return filter_var($param, FILTER_VALIDATE_BOOLEAN);
-            case 'float':
-                return (float) $param;
-            case 'fqcn':
-                return preg_replace('[^\\\w\d]', '', $param);
-            case 'int':
-                return (int) $param;
-            case 'key':
-                return sanitize_key($param);
-            case 'url':
-                return esc_url_raw($param);
-            case 'string':
-            default:
-                return sanitize_text_field($param);
-        }
-    }
+	/**
+	 * Will sanitize the supplied request parameter based on the specified data type
+	 *
+	 * @param mixed  $param     the supplied request parameter
+	 * @param string $type      the specified data type (default: "string")
+	 *                          valid values: "bool", "float", "int", "key", "url", or "string"
+	 * @param bool   $is_array  if true, then $param will be treated as an array of $type
+	 * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
+	 * @return array|bool|float|int|string
+	 * @since 4.10.14.p
+	 */
+	public function clean($param, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		if ($delimiter !== '' && is_string($param)) {
+			$param = explode($delimiter, $param);
+		}
+		// check if we are getting an improperly typed array and correct
+		$is_array = $is_array || is_array($param);
+		if ($is_array) {
+			$values        = [];
+			foreach ($param as $key => $value) {
+				$values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
+			}
+			return $values;
+		}
+		switch ($type) {
+			case 'bool':
+				return filter_var($param, FILTER_VALIDATE_BOOLEAN);
+			case 'float':
+				return (float) $param;
+			case 'fqcn':
+				return preg_replace('[^\\\w\d]', '', $param);
+			case 'int':
+				return (int) $param;
+			case 'key':
+				return sanitize_key($param);
+			case 'url':
+				return esc_url_raw($param);
+			case 'string':
+			default:
+				return sanitize_text_field($param);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,9 +23,9 @@
         // check if we are getting an improperly typed array and correct
         $is_array = $is_array || is_array($param);
         if ($is_array) {
-            $values        = [];
+            $values = [];
             foreach ($param as $key => $value) {
-                $values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
+                $values[$key] = $this->clean($value, $type, is_array($value), $delimiter);
             }
             return $values;
         }

core/libraries/messages/data_class/EE_Messages_Preview_incoming_data.class.php

Indentation +599 added lines, -599 removed lines

@@ -21,603 +21,603 @@
 class EE_Messages_Preview_incoming_data extends EE_Messages_incoming_data
 {
 
-    // some specific properties we need for this class
-    private $_events        = [];
-
-    private $_attendees     = [];
-
-    private $_registrations = [];
-
-
-    /**
-     * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
-     * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
-     * we'll get the first three published events from the users database and use that as a source.
-     *
-     * @param array $data
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($data = [])
-    {
-        $this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
-        $this->_setup_attendees_events();
-        parent::__construct($data);
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $data The incoming data to be prepped.
-     *
-     * @return array   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     *
-     * @return array
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * This will just setup the _events property in the expected format.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _setup_attendees_events()
-    {
-
-        // setup some attendee objects
-        $attendees = $this->_get_some_attendees();
-
-        // if empty $data we'll do a query to get some events from the server.
-        // otherwise we'll retrieve the event data for the given ids.
-        $events = $this->_get_some_events($this->_data);
-
-        $answers_n_questions = $this->_get_some_q_and_as();
-
-        if (count($events) < 1) {
-            throw new EE_Error(
-                esc_html__(
-                    'We can\'t generate a preview for you because there are no active events in your database',
-                    'event_espresso'
-                )
-            );
-        }
-
-
-        // now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
-        // we'll actually use the generated line_item identifiers for our loop
-        $dtts = $tkts = [];
-        foreach ($events as $id => $event) {
-            if (! $event instanceof EE_Event) {
-                continue;
-            }
-            $this->_events[ $id ]['ID']       = $id;
-            $this->_events[ $id ]['name']     = $event->get('EVT_name');
-            $datetime                         = $event->get_first_related('Datetime');
-            $tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
-                'Ticket',
-                ['default_where_conditions' => 'none']
-            ) : [];
-            $this->_events[ $id ]['event']    = $event;
-            $this->_events[ $id ]['reg_objs'] = [];
-            $this->_events[ $id ]['tkt_objs'] = $tickets;
-            $this->_events[ $id ]['dtt_objs'] = [];
-
-            $dttcache = [];
-            $tkts     = [];
-            foreach ($tickets as $ticket) {
-                if (! $ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                $reldatetime                       = $ticket->datetimes();
-                $tkts[ $ticket->ID() ]             = [];
-                $tkts[ $ticket->ID() ]['ticket']   = $ticket;
-                $tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
-                $tkts[ $ticket->ID() ]['att_objs'] = $attendees;
-                $tkts[ $ticket->ID() ]['count']    = count($attendees);
-                $tkts[ $ticket->ID() ]['EE_Event'] = $event;
-                foreach ($reldatetime as $datetime) {
-                    if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
-                        $this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
-                        $dtts[ $datetime->ID() ]['datetime']                 = $datetime;
-                        $dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
-                        $dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
-                        $dttcache[ $datetime->ID() ]                         = $datetime;
-                    }
-                }
-            }
-
-            $this->_events[ $id ]['total_attendees'] = count($attendees);
-            $this->_events[ $id ]['att_objs']        = $attendees;
-
-            // let's also setup the dummy attendees property!
-            foreach ($attendees as $att_key => $attendee) {
-                if (! $attendee instanceof EE_Attendee) {
-                    continue;
-                }
-                $this->_attendees[ $att_key ]['line_ref'][] =
-                    $id;  // so later it can be determined what events this attendee registered for!
-                $this->_attendees[ $att_key ]['evt_objs'][] = $event;
-                $this->_attendees[ $att_key ]['att_obj']    = $attendee;
-                // $this->_attendees[$att_key]['registration_id'] = 0;
-                $this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
-                $this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
-                if ($att_key == 999999991) {
-                    $this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
-                    $this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
-                    $this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
-                } elseif ($att_key == 999999992) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
-                    $this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
-                    $this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
-                } elseif ($att_key == 999999993) {
-                    $this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
-                    $this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
-                    $this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
-                }
-            }
-        }
-
-        $this->tickets            = $tkts;
-        $this->datetimes          = $dtts;
-        $this->answers            = $answers_n_questions['answers'];
-        $this->questions          = $answers_n_questions['questions'];
-        $this->total_ticket_count = count($tkts) * count($this->_attendees);
-    }
-
-
-    /**
-     * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
-     *
-     * @access private
-     * @return array an array of attendee objects
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _get_some_attendees()
-    {
-        // let's just setup a dummy array of various attendee details
-        $dummy_attendees = [
-            0 => [
-                'Luke',
-                'Skywalker',
-                'farfaraway@galaxy.sp',
-                '804 Bantha Dr.',
-                'Complex 8',
-                'Mos Eisley',
-                32,
-                'US',
-                'f0r3e',
-                '222-333-4763',
-                false,
-                '999999991',
-            ],
-            1 => [
-                'Princess',
-                'Leia',
-                'buns@fcn.al',
-                '1456 Valley Way Boulevard',
-                'Suite 9',
-                'Alderaan',
-                15,
-                'US',
-                'c1h2c',
-                '78-123-111-1111',
-                false,
-                '999999992',
-            ],
-            2 => [
-                'Yoda',
-                'I Am',
-                'arrivenot@emailbad.fr',
-                '4th Tree',
-                '5th Knot',
-                'Marsh',
-                22,
-                'US',
-                'l18n',
-                '999-999-9999',
-                false,
-                '999999993',
-            ],
-        ];
-
-        // let's generate the attendee objects
-        $attendees = [];
-        $var_array = [
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'staid',
-            'cntry',
-            'zip',
-            'phone',
-            'deleted',
-            'attid',
-        ];
-
-        // EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
-        foreach ($dummy_attendees as $dummy) {
-            $att = array_combine($var_array, $dummy);
-            extract($att);
-            /** @var $fname string */
-            /** @var $lname string */
-            /** @var $address string */
-            /** @var $address2 string */
-            /** @var $city string */
-            /** @var $staid string */
-            /** @var $cntry string */
-            /** @var $zip string */
-            /** @var $email string */
-            /** @var $phone string */
-            /** @var $attid string */
-            $attendees[ $attid ] = EE_Attendee::new_instance(
-                [
-                    'ATT_fname'    => $fname,
-                    'ATT_lname'    => $lname,
-                    'ATT_address'  => $address,
-                    'ATT_address2' => $address2,
-                    'ATT_city'     => $city,
-                    'STA_ID'       => $staid,
-                    'CNT_ISO'      => $cntry,
-                    'ATT_zip'      => $zip,
-                    'ATT_email'    => $email,
-                    'ATT_phone'    => $phone,
-                    'ATT_ID'       => $attid,
-                ]
-            );
-        }
-
-        return $attendees;
-    }
-
-
-    /**
-     * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
-     * This will be used in our dummy data setup
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_some_q_and_as()
-    {
-        $quests_array = [
-            0 => [
-                555,
-                esc_html__('What is your favorite planet?', 'event_espresso'),
-                0,
-            ],
-            1 => [
-                556,
-                esc_html__('What is your favorite food?', 'event_espresso'),
-                0,
-            ],
-            2 => [
-                557,
-                esc_html__('How many lightyears have you travelled', 'event_espresso'),
-                0,
-            ],
-        ];
-
-        $ans_array = [
-            0 => [
-                999,
-                555,
-                'Tattoine',
-            ],
-            1 => [
-                1000,
-                555,
-                'Alderaan',
-            ],
-            2 => [
-                1001,
-                555,
-                'Dantooine',
-            ],
-            3 => [
-                1002,
-                556,
-                'Fish Fingers',
-            ],
-            4 => [
-                1003,
-                556,
-                'Sushi',
-            ],
-            5 => [
-                1004,
-                556,
-                'Water',
-            ],
-            6 => [
-                1005,
-                557,
-                'A lot',
-            ],
-            7 => [
-                1006,
-                557,
-                "That's none of your business.",
-            ],
-            8 => [
-                1007,
-                557,
-                "People less travel me then.",
-            ],
-        ];
-
-        $qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
-        $ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
-
-        // EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
-        // EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
-
-        $qsts = [];
-        // first the questions
-        foreach ($quests_array as $qst) {
-            $qstobj                    = array_combine($qst_columns, $qst);
-            $qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
-        }
-
-        // now the answers (and we'll setup our arrays)
-        $q_n_as = [];
-        foreach ($ans_array as $ans) {
-            $ansobj                               = array_combine($ans_columns, $ans);
-            $ansobj                               = EE_Answer::new_instance($ansobj);
-            $q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
-            $q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
-        }
-
-        return $q_n_as;
-    }
-
-
-    /**
-     * Return an array of event objects from the database
-     *
-     * If event ids are not included then we'll just retrieve the first published event from the database.
-     *
-     * @param array $event_ids if set, this will be an array of event ids to obtain events for.
-     *
-     * @return array    An array of event objects from the db.
-     * @throws EE_Error
-     */
-    private function _get_some_events(array $event_ids = [])
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        // if we have an evt_id then we want to make sure we use that for the preview
-        // (because a specific event template is being viewed);
-        $event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
-        $limit     = ! empty($event_ids)
-            ? null
-            : apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
-
-        $where = ! empty($event_ids)
-            ? [
-                'EVT_ID'                 => ['IN', $event_ids],
-                'Datetime.Ticket.TKT_ID' => ['>', 1],
-            ]
-            : ['Datetime.Ticket.TKT_ID' => ['>', 1]];
-
-        return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _setup_data()
-    {
-        // need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-            $session = EE_Registry::instance()->SSN;
-        } else {
-            $session = EE_Registry::instance()->load_core('Session');
-        }
-        $cart = EE_Cart::instance(null, $session);
-
-        // add tickets to cart
-        foreach ($this->tickets as $ticket) {
-            $cart->add_ticket_to_cart($ticket['ticket']);
-        }
-
-        // setup txn property
-        $this->txn = EE_Transaction::new_instance(
-            [
-                'TXN_timestamp'    => time(), // unix timestamp
-                'TXN_total'        => 0, // txn_total
-                'TXN_paid'         => 0, // txn_paid
-                'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
-                'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
-                'TXN_hash_salt'    => null, // hash salt blank as well
-                'TXN_ID'           => 999999,
-            ]
-        );
-
-
-        // setup reg_objects
-        // note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
-        $this->reg_objs = [];
-        $regid          = 9999990;
-        foreach ($this->_attendees as $key => $attendee) {
-            // note we need to setup reg_objects for each event this attendee belongs to
-            $regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
-            $regtxn = $this->txn->ID();
-            $regcnt = 1;
-            foreach ($attendee['line_ref'] as $evtid) {
-                foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
-                    if (! $ticket instanceof EE_Ticket) {
-                        continue;
-                    }
-                    $reg_array                                            = [
-                        'EVT_ID'           => $evtid,
-                        'ATT_ID'           => $regatt,
-                        'TXN_ID'           => $regtxn,
-                        'TKT_ID'           => $ticket->ID(),
-                        'STS_ID'           => EEM_Registration::status_id_pending_payment,
-                        'REG_date'         => time(),
-                        'REG_final_price'  => $ticket->get('TKT_price'),
-                        'REG_session'      => 'dummy_session_id',
-                        'REG_code'         => $regid . '-dummy-generated-code',
-                        'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
-                        'REG_count'        => $regcnt,
-                        'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
-                        'REG_att_is_going' => true,
-                        'REG_ID'           => $regid,
-                    ];
-                    $REG_OBJ                                              = EE_Registration::new_instance($reg_array);
-                    $this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
-                    $this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
-                    $this->reg_objs[]                                     = $REG_OBJ;
-                    $this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
-
-                    $regcnt++;
-                    $regid++;
-                }
-            }
-        }
-
-
-        // setup line items!
-        $line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
-
-        // add tickets
-        foreach ($this->tickets as $item) {
-            $qty    = $item['count'];
-            $ticket = $item['ticket'];
-            EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
-        }
-
-        $shipping_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => esc_html__(
-                    'Shipping Surcharge',
-                    'event_espresso'
-                ),
-                'LIN_desc'       => esc_html__(
-                    'Sent via Millenium Falcon',
-                    'event_espresso'
-                ),
-                'LIN_unit_price' => 20,
-                'LIN_quantity'   => 1,
-                'LIN_is_taxable' => true,
-                'LIN_total'      => 20,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-            ]
-        );
-        EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
-        $this->additional_line_items = [$shipping_line_item];
-
-        // now let's add taxes
-        EEH_Line_Item::apply_taxes($line_item_total);
-
-        // now we should be able to get the items we need from this object
-        $event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
-        $line_items       = [];
-        foreach ($event_line_items as $line_item) {
-            if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
-                continue;
-            }
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
-                $this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
-                $line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
-                    $this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
-            }
-        }
-
-        $this->line_items_with_children = $line_items;
-        $this->tax_line_items           = $line_item_total->tax_descendants();
-
-        // add proper total to transaction object.
-        $grand_total                 = $line_item_total->recalculate_total_including_taxes();
-        $this->grand_total_line_item = $line_item_total;
-        $this->txn->set_total($grand_total);
-
-
-        // add additional details for each registration
-        foreach ($this->reg_objs as $reg) {
-            if (! $reg instanceof EE_Registration) {
-                continue;
-            }
-            $this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
-            $this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
-            $this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
-            $this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
-            $this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
-            $this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
-        }
-
-
-        // events and attendees
-        $this->events        = $this->_events;
-        $this->attendees     = $this->_attendees;
-        $this->registrations = $this->_registrations;
-
-        $attendees_to_shift = $this->_attendees;
-
-        // setup primary attendee property
-        $this->primary_attendee_data = [
-            'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->fname()
-                : '',
-
-            'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->lname()
-                : '',
-
-            'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
-                ? $this->_attendees[999999991]['att_obj']->email()
-                : '',
-
-            'att_obj' => $this->_attendees[999999991]['att_obj'],
-
-            'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
-        ];
-
-        // reg_info property
-        // note this isn't referenced by any shortcode parsers so we'll ignore for now.
-        $this->reg_info = [];
-
-        // let's set a reg_obj for messengers expecting one.
-        $this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
-
-        // the below are just dummy items.
-        $this->user_id     = 1;
-        $this->ip_address  = '192.0.2.1';
-        $this->user_agent  = '';
-        $this->init_access = time();
-        $this->last_access = time();
-    }
+	// some specific properties we need for this class
+	private $_events        = [];
+
+	private $_attendees     = [];
+
+	private $_registrations = [];
+
+
+	/**
+	 * For the constructor of this special preview class.  We're either looking for an event id or empty data.  If we
+	 * have an event id (or ids) then we'll use that as the source for the "dummy" data.  If the data is empty then
+	 * we'll get the first three published events from the users database and use that as a source.
+	 *
+	 * @param array $data
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($data = [])
+	{
+		$this->_data = isset($data['event_ids']) ? $data['event_ids'] : [];
+		$this->_setup_attendees_events();
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $data The incoming data to be prepped.
+	 *
+	 * @return array   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 *
+	 * @return array
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * This will just setup the _events property in the expected format.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _setup_attendees_events()
+	{
+
+		// setup some attendee objects
+		$attendees = $this->_get_some_attendees();
+
+		// if empty $data we'll do a query to get some events from the server.
+		// otherwise we'll retrieve the event data for the given ids.
+		$events = $this->_get_some_events($this->_data);
+
+		$answers_n_questions = $this->_get_some_q_and_as();
+
+		if (count($events) < 1) {
+			throw new EE_Error(
+				esc_html__(
+					'We can\'t generate a preview for you because there are no active events in your database',
+					'event_espresso'
+				)
+			);
+		}
+
+
+		// now let's loop and set up the _events property.  At the same time we'll set up attendee properties.
+		// we'll actually use the generated line_item identifiers for our loop
+		$dtts = $tkts = [];
+		foreach ($events as $id => $event) {
+			if (! $event instanceof EE_Event) {
+				continue;
+			}
+			$this->_events[ $id ]['ID']       = $id;
+			$this->_events[ $id ]['name']     = $event->get('EVT_name');
+			$datetime                         = $event->get_first_related('Datetime');
+			$tickets                          = $datetime instanceof EE_Datetime ? $datetime->get_many_related(
+				'Ticket',
+				['default_where_conditions' => 'none']
+			) : [];
+			$this->_events[ $id ]['event']    = $event;
+			$this->_events[ $id ]['reg_objs'] = [];
+			$this->_events[ $id ]['tkt_objs'] = $tickets;
+			$this->_events[ $id ]['dtt_objs'] = [];
+
+			$dttcache = [];
+			$tkts     = [];
+			foreach ($tickets as $ticket) {
+				if (! $ticket instanceof EE_Ticket) {
+					continue;
+				}
+				$reldatetime                       = $ticket->datetimes();
+				$tkts[ $ticket->ID() ]             = [];
+				$tkts[ $ticket->ID() ]['ticket']   = $ticket;
+				$tkts[ $ticket->ID() ]['dtt_objs'] = $reldatetime;
+				$tkts[ $ticket->ID() ]['att_objs'] = $attendees;
+				$tkts[ $ticket->ID() ]['count']    = count($attendees);
+				$tkts[ $ticket->ID() ]['EE_Event'] = $event;
+				foreach ($reldatetime as $datetime) {
+					if ($datetime instanceof EE_Datetime && ! isset($dtts[ $datetime->ID() ])) {
+						$this->_events[ $id ]['dtt_objs'][ $datetime->ID() ] = $datetime;
+						$dtts[ $datetime->ID() ]['datetime']                 = $datetime;
+						$dtts[ $datetime->ID() ]['tkt_objs'][]               = $ticket;
+						$dtts[ $datetime->ID() ]['evt_objs'][]               = $event;
+						$dttcache[ $datetime->ID() ]                         = $datetime;
+					}
+				}
+			}
+
+			$this->_events[ $id ]['total_attendees'] = count($attendees);
+			$this->_events[ $id ]['att_objs']        = $attendees;
+
+			// let's also setup the dummy attendees property!
+			foreach ($attendees as $att_key => $attendee) {
+				if (! $attendee instanceof EE_Attendee) {
+					continue;
+				}
+				$this->_attendees[ $att_key ]['line_ref'][] =
+					$id;  // so later it can be determined what events this attendee registered for!
+				$this->_attendees[ $att_key ]['evt_objs'][] = $event;
+				$this->_attendees[ $att_key ]['att_obj']    = $attendee;
+				// $this->_attendees[$att_key]['registration_id'] = 0;
+				$this->_attendees[ $att_key ]['attendee_email'] = $attendee->email();
+				$this->_attendees[ $att_key ]['tkt_objs']       = $tickets;
+				if ($att_key == 999999991) {
+					$this->_attendees[ $att_key ]['ans_objs'][999]  = $answers_n_questions['answers'][999];
+					$this->_attendees[ $att_key ]['ans_objs'][1002] = $answers_n_questions['answers'][1002];
+					$this->_attendees[ $att_key ]['ans_objs'][1005] = $answers_n_questions['answers'][1005];
+				} elseif ($att_key == 999999992) {
+					$this->_attendees[ $att_key ]['ans_objs'][1000] = $answers_n_questions['answers'][1000];
+					$this->_attendees[ $att_key ]['ans_objs'][1003] = $answers_n_questions['answers'][1003];
+					$this->_attendees[ $att_key ]['ans_objs'][1006] = $answers_n_questions['answers'][1006];
+				} elseif ($att_key == 999999993) {
+					$this->_attendees[ $att_key ]['ans_objs'][1001] = $answers_n_questions['answers'][1001];
+					$this->_attendees[ $att_key ]['ans_objs'][1004] = $answers_n_questions['answers'][1004];
+					$this->_attendees[ $att_key ]['ans_objs'][1007] = $answers_n_questions['answers'][1007];
+				}
+			}
+		}
+
+		$this->tickets            = $tkts;
+		$this->datetimes          = $dtts;
+		$this->answers            = $answers_n_questions['answers'];
+		$this->questions          = $answers_n_questions['questions'];
+		$this->total_ticket_count = count($tkts) * count($this->_attendees);
+	}
+
+
+	/**
+	 * This just returns an array of dummy attendee objects that we'll use to attach to events for our preview data
+	 *
+	 * @access private
+	 * @return array an array of attendee objects
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _get_some_attendees()
+	{
+		// let's just setup a dummy array of various attendee details
+		$dummy_attendees = [
+			0 => [
+				'Luke',
+				'Skywalker',
+				'farfaraway@galaxy.sp',
+				'804 Bantha Dr.',
+				'Complex 8',
+				'Mos Eisley',
+				32,
+				'US',
+				'f0r3e',
+				'222-333-4763',
+				false,
+				'999999991',
+			],
+			1 => [
+				'Princess',
+				'Leia',
+				'buns@fcn.al',
+				'1456 Valley Way Boulevard',
+				'Suite 9',
+				'Alderaan',
+				15,
+				'US',
+				'c1h2c',
+				'78-123-111-1111',
+				false,
+				'999999992',
+			],
+			2 => [
+				'Yoda',
+				'I Am',
+				'arrivenot@emailbad.fr',
+				'4th Tree',
+				'5th Knot',
+				'Marsh',
+				22,
+				'US',
+				'l18n',
+				'999-999-9999',
+				false,
+				'999999993',
+			],
+		];
+
+		// let's generate the attendee objects
+		$attendees = [];
+		$var_array = [
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'staid',
+			'cntry',
+			'zip',
+			'phone',
+			'deleted',
+			'attid',
+		];
+
+		// EE_Registry::instance()->load_class( 'Attendee', array(), FALSE, false, TRUE );
+		foreach ($dummy_attendees as $dummy) {
+			$att = array_combine($var_array, $dummy);
+			extract($att);
+			/** @var $fname string */
+			/** @var $lname string */
+			/** @var $address string */
+			/** @var $address2 string */
+			/** @var $city string */
+			/** @var $staid string */
+			/** @var $cntry string */
+			/** @var $zip string */
+			/** @var $email string */
+			/** @var $phone string */
+			/** @var $attid string */
+			$attendees[ $attid ] = EE_Attendee::new_instance(
+				[
+					'ATT_fname'    => $fname,
+					'ATT_lname'    => $lname,
+					'ATT_address'  => $address,
+					'ATT_address2' => $address2,
+					'ATT_city'     => $city,
+					'STA_ID'       => $staid,
+					'CNT_ISO'      => $cntry,
+					'ATT_zip'      => $zip,
+					'ATT_email'    => $email,
+					'ATT_phone'    => $phone,
+					'ATT_ID'       => $attid,
+				]
+			);
+		}
+
+		return $attendees;
+	}
+
+
+	/**
+	 * Return an array of dummy question objects indexed by answer id and dummy answer objects indexed by answer id.
+	 * This will be used in our dummy data setup
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_some_q_and_as()
+	{
+		$quests_array = [
+			0 => [
+				555,
+				esc_html__('What is your favorite planet?', 'event_espresso'),
+				0,
+			],
+			1 => [
+				556,
+				esc_html__('What is your favorite food?', 'event_espresso'),
+				0,
+			],
+			2 => [
+				557,
+				esc_html__('How many lightyears have you travelled', 'event_espresso'),
+				0,
+			],
+		];
+
+		$ans_array = [
+			0 => [
+				999,
+				555,
+				'Tattoine',
+			],
+			1 => [
+				1000,
+				555,
+				'Alderaan',
+			],
+			2 => [
+				1001,
+				555,
+				'Dantooine',
+			],
+			3 => [
+				1002,
+				556,
+				'Fish Fingers',
+			],
+			4 => [
+				1003,
+				556,
+				'Sushi',
+			],
+			5 => [
+				1004,
+				556,
+				'Water',
+			],
+			6 => [
+				1005,
+				557,
+				'A lot',
+			],
+			7 => [
+				1006,
+				557,
+				"That's none of your business.",
+			],
+			8 => [
+				1007,
+				557,
+				"People less travel me then.",
+			],
+		];
+
+		$qst_columns = ['QST_ID', 'QST_display_text', 'QST_system'];
+		$ans_columns = ['ANS_ID', 'QST_ID', 'ANS_value'];
+
+		// EE_Registry::instance()->load_class( 'Question', array(), FALSE, TRUE, TRUE );
+		// EE_Registry::instance()->load_class( 'Answer', array(), FALSE, TRUE, TRUE );
+
+		$qsts = [];
+		// first the questions
+		foreach ($quests_array as $qst) {
+			$qstobj                    = array_combine($qst_columns, $qst);
+			$qsts[ $qstobj['QST_ID'] ] = EE_Question::new_instance($qstobj);
+		}
+
+		// now the answers (and we'll setup our arrays)
+		$q_n_as = [];
+		foreach ($ans_array as $ans) {
+			$ansobj                               = array_combine($ans_columns, $ans);
+			$ansobj                               = EE_Answer::new_instance($ansobj);
+			$q_n_as['answers'][ $ansobj->ID() ]   = $ansobj;
+			$q_n_as['questions'][ $ansobj->ID() ] = $qsts[ $ansobj->get('QST_ID') ];
+		}
+
+		return $q_n_as;
+	}
+
+
+	/**
+	 * Return an array of event objects from the database
+	 *
+	 * If event ids are not included then we'll just retrieve the first published event from the database.
+	 *
+	 * @param array $event_ids if set, this will be an array of event ids to obtain events for.
+	 *
+	 * @return array    An array of event objects from the db.
+	 * @throws EE_Error
+	 */
+	private function _get_some_events(array $event_ids = [])
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		// if we have an evt_id then we want to make sure we use that for the preview
+		// (because a specific event template is being viewed);
+		$event_ids = $request->getRequestParam('evt_id', $event_ids, 'int', true);
+		$limit     = ! empty($event_ids)
+			? null
+			: apply_filters('FHEE__EE_Messages_Preview_incoming_data___get_some_events__limit', '0,1');
+
+		$where = ! empty($event_ids)
+			? [
+				'EVT_ID'                 => ['IN', $event_ids],
+				'Datetime.Ticket.TKT_ID' => ['>', 1],
+			]
+			: ['Datetime.Ticket.TKT_ID' => ['>', 1]];
+
+		return EEM_Event::instance()->get_all([$where, 'limit' => $limit]);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _setup_data()
+	{
+		// need to figure out the running total for test purposes so... we're going to create a temp cart and add the tickets to it!
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+			$session = EE_Registry::instance()->SSN;
+		} else {
+			$session = EE_Registry::instance()->load_core('Session');
+		}
+		$cart = EE_Cart::instance(null, $session);
+
+		// add tickets to cart
+		foreach ($this->tickets as $ticket) {
+			$cart->add_ticket_to_cart($ticket['ticket']);
+		}
+
+		// setup txn property
+		$this->txn = EE_Transaction::new_instance(
+			[
+				'TXN_timestamp'    => time(), // unix timestamp
+				'TXN_total'        => 0, // txn_total
+				'TXN_paid'         => 0, // txn_paid
+				'STS_ID'           => EEM_Transaction::incomplete_status_code, // sts_id
+				'TXN_session_data' => null, // dump of txn session object (we're just going to leave blank here)
+				'TXN_hash_salt'    => null, // hash salt blank as well
+				'TXN_ID'           => 999999,
+			]
+		);
+
+
+		// setup reg_objects
+		// note we're setting up a reg object for each attendee in each event but ALSO adding to the reg_object array.
+		$this->reg_objs = [];
+		$regid          = 9999990;
+		foreach ($this->_attendees as $key => $attendee) {
+			// note we need to setup reg_objects for each event this attendee belongs to
+			$regatt = $attendee['att_obj'] instanceof EE_Attendee ? $attendee['att_obj']->ID() : null;
+			$regtxn = $this->txn->ID();
+			$regcnt = 1;
+			foreach ($attendee['line_ref'] as $evtid) {
+				foreach ($this->_events[ $evtid ]['tkt_objs'] as $ticket) {
+					if (! $ticket instanceof EE_Ticket) {
+						continue;
+					}
+					$reg_array                                            = [
+						'EVT_ID'           => $evtid,
+						'ATT_ID'           => $regatt,
+						'TXN_ID'           => $regtxn,
+						'TKT_ID'           => $ticket->ID(),
+						'STS_ID'           => EEM_Registration::status_id_pending_payment,
+						'REG_date'         => time(),
+						'REG_final_price'  => $ticket->get('TKT_price'),
+						'REG_session'      => 'dummy_session_id',
+						'REG_code'         => $regid . '-dummy-generated-code',
+						'REG_url_link'     => $regcnt . '-daafpapasdlfakasdfpqasdfasdf',
+						'REG_count'        => $regcnt,
+						'REG_group_size'   => $this->_events[ $evtid ]['total_attendees'],
+						'REG_att_is_going' => true,
+						'REG_ID'           => $regid,
+					];
+					$REG_OBJ                                              = EE_Registration::new_instance($reg_array);
+					$this->_attendees[ $key ]['reg_objs'][ $regid ]       = $REG_OBJ;
+					$this->_events[ $evtid ]['reg_objs'][]                = $REG_OBJ;
+					$this->reg_objs[]                                     = $REG_OBJ;
+					$this->tickets[ $ticket->ID() ]['reg_objs'][ $regid ] = $REG_OBJ;
+
+					$regcnt++;
+					$regid++;
+				}
+			}
+		}
+
+
+		// setup line items!
+		$line_item_total = EEH_Line_Item::create_total_line_item($this->txn);
+
+		// add tickets
+		foreach ($this->tickets as $item) {
+			$qty    = $item['count'];
+			$ticket = $item['ticket'];
+			EEH_Line_Item::add_ticket_purchase($line_item_total, $ticket, $qty);
+		}
+
+		$shipping_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => esc_html__(
+					'Shipping Surcharge',
+					'event_espresso'
+				),
+				'LIN_desc'       => esc_html__(
+					'Sent via Millenium Falcon',
+					'event_espresso'
+				),
+				'LIN_unit_price' => 20,
+				'LIN_quantity'   => 1,
+				'LIN_is_taxable' => true,
+				'LIN_total'      => 20,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+			]
+		);
+		EEH_Line_Item::add_item($line_item_total, $shipping_line_item);
+		$this->additional_line_items = [$shipping_line_item];
+
+		// now let's add taxes
+		EEH_Line_Item::apply_taxes($line_item_total);
+
+		// now we should be able to get the items we need from this object
+		$event_line_items = EEH_Line_Item::get_pre_tax_subtotal($line_item_total)->children();
+		$line_items       = [];
+		foreach ($event_line_items as $line_item) {
+			if (! $line_item instanceof EE_Line_Item || $line_item->OBJ_type() !== 'Event') {
+				continue;
+			}
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if (! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['line_item']      = $ticket_line_item;
+				$this->tickets[ $ticket_line_item->OBJ_ID() ]['sub_line_items'] = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['children']              = $ticket_line_item->children();
+				$line_items[ $ticket_line_item->ID() ]['EE_Ticket']             =
+					$this->tickets[ $ticket_line_item->OBJ_ID() ]['ticket'];
+			}
+		}
+
+		$this->line_items_with_children = $line_items;
+		$this->tax_line_items           = $line_item_total->tax_descendants();
+
+		// add proper total to transaction object.
+		$grand_total                 = $line_item_total->recalculate_total_including_taxes();
+		$this->grand_total_line_item = $line_item_total;
+		$this->txn->set_total($grand_total);
+
+
+		// add additional details for each registration
+		foreach ($this->reg_objs as $reg) {
+			if (! $reg instanceof EE_Registration) {
+				continue;
+			}
+			$this->_registrations[ $reg->ID() ]['tkt_obj']  = $this->tickets[ $reg->get('TKT_ID') ]['ticket'];
+			$this->_registrations[ $reg->ID() ]['evt_obj']  = $this->_events[ $reg->get('EVT_ID') ]['event'];
+			$this->_registrations[ $reg->ID() ]['reg_obj']  = $reg;
+			$this->_registrations[ $reg->ID() ]['ans_objs'] = $this->_attendees[ $reg->get('ATT_ID') ]['ans_objs'];
+			$this->_registrations[ $reg->ID() ]['att_obj']  = $this->_attendees[ $reg->get('ATT_ID') ]['att_obj'];
+			$this->_registrations[ $reg->ID() ]['dtt_objs'] = $this->tickets[ $reg->get('TKT_ID') ]['dtt_objs'];
+		}
+
+
+		// events and attendees
+		$this->events        = $this->_events;
+		$this->attendees     = $this->_attendees;
+		$this->registrations = $this->_registrations;
+
+		$attendees_to_shift = $this->_attendees;
+
+		// setup primary attendee property
+		$this->primary_attendee_data = [
+			'fname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->fname()
+				: '',
+
+			'lname' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->lname()
+				: '',
+
+			'email' => $this->_attendees[999999991]['att_obj'] instanceof EE_Attendee
+				? $this->_attendees[999999991]['att_obj']->email()
+				: '',
+
+			'att_obj' => $this->_attendees[999999991]['att_obj'],
+
+			'reg_obj' => array_shift($attendees_to_shift[999999991]['reg_objs']),
+		];
+
+		// reg_info property
+		// note this isn't referenced by any shortcode parsers so we'll ignore for now.
+		$this->reg_info = [];
+
+		// let's set a reg_obj for messengers expecting one.
+		$this->reg_obj = array_shift($this->_attendees[999999991]['reg_objs']);
+
+		// the below are just dummy items.
+		$this->user_id     = 1;
+		$this->ip_address  = '192.0.2.1';
+		$this->user_agent  = '';
+		$this->init_access = time();
+		$this->last_access = time();
+	}
 }