eventespresso / event-espresso-core

core/libraries/messages/validators/html/EE_Messages_Html_Receipt_Validator.class.php

Indentation +15 added lines, -15 removed lines

@@ -16,21 +16,21 @@
 class EE_Messages_Html_Receipt_Validator extends EE_Messages_Validator
 {
 
-    public function __construct($fields, $context)
-    {
-        $this->_m_name = 'html';
-        $this->_mt_name = 'receipt';
+	public function __construct($fields, $context)
+	{
+		$this->_m_name = 'html';
+		$this->_mt_name = 'receipt';
 
-        parent::__construct($fields, $context);
-    }
+		parent::__construct($fields, $context);
+	}
 
-    /**
-     * custom validator (restricting what was originally set by the messenger).
-     * Note nothing is currently done for this messenger and message type.
-     */
-    protected function _modify_validator()
-    {
-        $this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]');
-        return;
-    }
+	/**
+	 * custom validator (restricting what was originally set by the messenger).
+	 * Note nothing is currently done for this messenger and message type.
+	 */
+	protected function _modify_validator()
+	{
+		$this->_specific_shortcode_excludes['content'] = array('[DISPLAY_HTML_URL]');
+		return;
+	}
 }

core/libraries/messages/EE_Messenger_Collection.lib.php

Indentation +179 added lines, -179 removed lines

@@ -14,183 +14,183 @@
 class EE_Messenger_Collection extends EE_Object_Collection
 {
 
-    /**
-     * EE_Messenger_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_messenger';
-    }
-
-
-
-    /**
-     * add
-     *
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_info()
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function add($object, $info = null)
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::add($object, $info);
-    }
-
-
-
-    /**
-     * set_info
-     *
-     * Sets the data associated with an object in the Collection
-     * if no $info is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param object $object
-     * @param mixed  $info
-     * @return bool
-     */
-    public function set_info($object, $info = null)
-    {
-        $info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
-        return parent::set_info($object, $info);
-    }
-
-
-
-    /**
-     * get_by_info
-     *
-     * finds and returns an object in the Collection based on the info that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed
-     * @return null | object
-     */
-    public function get_by_info($info)
-    {
-        return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
-    }
-
-
-
-    /**
-     * has
-     *
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param object $object
-     * @return bool
-     */
-    public function has($object)
-    {
-        return parent::has($object);
-    }
-
-
-
-    /**
-     * has_by_name
-     *
-     * returns TRUE or FALSE depending on whether the supplied messenger name is within the Collection
-     *
-     * @access public
-     * @param string $messenger_name
-     * @return bool
-     */
-    public function has_by_name($messenger_name)
-    {
-        return $this->get_by_info($messenger_name) instanceof $this->interface ? true : false;
-    }
-
-
-
-    /**
-     * remove
-     *
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        return parent::remove($object);
-    }
-
-
-
-    /**
-     * current
-     *
-     * current object from the Collection
-     *
-     * @access public
-     * @return EE_messenger
-     */
-    public function current()
-    {
-        return parent::current();
-    }
-
-
-
-    /**
-     * set_current
-     *
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return void
-     */
-    public function set_current($object)
-    {
-        parent::set_current($object);
-    }
-
-
-
-    /**
-     * set_current_by_info
-     *
-     * advances pointer to the object whose info matches that which was provided
-     *
-     * @access public
-     * @param $info
-     * @return void
-     */
-    public function set_current_by_info($info)
-    {
-        parent::set_current_by_info($info);
-    }
-
-
-
-    /**
-     * show_collection_classes
-     *
-     * displays list of collection classes if WP_DEBUG is on
-     *
-     * @access public
-     * @return void
-     */
-    public function show_collection_classes()
-    {
-        if (WP_DEBUG) {
-            $this->rewind();
-            while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
-                $this->next();
-            }
-        }
-    }
+	/**
+	 * EE_Messenger_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_messenger';
+	}
+
+
+
+	/**
+	 * add
+	 *
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_info()
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function add($object, $info = null)
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::add($object, $info);
+	}
+
+
+
+	/**
+	 * set_info
+	 *
+	 * Sets the data associated with an object in the Collection
+	 * if no $info is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param object $object
+	 * @param mixed  $info
+	 * @return bool
+	 */
+	public function set_info($object, $info = null)
+	{
+		$info = empty($info) && $object instanceof $this->interface ? $object->name : $info;
+		return parent::set_info($object, $info);
+	}
+
+
+
+	/**
+	 * get_by_info
+	 *
+	 * finds and returns an object in the Collection based on the info that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed
+	 * @return null | object
+	 */
+	public function get_by_info($info)
+	{
+		return parent::get_by_info(str_replace(' ', '_', strtolower($info)));
+	}
+
+
+
+	/**
+	 * has
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param object $object
+	 * @return bool
+	 */
+	public function has($object)
+	{
+		return parent::has($object);
+	}
+
+
+
+	/**
+	 * has_by_name
+	 *
+	 * returns TRUE or FALSE depending on whether the supplied messenger name is within the Collection
+	 *
+	 * @access public
+	 * @param string $messenger_name
+	 * @return bool
+	 */
+	public function has_by_name($messenger_name)
+	{
+		return $this->get_by_info($messenger_name) instanceof $this->interface ? true : false;
+	}
+
+
+
+	/**
+	 * remove
+	 *
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		return parent::remove($object);
+	}
+
+
+
+	/**
+	 * current
+	 *
+	 * current object from the Collection
+	 *
+	 * @access public
+	 * @return EE_messenger
+	 */
+	public function current()
+	{
+		return parent::current();
+	}
+
+
+
+	/**
+	 * set_current
+	 *
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return void
+	 */
+	public function set_current($object)
+	{
+		parent::set_current($object);
+	}
+
+
+
+	/**
+	 * set_current_by_info
+	 *
+	 * advances pointer to the object whose info matches that which was provided
+	 *
+	 * @access public
+	 * @param $info
+	 * @return void
+	 */
+	public function set_current_by_info($info)
+	{
+		parent::set_current_by_info($info);
+	}
+
+
+
+	/**
+	 * show_collection_classes
+	 *
+	 * displays list of collection classes if WP_DEBUG is on
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function show_collection_classes()
+	{
+		if (WP_DEBUG) {
+			$this->rewind();
+			while ($this->valid()) {
+				echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
+				$this->next();
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -188,7 +188,7 @@
         if (WP_DEBUG) {
             $this->rewind();
             while ($this->valid()) {
-                echo '<h5 style="color:#2EA2CC;">' . __CLASS__ . ' class : . <span style="color:#E76700">' . $this->getInfo() . '</span></h5>';
+                echo '<h5 style="color:#2EA2CC;">'.__CLASS__.' class : . <span style="color:#E76700">'.$this->getInfo().'</span></h5>';
                 $this->next();
             }
         }

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

Spacing +9 added lines, -9 removed lines

@@ -56,7 +56,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,8 +482,8 @@ 
         $this->_ensure_has_from_email_address();
         $from    = $this->_from;
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -492,8 +492,8 @@ 
          * cover back compat where there may be users who have saved cc values in their db for the newsletter message
          * type which they are no longer able to change.
          */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+            $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
