eventespresso / event-espresso-core

espresso.php

Indentation +192 added lines, -192 removed lines

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

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

Indentation +339 added lines, -339 removed lines

@@ -7,7 +7,7 @@ 
  * @subpackage messages
  */
 if (!defined('EVENT_ESPRESSO_VERSION'))
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 
 /**
  *
@@ -24,343 +24,343 @@ 
 {
 
 
-    /**
-     * The following are the properties that this messenger requires for generating pdf
-     */
-
-    /**
-     * This is the pdf body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-
-    /**
-     * @return EE_Pdf_messenger
-     */
-    public function __construct()
-    {
-        //set properties
-        $this->name = 'pdf';
-        $this->description = __('This messenger is used for generating a pdf version of the message.', 'event_espresso');
-        $this->label = array(
-            'singular' => __('PDF', 'event_espresso'),
-            'plural' => __('PDFs', 'event_espresso')
-        );
-        $this->activate_on_install = TRUE;
-
-        parent::__construct();
-    }
-
-
-    /**
-     * PDF Messenger desires execution immediately.
-     * @see  parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     * @see parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => false);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'content' => array(
-                'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required' => array('[ATTENDEE_LIST]')
-            ),
-            'event_list' => array(
-                'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
-                'required' => array('[EVENT_LIST]')
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
-                'required' => array('[TICKET_LIST]')
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]')
-            ),
-        );
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => __('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => TRUE,
-                'validation' => TRUE,
-                'css_class' => 'large-text',
-                'format' => '%s'
-            ),
-            'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => __('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'rows' => '15'
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]')
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]')
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]')
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => TRUE,
-                        'validation' => TRUE,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]')
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     *
-     */
-    protected function _set_default_message_types()
-    {
-        //note currently PDF is only a secondary messenger so it never has any associated message types.
-        $this->_default_message_types = array();
-    }
-
-
-    /**
-     * @see definition of this method in parent
-     *
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array();
-    }
-
-
-    /**
-     * Generates html version of the message content and then sends it to the pdf generator.
-     *
-     *
-     * @since 4.5.0
-     *
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => stripslashes($this->_subject),
-            'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
-            'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
-            'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-            'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep($this->_content)), $this->_content)
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        $content = $this->_get_main_template();
+	/**
+	 * The following are the properties that this messenger requires for generating pdf
+	 */
+
+	/**
+	 * This is the pdf body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  This will end up being the filename for the generated pdf.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+
+	/**
+	 * @return EE_Pdf_messenger
+	 */
+	public function __construct()
+	{
+		//set properties
+		$this->name = 'pdf';
+		$this->description = __('This messenger is used for generating a pdf version of the message.', 'event_espresso');
+		$this->label = array(
+			'singular' => __('PDF', 'event_espresso'),
+			'plural' => __('PDFs', 'event_espresso')
+		);
+		$this->activate_on_install = TRUE;
+
+		parent::__construct();
+	}
+
+
+	/**
+	 * PDF Messenger desires execution immediately.
+	 * @see  parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 * @see parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => false);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'content' => array(
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required' => array('[ATTENDEE_LIST]')
+			),
+			'event_list' => array(
+				'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
+				'required' => array('[EVENT_LIST]')
+			),
+			'ticket_list' => array(
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
+				'required' => array('[TICKET_LIST]')
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]')
+			),
+		);
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => __('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => TRUE,
+				'validation' => TRUE,
+				'css_class' => 'large-text',
+				'format' => '%s'
+			),
+			'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => __('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'rows' => '15'
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]')
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]')
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]')
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => TRUE,
+						'validation' => TRUE,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]')
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 *
+	 */
+	protected function _set_default_message_types()
+	{
+		//note currently PDF is only a secondary messenger so it never has any associated message types.
+		$this->_default_message_types = array();
+	}
+
+
+	/**
+	 * @see definition of this method in parent
+	 *
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array();
+	}
+
+
+	/**
+	 * Generates html version of the message content and then sends it to the pdf generator.
+	 *
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => stripslashes($this->_subject),
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep($this->_content)), $this->_content)
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		$content = $this->_get_main_template();
 //		die( $content );
-        $this->_do_pdf($content);
-        exit(0);
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-
-        //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_head', 'wp_enqueue_scripts');
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for pdf purposes.
-     *
-     * @since  4.5.0
-     *
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = FALSE)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
-        //add message type to template_args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
-    }
-
-
-    /**
-     * This takes care of loading the dompdf library and generating the actual pdf
-     *
-     * @param string $content This is the generated html content being converted into a pdf.
-     *
-     * @return void
-     */
-    protected function _do_pdf($content = '')
-    {
-        $invoice_name = $this->_subject;
-
-        //only load dompdf if nobody else has yet...
-        if (!defined('DOMPDF_DIR')) {
-            define('DOMPDF_ENABLE_REMOTE', TRUE);
-            define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
-            define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-            require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
-        }
-        $dompdf = new DOMPDF();
-        if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
-            $dompdf->set_paper(DOMPDF_DEFAULT_PAPER_SIZE);
-        }
-        //Remove all spaces between HTML tags
-        $content = preg_replace('/>\s+</', '><', $content);
-        $dompdf->load_html($content);
-        $dompdf->render();
-        //forcing the browser to open a download dialog.
-        $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE));
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
+		$this->_do_pdf($content);
+		exit(0);
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates.  If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+
+		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_head', 'wp_enqueue_scripts');
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for pdf purposes.
+	 *
+	 * @since  4.5.0
+	 *
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = FALSE)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
+		//add message type to template_args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
+	}
+
+
+	/**
+	 * This takes care of loading the dompdf library and generating the actual pdf
+	 *
+	 * @param string $content This is the generated html content being converted into a pdf.
+	 *
+	 * @return void
+	 */
+	protected function _do_pdf($content = '')
+	{
+		$invoice_name = $this->_subject;
+
+		//only load dompdf if nobody else has yet...
+		if (!defined('DOMPDF_DIR')) {
+			define('DOMPDF_ENABLE_REMOTE', TRUE);
+			define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
+			define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
+			require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+		}
+		$dompdf = new DOMPDF();
+		if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
+			$dompdf->set_paper(DOMPDF_DEFAULT_PAPER_SIZE);
+		}
+		//Remove all spaces between HTML tags
+		$content = preg_replace('/>\s+</', '><', $content);
+		$dompdf->load_html($content);
+		$dompdf->render();
+		//forcing the browser to open a download dialog.
+		$dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE));
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -6,7 +6,7 @@ 
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
     exit('NO direct script access allowed');
 
 /**
@@ -268,7 +268,7 @@ 
             'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
             'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
             'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
-            'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
+            'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
             'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep($this->_content)), $this->_content)
         );
         $this->_deregister_wp_hooks();
@@ -332,11 +332,11 @@ 
         $invoice_name = $this->_subject;
 
         //only load dompdf if nobody else has yet...
-        if (!defined('DOMPDF_DIR')) {
+        if ( ! defined('DOMPDF_DIR')) {
             define('DOMPDF_ENABLE_REMOTE', TRUE);
             define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
             define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-            require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+            require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php');
         }
         $dompdf = new DOMPDF();
         if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) {
@@ -347,7 +347,7 @@ 
         $dompdf->load_html($content);
         $dompdf->render();
         //forcing the browser to open a download dialog.
-        $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE));
+        $dompdf->stream($invoice_name.".pdf", array('Attachment' => TRUE));
     }
 
 

Braces +2 added lines, -1 removed lines

@@ -6,8 +6,9 @@
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION'))
+if (!defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
+}
 
 /**
  *

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

Indentation +550 added lines, -550 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (!defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -16,554 +16,554 @@ 
 {
 
 
-    /**
-     * The following are the properties that this messenger requires for displaying the html
-     */
-    /**
-     * This is the html body generated by the template via the message type.
-     *
-     * @var string
-     */
-    protected $_content;
-
-
-    /**
-     * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
-     * equivalent to the "subject" of the page.
-     *
-     * @var string
-     */
-    protected $_subject;
-
-
-    /**
-     * EE_Html_messenger constructor.
-     */
-    public function __construct()
-    {
-        //set properties
-        $this->name = 'html';
-        $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso');
-        $this->label = array(
-            'singular' => __('html', 'event_espresso'),
-            'plural' => __('html', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-        // add the "powered by EE" credit link to the HTML receipt and invoice
-        add_filter(
-            'FHEE__EE_Html_messenger___send_message__main_body',
-            array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'),
-            10,
-            3
-        );
-        parent::__construct();
-    }
-
-
-    /**
-     * HTML Messenger desires execution immediately.
-     *
-     * @see    parent::send_now() for documentation.
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return true;
-    }
-
-
-    /**
-     * HTML Messenger allows an empty to field.
-     *
-     * @see    parent::allow_empty_to_field() for documentation
-     * @since  4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return true;
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array('events_edit' => true);
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $this->_valid_shortcodes = array();
-    }
-
-
-    /**
-     * @see abstract declaration in EE_messenger for details.
-     */
-    protected function _set_validator_config()
-    {
-        $this->_validator_config = array(
-            'subject' => array(
-                'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'),
-            ),
-            'content' => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_list',
-                    'primary_registration_details',
-                    'email',
-                    'transaction',
-                    'event_list',
-                    'payment_list',
-                    'venue',
-                    'line_item_list',
-                    'messenger',
-                    'ticket_list',
-                ),
-            ),
-            'event_list' => array(
-                'shortcodes' => array(
-                    'event',
-                    'ticket_list',
-                    'venue',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                ),
-                'required' => array('[EVENT_LIST]'),
-            ),
-            'ticket_list' => array(
-                'shortcodes' => array(
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'line_item_list',
-                    'venue',
-                ),
-                'required' => array('[TICKET_LIST]'),
-            ),
-            'ticket_line_item_no_pms' => array(
-                'shortcodes' => array('line_item', 'ticket'),
-                'required' => array('[TICKET_LINE_ITEM_LIST]'),
-            ),
-            'ticket_line_item_pms' => array(
-                'shortcodes' => array('line_item', 'ticket', 'line_item_list'),
-                'required' => array('[TICKET_LINE_ITEM_LIST]'),
-            ),
-            'price_modifier_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required' => array('[DATETIME_LIST]'),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee'),
-                'required' => array('[ATTENDEE_LIST]'),
-            ),
-            'tax_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[TAX_LINE_ITEM_LIST]'),
-            ),
-            'additional_line_item_list' => array(
-                'shortcodes' => array('line_item'),
-                'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
-            ),
-            'payment_list' => array(
-                'shortcodes' => array('payment'),
-                'required' => array('[PAYMENT_LIST_*]'),
-            ),
-        );
-    }
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
-     * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
-     * (i.e. swap out css files or something else).
-     *
-     * @since 4.5.0
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     * @return void
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'pdf') {
-            add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8);
-        }
-    }
-
-
-    /**
-     * @param                            $variation_path
-     * @param \EE_Messages_Template_Pack $template_pack
-     * @param                            $messenger_name
-     * @param                            $message_type_name
-     * @param                            $url
-     * @param                            $type
-     * @param                            $variation
-     * @param                            $skip_filters
-     * @return string
-     */
-    public function add_html_css(
-        $variation_path,
-        EE_Messages_Template_Pack $template_pack,
-        $messenger_name,
-        $message_type_name,
-        $url,
-        $type,
-        $variation,
-        $skip_filters
-    )
-    {
-        $variation = $template_pack->get_variation(
-            $this->name,
-            $message_type_name,
-            $type,
-            $variation,
-            $url,
-            '.css',
-            $skip_filters
-        );
-        return $variation;
-    }
-
-
-    /**
-     * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
-     * messenger can add their own js.
-     *
-     * @return void.
-     */
-    public function enqueue_scripts_styles()
-    {
-        parent::enqueue_scripts_styles();
-        do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger
-        // but will get used by a messenger field for shortcode replacement
-        // get added to the 'extra' key in an associated array
-        // indexed by the messenger field they relate to.
-        // This is important for the Messages_admin to know what fields to display to the user.
-        // Also, notice that the "values" are equal to the field type
-        // that messages admin will use to know what kind of field to display.
-        // The values ALSO have one index labeled "shortcode".
-        // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
-        // is required in order for this extra field to be displayed.
-        //  If the required shortcode isn't part of the shortcodes array
-        // then the field is not needed and will not be displayed/parsed.
-        $this->_template_fields = array(
-            'subject' => array(
-                'input' => 'text',
-                'label' => __('Page Title', 'event_espresso'),
-                'type' => 'string',
-                'required' => true,
-                'validation' => true,
-                'css_class' => 'large-text',
-                'format' => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra' => array(
-                'content' => array(
-                    'main' => array(
-                        'input' => 'wp_editor',
-                        'label' => __('Main Content', 'event_espresso'),
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                    ),
-                    'event_list' => array(
-                        'input' => 'wp_editor',
-                        'label' => '[EVENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'rows' => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'ticket_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'ticket_line_item_no_pms' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
-                                'Ticket Line Item List with no Price Modifiers',
-                                'event_espresso'
-                            ),
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
-                    ),
-                    'ticket_line_item_pms' => array(
-                        'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
-                                'Ticket Line Item List with Price Modifiers',
-                                'event_espresso'
-                            ),
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
-                    ),
-                    'price_modifier_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[DATETIME_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ATTENDEE_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'tax_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[TAX_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'),
-                    ),
-                    'additional_line_item_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[ADDITIONAL_LINE_ITEM_LIST]',
-                        'type' => 'string',
-                        'required' => false,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
-                    ),
-                    'payment_list' => array(
-                        'input' => 'textarea',
-                        'label' => '[PAYMENT_LIST]',
-                        'type' => 'string',
-                        'required' => true,
-                        'validation' => true,
-                        'format' => '%s',
-                        'css_class' => 'large-text',
-                        'rows' => '5',
-                        'shortcodes_required' => array('[PAYMENT_LIST_*]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array('receipt', 'invoice');
-    }
-
-
-    /**
-     * @see   definition of this method in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array('receipt', 'invoice');
-    }
-
-
-    /**
-     * Displays the message in the browser.
-     *
-     * @since 4.5.0
-     * @return string.
-     */
-    protected function _send_message()
-    {
-        $this->_template_args = array(
-            'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
-            'base_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'base',
-                $this->_variation
-            ),
-            'print_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'print',
-                $this->_variation
-            ),
-            'main_css' => $this->get_variation(
-                $this->_tmp_pack,
-                $this->_incoming_message_type->name,
-                true,
-                'main',
-                $this->_variation
-            ),
-            'main_body' => wpautop(
-                stripslashes_deep(
-                    apply_filters(
-                        'FHEE__EE_Html_messenger___send_message__main_body',
-                        $this->_content,
-                        $this->_content,
-                        $this->_incoming_message_type
-                    )
-                )
-            ),
-        );
-        $this->_deregister_wp_hooks();
-        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        echo $this->_get_main_template();
-        exit();
-    }
-
-
-    /**
-     * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
-     * interfere with our templates.  If users want to add any custom styles or scripts they must use the
-     * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected function _deregister_wp_hooks()
-    {
-        remove_all_actions('wp_head');
-        remove_all_actions('wp_footer');
-        remove_all_actions('wp_print_footer_scripts');
-        remove_all_actions('wp_enqueue_scripts');
-        global $wp_scripts, $wp_styles;
-        $wp_scripts = $wp_styles = array();
-        //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
-        add_action('wp_footer', 'wp_print_footer_scripts');
-        add_action('wp_print_footer_scripts', '_wp_footer_scripts');
-        add_action('wp_head', 'wp_enqueue_scripts');
-    }
-
-
-    /**
-     * Overwrite parent _get_main_template for display_html purposes.
-     *
-     * @since  4.5.0
-     * @param bool $preview
-     * @return string
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main');
-        //include message type as a template arg
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function _preview()
-    {
-        return $this->_send_message();
-    }
-
-
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-
-    /**
-     * add the "powered by EE" credit link to the HTML receipt and invoice
-     *
-     * @param string $content
-     * @param string $content_again
-     * @param \EE_message_type $incoming_message_type
-     * @return string
-     */
-    public function add_powered_by_credit_link_to_receipt_and_invoice(
-        $content = '',
-        $content_again = '',
-        EE_message_type $incoming_message_type
-    )
-    {
-        if (
-            ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
-            && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
-        ) {
-            $content .= \EEH_Template::powered_by_event_espresso(
-                    'aln-cntr',
-                    '',
-                    array('utm_content' => 'messages_system')
-                )
-                . EEH_HTML::div(EEH_HTML::p('&nbsp;'));
-        }
-        return $content;
-    }
+	/**
+	 * The following are the properties that this messenger requires for displaying the html
+	 */
+	/**
+	 * This is the html body generated by the template via the message type.
+	 *
+	 * @var string
+	 */
+	protected $_content;
+
+
+	/**
+	 * This is for the page title that gets displayed.  (Why use "subject"?  Because the "title" tag in html is
+	 * equivalent to the "subject" of the page.
+	 *
+	 * @var string
+	 */
+	protected $_subject;
+
+
+	/**
+	 * EE_Html_messenger constructor.
+	 */
+	public function __construct()
+	{
+		//set properties
+		$this->name = 'html';
+		$this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso');
+		$this->label = array(
+			'singular' => __('html', 'event_espresso'),
+			'plural' => __('html', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+		// add the "powered by EE" credit link to the HTML receipt and invoice
+		add_filter(
+			'FHEE__EE_Html_messenger___send_message__main_body',
+			array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'),
+			10,
+			3
+		);
+		parent::__construct();
+	}
+
+
+	/**
+	 * HTML Messenger desires execution immediately.
+	 *
+	 * @see    parent::send_now() for documentation.
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return true;
+	}
+
+
+	/**
+	 * HTML Messenger allows an empty to field.
+	 *
+	 * @see    parent::allow_empty_to_field() for documentation
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array('events_edit' => true);
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$this->_valid_shortcodes = array();
+	}
+
+
+	/**
+	 * @see abstract declaration in EE_messenger for details.
+	 */
+	protected function _set_validator_config()
+	{
+		$this->_validator_config = array(
+			'subject' => array(
+				'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'),
+			),
+			'content' => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_list',
+					'primary_registration_details',
+					'email',
+					'transaction',
+					'event_list',
+					'payment_list',
+					'venue',
+					'line_item_list',
+					'messenger',
+					'ticket_list',
+				),
+			),
+			'event_list' => array(
+				'shortcodes' => array(
+					'event',
+					'ticket_list',
+					'venue',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+				),
+				'required' => array('[EVENT_LIST]'),
+			),
+			'ticket_list' => array(
+				'shortcodes' => array(
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'line_item_list',
+					'venue',
+				),
+				'required' => array('[TICKET_LIST]'),
+			),
+			'ticket_line_item_no_pms' => array(
+				'shortcodes' => array('line_item', 'ticket'),
+				'required' => array('[TICKET_LINE_ITEM_LIST]'),
+			),
+			'ticket_line_item_pms' => array(
+				'shortcodes' => array('line_item', 'ticket', 'line_item_list'),
+				'required' => array('[TICKET_LINE_ITEM_LIST]'),
+			),
+			'price_modifier_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required' => array('[DATETIME_LIST]'),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee'),
+				'required' => array('[ATTENDEE_LIST]'),
+			),
+			'tax_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[TAX_LINE_ITEM_LIST]'),
+			),
+			'additional_line_item_list' => array(
+				'shortcodes' => array('line_item'),
+				'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
+			),
+			'payment_list' => array(
+				'shortcodes' => array('payment'),
+				'required' => array('[PAYMENT_LIST_*]'),
+			),
+		);
+	}
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger
+	 * is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary
+	 * (i.e. swap out css files or something else).
+	 *
+	 * @since 4.5.0
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 * @return void
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'pdf') {
+			add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8);
+		}
+	}
+
+
+	/**
+	 * @param                            $variation_path
+	 * @param \EE_Messages_Template_Pack $template_pack
+	 * @param                            $messenger_name
+	 * @param                            $message_type_name
+	 * @param                            $url
+	 * @param                            $type
+	 * @param                            $variation
+	 * @param                            $skip_filters
+	 * @return string
+	 */
+	public function add_html_css(
+		$variation_path,
+		EE_Messages_Template_Pack $template_pack,
+		$messenger_name,
+		$message_type_name,
+		$url,
+		$type,
+		$variation,
+		$skip_filters
+	)
+	{
+		$variation = $template_pack->get_variation(
+			$this->name,
+			$message_type_name,
+			$type,
+			$variation,
+			$url,
+			'.css',
+			$skip_filters
+		);
+		return $variation;
+	}
+
+
+	/**
+	 * Takes care of enqueuing any necessary scripts or styles for the page.  A do_action() so message types using this
+	 * messenger can add their own js.
+	 *
+	 * @return void.
+	 */
+	public function enqueue_scripts_styles()
+	{
+		parent::enqueue_scripts_styles();
+		do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles');
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger
+		// but will get used by a messenger field for shortcode replacement
+		// get added to the 'extra' key in an associated array
+		// indexed by the messenger field they relate to.
+		// This is important for the Messages_admin to know what fields to display to the user.
+		// Also, notice that the "values" are equal to the field type
+		// that messages admin will use to know what kind of field to display.
+		// The values ALSO have one index labeled "shortcode".
+		// The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE])
+		// is required in order for this extra field to be displayed.
+		//  If the required shortcode isn't part of the shortcodes array
+		// then the field is not needed and will not be displayed/parsed.
+		$this->_template_fields = array(
+			'subject' => array(
+				'input' => 'text',
+				'label' => __('Page Title', 'event_espresso'),
+				'type' => 'string',
+				'required' => true,
+				'validation' => true,
+				'css_class' => 'large-text',
+				'format' => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra' => array(
+				'content' => array(
+					'main' => array(
+						'input' => 'wp_editor',
+						'label' => __('Main Content', 'event_espresso'),
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+					),
+					'event_list' => array(
+						'input' => 'wp_editor',
+						'label' => '[EVENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'rows' => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'ticket_list' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'ticket_line_item_no_pms' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+								'Ticket Line Item List with no Price Modifiers',
+								'event_espresso'
+							),
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
+					),
+					'ticket_line_item_pms' => array(
+						'input' => 'textarea',
+						'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+								'Ticket Line Item List with Price Modifiers',
+								'event_espresso'
+							),
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'),
+					),
+					'price_modifier_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'),
+					),
+					'datetime_list' => array(
+						'input' => 'textarea',
+						'label' => '[DATETIME_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+					'attendee_list' => array(
+						'input' => 'textarea',
+						'label' => '[ATTENDEE_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'tax_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[TAX_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'),
+					),
+					'additional_line_item_list' => array(
+						'input' => 'textarea',
+						'label' => '[ADDITIONAL_LINE_ITEM_LIST]',
+						'type' => 'string',
+						'required' => false,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'),
+					),
+					'payment_list' => array(
+						'input' => 'textarea',
+						'label' => '[PAYMENT_LIST]',
+						'type' => 'string',
+						'required' => true,
+						'validation' => true,
+						'format' => '%s',
+						'css_class' => 'large-text',
+						'rows' => '5',
+						'shortcodes_required' => array('[PAYMENT_LIST_*]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array('receipt', 'invoice');
+	}
+
+
+	/**
+	 * @see   definition of this method in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array('receipt', 'invoice');
+	}
+
+
+	/**
+	 * Displays the message in the browser.
+	 *
+	 * @since 4.5.0
+	 * @return string.
+	 */
+	protected function _send_message()
+	{
+		$this->_template_args = array(
+			'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
+			'base_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'base',
+				$this->_variation
+			),
+			'print_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'print',
+				$this->_variation
+			),
+			'main_css' => $this->get_variation(
+				$this->_tmp_pack,
+				$this->_incoming_message_type->name,
+				true,
+				'main',
+				$this->_variation
+			),
+			'main_body' => wpautop(
+				stripslashes_deep(
+					apply_filters(
+						'FHEE__EE_Html_messenger___send_message__main_body',
+						$this->_content,
+						$this->_content,
+						$this->_incoming_message_type
+					)
+				)
+			),
+		);
+		$this->_deregister_wp_hooks();
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		echo $this->_get_main_template();
+		exit();
+	}
+
+
+	/**
+	 * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't
+	 * interfere with our templates.  If users want to add any custom styles or scripts they must use the
+	 * AHEE__EE_Html_messenger__enqueue_scripts_styles hook.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected function _deregister_wp_hooks()
+	{
+		remove_all_actions('wp_head');
+		remove_all_actions('wp_footer');
+		remove_all_actions('wp_print_footer_scripts');
+		remove_all_actions('wp_enqueue_scripts');
+		global $wp_scripts, $wp_styles;
+		$wp_scripts = $wp_styles = array();
+		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
+		add_action('wp_head', 'wp_enqueue_scripts');
+	}
+
+
+	/**
+	 * Overwrite parent _get_main_template for display_html purposes.
+	 *
+	 * @since  4.5.0
+	 * @param bool $preview
+	 * @return string
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main');
+		//include message type as a template arg
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function _preview()
+	{
+		return $this->_send_message();
+	}
+
+
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+
+	/**
+	 * add the "powered by EE" credit link to the HTML receipt and invoice
+	 *
+	 * @param string $content
+	 * @param string $content_again
+	 * @param \EE_message_type $incoming_message_type
+	 * @return string
+	 */
+	public function add_powered_by_credit_link_to_receipt_and_invoice(
+		$content = '',
+		$content_again = '',
+		EE_message_type $incoming_message_type
+	)
+	{
+		if (
+			($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt')
+			&& apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true)
+		) {
+			$content .= \EEH_Template::powered_by_event_espresso(
+					'aln-cntr',
+					'',
+					array('utm_content' => 'messages_system')
+				)
+				. EEH_HTML::div(EEH_HTML::p('&nbsp;'));
+		}
+		return $content;
+	}
 
 }

