eventespresso / event-espresso-core

core/libraries/messages/EE_Messenger_Collection_Loader.lib.php

Spacing +4 added lines, -4 removed lines

@@ -66,12 +66,12 @@ 
     {
         // make sure autoloaders are set (fail-safe)
         EED_Messages::set_autoloaders();
-        $folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/messenger';
-        $folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
+        $folder = ! empty($folder) ? $folder : EE_LIBRARIES.'messages/messenger';
+        $folder .= $folder[strlen($folder) - 1] != '/' ? '/' : '';
         // get all the files in that folder that end in ".class.php
         $filepaths = apply_filters(
             'FHEE__EE_messages__get_installed__messenger_files',
-            glob($folder . '*.class.php')
+            glob($folder.'*.class.php')
         );
         if (empty($filepaths)) {
             return;
@@ -87,7 +87,7 @@ 
                 continue;
             }
 
-            if (! class_exists($messenger_class_name)) {
+            if ( ! class_exists($messenger_class_name)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),

Indentation +123 added lines, -123 removed lines

@@ -13,127 +13,127 @@
  */
 class EE_Messenger_Collection_Loader
 {
-    /**
-     * @type EE_Messenger_Collection $_messenger_collection
-     */
-    protected $_messenger_collection = null;
-
-
-
-    /**
-     * EE_Messenger_Collection_Loader constructor.
-     *
-     * @param EE_Messenger_Collection $messengers
-     */
-    public function __construct(EE_Messenger_Collection $messengers)
-    {
-        $this->set_messenger_collection($messengers);
-    }
-
-
-
-    /**
-     * @return EE_Messenger_Collection
-     */
-    public function messenger_collection()
-    {
-        return $this->_messenger_collection;
-    }
-
-
-
-    /**
-     * @param mixed $messengers
-     */
-    public function set_messenger_collection(EE_Messenger_Collection $messengers)
-    {
-        $this->_messenger_collection = $messengers;
-    }
-
-
-
-    /**
-     * load_messengers
-     * globs the supplied filepath and adds any found
-     *
-     * @param  string $folder
-     * @throws \EE_Error
-     */
-    public function load_messengers_from_folder($folder = '')
-    {
-        // make sure autoloaders are set (fail-safe)
-        EED_Messages::set_autoloaders();
-        $folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/messenger';
-        $folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
-        // get all the files in that folder that end in ".class.php
-        $filepaths = apply_filters(
-            'FHEE__EE_messages__get_installed__messenger_files',
-            glob($folder . '*.class.php')
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ((array) $filepaths as $file_path) {
-            // extract filename from path
-            $file_path = basename($file_path);
-            // now remove any file extensions
-            $messenger_class_name = substr($file_path, 0, strpos($file_path, '.'));
-
-            // first check to see if the class name represents an actual messenger class.
-            if (strpos(strtolower($messenger_class_name), 'messenger') === false) {
-                continue;
-            }
-
-            if (! class_exists($messenger_class_name)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),
-                        $messenger_class_name,
-                        $file_path
-                    )
-                );
-            }
-
-            $this->_load_messenger(new $messenger_class_name());
-        }
-    }
-
-
-    /**
-     * load_messengers
-     * globs the supplied filepath and adds any found
-     *
-     * @return array
-     */
-    public function load_active_messengers_from_db()
-    {
-        // make sure autoloaders are set (fail-safe)
-        EED_Messages::set_autoloaders();
-        $active_messengers = apply_filters(
-            'FHEE__EEH_MSG_Template__get_active_messengers_in_db',
-            get_option('ee_active_messengers', array())
-        );
-        foreach ((array) $active_messengers as $active_messenger_classname => $active_messenger) {
-            $this->_load_messenger($active_messenger);
-        }
-    }
-
-
-
-    /**
-     * load_messenger
-     *
-     * @param \EE_messenger $messenger
-     * @return bool
-     */
-    protected function _load_messenger(EE_messenger $messenger)
-    {
-        if ($this->messenger_collection()->has_by_name($messenger->name)) {
-            return true;
-        }
-        return $this->messenger_collection()->add(
-            $messenger,
-            $messenger->name
-        );
-    }
+	/**
+	 * @type EE_Messenger_Collection $_messenger_collection
+	 */
+	protected $_messenger_collection = null;
+
+
+
+	/**
+	 * EE_Messenger_Collection_Loader constructor.
+	 *
+	 * @param EE_Messenger_Collection $messengers
+	 */
+	public function __construct(EE_Messenger_Collection $messengers)
+	{
+		$this->set_messenger_collection($messengers);
+	}
+
+
+
+	/**
+	 * @return EE_Messenger_Collection
+	 */
+	public function messenger_collection()
+	{
+		return $this->_messenger_collection;
+	}
+
+
+
+	/**
+	 * @param mixed $messengers
+	 */
+	public function set_messenger_collection(EE_Messenger_Collection $messengers)
+	{
+		$this->_messenger_collection = $messengers;
+	}
+
+
+
+	/**
+	 * load_messengers
+	 * globs the supplied filepath and adds any found
+	 *
+	 * @param  string $folder
+	 * @throws \EE_Error
+	 */
+	public function load_messengers_from_folder($folder = '')
+	{
+		// make sure autoloaders are set (fail-safe)
+		EED_Messages::set_autoloaders();
+		$folder = ! empty($folder) ? $folder : EE_LIBRARIES . 'messages/messenger';
+		$folder .= $folder[ strlen($folder) - 1 ] != '/' ? '/' : '';
+		// get all the files in that folder that end in ".class.php
+		$filepaths = apply_filters(
+			'FHEE__EE_messages__get_installed__messenger_files',
+			glob($folder . '*.class.php')
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ((array) $filepaths as $file_path) {
+			// extract filename from path
+			$file_path = basename($file_path);
+			// now remove any file extensions
+			$messenger_class_name = substr($file_path, 0, strpos($file_path, '.'));
+
+			// first check to see if the class name represents an actual messenger class.
+			if (strpos(strtolower($messenger_class_name), 'messenger') === false) {
+				continue;
+			}
+
+			if (! class_exists($messenger_class_name)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('The "%1$s" messenger class can\'t be loaded from %2$s.  Likely there is a typo in the class name or the file name.', 'event_espresso'),
+						$messenger_class_name,
+						$file_path
+					)
+				);
+			}
+
+			$this->_load_messenger(new $messenger_class_name());
+		}
+	}
+
+
+	/**
+	 * load_messengers
+	 * globs the supplied filepath and adds any found
+	 *
+	 * @return array
+	 */
+	public function load_active_messengers_from_db()
+	{
+		// make sure autoloaders are set (fail-safe)
+		EED_Messages::set_autoloaders();
+		$active_messengers = apply_filters(
+			'FHEE__EEH_MSG_Template__get_active_messengers_in_db',
+			get_option('ee_active_messengers', array())
+		);
+		foreach ((array) $active_messengers as $active_messenger_classname => $active_messenger) {
+			$this->_load_messenger($active_messenger);
+		}
+	}
+
+
+
+	/**
+	 * load_messenger
+	 *
+	 * @param \EE_messenger $messenger
+	 * @return bool
+	 */
+	protected function _load_messenger(EE_messenger $messenger)
+	{
+		if ($this->messenger_collection()->has_by_name($messenger->name)) {
+			return true;
+		}
+		return $this->messenger_collection()->add(
+			$messenger,
+			$messenger->name
+		);
+	}
 }

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

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);
     }
 }

