eventespresso / event-espresso-core

core/helpers/EEH_Qtip_Loader.helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
      * - registers and enqueues the qtip scripts and styles.
      *
      * @access public
-     * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
+     * @param  string[]  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
      * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
      * @return void
      */

Indentation +225 added lines, -225 removed lines

@@ -11,229 +11,229 @@
 class EEH_Qtip_Loader extends EEH_Base
 {
 
-    /**
-     * EEH_Qtip_Loader Object
-     * @var EEH_Qtip_Loader
-     * @access private
-     */
-    private static $_instance = null;
-
-    /**
-     * array of qtip config objects
-     * @var EE_Qtip_Config[]
-     */
-    private $_qtips = array();
-
-
-
-    /**
-     *@singleton method used to instantiate class object
-     *@access public
-     *@return EEH_Qtip_Loader instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null  or ! is_object(self::$_instance) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *private constructor to prevent direct creation
-     * @Constructor
-     * @access private
-     * @return \EEH_Qtip_Loader
-     */
-    private function __construct()
-    {
-        // let's just make sure this is instantiated in the right place.
-        if (did_action('wp_print_styles') || did_action('admin_head')) {
-            EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
-        }
-    }
-
-
-    /**
-     * Call this from wp_enqueue_scripts or admin_enqueue_scripts to setup and enqueue the qtip library
-     *
-     * @access public
-     * @return void
-     */
-    public function register_and_enqueue()
-    {
-        $qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-        $qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-        $qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
-
-        wp_register_script('qtip-map', $qtip_map, array(), '3', true);
-        wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', true);
-        wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
-
-        wp_register_style('qtip-css', $qtipcss, array(), '2.2');
-
-        // k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-        if (!empty($this->_qtips)) {
-            wp_enqueue_script('ee-qtip-helper');
-            wp_enqueue_style('qtip-css');
-            $qtips = array();
-            foreach ($this->_qtips as $qtip) {
-                $qts = $qtip->get_tips();
-                foreach ($qts as $qt) {
-                    if (! $qt instanceof EE_Qtip) {
-                        continue;
-                    }
-                    $qtips[] = array(
-                        'content_id' => $qt->content_id,
-                        'options' => $qt->options,
-                        'target' => $qt->target,
-                        );
-                }
-            }
-            if (!empty($qtips)) {
-                wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ));
-            }
-        } else {
-            // qtips has been requested without any registration (so assuming its just directly used in the admin).
-            wp_enqueue_script('qtip');
-            wp_enqueue_style('qtip-css');
-        }
-    }
-
-
-
-    /**
-     * This simply registers the given qtip config and:
-     * - adds it to the $_qtips property array.
-     * - sets up the content containers for all qtips in the config,
-     * - registers and enqueues the qtip scripts and styles.
-     *
-     * @access public
-     * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
-     * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
-     * @return void
-     */
-    public function register($configname, $paths = array())
-    {
-
-        // let's just make sure this is instantiated in the right place.
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
-        }
-
-        $configname = (array) $configname; // typecast to array
-        foreach ($configname as $config) {
-            $this->_register($config, $paths);
-        }
-
-        // hook into appropriate footer
-        $footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
-        add_action($footer_action, array($this, 'setup_qtip'), 10);
-
-        // make sure we "turn on" qtip js.
-        add_filter('FHEE_load_qtip', '__return_true');
-    }
-
-
-
-    /**
-     * private utility for registering and setting up qtip config objects
-     *
-     * @access private
-     * @param  string $config the short name of the class (will be used to generate the expected classname)
-     * @param  array  $paths  array of paths to check (or if empty we check core/libraries/qtips or assume its loaded)
-     * @throws EE_Error
-     * @return void
-     */
-    private function _register($config, $paths)
-    {
-        // before doing anything we have to make sure that EE_Qtip_Config parent is required.
-        EE_Registry::instance()->load_lib('Qtip_Config', array(), true);
-
-        if (!empty($paths)) {
-            $paths = (array) $paths;
-            foreach ($paths as $path) {
-                $path = $path . $config . '.lib.php';
-                if (!is_readable($path)) {
-                    continue;
-                } else {
-                    require_once $path;
-                }
-            }
-        }
-
-        // does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-        if (!class_exists($config)) {
-            $path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-            if (!is_readable($path)) {
-                throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
-            } else {
-                require_once $path;
-            }
-        }
-
-        // now we attempt a class_exists one more time.
-        if (!class_exists($config)) {
-            throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
-        }
-
-        // made it HERE?  FINALLY, let's get things setup.
-        $a = new ReflectionClass($config);
-        $qtip = $a->newInstance();
-
-        // verify that $qtip is a valid object
-        if (! $qtip instanceof EE_Qtip_Config) {
-            throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
-        }
-
-        $this->_qtips[] = $a->newInstance();
-    }
-
-
-
-    /**
-     * This takes care of generating the qtip content containers.
-     * Output gets put in the appropriate page footer (depending on context (either admin_footer or wp_footer) )
-     *
-     * @access public
-     * @return void
-     */
-    public function setup_qtip()
-    {
-        if (empty($this->_qtips)) {
-            return; // no qtips!
-        }
-
-        $content = array();
-
-        foreach ($this->_qtips as $qtip) {
-            $content[] = $this->_generate_content_container($qtip);
-        }
-
-        echo implode('<br />', $content);
-    }
-
-
-    /**
-     * Generates a content container from a given EE_Qtip_Config object.
-     *
-     * @param  EE_Qtip_Config $qtip
-     * @return string  (html content container for qtip);
-     */
-    private function _generate_content_container($qtip)
-    {
-        $qts = $qtip->get_tips();
-        $content = array();
-        foreach ($qts as $qt) {
-            if (! $qt instanceof EE_Qtip) {
-                continue;
-            }
-            $content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
-        }
-
-        return implode('<br />', $content);
-    }
+	/**
+	 * EEH_Qtip_Loader Object
+	 * @var EEH_Qtip_Loader
+	 * @access private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * array of qtip config objects
+	 * @var EE_Qtip_Config[]
+	 */
+	private $_qtips = array();
+
+
+
+	/**
+	 *@singleton method used to instantiate class object
+	 *@access public
+	 *@return EEH_Qtip_Loader instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null  or ! is_object(self::$_instance) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 * @Constructor
+	 * @access private
+	 * @return \EEH_Qtip_Loader
+	 */
+	private function __construct()
+	{
+		// let's just make sure this is instantiated in the right place.
+		if (did_action('wp_print_styles') || did_action('admin_head')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
+		}
+	}
+
+
+	/**
+	 * Call this from wp_enqueue_scripts or admin_enqueue_scripts to setup and enqueue the qtip library
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_and_enqueue()
+	{
+		$qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
+		$qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
+		$qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+
+		wp_register_script('qtip-map', $qtip_map, array(), '3', true);
+		wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', true);
+		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
+
+		wp_register_style('qtip-css', $qtipcss, array(), '2.2');
+
+		// k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
+		if (!empty($this->_qtips)) {
+			wp_enqueue_script('ee-qtip-helper');
+			wp_enqueue_style('qtip-css');
+			$qtips = array();
+			foreach ($this->_qtips as $qtip) {
+				$qts = $qtip->get_tips();
+				foreach ($qts as $qt) {
+					if (! $qt instanceof EE_Qtip) {
+						continue;
+					}
+					$qtips[] = array(
+						'content_id' => $qt->content_id,
+						'options' => $qt->options,
+						'target' => $qt->target,
+						);
+				}
+			}
+			if (!empty($qtips)) {
+				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ));
+			}
+		} else {
+			// qtips has been requested without any registration (so assuming its just directly used in the admin).
+			wp_enqueue_script('qtip');
+			wp_enqueue_style('qtip-css');
+		}
+	}
+
+
+
+	/**
+	 * This simply registers the given qtip config and:
+	 * - adds it to the $_qtips property array.
+	 * - sets up the content containers for all qtips in the config,
+	 * - registers and enqueues the qtip scripts and styles.
+	 *
+	 * @access public
+	 * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
+	 * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
+	 * @return void
+	 */
+	public function register($configname, $paths = array())
+	{
+
+		// let's just make sure this is instantiated in the right place.
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
+		}
+
+		$configname = (array) $configname; // typecast to array
+		foreach ($configname as $config) {
+			$this->_register($config, $paths);
+		}
+
+		// hook into appropriate footer
+		$footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
+		add_action($footer_action, array($this, 'setup_qtip'), 10);
+
+		// make sure we "turn on" qtip js.
+		add_filter('FHEE_load_qtip', '__return_true');
+	}
+
+
+
+	/**
+	 * private utility for registering and setting up qtip config objects
+	 *
+	 * @access private
+	 * @param  string $config the short name of the class (will be used to generate the expected classname)
+	 * @param  array  $paths  array of paths to check (or if empty we check core/libraries/qtips or assume its loaded)
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _register($config, $paths)
+	{
+		// before doing anything we have to make sure that EE_Qtip_Config parent is required.
+		EE_Registry::instance()->load_lib('Qtip_Config', array(), true);
+
+		if (!empty($paths)) {
+			$paths = (array) $paths;
+			foreach ($paths as $path) {
+				$path = $path . $config . '.lib.php';
+				if (!is_readable($path)) {
+					continue;
+				} else {
+					require_once $path;
+				}
+			}
+		}
+
+		// does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
+		if (!class_exists($config)) {
+			$path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
+			if (!is_readable($path)) {
+				throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
+			} else {
+				require_once $path;
+			}
+		}
+
+		// now we attempt a class_exists one more time.
+		if (!class_exists($config)) {
+			throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
+		}
+
+		// made it HERE?  FINALLY, let's get things setup.
+		$a = new ReflectionClass($config);
+		$qtip = $a->newInstance();
+
+		// verify that $qtip is a valid object
+		if (! $qtip instanceof EE_Qtip_Config) {
+			throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
+		}
+
+		$this->_qtips[] = $a->newInstance();
+	}
+
+
+
+	/**
+	 * This takes care of generating the qtip content containers.
+	 * Output gets put in the appropriate page footer (depending on context (either admin_footer or wp_footer) )
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function setup_qtip()
+	{
+		if (empty($this->_qtips)) {
+			return; // no qtips!
+		}
+
+		$content = array();
+
+		foreach ($this->_qtips as $qtip) {
+			$content[] = $this->_generate_content_container($qtip);
+		}
+
+		echo implode('<br />', $content);
+	}
+
+
+	/**
+	 * Generates a content container from a given EE_Qtip_Config object.
+	 *
+	 * @param  EE_Qtip_Config $qtip
+	 * @return string  (html content container for qtip);
+	 */
+	private function _generate_content_container($qtip)
+	{
+		$qts = $qtip->get_tips();
+		$content = array();
+		foreach ($qts as $qt) {
+			if (! $qt instanceof EE_Qtip) {
+				continue;
+			}
+			$content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+		}
+
+		return implode('<br />', $content);
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -34,7 +34,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (self::$_instance === null  or ! is_object(self::$_instance) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EEH_Qtip_Loader)) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -65,25 +65,25 @@ 
      */
     public function register_and_enqueue()
     {
-        $qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-        $qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-        $qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+        $qtips_js = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.js';
+        $qtip_map = EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.map';
+        $qtipcss = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.css';
 
         wp_register_script('qtip-map', $qtip_map, array(), '3', true);
         wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', true);
-        wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS.'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, true);
 
         wp_register_style('qtip-css', $qtipcss, array(), '2.2');
 
         // k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-        if (!empty($this->_qtips)) {
+        if ( ! empty($this->_qtips)) {
             wp_enqueue_script('ee-qtip-helper');
             wp_enqueue_style('qtip-css');
             $qtips = array();
             foreach ($this->_qtips as $qtip) {
                 $qts = $qtip->get_tips();
                 foreach ($qts as $qt) {
-                    if (! $qt instanceof EE_Qtip) {
+                    if ( ! $qt instanceof EE_Qtip) {
                         continue;
                     }
                     $qtips[] = array(
@@ -93,8 +93,8 @@ 
                         );
                 }
             }
-            if (!empty($qtips)) {
-                wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ));
+            if ( ! empty($qtips)) {
+                wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array('qtips' => $qtips));
             }
         } else {
             // qtips has been requested without any registration (so assuming its just directly used in the admin).
@@ -153,11 +153,11 @@ 
         // before doing anything we have to make sure that EE_Qtip_Config parent is required.
         EE_Registry::instance()->load_lib('Qtip_Config', array(), true);
 
-        if (!empty($paths)) {
+        if ( ! empty($paths)) {
             $paths = (array) $paths;
             foreach ($paths as $path) {
-                $path = $path . $config . '.lib.php';
-                if (!is_readable($path)) {
+                $path = $path.$config.'.lib.php';
+                if ( ! is_readable($path)) {
                     continue;
                 } else {
                     require_once $path;
@@ -166,9 +166,9 @@ 
         }
 
         // does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-        if (!class_exists($config)) {
-            $path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-            if (!is_readable($path)) {
+        if ( ! class_exists($config)) {
+            $path = EE_LIBRARIES.'qtips/'.$config.'.lib.php';
+            if ( ! is_readable($path)) {
                 throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
             } else {
                 require_once $path;
@@ -176,7 +176,7 @@ 
         }
 
         // now we attempt a class_exists one more time.
-        if (!class_exists($config)) {
+        if ( ! class_exists($config)) {
             throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
         }
 
@@ -185,7 +185,7 @@ 
         $qtip = $a->newInstance();
 
         // verify that $qtip is a valid object
-        if (! $qtip instanceof EE_Qtip_Config) {
+        if ( ! $qtip instanceof EE_Qtip_Config) {
             throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
         }
 
@@ -228,10 +228,10 @@ 
         $qts = $qtip->get_tips();
         $content = array();
         foreach ($qts as $qt) {
-            if (! $qt instanceof EE_Qtip) {
+            if ( ! $qt instanceof EE_Qtip) {
                 continue;
             }
-            $content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+            $content[] = '<div class="ee-qtip-helper-content hidden" id="'.$qt->content_id.'">'.$qt->content.'</div>';
         }
 
         return implode('<br />', $content);

core/helpers/EEH_Template.helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -308,7 +308,7 @@ 
      * _find_common_base_path
      * given two paths, this determines if there is a common base path between the two
      *
-     * @param array $paths
+     * @param string[] $paths
      * @return string
      */
     protected static function _find_common_base_path($paths)
@@ -338,7 +338,7 @@ 
      * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
      * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
      *                                      not found or is not readable
-     * @return mixed string
+     * @return string string
      * @throws \DomainException
      */
     public static function display_template(

Indentation +962 added lines, -962 removed lines

@@ -5,35 +5,35 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 
 if (! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @return string        the html output for the formatted money value
-     */
-    function espresso_get_template_part($slug = null, $name = null)
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @return string        the html output for the formatted money value
+	 */
+	function espresso_get_template_part($slug = null, $name = null)
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if (! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -48,672 +48,672 @@ 
 class EEH_Template
 {
 
-    private static $_espresso_themes = array();
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
-    }
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load it's functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes()
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return array();
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
-            }
-            EEH_Template::$_espresso_themes = array();
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = null,
-        $name = null,
-        $template_args = array(),
-        $return_string = false
-    ) {
-        do_action("get_template_part_{$slug}-{$name}", $slug, $name);
-        $templates = array();
-        $name      = (string) $name;
-        if ($name != '') {
-            $templates[] = "{$slug}-{$name}.php";
-        }
-        // allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
-            EEH_Template::locate_template($templates, $template_args, true, $return_string);
-        }
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param  array       $template_args   an array of arguments to be extracted for use in the template
-     * @param  boolean     $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return mixed
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function locate_template(
-        $templates = array(),
-        $template_args = array(),
-        $load = true,
-        $return_string = true,
-        $check_if_custom = false
-    ) {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = locate_template($templates);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                // get post_type
-                $post_type = EE_Registry::instance()->REQ->get('post_type');
-                /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-                $custom_post_types = LoaderFactory::getLoader()->getShared(
-                    'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-                );
-                // get array of EE Custom Post Types
-                $EE_CPTs = $custom_post_types->getDefinitions();
-                // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-
-            // array of paths to folders that may contain templates
-            $template_folder_paths = array(
-                // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
-                // then in the root of the /wp-content/uploads/espresso/templates/ folder
-                EVENT_ESPRESSO_TEMPLATE_DIR,
-            );
-
-            // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = array(
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                );
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths
-            );
-            $templates             = is_array($templates) ? $templates : array($templates);
-            $template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
-            // array to hold all possible template paths
-            $full_template_paths = array();
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        array($template_folder_path, $template_path_minus_file_name)
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths,
-                $file_name
-            );
-            // now loop through our final array of template location paths and check each location
-            foreach ((array) $full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
-                    break;
-                }
-            }
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            } else {
-                EEH_Template::display_template($template_path, $template_args, false);
-            }
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path server path to the file to be loaded, including file name and extension
-     * @param  array      $template_args an array of arguments to be extracted for use in the template
-     * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return mixed string
-     * @throws \DomainException
-     */
-    public static function display_template(
-        $template_path = false,
-        $template_args = array(),
-        $return_string = false,
-        $throw_exceptions = false
-    ) {
-
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
-            return '';
-        }
-        // if $template_args are not in an array, then make it so
-        if (! is_array($template_args) && ! is_object($template_args)) {
-            $template_args = array($template_args);
-        }
-        extract($template_args, EXTR_SKIP);
-        // ignore whether template is accessible ?
-        if ($throw_exceptions && ! is_readable($template_path)) {
-            throw new \DomainException(
-                esc_html__(
-                    'Invalid, unreadable, or missing file.',
-                    'event_espresso'
-                )
-            );
-        }
-
-
-        if ($return_string) {
-            // because we want to return a string, we are going to capture the output
-            ob_start();
-            include($template_path);
-            return ob_get_clean();
-        } else {
-            include($template_path);
-        }
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            switch ($obj_class) {
-                // no specifics just yet...
-                default:
-                    $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-            }
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param  float   $amount       raw money value
-     * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string   $CNT_ISO      2 letter ISO code for a country
-     * @param string   $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     * @throws \EE_Error
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        // ensure amount is float
-        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number or was amount converted to a string like "free" ?
-        if (is_float($amount_formatted)) {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-            // verify results
-            if (! $mny instanceof EE_Currency_Config) {
-                // set default config country currency settings
-                $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                    ? EE_Registry::instance()->CFG->currency
-                    : new EE_Currency_Config();
-            }
-            // format float
-            $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-            // add formatting ?
-            if (! $return_raw) {
-                // add currency sign
-                if ($mny->sign_b4) {
-                    if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
-                    } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                    }
-                } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
-                }
-
-                // filter to allow global setting of display_code
-                $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
-
-                // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
-            }
-            // filter results
-            $amount_formatted = apply_filters(
-                'FHEE__EEH_Template__format_currency__amount_formatted',
-                $amount_formatted,
-                $mny,
-                $return_raw
-            );
-        }
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param  boolean $plural    Whether to return plural or not
-     * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        /** @type EEM_Status $EEM_Status */
-        $EEM_Status = EE_Registry::instance()->load_model('Status');
-        $status     = $EEM_Status->localized_status(
-            array($status_id => __('unknown', 'event_espresso')),
-            $plural,
-            $schema
-        );
-        return $status[ $status_id ];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param  string $url   the url for the link, note that `esc_url` will be called on it
-     * @param  string $label What is the label you want displayed for the button
-     * @param  string $class what class is used for the button (defaults to 'button-primary')
-     * @param string  $icon
-     * @param string  $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if (! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
-        return $button;
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param  string     $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-
-        if (! $page) {
-            $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
-        }
-
-        if (! $action) {
-            $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
-        }
-
-        $action = empty($action) ? 'default' : $action;
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__(
-            'Click to open the \'Help\' tab for more information about this feature.',
-            'event_espresso'
-        ) . '" > ' . $help_text . ' </a>';
-    }
-
-
-    /**
-     * This helper generates the html structure for the jquery joyride plugin with the given params.
-     *
-     * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
-     * @param EE_Help_Tour
-     * @return string         html
-     */
-    public static function help_tour_stops_generator(EE_Help_Tour $tour)
-    {
-        $id    = $tour->get_slug();
-        $stops = $tour->get_stops();
-
-        $content = '<ol style="display:none" id="' . $id . '">';
-
-        foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
-
-            // if container is set to modal then let's make sure we set the options accordingly
-            if (empty($data_id) && empty($data_class)) {
-                $stop['options']['modal']  = true;
-                $stop['options']['expose'] = true;
-            }
-
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
-            $inner_content = isset($stop['content']) ? $stop['content'] : '';
-
-            // options
-            if (isset($stop['options']) && is_array($stop['options'])) {
-                $options = ' data-options="';
-                foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
-                }
-                $options .= '"';
-            } else {
-                $options = '';
-            }
-
-            // let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
-        }
-
-        $content .= '</ol>';
-        return $content;
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param  array  $status_array  array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @throws EE_Error
-     * @return string               html structure for status.
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if (! is_array($status_array)) {
-            throw new EE_Error(esc_html__(
-                'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                'event_espresso'
-            ));
-        }
-
-        $setup_array = array();
-        foreach ($status_array as $item => $status) {
-            $setup_array[ $item ] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
-                'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
-                'status' => $status,
-            );
-        }
-
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
-        foreach ($setup_array as $item => $details) {
-            $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
-        }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array) $data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) {
-                ?>
+	private static $_espresso_themes = array();
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
+	}
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load it's functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes()
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return array();
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[ $key ]);
+			}
+			EEH_Template::$_espresso_themes = array();
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = null,
+		$name = null,
+		$template_args = array(),
+		$return_string = false
+	) {
+		do_action("get_template_part_{$slug}-{$name}", $slug, $name);
+		$templates = array();
+		$name      = (string) $name;
+		if ($name != '') {
+			$templates[] = "{$slug}-{$name}.php";
+		}
+		// allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
+			EEH_Template::locate_template($templates, $template_args, true, $return_string);
+		}
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param  array       $template_args   an array of arguments to be extracted for use in the template
+	 * @param  boolean     $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function locate_template(
+		$templates = array(),
+		$template_args = array(),
+		$load = true,
+		$return_string = true,
+		$check_if_custom = false
+	) {
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = locate_template($templates);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				// get post_type
+				$post_type = EE_Registry::instance()->REQ->get('post_type');
+				/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+				$custom_post_types = LoaderFactory::getLoader()->getShared(
+					'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+				);
+				// get array of EE Custom Post Types
+				$EE_CPTs = $custom_post_types->getDefinitions();
+				// build template name based on request
+				if (isset($EE_CPTs[ $post_type ])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates         = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+
+			// array of paths to folders that may contain templates
+			$template_folder_paths = array(
+				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
+				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+				// then in the root of the /wp-content/uploads/espresso/templates/ folder
+				EVENT_ESPRESSO_TEMPLATE_DIR,
+			);
+
+			// add core plugin folders for checking only if we're not $check_if_custom
+			if (! $check_if_custom) {
+				$core_paths            = array(
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				);
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths
+			);
+			$templates             = is_array($templates) ? $templates : array($templates);
+			$template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
+			// array to hold all possible template paths
+			$full_template_paths = array();
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						array($template_folder_path, $template_path_minus_file_name)
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths,
+				$file_name
+			);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array) $full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
+					break;
+				}
+			}
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			} else {
+				EEH_Template::display_template($template_path, $template_args, false);
+			}
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path server path to the file to be loaded, including file name and extension
+	 * @param  array      $template_args an array of arguments to be extracted for use in the template
+	 * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return mixed string
+	 * @throws \DomainException
+	 */
+	public static function display_template(
+		$template_path = false,
+		$template_args = array(),
+		$return_string = false,
+		$throw_exceptions = false
+	) {
+
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if (! $template_path || ! is_readable($template_path)) {
+			return '';
+		}
+		// if $template_args are not in an array, then make it so
+		if (! is_array($template_args) && ! is_object($template_args)) {
+			$template_args = array($template_args);
+		}
+		extract($template_args, EXTR_SKIP);
+		// ignore whether template is accessible ?
+		if ($throw_exceptions && ! is_readable($template_path)) {
+			throw new \DomainException(
+				esc_html__(
+					'Invalid, unreadable, or missing file.',
+					'event_espresso'
+				)
+			);
+		}
+
+
+		if ($return_string) {
+			// because we want to return a string, we are going to capture the output
+			ob_start();
+			include($template_path);
+			return ob_get_clean();
+		} else {
+			include($template_path);
+		}
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			switch ($obj_class) {
+				// no specifics just yet...
+				default:
+					$class = strtolower(str_replace('_', '-', $obj_class));
+					$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+			}
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param  float   $amount       raw money value
+	 * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string   $CNT_ISO      2 letter ISO code for a country
+	 * @param string   $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 * @throws \EE_Error
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		// ensure amount is float
+		$amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number or was amount converted to a string like "free" ?
+		if (is_float($amount_formatted)) {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+			// verify results
+			if (! $mny instanceof EE_Currency_Config) {
+				// set default config country currency settings
+				$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+					? EE_Registry::instance()->CFG->currency
+					: new EE_Currency_Config();
+			}
+			// format float
+			$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+			// add formatting ?
+			if (! $return_raw) {
+				// add currency sign
+				if ($mny->sign_b4) {
+					if ($amount >= 0) {
+						$amount_formatted = $mny->sign . $amount_formatted;
+					} else {
+						$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+					}
+				} else {
+					$amount_formatted = $amount_formatted . $mny->sign;
+				}
+
+				// filter to allow global setting of display_code
+				$display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
+
+				// add currency code ?
+				$amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+			}
+			// filter results
+			$amount_formatted = apply_filters(
+				'FHEE__EEH_Template__format_currency__amount_formatted',
+				$amount_formatted,
+				$mny,
+				$return_raw
+			);
+		}
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param  boolean $plural    Whether to return plural or not
+	 * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		/** @type EEM_Status $EEM_Status */
+		$EEM_Status = EE_Registry::instance()->load_model('Status');
+		$status     = $EEM_Status->localized_status(
+			array($status_id => __('unknown', 'event_espresso')),
+			$plural,
+			$schema
+		);
+		return $status[ $status_id ];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param  string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param  string $label What is the label you want displayed for the button
+	 * @param  string $class what class is used for the button (defaults to 'button-primary')
+	 * @param string  $icon
+	 * @param string  $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if (! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		$label  = ! empty($icon) ? $icon_html . $label : $label;
+		$button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+		return $button;
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param  string     $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+
+		if (! $page) {
+			$page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
+		}
+
+		if (! $action) {
+			$action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
+		}
+
+		$action = empty($action) ? 'default' : $action;
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__(
+			'Click to open the \'Help\' tab for more information about this feature.',
+			'event_espresso'
+		) . '" > ' . $help_text . ' </a>';
+	}
+
+
+	/**
+	 * This helper generates the html structure for the jquery joyride plugin with the given params.
+	 *
+	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
+	 * @param EE_Help_Tour
+	 * @return string         html
+	 */
+	public static function help_tour_stops_generator(EE_Help_Tour $tour)
+	{
+		$id    = $tour->get_slug();
+		$stops = $tour->get_stops();
+
+		$content = '<ol style="display:none" id="' . $id . '">';
+
+		foreach ($stops as $stop) {
+			$data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
+			$data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+
+			// if container is set to modal then let's make sure we set the options accordingly
+			if (empty($data_id) && empty($data_class)) {
+				$stop['options']['modal']  = true;
+				$stop['options']['expose'] = true;
+			}
+
+			$custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
+			$button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+			$inner_content = isset($stop['content']) ? $stop['content'] : '';
+
+			// options
+			if (isset($stop['options']) && is_array($stop['options'])) {
+				$options = ' data-options="';
+				foreach ($stop['options'] as $option => $value) {
+					$options .= $option . ':' . $value . ';';
+				}
+				$options .= '"';
+			} else {
+				$options = '';
+			}
+
+			// let's put all together
+			$content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+		}
+
+		$content .= '</ol>';
+		return $content;
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param  array  $status_array  array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @throws EE_Error
+	 * @return string               html structure for status.
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if (! is_array($status_array)) {
+			throw new EE_Error(esc_html__(
+				'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+				'event_espresso'
+			));
+		}
+
+		$setup_array = array();
+		foreach ($status_array as $item => $status) {
+			$setup_array[ $item ] = array(
+				'class'  => 'ee-status-legend ee-status-legend-' . $status,
+				'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
+				'status' => $status,
+			);
+		}
+
+		$content = '<div class="ee-list-table-legend-container">' . "\n";
+		$content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
+		$content .= '<dl class="ee-list-table-legend">' . "\n\t";
+		foreach ($setup_array as $item => $details) {
+			$active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
+			$content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
+			$content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
+			$content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
+			$content .= '</dt>' . "\n";
+		}
+		$content .= '</dl>' . "\n";
+		$content .= '</div>' . "\n";
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array) $data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) {
+				?>
                 <table class="widefat">
                     <tbody>
                     <?php
-                    foreach ($data as $data_key => $data_values) {
-                        ?>
+					foreach ($data as $data_key => $data_values) {
+						?>
                         <tr>
                             <td>
                                 <?php echo $data_key; ?>
@@ -723,291 +723,291 @@ 
                             </td>
                         </tr>
                         <?php
-                    } ?>
+					} ?>
                     </tbody>
                 </table>
                 <?php
-            } else {
-                ?>
+			} else {
+				?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
                 <?php
-            }
-        } else {
-            // simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @since 4.4.0
-     * @see   self:get_paging_html() for argument docs.
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @return string
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        echo self::get_paging_html(
-            $total_items,
-            $current,
-            $per_page,
-            $url,
-            $show_num_field,
-            $paged_arg_name,
-            $items_label
-        );
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     * @param  integer $total_items     How many total items there are to page.
-     * @param  integer $current         What the current page is.
-     * @param  integer $per_page        How many items per page.
-     * @param  string  $url             What the base url for page links is.
-     * @param  boolean $show_num_field  Whether to show the input for changing page number.
-     * @param  string  $paged_arg_name  The name of the key for the paged query argument.
-     * @param  array   $items_label     An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     */
-    public static function get_paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        $page_links     = array();
-        $disable_first  = $disable_last = '';
-        $total_items    = (int) $total_items;
-        $per_page       = (int) $per_page;
-        $current        = (int) $current;
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        // filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = array(
-                'single' => __('1 item', 'event_espresso'),
-                'plural' => __('%s items', 'event_espresso'),
-            );
-        } else {
-            $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            );
-        }
-
-        $total_pages = ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        if ($current === 1) {
-            $disable_first = ' disabled';
-        }
-        if ($current == $total_pages) {
-            $disable_last = ' disabled';
-        }
-
-        $page_links[] = sprintf(
-            "<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
-            esc_attr__('Go to the first page', 'event_espresso'),
-            esc_url(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
-            esc_attr__('Go to the previous page', 'event_espresso'),
-            esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        if (! $show_num_field) {
-            $html_current_page = $current;
-        } else {
-            $html_current_page = sprintf(
-                "<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page', 'event_espresso'),
-                $current,
-                strlen($total_pages)
-            );
-        }
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
-            $html_current_page,
-            $html_total_pages,
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
-            esc_attr__('Go to the next page', 'event_espresso'),
-            esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
-            esc_attr__('Go to the last page', 'event_espresso'),
-            esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-        // set page class
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        } else {
-            $page_class = ' no-pages';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string $wrap_class
-     * @param string $wrap_id
-     * @return string
-     */
-    public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
-    {
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (! $admin &&
-            ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
-        $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            array(
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ),
-            $query_args
-        );
-        $powered_by = apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
-        );
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string) apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<{$tag}{$attributes}>",
-                "<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-    }
+			}
+		} else {
+			// simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @since 4.4.0
+	 * @see   self:get_paging_html() for argument docs.
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @return string
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		echo self::get_paging_html(
+			$total_items,
+			$current,
+			$per_page,
+			$url,
+			$show_num_field,
+			$paged_arg_name,
+			$items_label
+		);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 * @param  integer $total_items     How many total items there are to page.
+	 * @param  integer $current         What the current page is.
+	 * @param  integer $per_page        How many items per page.
+	 * @param  string  $url             What the base url for page links is.
+	 * @param  boolean $show_num_field  Whether to show the input for changing page number.
+	 * @param  string  $paged_arg_name  The name of the key for the paged query argument.
+	 * @param  array   $items_label     An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 */
+	public static function get_paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		$page_links     = array();
+		$disable_first  = $disable_last = '';
+		$total_items    = (int) $total_items;
+		$per_page       = (int) $per_page;
+		$current        = (int) $current;
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		// filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = array(
+				'single' => __('1 item', 'event_espresso'),
+				'plural' => __('%s items', 'event_espresso'),
+			);
+		} else {
+			$items_label = array(
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			);
+		}
+
+		$total_pages = ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		if ($current === 1) {
+			$disable_first = ' disabled';
+		}
+		if ($current == $total_pages) {
+			$disable_last = ' disabled';
+		}
+
+		$page_links[] = sprintf(
+			"<a class='%s' title='%s' href='%s'>%s</a>",
+			'first-page' . $disable_first,
+			esc_attr__('Go to the first page', 'event_espresso'),
+			esc_url(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'prev-page' . $disable_first,
+			esc_attr__('Go to the previous page', 'event_espresso'),
+			esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		if (! $show_num_field) {
+			$html_current_page = $current;
+		} else {
+			$html_current_page = sprintf(
+				"<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page', 'event_espresso'),
+				$current,
+				strlen($total_pages)
+			);
+		}
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
+			$html_current_page,
+			$html_total_pages,
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'next-page' . $disable_last,
+			esc_attr__('Go to the next page', 'event_espresso'),
+			esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'last-page' . $disable_last,
+			esc_attr__('Go to the last page', 'event_espresso'),
+			esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+		// set page class
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		} else {
+			$page_class = ' no-pages';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string $wrap_class
+	 * @param string $wrap_id
+	 * @return string
+	 */
+	public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
+	{
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (! $admin &&
+			! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
+		$wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			array(
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			),
+			$query_args
+		);
+		$powered_by = apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+		);
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		return (string) apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<{$tag}{$attributes}>",
+				"<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+	}
 }
 
 
 
 
 if (! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            array(
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            )
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			array(
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			)
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }
\ No newline at end of file

Spacing +74 added lines, -74 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\services\loaders\LoaderFactory;
 
-if (! function_exists('espresso_get_template_part')) {
+if ( ! function_exists('espresso_get_template_part')) {
     /**
      * espresso_get_template_part
      * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
@@ -21,7 +21,7 @@ 
 }
 
 
-if (! function_exists('espresso_get_object_css_class')) {
+if ( ! function_exists('espresso_get_object_css_class')) {
     /**
      * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
      *
@@ -69,9 +69,9 @@ 
      */
     public static function load_espresso_theme_functions()
     {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php');
             }
         }
     }
@@ -85,16 +85,16 @@ 
     public static function get_espresso_themes()
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return array();
             }
             if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