Spacing +3 added lines, -3 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -318,7 +318,7 @@ 
                     ),
                     'ticket_line_item_no_pms' => array(
                         'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__(
                                 'Ticket Line Item List with no Price Modifiers',
                                 'event_espresso'
                             ),
@@ -332,7 +332,7 @@ 
                     ),
                     'ticket_line_item_pms' => array(
                         'input' => 'textarea',
-                        'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__(
                                 'Ticket Line Item List with Price Modifiers',
                                 'event_espresso'
                             ),

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

Indentation +641 added lines, -641 removed lines

@@ -8,645 +8,645 @@
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            $this->_to,
-            stripslashes($this->_subject),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = stripslashes_deep($this->_from, ENT_QUOTES, "UTF-8");
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        if (! empty($this->_cc)) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
-
-        return stripslashes_deep($from_name);
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop(
-                stripslashes_deep(
-                    $this->_content
-                )
-            ),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			$this->_to,
+			stripslashes($this->_subject),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = stripslashes_deep($this->_from, ENT_QUOTES, "UTF-8");
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		if (! empty($this->_cc)) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		$from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;
+
+		return stripslashes_deep($from_name);
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop(
+				stripslashes_deep(
+					$this->_content
+				)
+			),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				//for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				//see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -438,7 +438,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -482,13 +482,13 @@ 
         $this->_ensure_has_from_email_address();
         $from    = stripslashes_deep($this->_from, ENT_QUOTES, "UTF-8");
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
-        if (! empty($this->_cc)) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc)) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -598,7 +598,7 @@ 
                 )
             ),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -608,10 +608,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,