eventespresso / event-espresso-core

core/helpers/EEH_Template_Validator.helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
     /**
      * For verifying that a variable is indeed an array, else throw an EE_Error
      * @param type $variable_to_test
-     * @param type $variable_name
+     * @param string $variable_name
      * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
      * @return void
      * @throws EE_Error
@@ -161,7 +161,7 @@ 
      * for verifying that a variable is one of the string optiosn supplied
      * @param mixed $variable_to_test
      * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
+     * @param string[] $string_options an array of acceptable values
      * @return void
      * @throws EE_Error
      */

Indentation +148 added lines, -148 removed lines

@@ -28,152 +28,152 @@
     
     
     
-    /**
-     * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful in throwing intelligent errors
-     * @param string $class_name eg EE_Answer, EE_Transaction, etc.
-     * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
-     * @return void
-     * @throws EE_Error (indirectly)
-     */
-    public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ('allow_null' == $allow_null && is_null($variable_to_test)) {
-            return;
-        }
-        self::verify_is_array($variable_to_test, $name_of_variable);
-        foreach ($variable_to_test as $key => $array_element) {
-            self::verify_instanceof($array_element, $key, $class_name);
-        }
-    }
-    
-    
-    
-    
-    
-    /**
-     * throws an EE_Error if $variable_to_test is null
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful for throwing intelligent errors
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_isnt_null($variable_to_test, $name_of_variable)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if ($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=false) {
-            $error[]=__('Variable named %s is null.', 'event_espresso');
-            $error[]=__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
-        }
-    }
-    
-    /**
-     * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
-     * @param boolean $expression_to_test
-     * @param string $expression_string_representation a string representation of your expression
-     * for example, if your expression were $var1==23, then this should be '$var1==23'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_true($expression_to_test, $expression_string_representation)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!$expression_to_test) {
-            $error[]=__('Template error.', 'event_espresso');
-            $error[]=__("%s evaluated to false, but it must be true!", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
-        }
-    }
-    
-    
-    
-    
-    
-    /**
-     * For verifying that a variable is indeed an object of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful when throwing errors
-     * @param string $class_name eg, EE_Answer,
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
-            return;
-        }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[]=__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[]=__("It should be of type %s", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
-        }
-    }
-    
-    
-    
-    
-    
-    /**
-     * For verifying that a variable is indeed an array, else throw an EE_Error
-     * @param type $variable_to_test
-     * @param type $variable_name
-     * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty'==$allow_empty) {
-            return;
-        }
-        if (!is_array($variable_to_test)) {
-            $error[]=__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[]=__("Its value is, instead '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
-        }
-    }
-    
-    
-    
-    
-    
-    
-    
-    /**
-     * for verifying that a variable is one of the string optiosn supplied
-     * @param mixed $variable_to_test
-     * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0]=__('Malconfigured template.', 'event_espresso');
-            $msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
-        }
-    }
+	/**
+	 * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful in throwing intelligent errors
+	 * @param string $class_name eg EE_Answer, EE_Transaction, etc.
+	 * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
+	 * @return void
+	 * @throws EE_Error (indirectly)
+	 */
+	public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
+			return;
+		}
+		self::verify_is_array($variable_to_test, $name_of_variable);
+		foreach ($variable_to_test as $key => $array_element) {
+			self::verify_instanceof($array_element, $key, $class_name);
+		}
+	}
+    
+    
+    
+    
+    
+	/**
+	 * throws an EE_Error if $variable_to_test is null
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful for throwing intelligent errors
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_isnt_null($variable_to_test, $name_of_variable)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if ($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=false) {
+			$error[]=__('Variable named %s is null.', 'event_espresso');
+			$error[]=__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
+		}
+	}
+    
+	/**
+	 * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
+	 * @param boolean $expression_to_test
+	 * @param string $expression_string_representation a string representation of your expression
+	 * for example, if your expression were $var1==23, then this should be '$var1==23'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_true($expression_to_test, $expression_string_representation)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!$expression_to_test) {
+			$error[]=__('Template error.', 'event_espresso');
+			$error[]=__("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
+		}
+	}
+    
+    
+    
+    
+    
+	/**
+	 * For verifying that a variable is indeed an object of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful when throwing errors
+	 * @param string $class_name eg, EE_Answer,
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
+			return;
+		}
+		if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+			$msg[]=__('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[]=__("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
+		}
+	}
+    
+    
+    
+    
+    
+	/**
+	 * For verifying that a variable is indeed an array, else throw an EE_Error
+	 * @param type $variable_to_test
+	 * @param type $variable_name
+	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty'==$allow_empty) {
+			return;
+		}
+		if (!is_array($variable_to_test)) {
+			$error[]=__('Variable %s should be an array, but it is not.', 'event_espresso');
+			$error[]=__("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
+		}
+	}
+    
+    
+    
+    
+    
+    
+    
+	/**
+	 * for verifying that a variable is one of the string optiosn supplied
+	 * @param mixed $variable_to_test
+	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
+	 * @param array $string_options an array of acceptable values
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!in_array($variable_to_test, $string_options)) {
+			$msg[0]=__('Malconfigured template.', 'event_espresso');
+			$msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
+		}
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -39,10 +39,10 @@ 
      */
     public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ('allow_null' == $allow_null && is_null($variable_to_test)) {
             return;
         }
@@ -65,12 +65,12 @@ 
      */
     public static function verify_isnt_null($variable_to_test, $name_of_variable)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if ($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=false) {
-            $error[]=__('Variable named %s is null.', 'event_espresso');
-            $error[]=__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+        if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
+            $error[] = __('Variable named %s is null.', 'event_espresso');
+            $error[] = __("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
         }
     }
@@ -85,12 +85,12 @@ 
      */
     public static function verify_is_true($expression_to_test, $expression_string_representation)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!$expression_to_test) {
-            $error[]=__('Template error.', 'event_espresso');
-            $error[]=__("%s evaluated to false, but it must be true!", 'event_espresso');
+        if ( ! $expression_to_test) {
+            $error[] = __('Template error.', 'event_espresso');
+            $error[] = __("%s evaluated to false, but it must be true!", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
         }
     }
@@ -109,16 +109,16 @@ 
      */
     public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
             return;
         }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[]=__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[]=__("It should be of type %s", 'event_espresso');
+        if ($variable_to_test == null || ! ($variable_to_test instanceof $class_name)) {
+            $msg[] = __('Variable %s is not of the correct type.', 'event_espresso');
+            $msg[] = __("It should be of type %s", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
         }
     }
@@ -137,16 +137,16 @@ 
      */
     public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty'==$allow_empty) {
+        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
+        if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
             return;
         }