+                unset($espresso_themes[$key]);
             }
             EEH_Template::$_espresso_themes = array();
             foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
             }
         }
         return EEH_Template::$_espresso_themes;
@@ -205,10 +205,10 @@ 
                 // get array of EE Custom Post Types
                 $EE_CPTs = $custom_post_types->getDefinitions();
                 // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
+                if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
+                    $templates         = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -217,18 +217,18 @@ 
             // array of paths to folders that may contain templates
             $template_folder_paths = array(
                 // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+                EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme,
                 // then in the root of the /wp-content/uploads/espresso/templates/ folder
                 EVENT_ESPRESSO_TEMPLATE_DIR,
             );
 
             // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = array(
+            if ( ! $check_if_custom) {
+                $core_paths = array(
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 );
@@ -261,10 +261,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -272,7 +272,7 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().'/'.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters(
@@ -361,11 +361,11 @@ 
         $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
 
         // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
+        if ( ! $template_path || ! is_readable($template_path)) {
             return '';
         }
         // if $template_args are not in an array, then make it so
-        if (! is_array($template_args) && ! is_object($template_args)) {
+        if ( ! is_array($template_args) && ! is_object($template_args)) {
             $template_args = array($template_args);
         }
         extract($template_args, EXTR_SKIP);
@@ -403,11 +403,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -417,10 +417,10 @@ 
                 // no specifics just yet...
                 default:
                     $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+                    $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
             }
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -461,7 +461,7 @@ 
             // was a country ISO code passed ? if so generate currency config object for that country
             $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
             // verify results
-            if (! $mny instanceof EE_Currency_Config) {
+            if ( ! $mny instanceof EE_Currency_Config) {
                 // set default config country currency settings
                 $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                     ? EE_Registry::instance()->CFG->currency
@@ -470,23 +470,23 @@ 
             // format float
             $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
             // add formatting ?
-            if (! $return_raw) {
+            if ( ! $return_raw) {
                 // add currency sign
                 if ($mny->sign_b4) {
                     if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
+                        $amount_formatted = $mny->sign.$amount_formatted;
                     } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                        $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                     }
                 } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
+                    $amount_formatted = $amount_formatted.$mny->sign;
                 }
 
                 // filter to allow global setting of display_code
                 $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
 
                 // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+                $amount_formatted = $display_code ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>' : $amount_formatted;
             }
             // filter results
             $amount_formatted = apply_filters(
@@ -523,7 +523,7 @@ 
             $plural,
             $schema
         );
-        return $status[ $status_id ];
+        return $status[$status_id];
     }
 
 
@@ -540,19 +540,19 @@ 
     public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
     {
         $icon_html = '';
-        if (! empty($icon)) {
+        if ( ! empty($icon)) {
             $dashicons = preg_split("(ee-icon |dashicons )", $icon);
             $dashicons = array_filter($dashicons);
             $count     = count($dashicons);
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
                 $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+        $label  = ! empty($icon) ? $icon_html.$label : $label;
+        $button = '<a id="'.sanitize_title_with_dashes($label).'" href="'.esc_url($url).'" class="'.$class.'" title="'.$title.'">'.$label.'</a>';
         return $button;
     }
 
@@ -575,24 +575,24 @@ 
         $help_text = false
     ) {
 
-        if (! $page) {
+        if ( ! $page) {
             $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
         }
 
-        if (! $action) {
+        if ( ! $action) {
             $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
         }
 
         $action = empty($action) ? 'default' : $action;
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__(
+        return '<a id="'.$help_tab_lnk.'" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'.$icon.'" title="'.esc_attr__(
             'Click to open the \'Help\' tab for more information about this feature.',
             'event_espresso'
-        ) . '" > ' . $help_text . ' </a>';
+        ).'" > '.$help_text.' </a>';
     }
 
 
@@ -609,11 +609,11 @@ 
         $id    = $tour->get_slug();
         $stops = $tour->get_stops();
 
-        $content = '<ol style="display:none" id="' . $id . '">';
+        $content = '<ol style="display:none" id="'.$id.'">';
 
         foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+            $data_id    = ! empty($stop['id']) ? ' data-id="'.$stop['id'].'"' : '';
+            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="'.$stop['class'].'"' : '';
 
             // if container is set to modal then let's make sure we set the options accordingly
             if (empty($data_id) && empty($data_class)) {
@@ -621,15 +621,15 @@ 
                 $stop['options']['expose'] = true;
             }
 
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+            $custom_class  = ! empty($stop['custom_class']) ? ' class="'.$stop['custom_class'].'"' : '';
+            $button_text   = ! empty($stop['button_text']) ? ' data-button="'.$stop['button_text'].'"' : '';
             $inner_content = isset($stop['content']) ? $stop['content'] : '';
 
             // options
             if (isset($stop['options']) && is_array($stop['options'])) {
                 $options = ' data-options="';
                 foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
+                    $options .= $option.':'.$value.';';
                 }
                 $options .= '"';
             } else {
@@ -637,7 +637,7 @@ 
             }
 
             // let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+            $content .= '<li'.$data_id.$data_class.$custom_class.$button_text.$options.'>'.$inner_content.'</li>';
         }
 
         $content .= '</ol>';
@@ -661,7 +661,7 @@ 
      */
     public static function status_legend($status_array, $active_status = '')
     {
-        if (! is_array($status_array)) {
+        if ( ! is_array($status_array)) {
             throw new EE_Error(esc_html__(
                 'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
                 'event_espresso'
@@ -670,25 +670,25 @@ 
 
         $setup_array = array();
         foreach ($status_array as $item => $status) {
-            $setup_array[ $item ] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
+            $setup_array[$item] = array(
+                'class'  => 'ee-status-legend ee-status-legend-'.$status,
                 'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
                 'status' => $status,
             );
         }
 
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
+        $content = '<div class="ee-list-table-legend-container">'."\n";
+        $content .= '<h4 class="status-legend-title">'.esc_html__('Status Legend', 'event_espresso').'</h4>'."\n";
+        $content .= '<dl class="ee-list-table-legend">'."\n\t";
         foreach ($setup_array as $item => $details) {
             $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
+            $content .= '<dt id="ee-legend-item-tooltip-'.$item.'"'.$active_class.'>'."\n\t\t";
+            $content .= '<span class="'.$details['class'].'"></span>'."\n\t\t";
+            $content .= '<span class="ee-legend-description">'.$details['desc'].'</span>'."\n\t";
+            $content .= '</dt>'."\n";
         }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
+        $content .= '</dl>'."\n";
+        $content .= '</div>'."\n";
         return $content;
     }
 
@@ -833,8 +833,8 @@ 
             );
         } else {
             $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             );
         }
 
@@ -846,7 +846,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         if ($current === 1) {
             $disable_first = ' disabled';
@@ -857,7 +857,7 @@ 
 
         $page_links[] = sprintf(
             "<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
+            'first-page'.$disable_first,
             esc_attr__('Go to the first page', 'event_espresso'),
             esc_url(remove_query_arg($paged_arg_name, $url)),
             '&laquo;'
@@ -865,13 +865,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
+            'prev-page'.$disable_first,
             esc_attr__('Go to the previous page', 'event_espresso'),
             esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
             '&lsaquo;'
         );
 
-        if (! $show_num_field) {
+        if ( ! $show_num_field) {
             $html_current_page = $current;
         } else {
             $html_current_page = sprintf(
@@ -886,7 +886,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
             $html_current_page,
             $html_total_pages,
@@ -896,7 +896,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
+            'next-page'.$disable_last,
             esc_attr__('Go to the next page', 'event_espresso'),
             esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
             '&rsaquo;'
@@ -904,13 +904,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
+            'last-page'.$disable_last,
             esc_attr__('Go to the last page', 'event_espresso'),
             esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
         // set page class
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
@@ -918,7 +918,7 @@ 
             $page_class = ' no-pages';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -930,7 +930,7 @@ 
     public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
     {
         $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (! $admin &&
+        if ( ! $admin &&
             ! apply_filters(
                 'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
                 EE_Registry::instance()->CFG->admin->show_reg_footer
@@ -955,7 +955,7 @@ 
         );
         $powered_by = apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso'
         );
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
@@ -980,7 +980,7 @@ 
 
 
 
-if (! function_exists('espresso_pagination')) {
+if ( ! function_exists('espresso_pagination')) {
     /**
      *    espresso_pagination
      *
@@ -1008,6 +1008,6 @@ 
                 'add_fragment' => '',
             )
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }
\ No newline at end of file

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 +328 added lines, -328 removed lines

@@ -14,332 +14,332 @@
 {
 
 
-    /**
-     * 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>'
-        );
-
-        $name_html = apply_filters(
-            'FHEE__EE_Admin_Table_Line_Item_Display_Strategy___item_row__name_html',
-            $name_html,
-            $line_item,
-            $options
-        );
-
-        $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>'
+		);
+
+		$name_html = apply_filters(
+			'FHEE__EE_Admin_Table_Line_Item_Display_Strategy___item_row__name_html',
+			$name_html,
+			$line_item,
+			$options
+		);
+
+		$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>'
         );
 
@@ -213,13 +213,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');
         }
@@ -294,7 +294,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
@@ -333,7 +333,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;
+	}
 }