@@ -600,7 +600,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop($this->_content),
         );
-        $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.
@@ -610,10 +610,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,

Indentation +644 added lines, -644 removed lines

@@ -6,648 +6,648 @@
 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,
-            // some old values for subject may be expecting HTML entities to be decoded in the subject
-            // and subjects aren't interpreted as HTML, so there should be no HTML in them
-            wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
-            $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    = $this->_from;
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        /**
-         * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
-         * cover back compat where there may be users who have saved cc values in their db for the newsletter message
-         * type which they are no longer able to change.
-         */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $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!)
-        // but realize the default name is HTML entity-encoded
-        $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
-
-        return $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($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,
+			// some old values for subject may be expecting HTML entities to be decoded in the subject
+			// and subjects aren't interpreted as HTML, so there should be no HTML in them
+			wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
+			$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    = $this->_from;
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		/**
+		 * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
+		 * cover back compat where there may be users who have saved cc values in their db for the newsletter message
+		 * type which they are no longer able to change.
+		 */
+		if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+			$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!)
+		// but realize the default name is HTML entity-encoded
+		$from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
+
+		return $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($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;
+	}
 }

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

Spacing +2 added lines, -2 removed lines

@@ -313,7 +313,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'
                         ),
@@ -327,7 +327,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'
                         ),

Indentation +545 added lines, -545 removed lines