Indentation +469 added lines, -469 removed lines

@@ -12,511 +12,511 @@
  */
 abstract class EE_Messages_Template_Pack
 {
-    /**
-     * 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);
+	}
 }

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

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 = '';

Indentation +63 added lines, -63 removed lines

@@ -10,71 +10,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;
+	}
 }

core/libraries/messages/EE_Payment_Base_message_type.lib.php

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 ';
     }
 
     /**

Indentation +44 added lines, -44 removed lines

@@ -12,67 +12,67 @@
  */
 abstract class EE_Payment_Base_message_type extends EE_message_type
 {
-    /**
-     * @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();
+	}
 }

core/libraries/messages/EE_Message_Generated_From_Token.php

Spacing +2 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
             return $this->_message;
         }
         $message = EEM_Message::instance()->get_one_by_token($this->token);
-        if (! $message instanceof EE_Message) {
+        if ( ! $message instanceof EE_Message) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
@@ -103,7 +103,7 @@ 
         }
         $message->set_STS_ID(EEM_Message::status_idle);
 
-        if (! $this->_sending_messenger instanceof EE_messenger) {
+        if ( ! $this->_sending_messenger instanceof EE_messenger) {
             $message->set_STS_ID(EEM_Message::status_failed);
             $message->set_error_message(
                 sprintf(

Indentation +107 added lines, -107 removed lines

@@ -11,111 +11,111 @@
  */
 class EE_Message_Generated_From_Token extends EE_Message_To_Generate implements EEI_Has_Sending_Messenger
 {
-    /**
-     * Sending messenger
-     *
-     * @type EE_messenger | string
-     */
-    protected $_sending_messenger = '';
-
-
-    /**
-     * Holds the incoming token;
-     * @type string
-     */
-    public $token = '';
-
-
-    /**
-     * Constructor
-     *
-     * @param   string    $sending_messenger_slug     This is used to set what messenger is used to "send"
-     *                                                the EE_Message retrieved from the DB via the given token.
-     * @param   string $token                         This is a token for a Message that should already exist int the db.
-     *                                                This is then used to populate the properties in here.
-     * @param   EE_Message_Resource_Manager $message_resource_manager
-     */
-    public function __construct($token, $sending_messenger_slug, EE_Message_Resource_Manager $message_resource_manager)
-    {
-        $this->token = $token;
-        $this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
-        $this->_message = $this->_generate_message();
-        // set params for parent from the message object
-        parent::__construct(
-            $this->_message->messenger(),
-            $this->_message->message_type(),
-            array(),
-            $this->_message->context(),
-            false
-        );
-    }
-
-
-
-    /**
-     * @param string                       $sending_messenger_slug
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return \EE_messenger | string
-     */
-    protected function _set_sending_messenger(
-        $sending_messenger_slug,
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
-        return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
-    }
-
-
-
-    /**
-     * @return EE_messenger
-     */
-    public function sending_messenger()
-    {
-        return $this->_sending_messenger;
-    }
-
-
-
-    /**
-     * generates an EE_Message using the supplied arguments and some defaults
-     *
-     * @param array $properties
-     * @return EE_Message
-     * @throws \EE_Error
-     */
-    protected function _generate_message($properties = array())
-    {
-        // a message was generated immediately but the parent class will call this again
-        if ($this->_message instanceof EE_Message) {
-            return $this->_message;
-        }
-        $message = EEM_Message::instance()->get_one_by_token($this->token);
-        if (! $message instanceof EE_Message) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
-                    $this->token
-                )
-            );
-        }
-        $message->set_STS_ID(EEM_Message::status_idle);
-
-        if (! $this->_sending_messenger instanceof EE_messenger) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                sprintf(
-                    esc_html__('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
-                    $this->_sending_messenger
-                )
-            );
-        }
-
-        // set properties
-        $this->_valid = true;
-        $this->_messenger = $message->messenger_object();
-        $this->_message_type = $message->message_type_object();
-        $this->_send_now = $message->send_now();
-        return $message;
-    }
+	/**
+	 * Sending messenger
+	 *
+	 * @type EE_messenger | string
+	 */
+	protected $_sending_messenger = '';
+
+
+	/**
+	 * Holds the incoming token;
+	 * @type string
+	 */
+	public $token = '';
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param   string    $sending_messenger_slug     This is used to set what messenger is used to "send"
+	 *                                                the EE_Message retrieved from the DB via the given token.
+	 * @param   string $token                         This is a token for a Message that should already exist int the db.
+	 *                                                This is then used to populate the properties in here.
+	 * @param   EE_Message_Resource_Manager $message_resource_manager
+	 */
+	public function __construct($token, $sending_messenger_slug, EE_Message_Resource_Manager $message_resource_manager)
+	{
+		$this->token = $token;
+		$this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
+		$this->_message = $this->_generate_message();
+		// set params for parent from the message object
+		parent::__construct(
+			$this->_message->messenger(),
+			$this->_message->message_type(),
+			array(),
+			$this->_message->context(),
+			false
+		);
+	}
+
+
+
+	/**
+	 * @param string                       $sending_messenger_slug
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return \EE_messenger | string
+	 */
+	protected function _set_sending_messenger(
+		$sending_messenger_slug,
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
+		return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
+	}
+
+
+
+	/**
+	 * @return EE_messenger
+	 */
+	public function sending_messenger()
+	{
+		return $this->_sending_messenger;
+	}
+
+
+
+	/**
+	 * generates an EE_Message using the supplied arguments and some defaults
+	 *
+	 * @param array $properties
+	 * @return EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _generate_message($properties = array())
+	{
+		// a message was generated immediately but the parent class will call this again
+		if ($this->_message instanceof EE_Message) {
+			return $this->_message;
+		}
+		$message = EEM_Message::instance()->get_one_by_token($this->token);
+		if (! $message instanceof EE_Message) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
+					$this->token
+				)
+			);
+		}
+		$message->set_STS_ID(EEM_Message::status_idle);
+
+		if (! $this->_sending_messenger instanceof EE_messenger) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				sprintf(
+					esc_html__('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
+					$this->_sending_messenger
+				)
+			);
+		}
+
+		// set properties
+		$this->_valid = true;
+		$this->_messenger = $message->messenger_object();
+		$this->_message_type = $message->message_type_object();
+		$this->_send_now = $message->send_now();
+		return $message;
+	}
 }

core/libraries/messages/EE_Registration_Base_message_type.lib.php

Spacing +7 added lines, -7 removed lines

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

Indentation +122 added lines, -122 removed lines

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

core/libraries/qtips/EE_Qtip_Config.lib.php

Spacing +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
     {
         foreach ($this->_qtipsa as $qt) {
             // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+            if ( ! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(

Indentation +225 added lines, -225 removed lines

@@ -14,235 +14,235 @@ 
  */
 abstract class EE_Qtip_Config extends EE_Base
 {
-    /**
-     * This will hold the qtips setup array (setup by children)
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_qtipsa;
+	/**
+	 * This will hold the qtips setup array (setup by children)
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_qtipsa;
 
 
-    /**
-     * This holds the constructed EE_Qtip objects
-     *
-     * @access protected
-     * @var EE_Qtip
-     */
-    protected $_qtips;
+	/**
+	 * This holds the constructed EE_Qtip objects
+	 *
+	 * @access protected
+	 * @var EE_Qtip
+	 */
+	protected $_qtips;
 
 
-    /**
-     * an array of default options for instantiated qtip js objects
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_default_options;
+	/**
+	 * an array of default options for instantiated qtip js objects
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_default_options;
 
 
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        $this->_qtipsa = $this->_qtips = array();
-        $this->_set_default_options();
-        $this->_set_tips_array();
-        $this->_construct_tips();
-    }
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		$this->_qtipsa = $this->_qtips = array();
+		$this->_set_default_options();
+		$this->_set_tips_array();
+		$this->_construct_tips();
+	}
 
 
-    /**
-     * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
-     *
-     * $qtipsa = array(
-     *        0 => array(
-     *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
-     *            'content' => 'html/text content for the qtip',
-     *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
-     *            target is for the qTip in the dom (i.e. if class then '.some-class').
-     *            'options' => array() //use this to override any of the default options for this specific qtip.
-     *        )
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tips_array();
+	/**
+	 * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
+	 *
+	 * $qtipsa = array(
+	 *        0 => array(
+	 *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
+	 *            'content' => 'html/text content for the qtip',
+	 *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
+	 *            target is for the qTip in the dom (i.e. if class then '.some-class').
+	 *            'options' => array() //use this to override any of the default options for this specific qtip.
+	 *        )
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tips_array();
 
 
-    /**
-     * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
-     * qtips defined in their config OR just leave it and have the parent default options apply.
-     *
-     * commented out options are there for reference so you know which can be defined by the child.
-     *
-     * Note: children do NOT have to define all these options.  Just define the ones to override.
-     *
-     * @link   http://qtip2.com/options
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_default_options()
-    {
-        $this->_default_options = array(
-            // 'id' => 'unique_id_referncing_qtip_instance',
-            'prerender'      => false,
-            // increases page load if true,
-            'suppress'       => true,
-            // whether default browser tooltips are suppressed.
-            'content'        => array(
-                'button' => false,
-                // what you want for the close button text/link.
-                'title'  => true,
-                // Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
-                'clone'  => true,
-                // Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
-            ),
-            'show_only_once' => false,
-            // this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
-            'position'       => array(
-                'my'        => 'top left',
-                // top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
-                'at'        => 'bottom right',
-                // same options as above.
-                'target'    => 'event',
-                // if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
-                'container' => false,
-                // what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
-                'viewport'  => true,
-                // @link http://qtip2.com/plugins#viewport
-                'adjust'    => array(
-                    'x'      => 0,
-                    // adjust position on x axis by 0 pixels.
-                    'y'      => 0,
-                    // adjust position on y axis by 0 pixels.
-                    'mouse'  => true,
-                    // when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
-                    'resize' => true,
-                    // adjust tooltip position when window is resized.
-                    'scroll' => true,
-                    // position of tooltip adjusted when window (or position.container) is scrolled.
-                    'method' => 'flipinvert',
-                    // @link http://qtip2.com/plugins#viewport
-                ),
-            ),
-            'show'           => array(
-                'event'  => 'mouseenter',
-                // what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
-                'target' => false,
-                // options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
-                'delay'  => 90,
-                // time in millisecons by which to delay showing of tooltip.
-                'solo'   => false,
-                // determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
-                'modal'  => array(
-                    'on'         => false, // does tooltip trigger modal?
-                    'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
-                    'escape'     => true, // hitting escape key hide the tooltip and cancel modal
-                    'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
-                ),
-            ),
-            'hide'           => array(
-                'event'    => 'mouseleave',
-                // similar as what you do for show.event.
-                'target'   => false,
-                // Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
-                'delay'    => 0,
-                // set time in milliseconds for delaying the hide of the tooltip
-                'inactive' => false,
-                // if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
-                'fixed'    => false,
-                // when set to true, the tooltip will not hide if moused over.
-                'leave'    => 'window',
-                // specify whether the tooltip will hide when leaving the window it's conained within.
-                'distance' => false,
-                // if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
-            ),
-            'style'          => array(
-                'classes' => 'qtip-tipsy',
-                // Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
-                'def'     => true,
-                // set to false and the default qtip class does not get applied
-                'widget'  => false,
-                // whether ui-widget classes of the themeroller UI styles are applied to tooltip.
-                'width'   => false,
-                // Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
-                'height'  => false,
-                // same as above except applies to height.
-                'tip'     => array(
-                    'corner' => true,
-                    // where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
-                    'mimic'  => false,
-                    // see documentation @link http://qtip2.com/plugins#tips
-                    'border' => true,
-                    // Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
-                    'width'  => 6,
-                    // width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
-                    'height' => 6,
-                    // works the same as tip.width
-                    'offset' => 0,
-                    // use to set the offset of the tip in relation to its corner position.
-                ),
-            ),
+	/**
+	 * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
+	 * qtips defined in their config OR just leave it and have the parent default options apply.
+	 *
+	 * commented out options are there for reference so you know which can be defined by the child.
+	 *
+	 * Note: children do NOT have to define all these options.  Just define the ones to override.
+	 *
+	 * @link   http://qtip2.com/options
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_default_options()
+	{
+		$this->_default_options = array(
+			// 'id' => 'unique_id_referncing_qtip_instance',
+			'prerender'      => false,
+			// increases page load if true,
+			'suppress'       => true,
+			// whether default browser tooltips are suppressed.
+			'content'        => array(
+				'button' => false,
+				// what you want for the close button text/link.
+				'title'  => true,
+				// Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
+				'clone'  => true,
+				// Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
+			),
+			'show_only_once' => false,
+			// this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
+			'position'       => array(
+				'my'        => 'top left',
+				// top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
+				'at'        => 'bottom right',
+				// same options as above.
+				'target'    => 'event',
+				// if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
+				'container' => false,
+				// what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
+				'viewport'  => true,
+				// @link http://qtip2.com/plugins#viewport
+				'adjust'    => array(
+					'x'      => 0,
+					// adjust position on x axis by 0 pixels.
+					'y'      => 0,
+					// adjust position on y axis by 0 pixels.
+					'mouse'  => true,
+					// when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
+					'resize' => true,
+					// adjust tooltip position when window is resized.
+					'scroll' => true,
+					// position of tooltip adjusted when window (or position.container) is scrolled.
+					'method' => 'flipinvert',
+					// @link http://qtip2.com/plugins#viewport
+				),
+			),
+			'show'           => array(
+				'event'  => 'mouseenter',
+				// what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
+				'target' => false,
+				// options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
+				'delay'  => 90,
+				// time in millisecons by which to delay showing of tooltip.
+				'solo'   => false,
+				// determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
+				'modal'  => array(
+					'on'         => false, // does tooltip trigger modal?
+					'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
+					'escape'     => true, // hitting escape key hide the tooltip and cancel modal
+					'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
+				),
+			),
+			'hide'           => array(
+				'event'    => 'mouseleave',
+				// similar as what you do for show.event.
+				'target'   => false,
+				// Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
+				'delay'    => 0,
+				// set time in milliseconds for delaying the hide of the tooltip
+				'inactive' => false,
+				// if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
+				'fixed'    => false,
+				// when set to true, the tooltip will not hide if moused over.
+				'leave'    => 'window',
+				// specify whether the tooltip will hide when leaving the window it's conained within.
+				'distance' => false,
+				// if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
+			),
+			'style'          => array(
+				'classes' => 'qtip-tipsy',
+				// Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
+				'def'     => true,
+				// set to false and the default qtip class does not get applied
+				'widget'  => false,
+				// whether ui-widget classes of the themeroller UI styles are applied to tooltip.
+				'width'   => false,
+				// Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
+				'height'  => false,
+				// same as above except applies to height.
+				'tip'     => array(
+					'corner' => true,
+					// where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
+					'mimic'  => false,
+					// see documentation @link http://qtip2.com/plugins#tips
+					'border' => true,
+					// Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
+					'width'  => 6,
+					// width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
+					'height' => 6,
+					// works the same as tip.width
+					'offset' => 0,
+					// use to set the offset of the tip in relation to its corner position.
+				),
+			),
 
-        );
-    }
+		);
+	}
 
 
-    /**
-     * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
-     * the $_qtips property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _construct_tips()
-    {
-        foreach ($this->_qtipsa as $qt) {
-            // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        var_export($qt, true)
-                    )
-                );
-            }
+	/**
+	 * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
+	 * the $_qtips property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _construct_tips()
+	{
+		foreach ($this->_qtipsa as $qt) {
+			// make sure we have what we need.
+			if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
+							'event_espresso'
+						),
+						get_class($this),
+						var_export($qt, true)
+					)
+				);
+			}
 
-            // make sure the options include defaults and just override via set config.
-            $options_override = isset($qt['options']) ? (array) $qt['options'] : array();
-            $options = array_merge($this->_default_options, $options_override);
-            $setup = array(
-                'content_id' => $qt['content_id'],
-                'options'    => $options,
-                'target'     => $qt['target'],
-                'content'    => $qt['content'],
-            );
-            $this->_qtips[] = new EE_Qtip($setup);
-        }
-    }
+			// make sure the options include defaults and just override via set config.
+			$options_override = isset($qt['options']) ? (array) $qt['options'] : array();
+			$options = array_merge($this->_default_options, $options_override);
+			$setup = array(
+				'content_id' => $qt['content_id'],
+				'options'    => $options,
+				'target'     => $qt['target'],
+				'content'    => $qt['content'],
+			);
+			$this->_qtips[] = new EE_Qtip($setup);
+		}
+	}
 
 
-    /**
-     * return the _qtips property contents
-     *
-     * @access public
-     * @return EE_Qtip[]
-     */
-    public function get_tips()
-    {
-        return $this->_qtips;
-    }
+	/**
+	 * return the _qtips property contents
+	 *
+	 * @access public
+	 * @return EE_Qtip[]
+	 */
+	public function get_tips()
+	{
+		return $this->_qtips;
+	}
 }
 
 // class names you can use for tooltip styles