-        if (!is_array($variable_to_test)) {
-            $error[]=__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[]=__("Its value is, instead '%s'", 'event_espresso');
+        if ( ! is_array($variable_to_test)) {
+            $error[] = __('Variable %s should be an array, but it is not.', 'event_espresso');
+            $error[] = __("Its value is, instead '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
         }
     }
@@ -167,12 +167,12 @@ 
      */
     public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0]=__('Malconfigured template.', 'event_espresso');
-            $msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+        if ( ! in_array($variable_to_test, $string_options)) {
+            $msg[0] = __('Malconfigured template.', 'event_espresso');
+            $msg[1] = __("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
         }
     }

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
      * Checks if that value is the one selected
      *
      * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-     * @return string
+     * @return boolean
      */
     protected function _check_if_option_selected($option_value)
     {

Indentation +65 added lines, -65 removed lines

@@ -14,78 +14,78 @@
 class EE_Select_Display_Strategy extends EE_Display_Strategy_Base
 {
 
-    /**
-     *
-     * @throws EE_Error
-     * @return string of html to display the field
-     */
-    public function display()
-    {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
-        }
+	/**
+	 *
+	 * @throws EE_Error
+	 * @return string of html to display the field
+	 */
+	public function display()
+	{
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select';
-        $html .= $this->_attributes_string(
-            $this->_standard_attributes_array()
-        );
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select';
+		$html .= $this->_attributes_string(
+			$this->_standard_attributes_array()
+		);
+		$html .= '>';
 
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            EEH_HTML::indent(1, 'optgroup');
-            foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
-                EEH_HTML::indent(1, 'option');
-                $html .= $this->_display_options($opt_group);
-                EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
-                }
-            }
-            EEH_HTML::indent(-1, 'optgroup');
-        } else {
-            $html.=$this->_display_options($this->_input->options());
-        }
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
+				EEH_HTML::indent(-1, 'option');
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+				}
+			}
+			EEH_HTML::indent(-1, 'optgroup');
+		} else {
+			$html.=$this->_display_options($this->_input->options());
+		}
 
-        $html.= EEH_HTML::nl(0, 'select') . '</select>';
-        return $html;
-    }
+		$html.= EEH_HTML::nl(0, 'select') . '</select>';
+		return $html;
+	}
 
 
 
-    /**
-     * Displays a flat list of options as option tags
-     * @param array $options
-     * @return string
-     */
-    protected function _display_options($options)
-    {
-        $html = '';
-        EEH_HTML::indent(1, 'option');
-        foreach ($options as $value => $display_text) {
-            // even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
-            $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
-        }
-        EEH_HTML::indent(-1, 'option');
-        return $html;
-    }
+	/**
+	 * Displays a flat list of options as option tags
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _display_options($options)
+	{
+		$html = '';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			// even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			// PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
+			$html.= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
+		}
+		EEH_HTML::indent(-1, 'option');
+		return $html;
+	}
 
 
 
-    /**
-     * Checks if that value is the one selected
-     *
-     * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-     * @return string
-     */
-    protected function _check_if_option_selected($option_value)
-    {
-        return $option_value === $this->_input->raw_value();
-    }
+	/**
+	 * Checks if that value is the one selected
+	 *
+	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
+	 * @return string
+	 */
+	protected function _check_if_option_selected($option_value)
+	{
+		return $option_value === $this->_input->raw_value();
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -21,7 +21,7 @@ 
      */
     public function display()
     {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+        if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
             throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
         }
 
@@ -35,22 +35,22 @@ 
         if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
             EEH_HTML::indent(1, 'optgroup');
             foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
                 }
                 EEH_HTML::indent(1, 'option');
                 $html .= $this->_display_options($opt_group);
                 EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+                if ( ! empty($opt_group_label)) {
+                    $html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
                 }
             }
             EEH_HTML::indent(-1, 'optgroup');
         } else {
-            $html.=$this->_display_options($this->_input->options());
+            $html .= $this->_display_options($this->_input->options());
         }
 
-        $html.= EEH_HTML::nl(0, 'select') . '</select>';
+        $html .= EEH_HTML::nl(0, 'select').'</select>';
         return $html;
     }
 
@@ -70,7 +70,7 @@ 
             // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
             $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
             $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl(0, 'option') . '<option value="' . esc_attr($unnormalized_value) . '"' . $selected . '>' . $display_text . '</option>';
+            $html .= EEH_HTML::nl(0, 'option').'<option value="'.esc_attr($unnormalized_value).'"'.$selected.'>'.$display_text.'</option>';
         }
         EEH_HTML::indent(-1, 'option');
         return $html;