@@ -12,549 +12,549 @@
 {
 
 
-    /**
-     * 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' => $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
-            ),
-            'main_body' => wpautop(
-                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' => $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
+			),
+			'main_body' => wpautop(
+				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;
+	}
 }

core/libraries/messages/EE_Messages_Data_Handler_Collection.lib.php

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      */
     public function get_key($classname, $data)
     {
-        return md5($classname . serialize($data));
+        return md5($classname.serialize($data));
     }
 
 

Indentation +65 added lines, -65 removed lines

@@ -11,69 +11,69 @@
 {
 
 
-    public function __construct()
-    {
-        $this->interface = 'EE_Messages_incoming_data';
-    }
-
-
-    /**
-     * This adds the EE_Messages_incoming_data data handler object to the collection.
-     *
-     * @param EE_Messages_incoming_data  $data_handler
-     * @param mixed                      $data           Usually an array of data used in combination with the $data_handler
-     *                                                   classname to create an alternative index for retrieving data_handlers.
-     * @return bool
-     */
-    public function add($data_handler, $data = null)
-    {
-        $data = $data === null ? array() : (array) $data;
-        $info['key'] = $this->get_key(get_class($data_handler), $data);
-        return parent::add($data_handler, $info);
-    }
-
-
-
-
-
-    /**
-     * This returns a key for retrieving data for the given references used to generate the key.
-     * Data handlers are cached to the repository along with a md5() generated key using known references.
-     * @param string    $classname      The classname of the datahandler being checked for.
-     * @param mixed     $data           The data that was used to instantiate the data_handler.
-     *
-     * @return  string      md5 hash using provided info.
-     */
-    public function get_key($classname, $data)
-    {
-        return md5($classname . serialize($data));
-    }
-
-
-
-
-
-
-    /**
-     * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string  $key  @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching.
-     *
-     * @return null|EE_Messages_incoming_data
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                $handler = $this->current();
-                $this->rewind();
-                return $handler;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	public function __construct()
+	{
+		$this->interface = 'EE_Messages_incoming_data';
+	}
+
+
+	/**
+	 * This adds the EE_Messages_incoming_data data handler object to the collection.
+	 *
+	 * @param EE_Messages_incoming_data  $data_handler
+	 * @param mixed                      $data           Usually an array of data used in combination with the $data_handler
+	 *                                                   classname to create an alternative index for retrieving data_handlers.
+	 * @return bool
+	 */
+	public function add($data_handler, $data = null)
+	{
+		$data = $data === null ? array() : (array) $data;
+		$info['key'] = $this->get_key(get_class($data_handler), $data);
+		return parent::add($data_handler, $info);
+	}
+
+
+
+
+
+	/**
+	 * This returns a key for retrieving data for the given references used to generate the key.
+	 * Data handlers are cached to the repository along with a md5() generated key using known references.
+	 * @param string    $classname      The classname of the datahandler being checked for.
+	 * @param mixed     $data           The data that was used to instantiate the data_handler.
+	 *
+	 * @return  string      md5 hash using provided info.
+	 */
+	public function get_key($classname, $data)
+	{
+		return md5($classname . serialize($data));
+	}
+
+
+
+
+
+
+	/**
+	 * This returns a saved EE_Messages_incoming_data object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string  $key  @see EE_Messages_Data_Handler_Collection::get_key() to setup a key formatted for searching.
+	 *
+	 * @return null|EE_Messages_incoming_data
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				$handler = $this->current();
+				$this->rewind();
+				return $handler;
+			}
+			$this->next();
+		}
+		return null;
+	}
 }

core/libraries/messages/EE_Message_To_Generate.php

Indentation +300 added lines, -300 removed lines

@@ -11,304 +11,304 @@
 class EE_Message_To_Generate
 {
 
-    /**
-     * @type string name of EE_messenger
-     */
-    protected $_messenger_name = null;
-
-    /**
-     * @type string name of EE_message_type
-     */
-    protected $_message_type_name = null;
-
-    /**
-     * @type EE_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type
-     */
-    protected $_message_type = null;
-
-    /**
-     * Identifier for the context the message is to be generated for.
-     * @type string
-     */
-    protected $_context = '';
-
-    /**
-     * Data that will be used to generate message.
-     * @type array
-     */
-    protected $_data = array();
-
-    /**
-     * Whether this message is for a preview or not.
-     * @type bool
-     */
-    protected $_preview = false;
-
-    /**
-     * @type EE_Message $_message
-     */
-    protected $_message = null;
-
-    /**
-     * This is set by the constructor to indicate whether the incoming messenger
-     * and message type are valid.  This can then be checked by callers to determine whether
-     * to generate this message or not.
-     * @type bool
-     */
-    protected $_valid = false;
-
-    /**
-     * If there are any errors (non exception errors) they get added to this array for callers to decide
-     * how to handle.
-     * @type array
-     */
-    protected $_error_msg = array();
-
-    /**
-     * Can be accessed via the send_now() method, this is set in the validation
-     * routine via the EE_messenger::send_now() method.
-     * @type bool
-     */
-    protected $_send_now = false;
-
-    /**
-     * Holds the classname for the data handler used by the current message type.
-     * This is set on the first call to the public `get_data_handler_class_name()` method.
-     * @type string
-     */
-    protected $_data_handler_class_name = '';
-
-    /**
-     * one of the message status constants on EEM_Message
-     *
-     * @type string
-     */
-    protected $_message_status = '';
-
-
-
-    /**
-     * Constructor
-     *
-     * @param string $messenger_name    Slug representing messenger
-     * @param string $message_type_name Slug representing message type.
-     * @param mixed  $data              Data used for generating message.
-     * @param string $context           Optional context to restrict message generated for.
-     * @param bool   $preview           Whether this is being used to generate a preview or not.
-     * @param string $status
-     */
-    public function __construct(
-        $messenger_name,
-        $message_type_name,
-        $data = array(),
-        $context = '',
-        $preview = false,
-        $status = EEM_Message::status_incomplete
-    ) {
-        $this->_messenger_name      = $messenger_name;
-        $this->_message_type_name   = $message_type_name;
-        $this->_data                = is_array($data) ? $data : array( $data );
-        $this->_context             = $context;
-        $this->_preview             = $preview;
-        $this->_status              = $status;
-        // attempt to generate message immediately
-        $this->_message = $this->_generate_message();
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function context()
-    {
-        return $this->_context;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function data()
-    {
-        return $this->_data;
-    }
-
-
-
-    /**
-     * @return EE_messenger
-     */
-    public function messenger()
-    {
-        return $this->_messenger;
-    }
-
-
-
-    /**
-     * @return EE_message_type
-     */
-    public function message_type()
-    {
-        return $this->_message_type;
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function preview()
-    {
-        return $this->_preview;
-    }
-
-
-
-    /**
-     * @param boolean $preview
-     */
-    public function set_preview($preview)
-    {
-        $this->_preview = filter_var($preview, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function send_now()
-    {
-        return $this->_send_now;
-    }
-
-
-
-    /**
-     * Simply returns the state of the $_valid property.
-     *
-     * @return bool
-     */
-    public function valid()
-    {
-        return $this->_valid;
-    }
-
-
-
-    /**
-     * generates an EE_Message using the supplied arguments and some defaults
-     *
-     * @param array $properties
-     * @return string
-     */
-    protected function _generate_message($properties = array())
-    {
-        $message = EE_Message_Factory::create(
-            array_merge(
-                array(
-                    'MSG_messenger'    => $this->_messenger_name,
-                    'MSG_message_type' => $this->_message_type_name,
-                    'MSG_context'      => $this->_context,
-                    'STS_ID'           => $this->_status,
-                ),
-                $properties
-            )
-        );
-        // validate the message, and if it's good, set some properties
-        try {
-            $message->is_valid_for_sending_or_generation(true);
-            $this->_valid = true;
-            $this->_messenger = $message->messenger_object();
-            $this->_message_type = $message->message_type_object();
-            $this->_send_now = $message->send_now();
-        } catch (Exception $e) {
-            $this->_valid = false;
-            $this->_error_msg[] = $e->getMessage();
-        }
-        return $message;
-    }
-
-
-
-    /**
-     *  Returns an instantiated EE_Message object from the internal data.
-     *
-     * @return EE_Message
-     */
-    public function get_EE_Message()
-    {
-        // already set ?
-        if ($this->_message instanceof EE_Message) {
-            return $this->_message;
-        }
-        // no? then let's create one
-        $this->_message = $this->_generate_message();
-        return $this->_message;
-    }
-
-
-
-    /**
-     * This returns the data_handler class name for the internal message type set.
-     * Note: this also verifies that the data handler class exists.  If it doesn't then $_valid is set to false
-     * and the data_handler_class name is set to an empty string.
-     *
-     * @param   bool    $preview    Used to indicate that the preview data handler is to be returned.
-     * @return  string
-     */
-    public function get_data_handler_class_name($preview = false)
-    {
-        if ($this->_data_handler_class_name === '' && $this->valid()) {
-            $ref = $preview ? 'Preview' : $this->_message_type->get_data_handler($this->_data);
-            // make sure internal data is updated.
-            $this->_data = $this->_message_type->get_data();
-
-            // verify
-            $this->_data_handler_class_name = EE_Message_To_Generate::verify_and_retrieve_class_name_for_data_handler_reference($ref);
-            if ($this->_data_handler_class_name === '') {
-                $this->_valid = false;
-            }
-        }
-        return $this->_data_handler_class_name;
-    }
-
-
-
-    /**
-     * Validates the given string as a reference for an existing, accessible data handler and returns the class name
-     * For the handler the reference matches.
-     *
-     * @param string $data_handler_reference
-     * @return string
-     */
-    public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
-    {
-        $class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
-        if (! class_exists($class_name)) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'The included data handler reference (%s) does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.',
-                        'event_espresso'
-                    ),
-                    $data_handler_reference,
-                    $class_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $class_name = ''; // clear out class_name so caller knows this isn't valid.
-        }
-        return $class_name;
-    }
+	/**
+	 * @type string name of EE_messenger
+	 */
+	protected $_messenger_name = null;
+
+	/**
+	 * @type string name of EE_message_type
+	 */
+	protected $_message_type_name = null;
+
+	/**
+	 * @type EE_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type
+	 */
+	protected $_message_type = null;
+
+	/**
+	 * Identifier for the context the message is to be generated for.
+	 * @type string
+	 */
+	protected $_context = '';
+
+	/**
+	 * Data that will be used to generate message.
+	 * @type array
+	 */
+	protected $_data = array();
+
+	/**
+	 * Whether this message is for a preview or not.
+	 * @type bool
+	 */
+	protected $_preview = false;
+
+	/**
+	 * @type EE_Message $_message
+	 */
+	protected $_message = null;
+
+	/**
+	 * This is set by the constructor to indicate whether the incoming messenger
+	 * and message type are valid.  This can then be checked by callers to determine whether
+	 * to generate this message or not.
+	 * @type bool
+	 */
+	protected $_valid = false;
+
+	/**
+	 * If there are any errors (non exception errors) they get added to this array for callers to decide
+	 * how to handle.
+	 * @type array
+	 */
+	protected $_error_msg = array();
+
+	/**
+	 * Can be accessed via the send_now() method, this is set in the validation
+	 * routine via the EE_messenger::send_now() method.
+	 * @type bool
+	 */
+	protected $_send_now = false;
+
+	/**
+	 * Holds the classname for the data handler used by the current message type.
+	 * This is set on the first call to the public `get_data_handler_class_name()` method.
+	 * @type string
+	 */
+	protected $_data_handler_class_name = '';
+
+	/**
+	 * one of the message status constants on EEM_Message
+	 *
+	 * @type string
+	 */
+	protected $_message_status = '';
+
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $messenger_name    Slug representing messenger
+	 * @param string $message_type_name Slug representing message type.
+	 * @param mixed  $data              Data used for generating message.
+	 * @param string $context           Optional context to restrict message generated for.
+	 * @param bool   $preview           Whether this is being used to generate a preview or not.
+	 * @param string $status
+	 */
+	public function __construct(
+		$messenger_name,
+		$message_type_name,
+		$data = array(),
+		$context = '',
+		$preview = false,
+		$status = EEM_Message::status_incomplete
+	) {
+		$this->_messenger_name      = $messenger_name;
+		$this->_message_type_name   = $message_type_name;
+		$this->_data                = is_array($data) ? $data : array( $data );
+		$this->_context             = $context;
+		$this->_preview             = $preview;
+		$this->_status              = $status;
+		// attempt to generate message immediately
+		$this->_message = $this->_generate_message();
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->_context;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function data()
+	{
+		return $this->_data;
+	}
+
+
+
+	/**
+	 * @return EE_messenger
+	 */
+	public function messenger()
+	{
+		return $this->_messenger;
+	}
+
+
+
+	/**
+	 * @return EE_message_type
+	 */
+	public function message_type()
+	{
+		return $this->_message_type;
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function preview()
+	{
+		return $this->_preview;
+	}
+
+
+
+	/**
+	 * @param boolean $preview
+	 */
+	public function set_preview($preview)
+	{
+		$this->_preview = filter_var($preview, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return $this->_send_now;
+	}
+
+
+
+	/**
+	 * Simply returns the state of the $_valid property.
+	 *
+	 * @return bool
+	 */
+	public function valid()
+	{
+		return $this->_valid;
+	}
+
+
+
+	/**
+	 * generates an EE_Message using the supplied arguments and some defaults
+	 *
+	 * @param array $properties
+	 * @return string
+	 */
+	protected function _generate_message($properties = array())
+	{
+		$message = EE_Message_Factory::create(
+			array_merge(
+				array(
+					'MSG_messenger'    => $this->_messenger_name,
+					'MSG_message_type' => $this->_message_type_name,
+					'MSG_context'      => $this->_context,
+					'STS_ID'           => $this->_status,
+				),
+				$properties
+			)
+		);
+		// validate the message, and if it's good, set some properties
+		try {
+			$message->is_valid_for_sending_or_generation(true);
+			$this->_valid = true;
+			$this->_messenger = $message->messenger_object();
+			$this->_message_type = $message->message_type_object();
+			$this->_send_now = $message->send_now();
+		} catch (Exception $e) {
+			$this->_valid = false;
+			$this->_error_msg[] = $e->getMessage();
+		}
+		return $message;
+	}
+
+
+
+	/**
+	 *  Returns an instantiated EE_Message object from the internal data.
+	 *
+	 * @return EE_Message
+	 */
+	public function get_EE_Message()
+	{
+		// already set ?
+		if ($this->_message instanceof EE_Message) {
+			return $this->_message;
+		}
+		// no? then let's create one
+		$this->_message = $this->_generate_message();
+		return $this->_message;
+	}
+
+
+
+	/**
+	 * This returns the data_handler class name for the internal message type set.
+	 * Note: this also verifies that the data handler class exists.  If it doesn't then $_valid is set to false
+	 * and the data_handler_class name is set to an empty string.
+	 *
+	 * @param   bool    $preview    Used to indicate that the preview data handler is to be returned.
+	 * @return  string
+	 */
+	public function get_data_handler_class_name($preview = false)
+	{
+		if ($this->_data_handler_class_name === '' && $this->valid()) {
+			$ref = $preview ? 'Preview' : $this->_message_type->get_data_handler($this->_data);
+			// make sure internal data is updated.
+			$this->_data = $this->_message_type->get_data();
+
+			// verify
+			$this->_data_handler_class_name = EE_Message_To_Generate::verify_and_retrieve_class_name_for_data_handler_reference($ref);
+			if ($this->_data_handler_class_name === '') {
+				$this->_valid = false;
+			}
+		}
+		return $this->_data_handler_class_name;
+	}
+
+
+
+	/**
+	 * Validates the given string as a reference for an existing, accessible data handler and returns the class name
+	 * For the handler the reference matches.
+	 *
+	 * @param string $data_handler_reference
+	 * @return string
+	 */
+	public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
+	{
+		$class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
+		if (! class_exists($class_name)) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'The included data handler reference (%s) does not match any valid, accessible, "EE_Messages_incoming_data" classes.  Looking for %s.',
+						'event_espresso'
+					),
+					$data_handler_reference,
+					$class_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$class_name = ''; // clear out class_name so caller knows this isn't valid.
+		}
+		return $class_name;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -112,7 +112,7 @@ 
     ) {
         $this->_messenger_name      = $messenger_name;
         $this->_message_type_name   = $message_type_name;
-        $this->_data                = is_array($data) ? $data : array( $data );
+        $this->_data                = is_array($data) ? $data : array($data);
         $this->_context             = $context;
         $this->_preview             = $preview;
         $this->_status              = $status;
@@ -292,8 +292,8 @@ 
      */
     public static function verify_and_retrieve_class_name_for_data_handler_reference($data_handler_reference)
     {
-        $class_name = 'EE_Messages_' . $data_handler_reference . '_incoming_data';
-        if (! class_exists($class_name)) {
+        $class_name = 'EE_Messages_'.$data_handler_reference.'_incoming_data';
+        if ( ! class_exists($class_name)) {
             EE_Error::add_error(
                 sprintf(
                     __(

core/libraries/messages/EE_Payment_Base_message_type.lib.php

Indentation +44 added lines, -44 removed lines

@@ -15,67 +15,67 @@
 
 
 
-    /**
-     * @see parent::get_priority() for documentation.
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_high;
-    }
+	/**
+	 * @see parent::get_priority() for documentation.
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_high;
+	}
 
 
 
 
-    /**
-     * 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_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true
+			);
+	}
 
 
 
-    protected function _set_data_handler()
-    {
-        $this->_data_handler = 'Gateways';
-    }
+	protected function _set_data_handler()
+	{
+		$this->_data_handler = 'Gateways';
+	}
 
 
 
 
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
 
-        // use the registration to get the transaction.
-        $transaction = $registration->transaction();
+		// use the registration to get the transaction.
+		$transaction = $registration->transaction();
 
-        // bail early if no transaction
-        if (! $transaction instanceof EE_Transaction) {
-            throw new EE_Error(__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
-        }
+		// bail early if no transaction
+		if (! $transaction instanceof EE_Transaction) {
+			throw new EE_Error(__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
+		}
 
-        $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+		$payment = ! empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
 
-        return array( $transaction, $payment );
-    }
+		return array( $transaction, $payment );
+	}
 
 
 
-    protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
-    {
-        // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
-    }
+	protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
+	{
+		// this is just a test
+		return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+	}
 
-    /**
-     * This message type doesn't need any settings so we are just setting to empty array.
-     */
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
+	/**
+	 * This message type doesn't need any settings so we are just setting to empty array.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -54,13 +54,13 @@ 
         $transaction = $registration->transaction();
 
         // bail early if no transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new EE_Error(__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
         }
 
-        $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+        $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array(array('PAY_ID' => $id, 'TXN_ID' => $transaction->ID()))) : 0;
 
-        return array( $transaction, $payment );
+        return array($transaction, $payment);
     }
 
 
@@ -68,7 +68,7 @@ 
     protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
     {
         // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+        return $this->name.' Message Type for '.$messenger->name.' Messenger ';
     }
 
     /**

core/libraries/messages/EE_Registration_Base_message_type.lib.php

Indentation +122 added lines, -122 removed lines

@@ -14,126 +14,126 @@
 {
 
 
-    /**
-     * @see parent::get_priority() for documentation.
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_medium;
-    }
-
-
-
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true
-            );
-    }
-
-
-    protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
-    {
-        // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
-    }
-
-
-
-
-    protected function _set_data_handler()
-    {
-        if (is_array($this->_data)) {
-            $data_type = reset($this->_data);
-
-            if (is_array($data_type)) {
-                // grab the first item and see if its a registration.
-                $maybe_reg = isset($data_type[0]) && is_array($data_type[0]) ? reset($data_type[0]) : reset($data_type);
-                if ($maybe_reg instanceof EE_Registration) {
-                    // is $data_type itself just an array of registrations?
-                    if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
-                        $regs = $data_type;
-                    } else {
-                        $regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
-                    }
-
-                    foreach ($regs as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $this->_regs_for_sending[] = $reg->ID();
-                        }
-                    }
-                    $this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
-                    $this->_data_handler = 'Gateways';
-                } else {
-                    $this->_data_handler = 'Gateways';
-                }
-            } else {
-                $this->_data_handler = $data_type instanceof EE_Registration ? 'REG' : 'Gateways';
-            }
-        } else {
-            $this->_data_handler = $this->_data instanceof EE_Registration ? 'REG' : 'Gateways';
-        }
-
-        $this->_single_message = $this->_data_handler == 'REG' ? true : false;
-    }
-
-
-
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
-        if ($context  == 'admin') {
-            // use the registration to get the transaction.
-            $transaction = $registration->transaction();
-
-            // bail early if no transaction
-            if (! $transaction instanceof EE_Transaction) {
-                throw new EE_Error(__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
-            }
-
-            $payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
-            return array( $transaction, $payment );
-        } else {
-            return $registration;
-        }
-    }
-
-
-
-    /**
-     * Setup admin settings for this message type.
-     */
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
-
-
-
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     */
-    protected function _admin_addressees()
-    {
-        if ($this->_single_message) {
-            return array();
-        }
-        return parent::_admin_addressees();
-    }
-
-
-
-    protected function _primary_attendee_addressees()
-    {
-        if ($this->_single_message) {
-            return array();
-        }
-
-        return parent::_primary_attendee_addressees();
-    }
+	/**
+	 * @see parent::get_priority() for documentation.
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_medium;
+	}
+
+
+
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true
+			);
+	}
+
+
+	protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
+	{
+		// this is just a test
+		return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+	}
+
+
+
+
+	protected function _set_data_handler()
+	{
+		if (is_array($this->_data)) {
+			$data_type = reset($this->_data);
+
+			if (is_array($data_type)) {
+				// grab the first item and see if its a registration.
+				$maybe_reg = isset($data_type[0]) && is_array($data_type[0]) ? reset($data_type[0]) : reset($data_type);
+				if ($maybe_reg instanceof EE_Registration) {
+					// is $data_type itself just an array of registrations?
+					if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
+						$regs = $data_type;
+					} else {
+						$regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
+					}
+
+					foreach ($regs as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$this->_regs_for_sending[] = $reg->ID();
+						}
+					}
+					$this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
+					$this->_data_handler = 'Gateways';
+				} else {
+					$this->_data_handler = 'Gateways';
+				}
+			} else {
+				$this->_data_handler = $data_type instanceof EE_Registration ? 'REG' : 'Gateways';
+			}
+		} else {
+			$this->_data_handler = $this->_data instanceof EE_Registration ? 'REG' : 'Gateways';
+		}
+
+		$this->_single_message = $this->_data_handler == 'REG' ? true : false;
+	}
+
+
+
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
+		if ($context  == 'admin') {
+			// use the registration to get the transaction.
+			$transaction = $registration->transaction();
+
+			// bail early if no transaction
+			if (! $transaction instanceof EE_Transaction) {
+				throw new EE_Error(__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
+			}
+
+			$payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+			return array( $transaction, $payment );
+		} else {
+			return $registration;
+		}
+	}
+
+
+
+	/**
+	 * Setup admin settings for this message type.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
+
+
+
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 */
+	protected function _admin_addressees()
+	{
+		if ($this->_single_message) {
+			return array();
+		}
+		return parent::_admin_addressees();
+	}
+
+
+
+	protected function _primary_attendee_addressees()
+	{
+		if ($this->_single_message) {
+			return array();
+		}
+
+		return parent::_primary_attendee_addressees();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -36,7 +36,7 @@ 
     protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
     {
         // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+        return $this->name.' Message Type for '.$messenger->name.' Messenger ';
     }
 
 
@@ -55,7 +55,7 @@ 
                     if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
                         $regs = $data_type;
                     } else {
-                        $regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
+                        $regs = is_array($data_type[0]) ? $data_type[0] : array($maybe_reg);
                     }
 
                     foreach ($regs as $reg) {
@@ -63,7 +63,7 @@ 
                             $this->_regs_for_sending[] = $reg->ID();
                         }
                     }
-                    $this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
+                    $this->_data = isset($this->_data[1]) ? array($maybe_reg->transaction(), null, $this->_data[1]) : array($maybe_reg->transaction());
                     $this->_data_handler = 'Gateways';
                 } else {
                     $this->_data_handler = 'Gateways';
@@ -82,17 +82,17 @@ 
 
     protected function _get_data_for_context($context, EE_Registration $registration, $id)
     {
-        if ($context  == 'admin') {
+        if ($context == 'admin') {
             // use the registration to get the transaction.
             $transaction = $registration->transaction();
 
             // bail early if no transaction
-            if (! $transaction instanceof EE_Transaction) {
+            if ( ! $transaction instanceof EE_Transaction) {
                 throw new EE_Error(__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
             }
 
-            $payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
-            return array( $transaction, $payment );
+            $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array(array('PAY_ID' => $id, 'TXN_ID' => $transaction->ID()))) : 0;
+            return array($transaction, $payment);
         } else {
             return $registration;
         }

core/libraries/messages/message_type/EE_Payment_Refund_message_type.class.php

Indentation +39 added lines, -39 removed lines

@@ -15,50 +15,50 @@
 class EE_Payment_Refund_message_type extends EE_Payment_Base_message_type
 {
 
-    public function __construct()
-    {
+	public function __construct()
+	{
 
-        // setup type details for reference
-        $this->name = 'payment_refund';
-        $this->description = __('This message type is used for all payment notification messages that go out for refunds.', 'event_espresso');
-        $this->label = array(
-            'singular' => __('refund issued', 'event_espresso'),
-            'plural' => __('refunds issued', 'event_espresso')
-            );
+		// setup type details for reference
+		$this->name = 'payment_refund';
+		$this->description = __('This message type is used for all payment notification messages that go out for refunds.', 'event_espresso');
+		$this->label = array(
+			'singular' => __('refund issued', 'event_espresso'),
+			'plural' => __('refunds issued', 'event_espresso')
+			);
 
-        $this->_master_templates = array(
-            'email' => 'payment'
-            );
+		$this->_master_templates = array(
+			'email' => 'payment'
+			);
 
-        parent::__construct();
-    }
+		parent::__construct();
+	}
 
 
 
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => __('recipient', 'event_espresso'),
-            'plural' => __('recipients', 'event_espresso'),
-            'description' => __('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
-            );
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => __('recipient', 'event_espresso'),
+			'plural' => __('recipients', 'event_espresso'),
+			'description' => __('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => __('Event Admin', 'event_espresso'),
-                'description' => __('This template is what event administrators will receive on a successful refund.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => __('Primary Registrant', 'event_espresso'),
-                'description' => __('This template is what the primary registrant (the person who made the main registration) will receive on successful refund.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => __('Event Admin', 'event_espresso'),
+				'description' => __('This template is what event administrators will receive on a successful refund.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => __('Primary Registrant', 'event_espresso'),
+				'description' => __('This template is what the primary registrant (the person who made the main registration) will receive on successful refund.', 'event_espresso')
+				)
+			);
+	}
 }