@@ -294,17 +294,17 @@ 
  */
 class EE_Qtip extends EE_Base
 {
-    public $content_id;
-    public $options;
-    public $target;
-    public $content;
+	public $content_id;
+	public $options;
+	public $target;
+	public $content;
 
-    public function __construct($setup_array)
-    {
-        foreach ($setup_array as $prop => $value) {
-            if (EEH_Class_Tools::has_property($this, $prop)) {
-                $this->{$prop} = $value;
-            }
-        }
-    }
+	public function __construct($setup_array)
+	{
+		foreach ($setup_array as $prop => $value) {
+			if (EEH_Class_Tools::has_property($this, $prop)) {
+				$this->{$prop} = $value;
+			}
+		}
+	}
 }

core/libraries/plugin_api/db/EEME_Base.lib.php

Spacing +17 added lines, -17 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function __construct()
     {
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 esc_html__(
                     "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
@@ -79,7 +79,7 @@ 
                 )
             );
         }
-        $construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
+        $construct_end_action = 'AHEE__EEM_'.$this->_model_name_extended.'__construct__end';
         if (did_action($construct_end_action)) {
             throw new EE_Error(
                 sprintf(
@@ -94,15 +94,15 @@ 
             );
         }
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__tables',
             array($this, 'add_extra_tables_on_filter')
         );
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__fields',
             array($this, 'add_extra_fields_on_filter')
         );
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__model_relations',
             array($this, 'add_extra_relations_on_filter')
         );
         $this->_register_extending_methods();