core/libraries/form_sections/strategies/validation/EE_Float_Validation_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
     /**
      *
      * @param $normalized_value
-     * @return bool
+     * @return boolean|null
      */
     public function validate($normalized_value)
     {

Indentation +26 added lines, -26 removed lines

@@ -11,36 +11,36 @@
 class EE_Float_Validation_Strategy extends EE_Validation_Strategy_Base
 {
 
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = sprintf(__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso"));
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = sprintf(__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso"));
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     *
-     * @param $normalized_value
-     * @return bool
-     */
-    public function validate($normalized_value)
-    {
-        // errors should have been detected by the normalization strategy
-    }
+	/**
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 */
+	public function validate($normalized_value)
+	{
+		// errors should have been detected by the normalization strategy
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array('number'=>true, 'messages' => array( 'number' => $this->get_validation_error_message() ) );
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array('number'=>true, 'messages' => array( 'number' => $this->get_validation_error_message() ) );
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
      */
     public function __construct($validation_error_message = null)
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = sprintf(__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso"));
         }
         parent::__construct($validation_error_message);
@@ -41,6 +41,6 @@ 
      */
     public function get_jquery_validation_rule_array()
     {
-        return array('number'=>true, 'messages' => array( 'number' => $this->get_validation_error_message() ) );
+        return array('number'=>true, 'messages' => array('number' => $this->get_validation_error_message()));
     }
 }

core/libraries/line_item_display/EE_Admin_Table_Line_Item_Display_Strategy.strategy.php

Doc Comments +6 added lines, -6 removed lines

@@ -49,7 +49,7 @@ 
      * This is used to output a single
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     public function display_line_item(EE_Line_Item $line_item, $options = array())
     {
@@ -166,7 +166,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     protected function _item_row(EE_Line_Item $line_item, $options = array())
     {
@@ -264,7 +264,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     protected function _sub_item_row(EE_Line_Item $line_item, $options = array())
     {
@@ -279,7 +279,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     protected function _tax_row(EE_Line_Item $line_item, $options = array())
     {
@@ -303,7 +303,7 @@ 
      * @param EE_Line_Item $line_item
      * @param string       $text
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     protected function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
     {
@@ -318,7 +318,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     protected function _total_row(EE_Line_Item $line_item, $options = array())
     {

Indentation +320 added lines, -320 removed lines

@@ -14,324 +14,324 @@
 {
 
 
-    /**
-     * whether to display the taxes row or not
-     * @type bool $_show_taxes
-     */
-    protected $_show_taxes = false;
-
-    /**
-     * html for any tax rows
-     * @type string $_show_taxes
-     */
-    protected $_taxes_html = '';
-
-
-    /**
-     * total amount including tax we can bill for at this time
-     * @type float $_grand_total
-     */
-    protected $_grand_total = 0.00;
-
-
-
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * This is used to output a single
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'odd' => true,
-            'use_table_wrapper' => true,
-            'table_css_class' => 'admin-primary-mbox-tbl',
-            'taxes_tr_css_class' => 'admin-primary-mbox-taxes-tr',
-            'total_tr_css_class' => 'admin-primary-mbox-total-tr'
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-            case EEM_Line_Item::type_sub_total:
-                if ($line_item->quantity() === 0) {
-                    return $html;
-                }
-                // loop through children
-                $child_line_items = $line_item->children();
-                // loop through children
-                foreach ($child_line_items as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_sub_total_row($line_item, $options);
-                break;
-
-            case EEM_Line_Item::type_tax:
-                if ($this->_show_taxes) {
-                    $this->_taxes_html .= $this->_tax_row($line_item, $options);
-                }
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-                foreach ($line_item->children() as $child_line_item) {
-                    if ($child_line_item->type() == EEM_Line_Item::type_tax) {
-                        $this->display_line_item($child_line_item, $options);
-                    }
-                }
-                break;
-
-            case EEM_Line_Item::type_total:
-                // determine whether to display taxes or not
-                $this->_show_taxes = $line_item->get_total_tax() > 0 ? true : false;
-                // get all child line items
-                $children = $line_item->children();
-
-                // loop thru all non-tax child line items
-                foreach ($children as $child_line_item) {
-                        $html .= $this->display_line_item($child_line_item, $options);
-                }
-
-                $html .= $this->_taxes_html;
-                $html .= $this->_total_row($line_item, $options);
-                if ($options['use_table_wrapper']) {
-                    $html = $this->_table_header($options) . $html . $this->_table_footer($options);
-                }
-                break;
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     * Table header for display.
-     * @since   4.8
-     * @param array $options
-     * @return string
-     */
-    protected function _table_header($options)
-    {
-        $html = EEH_HTML::table('', '', $options['table_css_class']);
-        $html .= EEH_HTML::thead();
-        $html .= EEH_HTML::tr();
-        $html .= EEH_HTML::th(__('Name', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Type', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Amount', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::th(__('Qty', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::th(__('Line Total', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::tbody();
-        return $html;
-    }
-
-
-    /**
-     * Table footer for display
-     * @since 4.8
-     * @param array $options array of options for the table.
-     * @return string
-     */
-    protected function _table_footer($options)
-    {
-        return EEH_HTML::tbodyx() .  EEH_HTML::tablex();
-    }
-
-
-
-    /**
-     *    _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        $line_item_related_object = $line_item->get_object();
-        $parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->get_object() : null;
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-
-
-        // Name Column
-        $name_link = $line_item_related_object instanceof EEI_Admin_Links ? $line_item_related_object->get_admin_details_link() : '';
-
-        // related object scope.
-        $parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object ? $parent_line_item_related_object->name() : '';
-        $parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->name() : $parent_related_object_name;
-        $parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links ? $parent_line_item_related_object->get_admin_details_link() : '';
-
-
-        $name_html = $line_item_related_object instanceof EEI_Line_Item_Object ? $line_item_related_object->name() : $line_item->name();
-        $name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>' : $name_html;
-        $name_html .= $line_item->is_taxable() ? ' *' : '';
-        // maybe preface with icon?
-        $name_html = $line_item_related_object instanceof EEI_Has_Icon ? $line_item_related_object->get_icon() . $name_html : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .=  sprintf(
-            _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
-            '<span class="ee-line-item-related-parent-object">',
-            $line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->OBJ_type_i18n() : __('Item:', 'event_espresso'),
-            $parent_related_object_link ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>' : $parent_related_object_name,
-            '</span>'
-        );
-        $html .= EEH_HTML::td($name_html, '', 'jst-left');
-        // Type Column
-        $type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
-        $type_html .= $this->_get_cancellations($line_item);
-        $type_html .= $line_item->OBJ_type() ? '<br />' : '';
-        $code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
-        $html .= EEH_HTML::td($type_html, '', 'jst-left');
-
-
-        // Amount Column
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
-        }
-
-        // QTY column
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'jst-rght');
-
-        // total column
-        $html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-
-        // finish things off and return
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *    _get_cancellations
-     *
-     * @param EE_Line_Item $line_item
-     * @return string
-     */
-    protected function _get_cancellations(EE_Line_Item $line_item)
-    {
-        $html = '';
-        $cancellations = $line_item->get_cancellations();
-        $cancellation = reset($cancellations);
-        // \EEH_Debug_Tools::printr( $cancellation, '$cancellation', __FILE__, __LINE__ );
-        if ($cancellation instanceof EE_Line_Item) {
-            $html .= ' <span class="ee-line-item-id">';
-            $html .= sprintf(
-                _n(
-                    '(%1$s Cancellation)',
-                    '(%1$s Cancellations)',
-                    $cancellation->quantity(),
-                    'event_espresso'
-                ),
-                $cancellation->quantity()
-            );
-            $html .= '</span>';
-        }
-        return $html;
-    }
-
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _sub_item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // for now we're not showing sub-items
-        return '';
-    }
-
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
-        // name th
-        $html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="4"');
-        // total th
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        // currently not showing subtotal row
-        return '';
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _total_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
-        // Total th label
-        $total_label = sprintf(__('Transaction Total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
-        $html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="4"');
-        // total th
-
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * whether to display the taxes row or not
+	 * @type bool $_show_taxes
+	 */
+	protected $_show_taxes = false;
+
+	/**
+	 * html for any tax rows
+	 * @type string $_show_taxes
+	 */
+	protected $_taxes_html = '';
+
+
+	/**
+	 * total amount including tax we can bill for at this time
+	 * @type float $_grand_total
+	 */
+	protected $_grand_total = 0.00;
+
+
+
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * This is used to output a single
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'odd' => true,
+			'use_table_wrapper' => true,
+			'table_css_class' => 'admin-primary-mbox-tbl',
+			'taxes_tr_css_class' => 'admin-primary-mbox-taxes-tr',
+			'total_tr_css_class' => 'admin-primary-mbox-total-tr'
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+			case EEM_Line_Item::type_sub_total:
+				if ($line_item->quantity() === 0) {
+					return $html;
+				}
+				// loop through children
+				$child_line_items = $line_item->children();
+				// loop through children
+				foreach ($child_line_items as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_sub_total_row($line_item, $options);
+				break;
+
+			case EEM_Line_Item::type_tax:
+				if ($this->_show_taxes) {
+					$this->_taxes_html .= $this->_tax_row($line_item, $options);
+				}
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+				foreach ($line_item->children() as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax) {
+						$this->display_line_item($child_line_item, $options);
+					}
+				}
+				break;
+
+			case EEM_Line_Item::type_total:
+				// determine whether to display taxes or not
+				$this->_show_taxes = $line_item->get_total_tax() > 0 ? true : false;
+				// get all child line items
+				$children = $line_item->children();
+
+				// loop thru all non-tax child line items
+				foreach ($children as $child_line_item) {
+						$html .= $this->display_line_item($child_line_item, $options);
+				}
+
+				$html .= $this->_taxes_html;
+				$html .= $this->_total_row($line_item, $options);
+				if ($options['use_table_wrapper']) {
+					$html = $this->_table_header($options) . $html . $this->_table_footer($options);
+				}
+				break;
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 * Table header for display.
+	 * @since   4.8
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _table_header($options)
+	{
+		$html = EEH_HTML::table('', '', $options['table_css_class']);
+		$html .= EEH_HTML::thead();
+		$html .= EEH_HTML::tr();
+		$html .= EEH_HTML::th(__('Name', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Type', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Amount', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::th(__('Qty', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::th(__('Line Total', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::tbody();
+		return $html;
+	}
+
+
+	/**
+	 * Table footer for display
+	 * @since 4.8
+	 * @param array $options array of options for the table.
+	 * @return string
+	 */
+	protected function _table_footer($options)
+	{
+		return EEH_HTML::tbodyx() .  EEH_HTML::tablex();
+	}
+
+
+
+	/**
+	 *    _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		$line_item_related_object = $line_item->get_object();
+		$parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->get_object() : null;
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+
+
+		// Name Column
+		$name_link = $line_item_related_object instanceof EEI_Admin_Links ? $line_item_related_object->get_admin_details_link() : '';
+
+		// related object scope.
+		$parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object ? $parent_line_item_related_object->name() : '';
+		$parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->name() : $parent_related_object_name;
+		$parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links ? $parent_line_item_related_object->get_admin_details_link() : '';
+
+
+		$name_html = $line_item_related_object instanceof EEI_Line_Item_Object ? $line_item_related_object->name() : $line_item->name();
+		$name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>' : $name_html;
+		$name_html .= $line_item->is_taxable() ? ' *' : '';
+		// maybe preface with icon?
+		$name_html = $line_item_related_object instanceof EEI_Has_Icon ? $line_item_related_object->get_icon() . $name_html : $name_html;
+		$name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+		$name_html .=  sprintf(
+			_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
+			'<span class="ee-line-item-related-parent-object">',
+			$line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->OBJ_type_i18n() : __('Item:', 'event_espresso'),
+			$parent_related_object_link ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>' : $parent_related_object_name,
+			'</span>'
+		);
+		$html .= EEH_HTML::td($name_html, '', 'jst-left');
+		// Type Column
+		$type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
+		$type_html .= $this->_get_cancellations($line_item);
+		$type_html .= $line_item->OBJ_type() ? '<br />' : '';
+		$code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
+		$type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
+		$html .= EEH_HTML::td($type_html, '', 'jst-left');
+
+
+		// Amount Column
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
+		}
+
+		// QTY column
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'jst-rght');
+
+		// total column
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+
+		// finish things off and return
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *    _get_cancellations
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return string
+	 */
+	protected function _get_cancellations(EE_Line_Item $line_item)
+	{
+		$html = '';
+		$cancellations = $line_item->get_cancellations();
+		$cancellation = reset($cancellations);
+		// \EEH_Debug_Tools::printr( $cancellation, '$cancellation', __FILE__, __LINE__ );
+		if ($cancellation instanceof EE_Line_Item) {
+			$html .= ' <span class="ee-line-item-id">';
+			$html .= sprintf(
+				_n(
+					'(%1$s Cancellation)',
+					'(%1$s Cancellations)',
+					$cancellation->quantity(),
+					'event_espresso'
+				),
+				$cancellation->quantity()
+			);
+			$html .= '</span>';
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _sub_item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// for now we're not showing sub-items
+		return '';
+	}
+
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
+		// name th
+		$html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="4"');
+		// total th
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		// currently not showing subtotal row
+		return '';
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _total_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
+		// Total th label
+		$total_label = sprintf(__('Transaction Total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+		$html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="4"');
+		// total th
+
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -117,7 +117,7 @@ 
                 $html .= $this->_taxes_html;
                 $html .= $this->_total_row($line_item, $options);
                 if ($options['use_table_wrapper']) {
-                    $html = $this->_table_header($options) . $html . $this->_table_footer($options);
+                    $html = $this->_table_header($options).$html.$this->_table_footer($options);
                 }
                 break;
         }
@@ -156,7 +156,7 @@ 
      */
     protected function _table_footer($options)
     {
-        return EEH_HTML::tbodyx() .  EEH_HTML::tablex();
+        return EEH_HTML::tbodyx().EEH_HTML::tablex();
     }
 
 
@@ -187,16 +187,16 @@ 
 
 
         $name_html = $line_item_related_object instanceof EEI_Line_Item_Object ? $line_item_related_object->name() : $line_item->name();
-        $name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>' : $name_html;
+        $name_html = $name_link ? '<a href="'.$name_link.'">'.$name_html.'</a>' : $name_html;
         $name_html .= $line_item->is_taxable() ? ' *' : '';
         // maybe preface with icon?
-        $name_html = $line_item_related_object instanceof EEI_Has_Icon ? $line_item_related_object->get_icon() . $name_html : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .=  sprintf(
+        $name_html = $line_item_related_object instanceof EEI_Has_Icon ? $line_item_related_object->get_icon().$name_html : $name_html;
+        $name_html = '<span class="ee-line-item-name linked">'.$name_html.'</span><br>';
+        $name_html .= sprintf(
             _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
             '<span class="ee-line-item-related-parent-object">',
             $line_item->parent() instanceof EE_Line_Item ? $line_item->parent()->OBJ_type_i18n() : __('Item:', 'event_espresso'),
-            $parent_related_object_link ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>' : $parent_related_object_name,
+            $parent_related_object_link ? '<a href="'.$parent_related_object_link.'">'.$parent_related_object_name.'</a>' : $parent_related_object_name,
             '</span>'
         );
         $html .= EEH_HTML::td($name_html, '', 'jst-left');
@@ -205,13 +205,13 @@ 
         $type_html .= $this->_get_cancellations($line_item);
         $type_html .= $line_item->OBJ_type() ? '<br />' : '';
         $code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
+        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">'.sprintf(__('Code: %s', 'event_espresso'), $code).'</span>' : '';
         $html .= EEH_HTML::td($type_html, '', 'jst-left');
 
 
         // Amount Column
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'jst-rght');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
         }
@@ -286,7 +286,7 @@ 
         // start of row
         $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
         // name th
-        $html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="4"');
+        $html .= EEH_HTML::th($line_item->name().'('.$line_item->get_pretty('LIN_percent').'%)', '', 'jst-rght', '', ' colspan="4"');
         // total th
         $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
         // end of row
@@ -325,7 +325,7 @@ 
         // start of row
         $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
         // Total th label
-        $total_label = sprintf(__('Transaction Total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+        $total_label = sprintf(__('Transaction Total %s', 'event_espresso'), '('.EE_Registry::instance()->CFG->currency->code.')');
         $html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="4"');
         // total th
 

core/libraries/line_item_display/EE_Default_Line_Item_Display_Strategy.strategy.php

Doc Comments +3 added lines, -3 removed lines

@@ -58,7 +58,7 @@ 
     /**
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     public function display_line_item(EE_Line_Item $line_item, $options = array())
     {
@@ -134,7 +134,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _item_row(EE_Line_Item $line_item, $options = array())
     {
@@ -189,7 +189,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _sub_item_row(EE_Line_Item $line_item, $options = array())
     {

Indentation +218 added lines, -218 removed lines

@@ -1,225 +1,225 @@
 <?php
  /**
- *
- * Class EE_Default_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Default_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 
 class EE_Default_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * total amount of tax to apply
-     * @type float $_tax_rate
-     */
-    private $_tax_rate = 0;
-
-    /**
-     * total amount including tax we can bill for at this time
-     * @type float $_grand_total
-     */
-    private $_grand_total = 0.00;
-
-    /**
-     * total number of items being billed for
-     * @type int $_total_items
-     */
-    private $_total_items = 0;
-
-
-
-    /**
-     * @return float
-     */
-    public function grand_total()
-    {
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function total_items()
-    {
-        return $this->_total_items;
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,  //    TRUE        FALSE
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
-                    $this->display_line_item($child_line_item, $options);
-                }
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-            case EEM_Line_Item::type_sub_total:
-                break;
-
-            case EEM_Line_Item::type_tax:
-                $this->_tax_rate += $line_item->percent();
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-                foreach ($line_item->children() as $child_line_item) {
-                    if ($child_line_item->type() == EEM_Line_Item::type_tax) {
-                        // recursively feed children back into this method
-                        $this->display_line_item($child_line_item, $options);
-                    }
-                }
-                break;
-
-            case EEM_Line_Item::type_total:
-                // get all child line items
-                $children = $line_item->children();
-                if ($options['set_tax_rate'] === true) {
-                    // loop thru tax child line items just to determine tax rate
-                    foreach ($children as $child_line_item) {
-                        if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
-                            // recursively feed children back into this method
-                            $this->display_line_item($child_line_item, $options);
-                        }
-                    }
-                } else {
-                    // now loop thru all non-tax child line items
-                    foreach ($children as $child_line_item) {
-                        if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
-                            // recursively feed children back into this method
-                            $html .= $this->display_line_item($child_line_item, $options);
-                        }
-                    }
-                }
-                break;
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-        // name && desc
-        $name_and_desc = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
-            $line_item->name(),
-            $line_item
-        );
-        $name_and_desc .= apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
-            ( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
-            $line_item,
-            $options
-        );
-        if ($line_item->is_taxable()) {
-            $ticket_price_includes_taxes = EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
-                ? esc_html__('* price includes taxes', 'event_espresso')
-                : esc_html__('* price does not include taxes', 'event_espresso');
-            $name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
-                  . $ticket_price_includes_taxes
-                  . '</span>';
-        }
-
-        // name td
-        $html .= EEH_HTML::td($name_and_desc, '', 'item_l');
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
-        $tax_rate = $line_item->is_taxable()
-                    && EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
-            ? 1 + ( $this->_tax_rate / 100 )
-            : 1;
-        // price td
-        $unit_price = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__unit_price',
-            EEH_Template::format_currency($line_item->unit_price() * $tax_rate, false, false),
-            $line_item,
-            $tax_rate
-        );
-        $html .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
-        // total td
-        $total = apply_filters(
-            'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
-            EEH_Template::format_currency($line_item->unit_price() * $line_item->quantity() * $tax_rate, false, false),
-            $line_item,
-            $tax_rate
-        );
-        $html .= EEH_HTML::td($total, '', 'item_r jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-
-        return $html;
-    }
-
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item-row');
-        // name && desc
-        $name_and_desc = $line_item->name();
-        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
-        // name td
-        $html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
-        }
-        // total td
-        $html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * total amount of tax to apply
+	 * @type float $_tax_rate
+	 */
+	private $_tax_rate = 0;
+
+	/**
+	 * total amount including tax we can bill for at this time
+	 * @type float $_grand_total
+	 */
+	private $_grand_total = 0.00;
+
+	/**
+	 * total number of items being billed for
+	 * @type int $_total_items
+	 */
+	private $_total_items = 0;
+
+
+
+	/**
+	 * @return float
+	 */
+	public function grand_total()
+	{
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function total_items()
+	{
+		return $this->_total_items;
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,  //    TRUE        FALSE
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
+					$this->display_line_item($child_line_item, $options);
+				}
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+			case EEM_Line_Item::type_sub_total:
+				break;
+
+			case EEM_Line_Item::type_tax:
+				$this->_tax_rate += $line_item->percent();
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+				foreach ($line_item->children() as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax) {
+						// recursively feed children back into this method
+						$this->display_line_item($child_line_item, $options);
+					}
+				}
+				break;
+
+			case EEM_Line_Item::type_total:
+				// get all child line items
+				$children = $line_item->children();
+				if ($options['set_tax_rate'] === true) {
+					// loop thru tax child line items just to determine tax rate
+					foreach ($children as $child_line_item) {
+						if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
+							// recursively feed children back into this method
+							$this->display_line_item($child_line_item, $options);
+						}
+					}
+				} else {
+					// now loop thru all non-tax child line items
+					foreach ($children as $child_line_item) {
+						if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
+							// recursively feed children back into this method
+							$html .= $this->display_line_item($child_line_item, $options);
+						}
+					}
+				}
+				break;
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+		// name && desc
+		$name_and_desc = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__name',
+			$line_item->name(),
+			$line_item
+		);
+		$name_and_desc .= apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
+			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			$line_item,
+			$options
+		);
+		if ($line_item->is_taxable()) {
+			$ticket_price_includes_taxes = EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
+				? esc_html__('* price includes taxes', 'event_espresso')
+				: esc_html__('* price does not include taxes', 'event_espresso');
+			$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'
+				  . $ticket_price_includes_taxes
+				  . '</span>';
+		}
+
+		// name td
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
+		$tax_rate = $line_item->is_taxable()
+					&& EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
+			? 1 + ( $this->_tax_rate / 100 )
+			: 1;
+		// price td
+		$unit_price = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__unit_price',
+			EEH_Template::format_currency($line_item->unit_price() * $tax_rate, false, false),
+			$line_item,
+			$tax_rate
+		);
+		$html .= EEH_HTML::td($unit_price, '', 'item_c jst-rght');
+		// total td
+		$total = apply_filters(
+			'FHEE__EE_Default_Line_Item_Display_Strategy___item_row__total',
+			EEH_Template::format_currency($line_item->unit_price() * $line_item->quantity() * $tax_rate, false, false),
+			$line_item,
+			$tax_rate
+		);
+		$html .= EEH_HTML::td($total, '', 'item_r jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+
+		return $html;
+	}
+
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item-row');
+		// name && desc
+		$name_and_desc = $line_item->name();
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
+		// name td
+		$html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
+		}
+		// total td
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -66,7 +66,7 @@ 
         $html = '';
         // set some default options and merge with incoming
         $default_options = array(
-            'show_desc' => true,  //    TRUE        FALSE
+            'show_desc' => true, //    TRUE        FALSE
             'odd' => false
         );
         $options = array_merge($default_options, (array) $options);
@@ -149,7 +149,7 @@ 
         );
         $name_and_desc .= apply_filters(
             'FHEE__EE_Default_Line_Item_Display_Strategy__item_row__desc',
-            ( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+            ($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : ''),
             $line_item,
             $options
         );
@@ -168,7 +168,7 @@ 
         $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
         $tax_rate = $line_item->is_taxable()
                     && EE_Registry::instance()->CFG->tax_settings->prices_displayed_including_taxes
-            ? 1 + ( $this->_tax_rate / 100 )
+            ? 1 + ($this->_tax_rate / 100)
             : 1;
         // price td
         $unit_price = apply_filters(
@@ -207,12 +207,12 @@ 
         $html = EEH_HTML::tr('', 'item sub-item-row');
         // name && desc
         $name_and_desc = $line_item->name();
-        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
+        $name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : '';
         // name td
         $html .= EEH_HTML::td(/*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item');
         // discount/surcharge td
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
         }

core/libraries/line_item_display/EE_Invoice_Line_Item_Display_Strategy.strategy.php

Doc Comments +6 added lines, -6 removed lines

@@ -17,7 +17,7 @@ 
     /**
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     public function display_line_item(EE_Line_Item $line_item, $options = array())
     {
@@ -92,7 +92,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _item_row(EE_Line_Item $line_item, $options = array())
     {
@@ -122,7 +122,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _sub_item_row(EE_Line_Item $line_item, $options = array())
     {
@@ -153,7 +153,7 @@ 
      *
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _tax_row(EE_Line_Item $line_item, $options = array())
     {
@@ -180,7 +180,7 @@ 
      * @param EE_Line_Item $line_item
      * @param string       $text
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
     {
@@ -205,7 +205,7 @@ 
      *  _separator_row
      *
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     private function _separator_row($options = array())
     {

Indentation +212 added lines, -212 removed lines

@@ -1,222 +1,222 @@
 <?php
  /**
- *
- * Class EE_Invoice_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Invoice_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 class EE_Invoice_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_separator_row($options);
-                $html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
-                    $this->display_line_item($child_line_item, $options);
-                }
-                break;
-
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax:
-                $html .= $this->_tax_row($line_item, $options);
-                break;
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', $row_class);
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
-        // price td
-        $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
-        // total td
-        $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
-        $html .= EEH_HTML::td($total, '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item-row');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
-        }
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item tax-total');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     */
-    private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="2"' : '';
-        // start of row
-        $html = EEH_HTML::tr('', '', 'total_tr odd');
-        // empty td
-        $html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _separator_row
-     *
-     * @param array        $options
-     * @return mixed
-     */
-    private function _separator_row($options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
-        // start of row
-        $html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_separator_row($options);
+				$html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
+					$this->display_line_item($child_line_item, $options);
+				}
+				break;
+
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax:
+				$html .= $this->_tax_row($line_item, $options);
+				break;
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', $row_class);
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
+		// price td
+		$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
+		// total td
+		$total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
+		$html .= EEH_HTML::td($total, '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item-row');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		$html .= EEH_HTML::td() . EEH_HTML::tdx();
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
+		}
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// percent td
+		$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="2"' : '';
+		// start of row
+		$html = EEH_HTML::tr('', '', 'total_tr odd');
+		// empty td
+		$html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _separator_row
+	 *
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _separator_row($options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
+		// start of row
+		$html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
 //      // separator td
 //      $html .= EEH_HTML::td( '<hr>', '',  '',  '',  $colspan );
 //      // end of row
 //      $html .= EEH_HTML::trx();
-        return $html;
-    }
+		return $html;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -108,7 +108,7 @@ 
         // price td
         $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
         // total td
-        $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
+        $total = $line_item->is_taxable() ? $line_item->total_no_code().'*' : $line_item->total_no_code();
         $html .= EEH_HTML::td($total, '', 'item_r');
         // end of row
         $html .= EEH_HTML::trx();
@@ -132,10 +132,10 @@ 
         $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
+        $html .= EEH_HTML::td().EEH_HTML::tdx();
         // discount/surcharge td
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
         }
@@ -164,7 +164,7 @@ 
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
         // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
+        $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c', '', ' colspan="2"');
         // total td
         $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
         // end of row

core/libraries/line_item_display/EE_Receipt_Line_Item_Display_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * @param EE_Line_Item $line_item
      * @param array        $options
-     * @return mixed
+     * @return string
      */
     public function display_line_item(EE_Line_Item $line_item, $options = array())
     {

Indentation +57 added lines, -57 removed lines

@@ -14,88 +14,88 @@
  * ------------------------------------------------------------------------
  */
  /**
- *
- * Class EE_Receipt_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Receipt_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 
 class EE_Receipt_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
 
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_separator_row( $options );
 //              $html .= $this->_total_row( $line_item, __('Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, __('Sub-Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, __('Tax Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_line_item:
-                // item row
+			case EEM_Line_Item::type_line_item:
+				// item row
 //              $html .= $this->_item_row( $line_item, $options );
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
 //                  $this->display_line_item( $child_line_item, $options );
-                }
-                break;
+				}
+				break;
 
 
-            case EEM_Line_Item::type_sub_line_item:
+			case EEM_Line_Item::type_sub_line_item:
 //              $html .= $this->_sub_item_row( $line_item, $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_tax:
 //              $html .= $this->_tax_row( $line_item, $options );
-                break;
-        }
+				break;
+		}
 
-        return $html;
-    }
+		return $html;
+	}
 }

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

Doc Comments +1 added lines

@@ -310,6 +310,7 @@
      * @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
+     * @param EE_Messages_Template_Pack_Default|null $default_pack
      *
      * @return string          The template contents.
      */

Indentation +469 added lines, -469 removed lines

@@ -14,511 +14,511 @@
 {
 
 
-    /**
-     * This defines the base_path where the templates are located.
-     *
-     * @since            4.5.0
-     *
-     * @var string
-     */
-    protected $_base_path;
+	/**
+	 * This defines the base_path where the templates are located.
+	 *
+	 * @since            4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_base_path;
 
 
 
 
-    /**
-     * This defines the base_url where things are found for this template pack (possibly variations).
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_base_url;
+	/**
+	 * This defines the base_url where things are found for this template pack (possibly variations).
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_base_url;
 
 
 
-    /**
-     * localized label for this template pack
-     *
-     * @since            4.5.0
-     *
-     * @var string
-     */
-    public $label;
+	/**
+	 * localized label for this template pack
+	 *
+	 * @since            4.5.0
+	 *
+	 * @var string
+	 */
+	public $label;
 
 
 
 
-    /**
-     * used to contain a description for the template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    public $description;
+	/**
+	 * used to contain a description for the template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	public $description;
 
 
 
 
-    /**
-     * How this template is referenced in the db
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    public $dbref;
+	/**
+	 * How this template is referenced in the db
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	public $dbref;
 
 
 
 
-    /**
-     * This is an array indexed by messenger and with an array of message types as values that indicate what messenger and message type this template pack supports by default.  It is possible for this to be modified by plugins via filters, but out of the box, this is what the template pack supports.
-     *
-     * @since 4.5.0
-     *
-     * @var array.
-     */
-    protected $_supports = array();
+	/**
+	 * This is an array indexed by messenger and with an array of message types as values that indicate what messenger and message type this template pack supports by default.  It is possible for this to be modified by plugins via filters, but out of the box, this is what the template pack supports.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array.
+	 */
+	protected $_supports = array();
 
 
 
 
 
-    /**
-     * Holds the retrieved default templates for this template pack in a multidimensional array indexed by context and field, for a given messenger and message type.  Example format:
-     *
-     * $templates = array(
-     *  'email' => array(
-     *      'registration' => array(
-     *          'admin' => array(
-     *              'to' => 'contents',
-     *              'from' => 'contents',
-     *              'subject' => 'contents',
-     *              'content' => 'contents',
-     *              'event_list' => 'contents',
-     *              'attendee_list' => 'contents'
-     *          ),
-     *          'attendee' => array(
-     *              'to' => 'contents',
-     *              'from' => 'contents',
-     *              'subject' => 'contents',
-     *              'content' => 'contents',
-     *              'event_list' => 'contents',
-     *              'attendee_list' => 'contents',
-     *          ),
-     *      )
-     *  )
-     * )
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected $_templates = array();
+	/**
+	 * Holds the retrieved default templates for this template pack in a multidimensional array indexed by context and field, for a given messenger and message type.  Example format:
+	 *
+	 * $templates = array(
+	 *  'email' => array(
+	 *      'registration' => array(
+	 *          'admin' => array(
+	 *              'to' => 'contents',
+	 *              'from' => 'contents',
+	 *              'subject' => 'contents',
+	 *              'content' => 'contents',
+	 *              'event_list' => 'contents',
+	 *              'attendee_list' => 'contents'
+	 *          ),
+	 *          'attendee' => array(
+	 *              'to' => 'contents',
+	 *              'from' => 'contents',
+	 *              'subject' => 'contents',
+	 *              'content' => 'contents',
+	 *              'event_list' => 'contents',
+	 *              'attendee_list' => 'contents',
+	 *          ),
+	 *      )
+	 *  )
+	 * )
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected $_templates = array();
 
 
 
 
 
 
-    /**
-     * Template Packs must ALWAYS have a default variation defined.  This property allow one to override the default variation labels per messenger.
-     * example:
-     * $this->_default_variation_labels = array( 'email' =>  __('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' =>  __('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(__('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(__('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(__('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(__('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(__('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(__('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 __('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 ] : __('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(__('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(__('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(__('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(__('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(__('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(__('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 __('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 ] : __('Default', 'event_espresso');
+
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
+	}
+
+
+
+
+
+	/**
+	 * This simply returns the _variations property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger if included then css variations matching the messenger are returned.  Otherwise, just the default variation is included.  If both message type AND messenger are empty then all variations are returned.
+	 * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
+	 * @return array
+	 */
+	public function get_variations($messenger = '', $message_type = '')
+	{
+		$messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
+
+		// message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
+		$variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
+
+		// now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
+		$variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
+
+		// filter per template pack and globally.
+		$variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
+		$variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
+
+		// prepend the _default_variation, but ONLY if we're returning the fully validated array.
+		if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
+			$variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
+		}
+
+		return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ): $variations;
+	}
+
+
+
+
+	/**
+	 * This is typically called by EE_messenger objects to get the specific css variation defined for the messenger, message_type and type (i.e. inline, wpeditor, preview etc.)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $messenger messenger slug
+	 * @param string $message_type message_type slug
+	 * @param string $type           variation type (i.e. inline, base, wpeditor, preview etc. //this varies per messenger).
+	 * @param string $variation    this should match one of the defined variations in the _variations property on this class.
+	 * @param string $file_extension  What type of file the variation file is (defaults to css)
+	 * @param bool   $url          if true then return the url otherwise path.
+	 * @param bool   $skip_filters This should not be set directly, its used internally to skip filters when the default template pack is called internally as the fallback.
+	 *
+	 * @return string The variation path or url (typically css reference)
+	 */
+	public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = false)
+	{
 
-        $base = $url ? $this->_base_url : $this->_base_path;
-        $base_path = $this->_base_path;
+		$base = $url ? $this->_base_url : $this->_base_path;
+		$base_path = $this->_base_path;
 
-        if (! $skip_filters) {
-            $base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
-            $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
-        }
+		if (! $skip_filters) {
+			$base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+			$base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
+		}
 
-        $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
-
-        // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
-
-        // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
-        // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
-        } else {
-            $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
-        }
+		$default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
+
+		// possible variation paths considering whether message type is present or not in the file name.
+		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
+		$default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+
+		// first see if fully validated file exists.
+		if (is_readable($base_path . $path_string)) {
+			$variation_path = $base . $path_string;
+		// otherwise see if default exists.
+		} elseif (is_readable($base_path . $default_path_string)) {
+			$variation_path = $base . $default_path_string;
+		} else {
+			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
+		}
 
-        if ($skip_filters) {
-            return $variation_path;
-        }
-
-        // filter result
-        $variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
-    }
-
-
-
-
-
-    /**
-     * This method is used to return the wrapper template for the given template pack.  If the given template pack does not include any wrapper templates then the default is used.
-     *
-     * @param string $messenger What messenger the wrapper is for.
-     * @param string $type           What type of wrapper is being returned ( for messengers that may have more than one wrapper )
-     *
-     * @return string returns the path for the requested wrapper template.
-     */
-    public function get_wrapper($messenger, $type = 'main')
-    {
-        $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
-
-        $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
-
-        if (is_readable($path_string)) {
-            $template = $path_string;
-        } else {
-            $template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
-        }
-
-        // filter
-        $template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
-        return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
-    }
+		if ($skip_filters) {
+			return $variation_path;
+		}
+
+		// filter result
+		$variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
+	}
+
+
+
+
+
+	/**
+	 * This method is used to return the wrapper template for the given template pack.  If the given template pack does not include any wrapper templates then the default is used.
+	 *
+	 * @param string $messenger What messenger the wrapper is for.
+	 * @param string $type           What type of wrapper is being returned ( for messengers that may have more than one wrapper )
+	 *
+	 * @return string returns the path for the requested wrapper template.
+	 */
+	public function get_wrapper($messenger, $type = 'main')
+	{
+		$default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
+
+		$path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+
+		if (is_readable($path_string)) {
+			$template = $path_string;
+		} else {
+			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
+		}
+
+		// filter
+		$template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
+	}
 }

Spacing +35 added lines, -35 removed lines

@@ -166,20 +166,20 @@ 
         // make sure required props have been set
 
         // if label is empty then throw an error because we should have it defined by now.
-        if (! isset($this->label)) {
+        if ( ! isset($this->label)) {
             throw new EE_Error(sprintf(__('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(__('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(__('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 ] : __('Default', 'event_espresso');
+        $label = empty($label) && ! empty($this->_default_variation_labels[$messenger]) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso');
 
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
     }
@@ -419,24 +419,24 @@ 
      */
     public function get_variations($messenger = '', $message_type = '')
     {
-        $messenger_variations = ! empty($messenger) && isset($this->_variations[ $messenger ]) ? $this->_variations[ $messenger ] : array();
+        $messenger_variations = ! empty($messenger) && isset($this->_variations[$messenger]) ? $this->_variations[$messenger] : array();
 
         // message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-        $variations = !empty($messenger) && !empty($message_type) && isset($messenger_variations[ $message_type ]) ? $messenger_variations[ $message_type ] : array();
+        $variations = ! empty($messenger) && ! empty($message_type) && isset($messenger_variations[$message_type]) ? $messenger_variations[$message_type] : array();
 
         // now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-        $variations = empty($variations) && !empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
+        $variations = empty($variations) && ! empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
 
         // filter per template pack and globally.
-        $variations = apply_filters('FHEE__' . get_class($this) . '__get_variations', $variations, $messenger, $message_type);
+        $variations = apply_filters('FHEE__'.get_class($this).'__get_variations', $variations, $messenger, $message_type);
         $variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
 
         // prepend the _default_variation, but ONLY if we're returning the fully validated array.
-        if (!empty($messenger) && !empty($message_type) && ! empty($variations)) {
-            $variations = array( 'default' => $this->get_default_variation_labels($messenger) ) + $variations;
+        if ( ! empty($messenger) && ! empty($message_type) && ! empty($variations)) {
+            $variations = array('default' => $this->get_default_variation_labels($messenger)) + $variations;
         }
 
-        return empty($variations) ? array( 'default' => $this->get_default_variation_labels('dft') ): $variations;
+        return empty($variations) ? array('default' => $this->get_default_variation_labels('dft')) : $variations;
     }
 
 
@@ -463,23 +463,23 @@ 
         $base = $url ? $this->_base_url : $this->_base_path;
         $base_path = $this->_base_path;
 
-        if (! $skip_filters) {
-            $base =  apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+        if ( ! $skip_filters) {
+            $base = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
             $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, false, $file_extension, $this);
         }
 
         $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
 
         // possible variation paths considering whether message type is present or not in the file name.
-        $path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-        $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+        $path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_'.$variation.$file_extension;
+        $default_path_string = 'variations/'.$messenger.'_'.$type.'_'.$variation.$file_extension;
 
         // first see if fully validated file exists.
-        if (is_readable($base_path . $path_string)) {
-            $variation_path = $base . $path_string;
+        if (is_readable($base_path.$path_string)) {
+            $variation_path = $base.$path_string;
         // otherwise see if default exists.
-        } elseif (is_readable($base_path . $default_path_string)) {
-            $variation_path = $base . $default_path_string;
+        } elseif (is_readable($base_path.$default_path_string)) {
+            $variation_path = $base.$default_path_string;
         } else {
             $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
         }
@@ -489,7 +489,7 @@ 
         }
 
         // filter result
-        $variation_path = apply_filters('FHEE__' . get_class($this) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+        $variation_path = apply_filters('FHEE__'.get_class($this).'__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
     }
 
@@ -509,7 +509,7 @@ 
     {
         $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : null;
 
-        $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+        $path_string = $this->_base_path.$messenger.'_'.$type.'_wrapper.template.php';
 
         if (is_readable($path_string)) {
             $template = $path_string;
@@ -518,7 +518,7 @@ 
         }
 
         // filter
-        $template = apply_filters('FHEE__' . get_class($this) . '__get_wrapper', $template, $messenger, $type);
+        $template = apply_filters('FHEE__'.get_class($this).'__get_wrapper', $template, $messenger, $type);
         return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
     }
 }

core/libraries/messages/EE_Message_To_Generate.php

Doc Comments +1 added lines, -1 removed lines

@@ -208,7 +208,7 @@
      * generates an EE_Message using the supplied arguments and some defaults
      *
      * @param array $properties
-     * @return string
+     * @return EE_Message
      */
     protected function _generate_message($properties = array())
     {

Indentation +300 added lines, -300 removed lines

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

Spacing +3 added lines, -3 removed lines

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