eventespresso / event-espresso-core

core/libraries/messages/defaults/default/html_receipt_ticket_line_item_pms.template.php

Spacing +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 <tr class="item">
     <td>[LINE_ITEM_NAME][LINE_ITEM_TAXABLE_*]</td>
     <td colspan="2">[LINE_ITEM_DESCRIPTION]
-        <p class="ticket-note"><?php echo sprintf(esc_html__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema=' . esc_html__('any', 'event_espresso') . ']'); ?></p>
+        <p class="ticket-note"><?php echo sprintf(esc_html__('This ticket can be used once at %s of the dates/times below.', 'event_espresso'), '[TKT_USES_* schema='.esc_html__('any', 'event_espresso').']'); ?></p>
     </td>
     <td class="item_c">[LINE_ITEM_QUANTITY]</td>
     <td class="item_c">[LINE_ITEM_AMOUNT]</td>

core/libraries/messages/defaults/EE_Messages_Template_Pack.core.php

Indentation +469 added lines, -469 removed lines

@@ -14,511 +14,511 @@
 {
 
 
-    /**
-     * This defines the base_path where the templates are located.
-     *
-     * @since            4.5.0
-     *
-     * @var string
-     */
-    protected $_base_path;
+	/**
+	 * This defines the base_path where the templates are located.
+	 *
+	 * @since            4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_base_path;
 
 
 
 
-    /**
-     * This defines the base_url where things are found for this template pack (possibly variations).
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_base_url;
+	/**
+	 * This defines the base_url where things are found for this template pack (possibly variations).
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_base_url;
 
 
 
-    /**
-     * localized label for this template pack
-     *
-     * @since            4.5.0
-     *
-     * @var string
-     */
-    public $label;
+	/**
+	 * localized label for this template pack
+	 *
+	 * @since            4.5.0
+	 *
+	 * @var string
+	 */
+	public $label;
 
 
 
 
-    /**
-     * used to contain a description for the template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    public $description;
+	/**
+	 * used to contain a description for the template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	public $description;
 
 
 
 
-    /**
-     * How this template is referenced in the db
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    public $dbref;
+	/**
+	 * How this template is referenced in the db
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	public $dbref;
 
 
 
 
-    /**
-     * This is an array indexed by messenger and with an array of message types as values that indicate what messenger and message type this template pack supports by default.  It is possible for this to be modified by plugins via filters, but out of the box, this is what the template pack supports.
-     *
-     * @since 4.5.0
-     *
-     * @var array.
-     */
-    protected $_supports = array();
+	/**
+	 * This is an array indexed by messenger and with an array of message types as values that indicate what messenger and message type this template pack supports by default.  It is possible for this to be modified by plugins via filters, but out of the box, this is what the template pack supports.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array.
+	 */
+	protected $_supports = array();
 
 
 
 
 
-    /**
-     * Holds the retrieved default templates for this template pack in a multidimensional array indexed by context and field, for a given messenger and message type.  Example format:
-     *
-     * $templates = array(
-     *  'email' => array(
-     *      'registration' => array(
-     *          'admin' => array(
-     *              'to' => 'contents',
-     *              'from' => 'contents',
-     *              'subject' => 'contents',
-     *              'content' => 'contents',
-     *              'event_list' => 'contents',
-     *              'attendee_list' => 'contents'
-     *          ),
-     *          'attendee' => array(
-     *              'to' => 'contents',
-     *              'from' => 'contents',
-     *              'subject' => 'contents',
-     *              'content' => 'contents',
-     *              'event_list' => 'contents',
-     *              'attendee_list' => 'contents',
-     *          ),
-     *      )
-     *  )
-     * )
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected $_templates = array();
+	/**
+	 * Holds the retrieved default templates for this template pack in a multidimensional array indexed by context and field, for a given messenger and message type.  Example format:
+	 *
+	 * $templates = array(
+	 *  'email' => array(
+	 *      'registration' => array(
+	 *          'admin' => array(
+	 *              'to' => 'contents',
+	 *              'from' => 'contents',
+	 *              'subject' => 'contents',
+	 *              'content' => 'contents',
+	 *              'event_list' => 'contents',
+	 *              'attendee_list' => 'contents'
+	 *          ),
+	 *          'attendee' => array(
+	 *              'to' => 'contents',
+	 *              'from' => 'contents',
+	 *              'subject' => 'contents',
+	 *              'content' => 'contents',
+	 *              'event_list' => 'contents',
+	 *              'attendee_list' => 'contents',
+	 *          ),
+	 *      )
+	 *  )
+	 * )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected $_templates = array();
 
 
 
 
 
 
-    /**
-     * Template Packs must ALWAYS have a default variation defined.  This property allow one to override the default variation labels per messenger.
-     * example:
-     * $this->_default_variation_labels = array( 'email' =>  esc_html__('Default', 'event_espresso' ) );
-     *
-     * @var array
-     */
-    protected $_default_variation_labels = array();
+	/**
+	 * Template Packs must ALWAYS have a default variation defined.  This property allow one to override the default variation labels per messenger.
+	 * example:
+	 * $this->_default_variation_labels = array( 'email' =>  esc_html__('Default', 'event_espresso' ) );
+	 *
+	 * @var array
+	 */
+	protected $_default_variation_labels = array();
 
 
 
 
-    /**
-     * This is an array of extra css variations for message templates indexed by messenger with the values as an array or message types the variations apply to as the key  and then values are an array with variation slugs as the key and label as the value. Note the default variation is not included in this array.  So the structure is:
-     * array(
-     *  'email' => array(
-     *  )
-     * )
-     *
-     * Keep in mind that this property is used both for indicating valid variations for a given message type and messenger but the variation files themselves are ONLY unique to the messenger.  So if you have a variation for the html messenger referenced by the slug "sunset_red" Then the variation file for the main type will be html_main_sunset_red.css.  All the array in this property allows you to do, is indicate that with certain message types the sunset_red variation is available but for other message types its not.  But you could NOT have a sunset_red variation file for one messenger/message_type and a different one for another messenger/message_type.  If you want different css looks then you can define a different structural layout for the template , messenger, message type combination and in the same sunset_red.css variation file just add css specific to that layout.
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    public $_variations = array();
-
-
-
-
-    /**
-     * Template pack constructor
-     *
-     * @since 4.5.0
-     */
-    public function __construct()
-    {
-        $this->_set_props();
-        // make sure classname is correct
-        $classname = get_class($this);
-        // make sure required props have been set
-
-        // if label is empty then throw an error because we should have it defined by now.
-        if (! isset($this->label)) {
-            throw new EE_Error(sprintf(esc_html__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-
-        // the reference for this template pack
-        if (! isset($this->dbref)) {
-            throw new EE_Error(sprintf(esc_html__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-        // make sure dbref is safe
-        $this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
-
-        $should_be = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
-
-        if ($should_be !== $classname) {
-            throw new EE_Error(sprintf(esc_html__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
-        }
-
-        // if _base_path is not set then throw an error because a base path string is needed.
-        if (empty($this->_base_path)) {
-            throw new EE_Error(sprintf(esc_html__('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-
-        // if _base_url is not set then throw an error because a  string is needed for variations.
-        if (empty($this->_base_url)) {
-            throw new EE_Error(sprintf(esc_html__('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-
-
-        // if $supports is not set then throw an error because that effectively means this template_pack does not have any templates!
-        if (empty($this->_supports)) {
-            throw new EE_Error(sprintf(esc_html__('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
-        }
-    }
-
-
-
-    /**
-     * This method should be used to define the following properties:
-     * - label
-     * - dbref
-     * - description
-     * - _base_path
-     * - _base_url
-     * - supports
-     * - variations
-     *
-     * @since 4.5.0
-     * @return void.
-     * @abstract
-     */
-    abstract protected function _set_props();
-
-
-
-
-    /**
-     * Wrapper for get_templates() ( @see get_templates() for documentation)
-     *
-     * @since 4.5.0
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     *
-     * @return array
-     */
-    public function get_templates(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        return isset($this->_templates[ $messenger->name ][ $message_type->name ]) ? $this->_templates[ $messenger->name ][ $message_type->name ] : $this->_get_templates($messenger, $message_type);
-    }
-
-
-
-
-    /**
-     * This takes the incoming messenger and message type objects, uses them to get the set fields and contexts, then attempts to retrieve the templates matching those for this given template pack.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     *
-     * @return array          Returns an multi-level associative array indexed by template context and field in the format:
-     *                                array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) );
-     */
-    protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        $templates = array();
-
-        /**
-         * Retrieving the default pack for later usage of default templates for template packs that
-         * are NOT the default pack ( or an extension of the default pack ).
-         * We ONLY set this variable to be the default pack IF the loaded class is NOT the default
-         * pack.  This prevents recursion in _get_specific_template().  The intention is that for
-         * template packs that are NOT default packs, we use the default template pack to provide
-         * the final fallback templates if there aren't any defined for the called template pack.
-         *
-         * @type EE_Messages_Template_Pack_Default | null $default_pack
-         */
-        $default_pack = ! $this instanceof EE_Messages_Template_Pack_Default ? new EE_Messages_Template_Pack_Default() : null;
-
-        $fields = $messenger->get_template_fields();
-        $contexts = $message_type->get_contexts();
-
-
-        foreach ($contexts as $context => $details) {
-            foreach ($fields as $field => $field_details) {
-                if (empty($field_details)) {
-                    continue;
-                }
-                /**
-                 * is this a field array (linked to a main field)?
-                 */
-                if ($field == 'extra') {
-                    foreach ($field_details as $main_field => $sub_fields) {
-                        foreach ($sub_fields as $sub_field => $sub_field_details) {
-                            // make sure that the template_field_ref matches what the main template field is for this template group.
-                            $template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
-                            $templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
-                        }
-                    }
-                } else {
-                    $templates[ $context ][ $field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
-                }
-            }
-        }
-
-        $templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
-
-        $this->_templates[ $messenger->name ][ $message_type->name ] = $templates;
-         return $templates;
-    }
-
-
-    /**
-     * Utility method for retrieving a specific template matching the given parameters
-     *
-     * @param null | EE_Messages_Template_Pack_Default $default_pack
-     * @param EE_messenger                             $messenger
-     * @param EE_message_type                          $message_type
-     * @param string                                   $field          The field reference for the specific template being looked up.
-     * @param string                                   $context      The context reference for the specific template being looked up
-     *
-     * @return string          The template contents.
-     */
-    protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context)
-    {
-
-        // default templates
-        $default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array();
-
-        // first we allow for the $_base_path to be filtered.  However, we assign this to a new variable so that we have the original base_path as a fallback.
-        $filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
-
-        $master_templates = $message_type->get_master_templates();
-        $master_templates_mt = isset($master_templates[ $messenger->name ]) ? $master_templates[ $messenger->name ] : $message_type->name;
-        $full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
-        $fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
-        $mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-        $base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-
-        /**
-         * Template checks are done hierarchically in the following order:
-         *
-         * - a match for the full messenger name, message type, context and field in the full path for the given template pack.
-         * - a match for the full messenger name, message type, field in the full path for the given template pack.
-         * - a match for the full messenger name, message type, field, context in the path grabbed for the related message type defined in the _master_templates property for the message type (i.e. all registration message types share the same template as the main registration message type).
-         * - match for the full messenger name, message type, field for the related message type defined in the _master templates property for the message type
-         * - a match for a default template matching the messenger, name, context, field (as set by the default template packs).
-         * - empty string.
-         */
-
-
-        if (is_readable($full_path)) {
-            $actual_path = $full_path;
-        } elseif (is_readable($fallback_path)) {
-            $actual_path = $fallback_path;
-        } elseif (is_readable($mt_defined_full_path)) {
-            $actual_path = $mt_defined_full_path;
-        } elseif (is_readable($mt_defined_fallback_path)) {
-            $actual_path = $mt_defined_fallback_path;
-        } elseif (is_readable($base_defined_full_path)) {
-            $actual_path = $base_defined_full_path;
-        } elseif (is_readable($base_defined_fallback_path)) {
-            $actual_path = $base_defined_fallback_path;
-        } else {
-            $actual_path = '';
-        }
-        if (empty($actual_path)) {
-            $contents = isset($default_templates[ $context ][ $field ]) ? $default_templates[ $context ][ $field ] : '';
-        } else {
-            $contents = EEH_Template::display_template($actual_path, array(), true);
-        }
-
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this);
-    }
-
-
-
-
-
-    /**
-     * Return filtered _supports property.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    public function get_supports()
-    {
-        $supports = apply_filters('FHEE__' . get_class($this) . '__get_supports', $this->_supports);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
-    }
-
-
-
-
-    /**
-     * This simply returns the $_default_variation_labels property value.
-     *
-     * @since 4.5.0
-     *
-     * @param string $messenger if the messenger slug is returned then the default label for the specific messenger is retrieved.  If it doesn't exist then the esc_html__('Default', 'event_espresso') is returned.  If NO value is provided then whatever is set on the _default_variation_labels property is returned.
-     *
-     * @return array|string
-     */
-    public function get_default_variation_labels($messenger = '')
-    {
-        $label = empty($messenger) ? $this->_default_variation_labels : array();
-        $label = empty($label) && ! empty($this->_default_variation_labels[ $messenger ]) ? $this->_default_variation_labels[ $messenger ] : esc_html__('Default', 'event_espresso');
-
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
-    }
-
-
-
-
-
-    /**
-     * This simply returns the _variations property.
-     *
-     * @since 4.5.0
-     *
-     * @param string $messenger if included then css variations matching the messenger are returned.  Otherwise, just the default variation is included.  If both message type AND messenger are empty then all variations are returned.
-     * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
-     * @return array
-     */
-    public function get_variations($messenger = '', $message_type = '')
-    {
-        $messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
-
-        // message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-        $variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
-
-        // now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-        $variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
-
-        // filter per template pack and globally.
-        $variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
-        $variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
-
-        // prepend the _default_variation, but ONLY if we're returning the fully validated array.
-        if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
-            $variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
-        }
-
-        return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ) : $variations;
-    }
-
-
-
-
-    /**
-     * This is typically called by EE_messenger objects to get the specific css variation defined for the messenger, message_type and type (i.e. inline, wpeditor, preview etc.)
-     *
-     * @since 4.5.0
-     *
-     * @param string $messenger messenger slug
-     * @param string $message_type message_type slug
-     * @param string $type           variation type (i.e. inline, base, wpeditor, preview etc. //this varies per messenger).
-     * @param string $variation    this should match one of the defined variations in the _variations property on this class.
-     * @param string $file_extension  What type of file the variation file is (defaults to css)
-     * @param bool   $url          if true then return the url otherwise path.
-     * @param bool   $skip_filters This should not be set directly, its used internally to skip filters when the default template pack is called internally as the fallback.
-     *
-     * @return string The variation path or url (typically css reference)
-     */
-    public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = false)
-    {
+	/**
+	 * This is an array of extra css variations for message templates indexed by messenger with the values as an array or message types the variations apply to as the key  and then values are an array with variation slugs as the key and label as the value. Note the default variation is not included in this array.  So the structure is:
+	 * array(
+	 *  'email' => array(
+	 *  )
+	 * )
+	 *
+	 * Keep in mind that this property is used both for indicating valid variations for a given message type and messenger but the variation files themselves are ONLY unique to the messenger.  So if you have a variation for the html messenger referenced by the slug "sunset_red" Then the variation file for the main type will be html_main_sunset_red.css.  All the array in this property allows you to do, is indicate that with certain message types the sunset_red variation is available but for other message types its not.  But you could NOT have a sunset_red variation file for one messenger/message_type and a different one for another messenger/message_type.  If you want different css looks then you can define a different structural layout for the template , messenger, message type combination and in the same sunset_red.css variation file just add css specific to that layout.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	public $_variations = array();
+
+
+
+
+	/**
+	 * Template pack constructor
+	 *
+	 * @since 4.5.0
+	 */
+	public function __construct()
+	{
+		$this->_set_props();
+		// make sure classname is correct
+		$classname = get_class($this);
+		// make sure required props have been set
+
+		// if label is empty then throw an error because we should have it defined by now.
+		if (! isset($this->label)) {
+			throw new EE_Error(sprintf(esc_html__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+
+		// the reference for this template pack
+		if (! isset($this->dbref)) {
+			throw new EE_Error(sprintf(esc_html__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+		// make sure dbref is safe
+		$this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
+
+		$should_be = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
+
+		if ($should_be !== $classname) {
+			throw new EE_Error(sprintf(esc_html__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
+		}
+
+		// if _base_path is not set then throw an error because a base path string is needed.
+		if (empty($this->_base_path)) {
+			throw new EE_Error(sprintf(esc_html__('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+
+		// if _base_url is not set then throw an error because a  string is needed for variations.
+		if (empty($this->_base_url)) {
+			throw new EE_Error(sprintf(esc_html__('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+
+
+		// if $supports is not set then throw an error because that effectively means this template_pack does not have any templates!
+		if (empty($this->_supports)) {
+			throw new EE_Error(sprintf(esc_html__('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
+		}
+	}
+
+
+
+	/**
+	 * This method should be used to define the following properties:
+	 * - label
+	 * - dbref
+	 * - description
+	 * - _base_path
+	 * - _base_url
+	 * - supports
+	 * - variations
+	 *
+	 * @since 4.5.0
+	 * @return void.
+	 * @abstract
+	 */
+	abstract protected function _set_props();
+
+
+
+
+	/**
+	 * Wrapper for get_templates() ( @see get_templates() for documentation)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 *
+	 * @return array
+	 */
+	public function get_templates(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		return isset($this->_templates[ $messenger->name ][ $message_type->name ]) ? $this->_templates[ $messenger->name ][ $message_type->name ] : $this->_get_templates($messenger, $message_type);
+	}
+
+
+
+
+	/**
+	 * This takes the incoming messenger and message type objects, uses them to get the set fields and contexts, then attempts to retrieve the templates matching those for this given template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 *
+	 * @return array          Returns an multi-level associative array indexed by template context and field in the format:
+	 *                                array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) );
+	 */
+	protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		$templates = array();
+
+		/**
+		 * Retrieving the default pack for later usage of default templates for template packs that
+		 * are NOT the default pack ( or an extension of the default pack ).
+		 * We ONLY set this variable to be the default pack IF the loaded class is NOT the default
+		 * pack.  This prevents recursion in _get_specific_template().  The intention is that for
+		 * template packs that are NOT default packs, we use the default template pack to provide
+		 * the final fallback templates if there aren't any defined for the called template pack.
+		 *
+		 * @type EE_Messages_Template_Pack_Default | null $default_pack
+		 */
+		$default_pack = ! $this instanceof EE_Messages_Template_Pack_Default ? new EE_Messages_Template_Pack_Default() : null;
+
+		$fields = $messenger->get_template_fields();
+		$contexts = $message_type->get_contexts();
+
+
+		foreach ($contexts as $context => $details) {
+			foreach ($fields as $field => $field_details) {
+				if (empty($field_details)) {
+					continue;
+				}
+				/**
+				 * is this a field array (linked to a main field)?
+				 */
+				if ($field == 'extra') {
+					foreach ($field_details as $main_field => $sub_fields) {
+						foreach ($sub_fields as $sub_field => $sub_field_details) {
+							// make sure that the template_field_ref matches what the main template field is for this template group.
+							$template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
+							$templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
+						}
+					}
+				} else {
+					$templates[ $context ][ $field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
+				}
+			}
+		}
+
+		$templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
+
+		$this->_templates[ $messenger->name ][ $message_type->name ] = $templates;
+		 return $templates;
+	}
+
+
+	/**
+	 * Utility method for retrieving a specific template matching the given parameters
+	 *
+	 * @param null | EE_Messages_Template_Pack_Default $default_pack
+	 * @param EE_messenger                             $messenger
+	 * @param EE_message_type                          $message_type
+	 * @param string                                   $field          The field reference for the specific template being looked up.
+	 * @param string                                   $context      The context reference for the specific template being looked up
+	 *
+	 * @return string          The template contents.
+	 */
+	protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context)
+	{
+
+		// default templates
+		$default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array();
+
+		// first we allow for the $_base_path to be filtered.  However, we assign this to a new variable so that we have the original base_path as a fallback.
+		$filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
+
+		$master_templates = $message_type->get_master_templates();
+		$master_templates_mt = isset($master_templates[ $messenger->name ]) ? $master_templates[ $messenger->name ] : $message_type->name;
+		$full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
+		$fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
+		$mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
+		$mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+		$base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
+		$base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+
+		/**
+		 * Template checks are done hierarchically in the following order:
+		 *
+		 * - a match for the full messenger name, message type, context and field in the full path for the given template pack.
+		 * - a match for the full messenger name, message type, field in the full path for the given template pack.
+		 * - a match for the full messenger name, message type, field, context in the path grabbed for the related message type defined in the _master_templates property for the message type (i.e. all registration message types share the same template as the main registration message type).
+		 * - match for the full messenger name, message type, field for the related message type defined in the _master templates property for the message type
+		 * - a match for a default template matching the messenger, name, context, field (as set by the default template packs).
+		 * - empty string.
+		 */
+
+
+		if (is_readable($full_path)) {
+			$actual_path = $full_path;
+		} elseif (is_readable($fallback_path)) {
+			$actual_path = $fallback_path;
+		} elseif (is_readable($mt_defined_full_path)) {
+			$actual_path = $mt_defined_full_path;
+		} elseif (is_readable($mt_defined_fallback_path)) {
+			$actual_path = $mt_defined_fallback_path;
+		} elseif (is_readable($base_defined_full_path)) {
+			$actual_path = $base_defined_full_path;
+		} elseif (is_readable($base_defined_fallback_path)) {
+			$actual_path = $base_defined_fallback_path;
+		} else {
+			$actual_path = '';
+		}
+		if (empty($actual_path)) {
+			$contents = isset($default_templates[ $context ][ $field ]) ? $default_templates[ $context ][ $field ] : '';
+		} else {
+			$contents = EEH_Template::display_template($actual_path, array(), true);
+		}
+
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this);
+	}
+
+
+
+
+
+	/**
+	 * Return filtered _supports property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	public function get_supports()
+	{
+		$supports = apply_filters('FHEE__' . get_class($this) . '__get_supports', $this->_supports);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
+	}
+
+
+
+
+	/**
+	 * This simply returns the $_default_variation_labels property value.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger if the messenger slug is returned then the default label for the specific messenger is retrieved.  If it doesn't exist then the esc_html__('Default', 'event_espresso') is returned.  If NO value is provided then whatever is set on the _default_variation_labels property is returned.
+	 *
+	 * @return array|string
+	 */
+	public function get_default_variation_labels($messenger = '')
+	{
+		$label = empty($messenger) ? $this->_default_variation_labels : array();
+		$label = empty($label) && ! empty($this->_default_variation_labels[ $messenger ]) ? $this->_default_variation_labels[ $messenger ] : esc_html__('Default', 'event_espresso');
+
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
+	}
+
+
+
+
+
+	/**
+	 * This simply returns the _variations property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger if included then css variations matching the messenger are returned.  Otherwise, just the default variation is included.  If both message type AND messenger are empty then all variations are returned.
+	 * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
+	 * @return array
+	 */
+	public function get_variations($messenger = '', $message_type = '')
+	{
+		$messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
+
+		// message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
+		$variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
+
+		// now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
+		$variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
+
+		// filter per template pack and globally.
+		$variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
+		$variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
+
+		// prepend the _default_variation, but ONLY if we're returning the fully validated array.
+		if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
+			$variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
+		}
+
+		return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ) : $variations;
+	}
+
+
+
+
+	/**
+	 * This is typically called by EE_messenger objects to get the specific css variation defined for the messenger, message_type and type (i.e. inline, wpeditor, preview etc.)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger messenger slug
+	 * @param string $message_type message_type slug
+	 * @param string $type           variation type (i.e. inline, base, wpeditor, preview etc. //this varies per messenger).
+	 * @param string $variation    this should match one of the defined variations in the _variations property on this class.
+	 * @param string $file_extension  What type of file the variation file is (defaults to css)
+	 * @param bool   $url          if true then return the url otherwise path.
+	 * @param bool   $skip_filters This should not be set directly, its used internally to skip filters when the default template pack is called internally as the fallback.
+	 *
+	 * @return string The variation path or url (typically css reference)
+	 */
+	public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = false)
+	{
 
-        $base = $url ? $this->_base_url : $this->_base_path;
-        $base_path = $this->_base_path;
+		$base = $url ? $this->_base_url : $this->_base_path;
+		$base_path = $this->_base_path;
 
-        if (! $skip_filters) {
-            $base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
-            $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
-        }
+		if (! $skip_filters) {
+			$base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+			$base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
+		}
 
-        $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
-
-        // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
-
-        // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
-        // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
-        } else {
-            $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
-        }
+		$default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
+
+		// possible variation paths considering whether message type is present or not in the file name.
+		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
+		$default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+
+		// first see if fully validated file exists.
+		if (is_readable($base_path . $path_string)) {
+			$variation_path = $base . $path_string;
+		// otherwise see if default exists.
+		} elseif (is_readable($base_path . $default_path_string)) {
+			$variation_path = $base . $default_path_string;
+		} else {
+			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
+		}
 
-        if ($skip_filters) {
-            return $variation_path;
-        }
-
-        // filter result
-        $variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
-    }
-
-
-
-
-
-    /**
-     * This method is used to return the wrapper template for the given template pack.  If the given template pack does not include any wrapper templates then the default is used.
-     *
-     * @param string $messenger What messenger the wrapper is for.
-     * @param string $type           What type of wrapper is being returned ( for messengers that may have more than one wrapper )
-     *
-     * @return string returns the path for the requested wrapper template.
-     */
-    public function get_wrapper($messenger, $type = 'main')
-    {
-        $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
-
-        $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
-
-        if (is_readable($path_string)) {
-            $template = $path_string;
-        } else {
-            $template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
-        }
-
-        // filter
-        $template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
-    }
+		if ($skip_filters) {
+			return $variation_path;
+		}
+
+		// filter result
+		$variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
+	}
+
+
+
+
+
+	/**
+	 * This method is used to return the wrapper template for the given template pack.  If the given template pack does not include any wrapper templates then the default is used.
+	 *
+	 * @param string $messenger What messenger the wrapper is for.
+	 * @param string $type           What type of wrapper is being returned ( for messengers that may have more than one wrapper )
+	 *
+	 * @return string returns the path for the requested wrapper template.
+	 */
+	public function get_wrapper($messenger, $type = 'main')
+	{
+		$default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
+
+		$path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+
+		if (is_readable($path_string)) {
+			$template = $path_string;
+		} else {
+			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
+		}
+
+		// filter
+		$template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
+	}
 }

Spacing +35 added lines, -35 removed lines

@@ -166,20 +166,20 @@ 
         // make sure required props have been set
 
         // if label is empty then throw an error because we should have it defined by now.
-        if (! isset($this->label)) {
+        if ( ! isset($this->label)) {
             throw new EE_Error(sprintf(esc_html__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
         }
 
 
         // the reference for this template pack
-        if (! isset($this->dbref)) {
+        if ( ! isset($this->dbref)) {
             throw new EE_Error(sprintf(esc_html__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
         }
 
         // make sure dbref is safe
         $this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
 
-        $should_be = 'EE_Messages_Template_Pack_' . str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
+        $should_be = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
 
         if ($should_be !== $classname) {
             throw new EE_Error(sprintf(esc_html__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
@@ -236,7 +236,7 @@ 
      */
     public function get_templates(EE_messenger $messenger, EE_message_type $message_type)
     {
-        return isset($this->_templates[ $messenger->name ][ $message_type->name ]) ? $this->_templates[ $messenger->name ][ $message_type->name ] : $this->_get_templates($messenger, $message_type);
+        return isset($this->_templates[$messenger->name][$message_type->name]) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates($messenger, $message_type);
     }
 
 
@@ -286,18 +286,18 @@ 
                         foreach ($sub_fields as $sub_field => $sub_field_details) {
                             // make sure that the template_field_ref matches what the main template field is for this template group.
                             $template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
-                            $templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
+                            $templates[$context][$main_field][$sub_field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
                         }
                     }
                 } else {
-                    $templates[ $context ][ $field ] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
+                    $templates[$context][$field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
                 }
             }
         }
 
         $templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
 
-        $this->_templates[ $messenger->name ][ $message_type->name ] = $templates;
+        $this->_templates[$messenger->name][$message_type->name] = $templates;
          return $templates;
     }
 
@@ -323,13 +323,13 @@ 
         $filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
 
         $master_templates = $message_type->get_master_templates();
-        $master_templates_mt = isset($master_templates[ $messenger->name ]) ? $master_templates[ $messenger->name ] : $message_type->name;
-        $full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
-        $fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
-        $mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-        $base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-        $base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+        $master_templates_mt = isset($master_templates[$messenger->name]) ? $master_templates[$messenger->name] : $message_type->name;
+        $full_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'_'.$context.'.template.php';
+        $fallback_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'.template.php';
+        $mt_defined_full_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+        $mt_defined_fallback_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
+        $base_defined_full_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+        $base_defined_fallback_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
 
         /**
          * Template checks are done hierarchically in the following order:
@@ -359,7 +359,7 @@ 
             $actual_path = '';
         }
         if (empty($actual_path)) {
-            $contents = isset($default_templates[ $context ][ $field ]) ? $default_templates[ $context ][ $field ] : '';
+            $contents = isset($default_templates[$context][$field]) ? $default_templates[$context][$field] : '';
         } else {
             $contents = EEH_Template::display_template($actual_path, array(), true);
         }
@@ -380,7 +380,7 @@ 
      */
     public function get_supports()
     {
-        $supports = apply_filters('FHEE__' . get_class($this) . '__get_supports', $this->_supports);
+        $supports = apply_filters('FHEE__'.get_class($this).'__get_supports', $this->_supports);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
     }
 
@@ -399,7 +399,7 @@ 
     public function get_default_variation_labels($messenger = '')
     {
         $label = empty($messenger) ? $this->_default_variation_labels : array();
-        $label = empty($label) && ! empty($this->_default_variation_labels[ $messenger ]) ? $this->_default_variation_labels[ $messenger ] : esc_html__('Default', 'event_espresso');
+        $label = empty($label) && ! empty($this->_default_variation_labels[$messenger]) ? $this->_default_variation_labels[$messenger] : esc_html__('Default', 'event_espresso');
 
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
     }
@@ -419,24 +419,24 @@ 
      */
     public function get_variations($messenger = '', $message_type = '')
     {
-        $messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
+        $messenger_variations = ! empty($messenger) && isset($this->_variations[$messenger]) ? $this->_variations[$messenger] : array();
 
         // message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-        $variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
+        $variations = ! empty($messenger) && ! empty($message_type) && isset($messenger_variations[$message_type]) ? $messenger_variations[$message_type] : array();
 
         // now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-        $variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
+        $variations = empty($variations) && ! empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
 
         // filter per template pack and globally.
-        $variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
+        $variations = apply_filters('FHEE__'.get_class($this).'__get_variations', $variations, $messenger, $message_type);
         $variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
 
         // prepend the _default_variation, but ONLY if we're returning the fully validated array.
-        if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
-            $variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
+        if ( ! empty($messenger) && ! empty($message_type) && ! empty($variations)) {
+            $variations = array('default' => $this->get_default_variation_labels($messenger)) + $variations;
         }
 
-        return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ) : $variations;
+        return empty($variations) ? array('default' => $this->get_default_variation_labels('dft')) : $variations;
     }
 
 
@@ -463,23 +463,23 @@ 
         $base = $url ? $this->_base_url : $this->_base_path;
         $base_path = $this->_base_path;
 
-        if (! $skip_filters) {
-            $base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+        if ( ! $skip_filters) {
+            $base = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
             $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
         }
 
         $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
 
         // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+        $path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_'.$variation.$file_extension;
+        $default_path_string = 'variations/'.$messenger.'_'.$type.'_'.$variation.$file_extension;
 
         // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
+        if (is_readable($base_path.$path_string)) {
+            $variation_path = $base.$path_string;
         // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
+        } elseif (is_readable($base_path.$default_path_string)) {
+            $variation_path = $base.$default_path_string;
         } else {
             $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
         }
@@ -489,7 +489,7 @@ 
         }
 
         // filter result
-        $variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+        $variation_path = apply_filters('FHEE__'.get_class($this).'__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
     }
 
@@ -509,7 +509,7 @@ 
     {
         $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
 
-        $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+        $path_string = $this->_base_path.$messenger.'_'.$type.'_wrapper.template.php';
 
         if (is_readable($path_string)) {
             $template = $path_string;
@@ -518,7 +518,7 @@ 
         }
 
         // filter
-        $template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
+        $template = apply_filters('FHEE__'.get_class($this).'__get_wrapper', $template, $messenger, $type);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
     }
 }

core/libraries/messages/defaults/EE_Messages_Template_Pack_Default.class.php

Indentation +63 added lines, -63 removed lines

@@ -11,71 +11,71 @@
 class EE_Messages_Template_Pack_Default extends EE_Messages_Template_Pack
 {
 
-    public function _set_props()
-    {
-        $this->label = esc_html__('Default', 'event_espresso');
-        $this->dbref = 'default';
-        $this->description = esc_html__('This is the default template pack included with Event Espresso core messages system.', 'event_espresso');
-        $this->_base_url = EE_PLUGIN_DIR_URL . 'core/libraries/messages/defaults/default/';
-        $this->_base_path = EE_LIBRARIES . 'messages/defaults/default/';
-        $this->_supports = array(
-            'email' => array(
-                'cancelled_registration', 'declined_registration', 'not_approved_registration', 'pending_approval', 'registration',
-                    'registration_summary',
-                'payment_declined', 'payment', 'payment_refund', 'payment_reminder'
-                ),
-            'html' => array(
-                'receipt', 'invoice'
-                )
-            );
-        $this->_default_variation_labels = array(
-            'email' => esc_html__('Default', 'event_espresso'),
-            'html' =>  esc_html__('Simple', 'event_espresso')
-             );
-        $this->_variations = array(
-            'html' => array(
-                'receipt' =>
-                    array(
-                    'bauhaus' => esc_html__('Bauhaus', 'event_espresso'),
-                    'ejs' => esc_html__('Elliot Jay Stocks', 'event_espresso'),
-                    'horizon' => esc_html__('Horizon', 'event_espresso'),
-                    'lola' => esc_html__('Lola', 'event_espresso'),
-                    'tranquility' => esc_html__('Tranquility', 'event_espresso'),
-                    'union' => esc_html__('Union', 'event_espresso'),
-                    ),
-                'invoice' =>
-                    array(
-                    'bauhaus' => esc_html__('Bauhaus', 'event_espresso'),
-                    'ejs' => esc_html__('Elliot Jay Stocks', 'event_espresso'),
-                    'horizon' => esc_html__('Horizon', 'event_espresso'),
-                    'lola' => esc_html__('Lola', 'event_espresso'),
-                    'tranquility' => esc_html__('Tranquility', 'event_espresso'),
-                    'union' => esc_html__('Union', 'event_espresso'),
-                    )
-                )
-            );
-    }
+	public function _set_props()
+	{
+		$this->label = esc_html__('Default', 'event_espresso');
+		$this->dbref = 'default';
+		$this->description = esc_html__('This is the default template pack included with Event Espresso core messages system.', 'event_espresso');
+		$this->_base_url = EE_PLUGIN_DIR_URL . 'core/libraries/messages/defaults/default/';
+		$this->_base_path = EE_LIBRARIES . 'messages/defaults/default/';
+		$this->_supports = array(
+			'email' => array(
+				'cancelled_registration', 'declined_registration', 'not_approved_registration', 'pending_approval', 'registration',
+					'registration_summary',
+				'payment_declined', 'payment', 'payment_refund', 'payment_reminder'
+				),
+			'html' => array(
+				'receipt', 'invoice'
+				)
+			);
+		$this->_default_variation_labels = array(
+			'email' => esc_html__('Default', 'event_espresso'),
+			'html' =>  esc_html__('Simple', 'event_espresso')
+			 );
+		$this->_variations = array(
+			'html' => array(
+				'receipt' =>
+					array(
+					'bauhaus' => esc_html__('Bauhaus', 'event_espresso'),
+					'ejs' => esc_html__('Elliot Jay Stocks', 'event_espresso'),
+					'horizon' => esc_html__('Horizon', 'event_espresso'),
+					'lola' => esc_html__('Lola', 'event_espresso'),
+					'tranquility' => esc_html__('Tranquility', 'event_espresso'),
+					'union' => esc_html__('Union', 'event_espresso'),
+					),
+				'invoice' =>
+					array(
+					'bauhaus' => esc_html__('Bauhaus', 'event_espresso'),
+					'ejs' => esc_html__('Elliot Jay Stocks', 'event_espresso'),
+					'horizon' => esc_html__('Horizon', 'event_espresso'),
+					'lola' => esc_html__('Lola', 'event_espresso'),
+					'tranquility' => esc_html__('Tranquility', 'event_espresso'),
+					'union' => esc_html__('Union', 'event_espresso'),
+					)
+				)
+			);
+	}
 
 
 
-    public function get_default_variation($messenger, $message_type, $type, $url, $file_extension)
-    {
-        $base = $url ? $this->_base_url : $this->_base_path;
-        $base_path = $this->_base_path;
-        // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_default' . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_default' . $file_extension;
-        // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
-        // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
-        } else {
-            // no matches found so nothing is present.
-            $variation_path = '';
-        }
+	public function get_default_variation($messenger, $message_type, $type, $url, $file_extension)
+	{
+		$base = $url ? $this->_base_url : $this->_base_path;
+		$base_path = $this->_base_path;
+		// possible variation paths considering whether message type is present or not in the file name.
+		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_default' . $file_extension;
+		$default_path_string = 'variations/' . $messenger . '_' . $type . '_default' . $file_extension;
+		// first see if fully validated file exists.
+		if (is_readable($base_path . $path_string)) {
+			$variation_path = $base . $path_string;
+		// otherwise see if default exists.
+		} elseif (is_readable($base_path . $default_path_string)) {
+			$variation_path = $base . $default_path_string;
+		} else {
+			// no matches found so nothing is present.
+			$variation_path = '';
+		}
 
-        return $variation_path;
-    }
+		return $variation_path;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -16,8 +16,8 @@ 
         $this->label = esc_html__('Default', 'event_espresso');
         $this->dbref = 'default';
         $this->description = esc_html__('This is the default template pack included with Event Espresso core messages system.', 'event_espresso');
-        $this->_base_url = EE_PLUGIN_DIR_URL . 'core/libraries/messages/defaults/default/';
-        $this->_base_path = EE_LIBRARIES . 'messages/defaults/default/';
+        $this->_base_url = EE_PLUGIN_DIR_URL.'core/libraries/messages/defaults/default/';
+        $this->_base_path = EE_LIBRARIES.'messages/defaults/default/';
         $this->_supports = array(
             'email' => array(
                 'cancelled_registration', 'declined_registration', 'not_approved_registration', 'pending_approval', 'registration',
@@ -63,14 +63,14 @@ 
         $base = $url ? $this->_base_url : $this->_base_path;
         $base_path = $this->_base_path;
         // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_default' . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_default' . $file_extension;
+        $path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_default'.$file_extension;
+        $default_path_string = 'variations/'.$messenger.'_'.$type.'_default'.$file_extension;
         // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
+        if (is_readable($base_path.$path_string)) {
+            $variation_path = $base.$path_string;
         // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
+        } elseif (is_readable($base_path.$default_path_string)) {
+            $variation_path = $base.$default_path_string;
         } else {
             // no matches found so nothing is present.
             $variation_path = '';

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>' . esc_html__(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.esc_html__(
                             '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>' . esc_html__(
+                        'label' => '[TICKET_LINE_ITEM_LIST] <br>'.esc_html__(
                             '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 = esc_html__('This messenger outputs a message to a browser for display.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('html', 'event_espresso'),
-            'plural' => esc_html__('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' => esc_html__('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' => 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]'),
-                    ),
-                    '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>' . esc_html__(
-                            '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>' . esc_html__(
-                            '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(); // already escaped
-        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 = esc_html__('This messenger outputs a message to a browser for display.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('html', 'event_espresso'),
+			'plural' => esc_html__('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' => esc_html__('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' => 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]'),
+					),
+					'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>' . esc_html__(
+							'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>' . esc_html__(
+							'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(); // already escaped
+		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_messenger.lib.php

Indentation +735 added lines, -735 removed lines

@@ -19,182 +19,182 @@ 
 
 
 
-    /**
-     * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
-     * This property gets set by the _set_default_message_types() method.
-     *
-     * @var array
-     */
-    protected $_default_message_types = array();
+	/**
+	 * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
+	 * This property gets set by the _set_default_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_default_message_types = array();
 
 
 
 
-    /**
-     * This property holds the message types that are valid for use with this messenger.
-     * It gets set by the _set_valid_message_types() method.
-     *
-     * @var array
-     */
-    protected $_valid_message_types = array();
+	/**
+	 * This property holds the message types that are valid for use with this messenger.
+	 * It gets set by the _set_valid_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_message_types = array();
 
 
 
-    /**
-     * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
-     *
-     * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
-     *
-     * Array should be in this format:
-     *
-     * array(
-     *  'field_name(i.e.to)' => array(
-     *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
-     *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => esc_html__('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
-     *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
-     *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
-     *  )
-     * )
-     *
-     * @var array
-     */
-    protected $_validator_config = array();
+	/**
+	 * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
+	 *
+	 * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
+	 *
+	 * Array should be in this format:
+	 *
+	 * array(
+	 *  'field_name(i.e.to)' => array(
+	 *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
+	 *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => esc_html__('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
+	 *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
+	 *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_validator_config = array();
 
 
 
-    /**
-     * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
-     * @var object
-     */
-    protected $_EEM_data;
+	/**
+	 * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
+	 * @var object
+	 */
+	protected $_EEM_data;
 
 
 
-    /**
-     * this property just holds an array of the various template refs.
-     * @var array
-     */
-    protected $_template_fields = array();
+	/**
+	 * this property just holds an array of the various template refs.
+	 * @var array
+	 */
+	protected $_template_fields = array();
 
 
 
 
-    /**
-     * This holds an array of the arguments used in parsing a template for the sender.
-     * @var array
-     */
-    protected $_template_args = array();
+	/**
+	 * This holds an array of the arguments used in parsing a template for the sender.
+	 * @var array
+	 */
+	protected $_template_args = array();
 
 
 
 
 
 
-    /**
-     * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
-     *
-     * @protected
-     * @var array
-     */
-    protected $_test_settings_fields = array();
+	/**
+	 * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
+	 *
+	 * @protected
+	 * @var array
+	 */
+	protected $_test_settings_fields = array();
 
 
 
 
 
 
-    /**
-     * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_tmp_pack;
+	/**
+	 * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_tmp_pack;
 
 
 
 
-    /**
-     * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
+	/**
+	 * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
 
 
 
 
 
-    /**
-     * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
-     *
-     *  - template pack
-     *  - template variation
-     *
-     * @since 4.5.0
-     *
-     * @var stdClass
-     */
-    protected $_supports_labels;
+	/**
+	 * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
+	 *
+	 *  - template pack
+	 *  - template variation
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var stdClass
+	 */
+	protected $_supports_labels;
 
 
 
 
 
-    /**
-     * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
-     *
-     * @var EE_message_type
-     */
-    protected $_incoming_message_type;
+	/**
+	 * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_incoming_message_type;
 
 
 
-    /**
-     * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
-     *
-     * @var bool
-     */
-    public $activate_on_install = false;
+	/**
+	 * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
+	 *
+	 * @var bool
+	 */
+	public $activate_on_install = false;
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_EEM_data = EEM_Message_Template_Group::instance();
-        $this->_messages_item_type = 'messenger';
+	public function __construct()
+	{
+		$this->_EEM_data = EEM_Message_Template_Group::instance();
+		$this->_messages_item_type = 'messenger';
 
-        parent::__construct();
+		parent::__construct();
 
-        $this->_set_test_settings_fields();
-        $this->_set_template_fields();
-        $this->_set_default_message_types();
-        $this->_set_valid_message_types();
-        $this->_set_validator_config();
+		$this->_set_test_settings_fields();
+		$this->_set_template_fields();
+		$this->_set_default_message_types();
+		$this->_set_valid_message_types();
+		$this->_set_validator_config();
 
 
-        $this->_supports_labels = new stdClass();
-        $this->_set_supports_labels();
-    }
+		$this->_supports_labels = new stdClass();
+		$this->_set_supports_labels();
+	}
 
 
 
 
 
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @abstract
-     * @access  protected
-     * @return void
-     */
-    abstract protected function _set_template_fields();
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return void
+	 */
+	abstract protected function _set_template_fields();
 
 
 
@@ -204,14 +204,14 @@ 
 
 
 
-    /**
-     * This method sets the _default_message_type property (see definition in docs attached to property)
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_default_message_types();
+	/**
+	 * This method sets the _default_message_type property (see definition in docs attached to property)
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_default_message_types();
 
 
 
@@ -219,15 +219,15 @@ 
 
 
 
-    /**
-     * Sets the _valid_message_types property (see definition in cods attached to property)
-     *
-     * @since 4.5.0
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_valid_message_types();
+	/**
+	 * Sets the _valid_message_types property (see definition in cods attached to property)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_valid_message_types();
 
 
 
@@ -235,171 +235,171 @@ 
 
 
 
-    /**
-     * Child classes must declare the $_validator_config property using this method.
-     * See comments for $_validator_config for details on what it is used for.
-     *
-     * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_validator_config();
+	/**
+	 * Child classes must declare the $_validator_config property using this method.
+	 * See comments for $_validator_config for details on what it is used for.
+	 *
+	 * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_validator_config();
 
 
 
 
 
 
-    /**
-     * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
-     *
-     * @return bool|WP_Error
-     * @throw \Exception
-     */
-    abstract protected function _send_message();
+	/**
+	 * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
+	 *
+	 * @return bool|WP_Error
+	 * @throw \Exception
+	 */
+	abstract protected function _send_message();
 
 
 
 
-    /**
-     * We give you pretty previews of the messages!
-     * @return string html body for message content.
-     */
-    abstract protected function _preview();
+	/**
+	 * We give you pretty previews of the messages!
+	 * @return string html body for message content.
+	 */
+	abstract protected function _preview();
 
 
 
 
-    /**
-     * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-        do_action('AHEE__EE_messenger__enqueue_scripts_styles');
-    }
+	/**
+	 * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+		do_action('AHEE__EE_messenger__enqueue_scripts_styles');
+	}
 
 
 
 
 
-    /**
-     * This is used to indicate whether a messenger must be sent immediately or not.
-     * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
-     * away.  The PDF messenger is similar.
-     *
-     * This flag thus overrides any priorities that may be set on the message type used to generate the message.
-     *
-     * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
-     *
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return false;
-    }
+	/**
+	 * This is used to indicate whether a messenger must be sent immediately or not.
+	 * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
+	 * away.  The PDF messenger is similar.
+	 *
+	 * This flag thus overrides any priorities that may be set on the message type used to generate the message.
+	 *
+	 * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
+	 *
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * This is a way for a messenger to indicate whether it allows an empty to field or not.
-     * Note: If the generated message is a for a preview, this value is ignored.
-     * @since 4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return false;
-    }
+	/**
+	 * This is a way for a messenger to indicate whether it allows an empty to field or not.
+	 * Note: If the generated message is a for a preview, this value is ignored.
+	 * @since 4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
-     * @see property definition for info on how its formatted.
-     *
-     * @since 4.5.0;
-     * @return void
-     */
-    protected function _set_supports_labels()
-    {
-        $this->_set_supports_labels_defaults();
-    }
+	/**
+	 * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
+	 * @see property definition for info on how its formatted.
+	 *
+	 * @since 4.5.0;
+	 * @return void
+	 */
+	protected function _set_supports_labels()
+	{
+		$this->_set_supports_labels_defaults();
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    private function _set_supports_labels_defaults()
-    {
-        $this->_supports_labels->template_pack = esc_html__('Template Structure', 'event_espresso');
-        $this->_supports_labels->template_variation = esc_html__('Template Style', 'event_espresso');
-        $this->_supports_labels->template_pack_description = esc_html__('Template Structure options are bundled structural changes for templates.', 'event_espresso');
+	/**
+	 * Sets the defaults for the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	private function _set_supports_labels_defaults()
+	{
+		$this->_supports_labels->template_pack = esc_html__('Template Structure', 'event_espresso');
+		$this->_supports_labels->template_variation = esc_html__('Template Style', 'event_espresso');
+		$this->_supports_labels->template_pack_description = esc_html__('Template Structure options are bundled structural changes for templates.', 'event_espresso');
 
-        $this->_supports_labels->template_variation_description = esc_html__('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
+		$this->_supports_labels->template_variation_description = esc_html__('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
 
-        $this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
-    }
+		$this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
 
-    /**
-     * This returns the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return stdClass
-     */
-    public function get_supports_labels()
-    {
-        if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
-            $this->_set_supports_labels_defaults();
-        }
-        return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
-    }
+	/**
+	 * This returns the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return stdClass
+	 */
+	public function get_supports_labels()
+	{
+		if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
+			$this->_set_supports_labels_defaults();
+		}
+		return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
-    /**
-     * Used to retrieve a variation (typically the path/url to a css file)
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
-     * @param string                    $message_type_name The name property of the message type that we need the variation for.
-     * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
-     * @param string                    $type What variation type to return. Default is 'main'.
-     * @param string               $variation What variation for the template pack
-     * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
-     *
-     * @return string                    path or url for the requested variation.
-     */
-    public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
-    {
-        $this->_tmp_pack = $pack;
-        $variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
-        $variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
-        return $variation_path;
-    }
+	/**
+	 * Used to retrieve a variation (typically the path/url to a css file)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
+	 * @param string                    $message_type_name The name property of the message type that we need the variation for.
+	 * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
+	 * @param string                    $type What variation type to return. Default is 'main'.
+	 * @param string               $variation What variation for the template pack
+	 * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
+	 *
+	 * @return string                    path or url for the requested variation.
+	 */
+	public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
+	{
+		$this->_tmp_pack = $pack;
+		$variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
+		$variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
+		return $variation_path;
+	}
 
 
 
@@ -407,492 +407,492 @@ 
 
 
 
-    /**
-     * This just returns the default message types associated with this messenger when it is first activated.
-     *
-     * @access public
-     * @return array
-     */
-    public function get_default_message_types()
-    {
-        $class = get_class($this);
+	/**
+	 * This just returns the default message types associated with this messenger when it is first activated.
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_default_message_types()
+	{
+		$class = get_class($this);
 
-        // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+		// messenger specific filter
+		$default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
 
-        // all messengers filter
-        $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
-        return $default_types;
-    }
+		// all messengers filter
+		$default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
+		return $default_types;
+	}
 
 
 
 
-    /**
-     * Returns the valid message types associated with this messenger.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    public function get_valid_message_types()
-    {
-        $class = get_class($this);
-
-        // messenger specific filter
-        // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
-
-        // all messengers filter
-        $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
-        return $valid_types;
-    }
-
-
-
-
-
-    /**
-     * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
-     *
-     * @access public
-     * @param array $new_config Whatever is put in here will reset the _validator_config property
-     */
-    public function set_validator_config($new_config)
-    {
-        $this->_validator_config = $new_config;
-    }
-
-
-
-
-    /**
-     * This returns the _validator_config property
-     *
-     * @access public
-     * @return array
-     */
-    public function get_validator_config()
-    {
-        $class = get_class($this);
-
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
-        $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
-        return $config;
-    }
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $message_types an array of active message type objects
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
-     * @access public
-     * @return string content for page
-     */
-    public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
-    {
-        return $this->_get_admin_page_content($page, $action, $extra, $message_types);
-    }
-
-
-
-    /**
-     * @param $message_types
-     * @param array $extra
-     * @return mixed|string
-     */
-    protected function _get_admin_content_events_edit($message_types, $extra)
-    {
-        // defaults
-        $template_args = array();
-        $selector_rows = '';
-
-        // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
-        $event_id = isset($extra['event']) ? $extra['event'] : null;
-
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
-
-        // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
-        $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
-        );
-        $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
-            $event_id,
-            array(
-                'MTP_messenger' => $this->name,
-                'MTP_is_active' => true
-            )
-        );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
-
-        // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
-        foreach ($global_templates as $mtpgID => $mtpg) {
-            if ($mtpg instanceof EE_Message_Template_Group) {
-                // verify this message type is supposed to show on this page
-                $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
-                    continue;
-                }
-                $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
-                    continue;
-                }
-                $select_values = array();
-                $select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
-                $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
-                // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
-                    // any custom templates for this message type?
-                    $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
-                    foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
-                        $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
-                    }
-                }
-                // if there is no $default_value then we set it as the global
-                $default_value = empty($default_value) ? $mtpgID : $default_value;
-                $edit_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'edit_message_template',
-                    'id' => $default_value,
-                    'evt_id' => $event_id
-                ];
-                $edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
-                $create_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'add_new_message_template',
-                    'GRP_ID' => $default_value
-                ];
-                $create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
-                $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
-                $st_args['mt_slug'] = $mtpg->message_type();
-                $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
-                // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . esc_html__('Create New Custom', 'event_espresso') . '</a>';
-                $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
-                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . esc_html__('Edit', 'event_espresso') . '</a>' : '';
-                $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
-            }
-        }
-
-        // if no selectors present then get out.
-        if (empty($selector_rows)) {
-            return '';
-        }
-
-        $template_args['selector_rows'] = $selector_rows;
-        return EEH_Template::display_template($template_wrapper_path, $template_args, true);
-    }
-
-
-
-
-
-
-    /**
-     * get_template_fields
-     *
-     * @access public
-     * @return array $this->_template_fields
-     */
-    public function get_template_fields()
-    {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
-        $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
-        return $template_fields;
-    }
-
-
-
-
-    /** SETUP METHODS **/
-    /**
-     * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
-     * @param string $item
-     * @param mixed $value
-     */
-    protected function _set_template_value($item, $value)
-    {
-        if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
-            $this->{$prop} = $value;
-        }
-    }
-
-    /**
-     * Sets up the message for sending.
-     *
-     * @param  EE_message $message the message object that contains details about the message.
-     * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
-     *
-     * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
-     *              added to EE_Error.
-     *              true = message sent successfully
-     *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
-     *              Throwing a SendMessageException means the message failed sending and cannot be retried.
-     *
-     * @throws SendMessageException
-     */
-    final public function send_message($message, EE_message_type $message_type)
-    {
-        try {
-            $this->_validate_and_setup($message);
-            $this->_incoming_message_type = $message_type;
-            $response = $this->_send_message();
-            if ($response instanceof WP_Error) {
-                EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
-                $response = false;
-            }
-        } catch (\Exception $e) {
-            // convert to an instance of SendMessageException
-            throw new SendMessageException($e->getMessage());
-        }
-        return $response;
-    }
-
-
-
-    /**
-     * Sets up and returns message preview
-     * @param  EE_Message $message incoming message object
-     * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
-     * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
-     * @return string          return the message html content
-     */
-    public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
-    {
-        $this->_validate_and_setup($message);
-
-        $this->_incoming_message_type = $message_type;
-
-        if ($send) {
-            // are we overriding any existing template fields?
-            $settings = apply_filters(
-                'FHEE__EE_messenger__get_preview__messenger_test_settings',
-                $this->get_existing_test_settings(),
-                $this,
-                $send,
-                $message,
-                $message_type
-            );
-            if (! empty($settings)) {
-                foreach ($settings as $field => $value) {
-                    $this->_set_template_value($field, $value);
-                }
-            }
-        }
-
-        // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
-            // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
-            // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
-        }
-
-        return $send ? $this->_send_message() : $this->_preview();
-    }
-
-
-
-
-    /**
-     * Callback for enqueue_scripts so that we setup the preview script for all previews.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function add_preview_script()
-    {
-        // error message
-        EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
-            __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
-        );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
-        wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
-        wp_enqueue_script('ee-messages-preview-js');
-    }
-
-
-
-
-    /**
-     * simply validates the incoming message object and then sets up the properties for the messenger
-     * @param  EE_Message $message
-     * @throws EE_Error
-     */
-    protected function _validate_and_setup(EE_Message $message)
-    {
-        $template_pack = $message->get_template_pack();
-        $variation = $message->get_template_pack_variation();
-
-        // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
-            throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
-        }
-
-        $this->_tmp_pack = $template_pack;
-
-        $this->_variation = $variation ? $variation : 'default';
-
-        $template_fields = $this->get_template_fields();
-
-        foreach ($template_fields as $template => $value) {
-            if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
-                $message_template_value = $column_value ? $column_value : null;
-                $this->_set_template_value($template, $message_template_value);
-            }
-        }
-    }
-
-
-
-    /**
-     * Utility method for child classes to get the contents of a template file and return
-     *
-     * We're assuming the child messenger class has already setup template args!
-     * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $type = $preview ? 'preview' : 'main';
-
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
-
-        // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
-            throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
-        }
-
-        // add message type to template args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-
-    /**
-     * set the _test_settings_fields property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array();
-    }
-
-
-
-    /**
-     * return the _test_settings_fields property
-     * @return array
-     */
-    public function get_test_settings_fields()
-    {
-        return $this->_test_settings_fields;
-    }
-
-
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
-    }
-
-
-
-    /**
-     * All this does is set the existing test settings (in the db) for the messenger
-     *
-     * @access public
-     * @param $settings
-     * @return bool success/fail
-     */
-    public function set_existing_test_settings($settings)
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
-        return $Message_Resource_Manager->update_active_messengers_option($existing);
-    }
-
-
-
-    /**
-     * This just returns the field label for a given field setup in the _template_fields property.
-     *
-     * @since   4.3.0
-     *
-     * @param string $field The field to retrieve the label for
-     * @return string             The label
-     */
-    public function get_field_label($field)
-    {
-        // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
-        }
-
-        // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
-        }
-
-        // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
-            foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
-                    continue;
-                }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
-                }
-            }
-        }
-
-        // if we made it here then there's no label set so let's just return the $field.
-        return $field;
-    }
-
-
-
-
-    /**
-     * 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)
-    {
-        return;
-    }
+	/**
+	 * Returns the valid message types associated with this messenger.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	public function get_valid_message_types()
+	{
+		$class = get_class($this);
+
+		// messenger specific filter
+		// messenger specific filter
+		$valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+
+		// all messengers filter
+		$valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
+		return $valid_types;
+	}
+
+
+
+
+
+	/**
+	 * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
+	 *
+	 * @access public
+	 * @param array $new_config Whatever is put in here will reset the _validator_config property
+	 */
+	public function set_validator_config($new_config)
+	{
+		$this->_validator_config = $new_config;
+	}
+
+
+
+
+	/**
+	 * This returns the _validator_config property
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_validator_config()
+	{
+		$class = get_class($this);
+
+		$config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+		$config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
+		return $config;
+	}
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $message_types an array of active message type objects
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
+	 * @access public
+	 * @return string content for page
+	 */
+	public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
+	{
+		return $this->_get_admin_page_content($page, $action, $extra, $message_types);
+	}
+
+
+
+	/**
+	 * @param $message_types
+	 * @param array $extra
+	 * @return mixed|string
+	 */
+	protected function _get_admin_content_events_edit($message_types, $extra)
+	{
+		// defaults
+		$template_args = array();
+		$selector_rows = '';
+
+		// we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
+		$event_id = isset($extra['event']) ? $extra['event'] : null;
+
+		$template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+		$template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+
+		// array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
+		$global_templates = EEM_Message_Template_Group::instance()->get_all(
+			array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+		);
+		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
+			$event_id,
+			array(
+				'MTP_messenger' => $this->name,
+				'MTP_is_active' => true
+			)
+		);
+		$templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+
+		// so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
+		foreach ($global_templates as $mtpgID => $mtpg) {
+			if ($mtpg instanceof EE_Message_Template_Group) {
+				// verify this message type is supposed to show on this page
+				$mtp_obj = $mtpg->message_type_obj();
+				if (! $mtp_obj instanceof EE_message_type) {
+					continue;
+				}
+				$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
+				if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+					continue;
+				}
+				$select_values = array();
+				$select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
+				$default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
+				// if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
+				if (! $mtpg->get('MTP_is_override')) {
+					// any custom templates for this message type?
+					$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
+					foreach ($custom_templates as $cmtpgID => $cmtpg) {
+						$select_values[ $cmtpgID ] = $cmtpg->name();
+						$default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
+					}
+				}
+				// if there is no $default_value then we set it as the global
+				$default_value = empty($default_value) ? $mtpgID : $default_value;
+				$edit_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'edit_message_template',
+					'id' => $default_value,
+					'evt_id' => $event_id
+				];
+				$edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
+				$create_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'add_new_message_template',
+					'GRP_ID' => $default_value
+				];
+				$create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
+				$st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
+				$st_args['mt_slug'] = $mtpg->message_type();
+				$st_args['messenger_slug'] = $this->name;
+				$st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
+				// note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
+				$st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . esc_html__('Create New Custom', 'event_espresso') . '</a>';
+				$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
+				$st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . esc_html__('Edit', 'event_espresso') . '</a>' : '';
+				$selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
+			}
+		}
+
+		// if no selectors present then get out.
+		if (empty($selector_rows)) {
+			return '';
+		}
+
+		$template_args['selector_rows'] = $selector_rows;
+		return EEH_Template::display_template($template_wrapper_path, $template_args, true);
+	}
+
+
+
+
+
+
+	/**
+	 * get_template_fields
+	 *
+	 * @access public
+	 * @return array $this->_template_fields
+	 */
+	public function get_template_fields()
+	{
+		$template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+		$template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
+		return $template_fields;
+	}
+
+
+
+
+	/** SETUP METHODS **/
+	/**
+	 * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
+	 * @param string $item
+	 * @param mixed $value
+	 */
+	protected function _set_template_value($item, $value)
+	{
+		if (array_key_exists($item, $this->_template_fields)) {
+			$prop = '_' . $item;
+			$this->{$prop} = $value;
+		}
+	}
+
+	/**
+	 * Sets up the message for sending.
+	 *
+	 * @param  EE_message $message the message object that contains details about the message.
+	 * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
+	 *
+	 * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
+	 *              added to EE_Error.
+	 *              true = message sent successfully
+	 *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
+	 *              Throwing a SendMessageException means the message failed sending and cannot be retried.
+	 *
+	 * @throws SendMessageException
+	 */
+	final public function send_message($message, EE_message_type $message_type)
+	{
+		try {
+			$this->_validate_and_setup($message);
+			$this->_incoming_message_type = $message_type;
+			$response = $this->_send_message();
+			if ($response instanceof WP_Error) {
+				EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
+				$response = false;
+			}
+		} catch (\Exception $e) {
+			// convert to an instance of SendMessageException
+			throw new SendMessageException($e->getMessage());
+		}
+		return $response;
+	}
+
+
+
+	/**
+	 * Sets up and returns message preview
+	 * @param  EE_Message $message incoming message object
+	 * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
+	 * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
+	 * @return string          return the message html content
+	 */
+	public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
+	{
+		$this->_validate_and_setup($message);
+
+		$this->_incoming_message_type = $message_type;
+
+		if ($send) {
+			// are we overriding any existing template fields?
+			$settings = apply_filters(
+				'FHEE__EE_messenger__get_preview__messenger_test_settings',
+				$this->get_existing_test_settings(),
+				$this,
+				$send,
+				$message,
+				$message_type
+			);
+			if (! empty($settings)) {
+				foreach ($settings as $field => $value) {
+					$this->_set_template_value($field, $value);
+				}
+			}
+		}
+
+		// enqueue preview js so that any links/buttons on the page are disabled.
+		if (! $send) {
+			// the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
+			// it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
+			add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+		}
+
+		return $send ? $this->_send_message() : $this->_preview();
+	}
+
+
+
+
+	/**
+	 * Callback for enqueue_scripts so that we setup the preview script for all previews.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function add_preview_script()
+	{
+		// error message
+		EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
+			__('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
+		);
+		wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+		wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
+		wp_enqueue_script('ee-messages-preview-js');
+	}
+
+
+
+
+	/**
+	 * simply validates the incoming message object and then sets up the properties for the messenger
+	 * @param  EE_Message $message
+	 * @throws EE_Error
+	 */
+	protected function _validate_and_setup(EE_Message $message)
+	{
+		$template_pack = $message->get_template_pack();
+		$variation = $message->get_template_pack_variation();
+
+		// verify we have the required template pack value on the $message object.
+		if (! $template_pack instanceof EE_Messages_Template_Pack) {
+			throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
+		}
+
+		$this->_tmp_pack = $template_pack;
+
+		$this->_variation = $variation ? $variation : 'default';
+
+		$template_fields = $this->get_template_fields();
+
+		foreach ($template_fields as $template => $value) {
+			if ($template !== 'extra') {
+				$column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+				$message_template_value = $column_value ? $column_value : null;
+				$this->_set_template_value($template, $message_template_value);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Utility method for child classes to get the contents of a template file and return
+	 *
+	 * We're assuming the child messenger class has already setup template args!
+	 * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$type = $preview ? 'preview' : 'main';
+
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
+
+		// check file exists and is readable
+		if (!is_readable($wrapper_template)) {
+			throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
+		}
+
+		// add message type to template args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+
+	/**
+	 * set the _test_settings_fields property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array();
+	}
+
+
+
+	/**
+	 * return the _test_settings_fields property
+	 * @return array
+	 */
+	public function get_test_settings_fields()
+	{
+		return $this->_test_settings_fields;
+	}
+
+
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$settings = $Message_Resource_Manager->get_active_messengers_option();
+		return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+	}
+
+
+
+	/**
+	 * All this does is set the existing test settings (in the db) for the messenger
+	 *
+	 * @access public
+	 * @param $settings
+	 * @return bool success/fail
+	 */
+	public function set_existing_test_settings($settings)
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$existing = $Message_Resource_Manager->get_active_messengers_option();
+		$existing[ $this->name ]['test_settings'] = $settings;
+		return $Message_Resource_Manager->update_active_messengers_option($existing);
+	}
+
+
+
+	/**
+	 * This just returns the field label for a given field setup in the _template_fields property.
+	 *
+	 * @since   4.3.0
+	 *
+	 * @param string $field The field to retrieve the label for
+	 * @return string             The label
+	 */
+	public function get_field_label($field)
+	{
+		// first let's see if the field requests is in the top level array.
+		if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
+			return $this->_template[ $field ]['label'];
+		}
+
+		// nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
+		if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
+			return $this->_template_fields['extra'][ $field ]['main']['label'];
+		}
+
+		// now it's possible this field may just be existing in any of the extra array items.
+		if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+			foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
+				if (!is_array($subfields)) {
+					continue;
+				}
+				if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
+					return $subfields[ $field ]['label'];
+				}
+			}
+		}
+
+		// if we made it here then there's no label set so let's just return the $field.
+		return $field;
+	}
+
+
+
+
+	/**
+	 * 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)
+	{
+		return;
+	}
 }

Spacing +36 added lines, -36 removed lines

@@ -418,7 +418,7 @@ 
         $class = get_class($this);
 
         // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+        $default_types = apply_filters('FHEE__'.$class.'__get_default_message_types__default_types', $this->_default_message_types, $this);
 
         // all messengers filter
         $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
@@ -441,7 +441,7 @@ 
 
         // messenger specific filter
         // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+        $valid_types = apply_filters('FHEE__'.$class.'__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
 
         // all messengers filter
         $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
@@ -476,7 +476,7 @@ 
     {
         $class = get_class($this);
 
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+        $config = apply_filters('FHEE__'.$class.'__get_validator_config', $this->_validator_config, $this);
         $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
         return $config;
     }
@@ -515,12 +515,12 @@ 
         // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
         $event_id = isset($extra['event']) ? $extra['event'] : null;
 
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+        $template_wrapper_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+        $template_row_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_row.template.php';
 
         // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
         $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+            array(array('MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true))
         );
         $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
             $event_id,
@@ -529,29 +529,29 @@ 
                 'MTP_is_active' => true
             )
         );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+        $templates_for_event = ! empty($templates_for_event) ? $templates_for_event : array();
 
         // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
         foreach ($global_templates as $mtpgID => $mtpg) {
             if ($mtpg instanceof EE_Message_Template_Group) {
                 // verify this message type is supposed to show on this page
                 $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
+                if ( ! $mtp_obj instanceof EE_message_type) {
                     continue;
                 }
                 $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+                if ( ! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
                     continue;
                 }
                 $select_values = array();
-                $select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
+                $select_values[$mtpgID] = esc_html__('Global', 'event_espresso');
                 $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
                 // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
+                if ( ! $mtpg->get('MTP_is_override')) {
                     // any custom templates for this message type?
                     $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
                     foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
+                        $select_values[$cmtpgID] = $cmtpg->name();
                         $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
                     }
                 }
@@ -573,11 +573,11 @@ 
                 $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
                 $st_args['mt_slug'] = $mtpg->message_type();
                 $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector');
+                $st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation['.$mtpgID.']', $select_values, $default_value, 'data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'"', 'message-template-selector');
                 // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . esc_html__('Create New Custom', 'event_espresso') . '</a>';
+                $st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$create_url.'" class="button button-small create-mtpg-button">'.esc_html__('Create New Custom', 'event_espresso').'</a>';
                 $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messages_add_new_message_template') ? $st_args['create_button'] : '';
-                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . esc_html__('Edit', 'event_espresso') . '</a>' : '';
+                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$edit_url.'" class="button button-small edit-mtpg-button">'.esc_html__('Edit', 'event_espresso').'</a>' : '';
                 $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
             }
         }
@@ -604,7 +604,7 @@ 
      */
     public function get_template_fields()
     {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+        $template_fields = apply_filters('FHEE__'.get_class($this).'__get_template_fields', $this->_template_fields, $this);
         $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
         return $template_fields;
     }
@@ -621,7 +621,7 @@ 
     protected function _set_template_value($item, $value)
     {
         if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
+            $prop = '_'.$item;
             $this->{$prop} = $value;
         }
     }
@@ -682,7 +682,7 @@ 
                 $message,
                 $message_type
             );
-            if (! empty($settings)) {
+            if ( ! empty($settings)) {
                 foreach ($settings as $field => $value) {
                     $this->_set_template_value($field, $value);
                 }
@@ -690,12 +690,12 @@ 
         }
 
         // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
+        if ( ! $send) {
             // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
             // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+            add_action('admin_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('wp_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array($this, 'add_preview_script'), 10);
         }
 
         return $send ? $this->_send_message() : $this->_preview();
@@ -717,7 +717,7 @@ 
         EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
             __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
         );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL.'messages/messenger/assets/js/ee-messages-preview.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
         wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
         wp_enqueue_script('ee-messages-preview-js');
     }
@@ -736,7 +736,7 @@ 
         $variation = $message->get_template_pack_variation();
 
         // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack) {
             throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
         }
 
@@ -748,7 +748,7 @@ 
 
         foreach ($template_fields as $template => $value) {
             if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+                $column_value = $message->get_field_or_extra_meta('MSG_'.$template);
                 $message_template_value = $column_value ? $column_value : null;
                 $this->_set_template_value($template, $message_template_value);
             }
@@ -772,7 +772,7 @@ 
         $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
 
         // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
+        if ( ! is_readable($wrapper_template)) {
             throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
         }
 
@@ -820,7 +820,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+        return isset($settings[$this->name]['test_settings']) ? $settings[$this->name]['test_settings'] : array();
     }
 
 
@@ -837,7 +837,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
+        $existing[$this->name]['test_settings'] = $settings;
         return $Message_Resource_Manager->update_active_messengers_option($existing);
     }
 
@@ -854,23 +854,23 @@ 
     public function get_field_label($field)
     {
         // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
+        if (isset($this->_template_fields[$field]) && ! empty($this->_template_fields[$field]['label'])) {
+            return $this->_template[$field]['label'];
         }
 
         // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
+        if (isset($this->_template_fields['extra']) && ! empty($this->_template_fields['extra'][$field]) && ! empty($this->_template_fields['extra'][$field]['main']['label'])) {
+            return $this->_template_fields['extra'][$field]['main']['label'];
         }
 
         // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+        if ( ! empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
             foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
+                if ( ! is_array($subfields)) {
                     continue;
                 }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
+                if (isset($subfields[$field]) && ! empty($subfields[$field]['label'])) {
+                    return $subfields[$field]['label'];
                 }
             }
         }

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(esc_html__('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(esc_html__('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(esc_html__('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/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 = esc_html__('This message type is used for all payment notification messages that go out for refunds.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('refund issued', 'event_espresso'),
-            'plural' => esc_html__('refunds issued', 'event_espresso')
-            );
+		// setup type details for reference
+		$this->name = 'payment_refund';
+		$this->description = esc_html__('This message type is used for all payment notification messages that go out for refunds.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('refund issued', 'event_espresso'),
+			'plural' => esc_html__('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' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('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' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('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' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive on a successful refund.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('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' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive on a successful refund.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful refund.', 'event_espresso')
+				)
+			);
+	}
 }

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

Indentation +39 added lines, -39 removed lines

@@ -14,48 +14,48 @@
 class EE_Registration_message_type extends EE_Registration_Base_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'registration';
-        $this->description = esc_html__('This message type is for messages sent to attendees when their registration is approved.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('registration approved', 'event_espresso'),
-            'plural' => esc_html__('registrations approved', 'event_espresso')
-            );
+	public function __construct()
+	{
+		$this->name = 'registration';
+		$this->description = esc_html__('This message type is for messages sent to attendees when their registration is approved.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('registration approved', 'event_espresso'),
+			'plural' => esc_html__('registrations approved', 'event_espresso')
+			);
 
-        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' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different registration 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' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different registration details sent out depending on who the recipient is', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive with an approved registration', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive with approved registration', 'event_espresso')
-                ),
-            'attendee' => array(
-                'label' => esc_html__('Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what each registrant for the event will receive when their registration is approved.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive with an approved registration', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive with approved registration', 'event_espresso')
+				),
+			'attendee' => array(
+				'label' => esc_html__('Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what each registrant for the event will receive when their registration is approved.', 'event_espresso')
+				)
+			);
+	}
 }

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

Indentation +46 added lines, -46 removed lines

@@ -14,59 +14,59 @@
 class EE_Pending_Approval_message_type extends EE_Registration_Base_message_type
 {
 
-    public function __construct()
-    {
-        $this->name = 'pending_approval';
-        $this->description = esc_html__('This message type is used for recipients who have Pending Payment registration status.', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('registration pending payment', 'event_espresso'),
-            'plural' => esc_html__('registrations pending payment', 'event_espresso')
-            );
+	public function __construct()
+	{
+		$this->name = 'pending_approval';
+		$this->description = esc_html__('This message type is used for recipients who have Pending Payment registration status.', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('registration pending payment', 'event_espresso'),
+			'plural' => esc_html__('registrations pending payment', 'event_espresso')
+			);
 
-        $this->_master_templates = array(
-            'email' => 'registration'
-            );
+		$this->_master_templates = array(
+			'email' => 'registration'
+			);
 
-        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' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different pending approval details sent out depending on who the recipient is.  To "turn off" a recipient from receiving message, simply remove any content from the "to" field in the template.', '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' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different pending approval details sent out depending on who the recipient is.  To "turn off" a recipient from receiving message, simply remove any content from the "to" field in the template.', 'event_espresso')
+			);
 
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive when a message is sent to registrants with the pending payment registration status.', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive on when their registration status is pending payment.', 'event_espresso')
-                )
-            );
-    }
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive when a message is sent to registrants with the pending payment registration status.', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who completed the initial transaction) will receive on when their registration status is pending payment.', 'event_espresso')
+				)
+			);
+	}
 
 
 
-    protected function _primary_attendee_addressees()
-    {
-        $cached = $this->_single_message;
-        $this->_single_message = false;
-        $addressees = parent::_primary_attendee_addressees();
-        $this->_single_message = $cached;
-        return $addressees;
-    }
+	protected function _primary_attendee_addressees()
+	{
+		$cached = $this->_single_message;
+		$this->_single_message = false;
+		$addressees = parent::_primary_attendee_addressees();
+		$this->_single_message = $cached;
+		return $addressees;
+	}
 }