@@ -127,12 +127,12 @@ 
     {
         if ($this->_extra_fields) {
             foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = array();
+                if ( ! isset($existing_fields[$table_alias])) {
+                    $existing_fields[$table_alias] = array();
                 }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
+                $existing_fields[$table_alias] = array_merge(
+                    (array) $existing_fields[$table_alias],
+                    $this->_extra_fields[$table_alias]
                 );
             }
         }
@@ -163,7 +163,7 @@ 
                 $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10,
                     10
                 );
@@ -178,15 +178,15 @@ 
     public function deregister()
     {
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__tables',
             array($this, 'add_extra_tables_on_filter')
         );
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__fields',
             array($this, 'add_extra_fields_on_filter')
         );
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__model_relations',
             array($this, 'add_extra_relations_on_filter')
         );
         $all_methods = get_class_methods(get_class($this));
@@ -196,13 +196,13 @@ 
                 $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10
                 );
             }
         }
         /** @var EEM_Base $model_to_reset */
-        $model_to_reset = 'EEM_' . $this->_model_name_extended;
+        $model_to_reset = 'EEM_'.$this->_model_name_extended;
         if (class_exists($model_to_reset)) {
             $model_to_reset::reset();
         }
@@ -224,7 +224,7 @@ 
             // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
             $this->_ = $model_called;
             // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
+            $extending_method = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
             } else {

Indentation +207 added lines, -207 removed lines

@@ -43,211 +43,211 @@
  */
 abstract class EEME_Base
 {
-    const extending_method_prefix = 'ext_';
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
-
-    protected $_extra_tables = array();
-    protected $_extra_fields = array();
-    protected $_extra_relations = array();
-
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string
-     */
-    protected $_model_name_extended = null;
-
-    /**
-     * The model this extends
-     *
-     * @var EEM_Base
-     */
-    protected $_ = null;
-
-
-    /**
-     * @throws \EE_Error
-     */
-    public function __construct()
-    {
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                esc_html__(
-                    "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
-                    "event_espresso"
-                )
-            );
-        }
-        $construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
-        if (did_action($construct_end_action)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->_model_name_extended,
-                    $construct_end_action
-                )
-            );
-        }
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
-            array($this, 'add_extra_tables_on_filter')
-        );
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
-            array($this, 'add_extra_fields_on_filter')
-        );
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
-            array($this, 'add_extra_relations_on_filter')
-        );
-        $this->_register_extending_methods();
-    }
-
-
-    /**
-     * @param array $existing_tables
-     * @return array
-     */
-    public function add_extra_tables_on_filter($existing_tables)
-    {
-        return array_merge((array) $existing_tables, $this->_extra_tables);
-    }
-
-
-    /**
-     * @param array $existing_fields
-     * @return array
-     */
-    public function add_extra_fields_on_filter($existing_fields)
-    {
-        if ($this->_extra_fields) {
-            foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = array();
-                }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
-                );
-            }
-        }
-        return $existing_fields;
-    }
-
-
-    /**
-     * @param array $existing_relations
-     * @return array
-     */
-    public function add_extra_relations_on_filter($existing_relations)
-    {
-        return array_merge((array) $existing_relations, $this->_extra_relations);
-    }
-
-
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10,
-                    10
-                );
-            }
-        }
-    }
-
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
-            array($this, 'add_extra_tables_on_filter')
-        );
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
-            array($this, 'add_extra_fields_on_filter')
-        );
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
-            array($this, 'add_extra_relations_on_filter')
-        );
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10
-                );
-            }
-        }
-        /** @var EEM_Base $model_to_reset */
-        $model_to_reset = 'EEM_' . $this->_model_name_extended;
-        if (class_exists($model_to_reset)) {
-            $model_to_reset::reset();
-        }
-    }
-
-
-    /**
-     * @param string $callback_method_name
-     * @param array  $args
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function __call($callback_method_name, $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            list($original_return_val, $model_called, $args_provided_to_method_on_model) = (array) $args;
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                            "event_espresso"
-                        ),
-                        $this->_model_name_extended,
-                        get_class($this),
-                        $extending_method,
-                        $extending_method
-                    )
-                );
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                    $callback_method_name,
-                    get_class($this)
-                )
-            );
-        }
-    }
+	const extending_method_prefix = 'ext_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+
+	protected $_extra_tables = array();
+	protected $_extra_fields = array();
+	protected $_extra_relations = array();
+
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string
+	 */
+	protected $_model_name_extended = null;
+
+	/**
+	 * The model this extends
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_ = null;
+
+
+	/**
+	 * @throws \EE_Error
+	 */
+	public function __construct()
+	{
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				esc_html__(
+					"When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
+					"event_espresso"
+				)
+			);
+		}
+		$construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
+		if (did_action($construct_end_action)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->_model_name_extended,
+					$construct_end_action
+				)
+			);
+		}
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+			array($this, 'add_extra_tables_on_filter')
+		);
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+			array($this, 'add_extra_fields_on_filter')
+		);
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+			array($this, 'add_extra_relations_on_filter')
+		);
+		$this->_register_extending_methods();
+	}
+
+
+	/**
+	 * @param array $existing_tables
+	 * @return array
+	 */
+	public function add_extra_tables_on_filter($existing_tables)
+	{
+		return array_merge((array) $existing_tables, $this->_extra_tables);
+	}
+
+
+	/**
+	 * @param array $existing_fields
+	 * @return array
+	 */
+	public function add_extra_fields_on_filter($existing_fields)
+	{
+		if ($this->_extra_fields) {
+			foreach ($this->_extra_fields as $table_alias => $fields) {
+				if (! isset($existing_fields[ $table_alias ])) {
+					$existing_fields[ $table_alias ] = array();
+				}
+				$existing_fields[ $table_alias ] = array_merge(
+					(array) $existing_fields[ $table_alias ],
+					$this->_extra_fields[ $table_alias ]
+				);
+			}
+		}
+		return $existing_fields;
+	}
+
+
+	/**
+	 * @param array $existing_relations
+	 * @return array
+	 */
+	public function add_extra_relations_on_filter($existing_relations)
+	{
+		return array_merge((array) $existing_relations, $this->_extra_relations);
+	}
+
+
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10,
+					10
+				);
+			}
+		}
+	}
+
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+			array($this, 'add_extra_tables_on_filter')
+		);
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+			array($this, 'add_extra_fields_on_filter')
+		);
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+			array($this, 'add_extra_relations_on_filter')
+		);
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10
+				);
+			}
+		}
+		/** @var EEM_Base $model_to_reset */
+		$model_to_reset = 'EEM_' . $this->_model_name_extended;
+		if (class_exists($model_to_reset)) {
+			$model_to_reset::reset();
+		}
+	}
+
+
+	/**
+	 * @param string $callback_method_name
+	 * @param array  $args
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function __call($callback_method_name, $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			list($original_return_val, $model_called, $args_provided_to_method_on_model) = (array) $args;
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$extending_method = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+							"event_espresso"
+						),
+						$this->_model_name_extended,
+						get_class($this),
+						$extending_method,
+						$extending_method
+					)
+				);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+					$callback_method_name,
+					get_class($this)
+				)
+			);
+		}
+	}
 }