eventespresso / event-espresso-core

core/helpers/EEH_Qtip_Loader.helper.php

Indentation +226 added lines, -226 removed lines

@@ -12,230 +12,230 @@
 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', esc_html__('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()', esc_html__('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(esc_html__('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(esc_html__('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="' . esc_attr($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', esc_html__('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()', esc_html__('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(esc_html__('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(esc_html__('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="' . esc_attr($qt->content_id) . '">' .
+						 $qt->content . '</div>';
+		}
+
+		return implode('<br />', $content);
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -35,7 +35,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;
@@ -66,25 +66,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(
@@ -94,8 +94,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).
@@ -154,11 +154,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;
@@ -167,9 +167,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(esc_html__('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;
@@ -177,7 +177,7 @@ 
         }
 
         // now we attempt a class_exists one more time.
-        if (!class_exists($config)) {
+        if ( ! class_exists($config)) {
             throw new EE_Error(sprintf(esc_html__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
         }
 
@@ -186,7 +186,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>'));
         }
 
@@ -229,11 +229,11 @@ 
         $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="' . esc_attr($qt->content_id) . '">' .
-                         $qt->content . '</div>';
+            $content[] = '<div class="ee-qtip-helper-content hidden" id="'.esc_attr($qt->content_id).'">'.
+                         $qt->content.'</div>';
         }
 
         return implode('<br />', $content);

core/helpers/EEH_Venue_View.helper.php

Spacing +11 added lines, -11 removed lines

@@ -99,7 +99,7 @@ 
             }
         }
         // now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
-        if (! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
+        if ( ! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
             // sigh... pull it from the db
             EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
         }
@@ -175,7 +175,7 @@ 
     public static function is_venue_private($VNU_ID = false)
     {
         $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if (! $venue instanceof EE_Venue) {
+        if ( ! $venue instanceof EE_Venue) {
             return null;
         }
 
@@ -260,11 +260,11 @@ 
         $venue = EEH_Venue_View::get_venue($VNU_ID);
         if ($venue instanceof EE_Venue) {
             $excerpt    = $venue->excerpt() != null && $venue->excerpt() ? $venue->excerpt() : $venue->description();
-            $venue_link = ' ' . EEH_Venue_View::venue_details_link(
+            $venue_link = ' '.EEH_Venue_View::venue_details_link(
                 $venue->ID(),
-                esc_html__('more', 'event_espresso') . '…'
+                esc_html__('more', 'event_espresso').'…'
             );
-            return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '') . $venue_link : '';
+            return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '').$venue_link : '';
         }
         return '';
     }
@@ -299,7 +299,7 @@ 
                              ))
                             || ! $hide_uncategorized)
                     ) {
-                        $category_links[] = '<a href="' . esc_url($url) . '" rel="tag">' . $term->name . '</a> ';
+                        $category_links[] = '<a href="'.esc_url($url).'" rel="tag">'.$term->name.'</a> ';
                     }
                 }
             }
@@ -367,7 +367,7 @@ 
             $venue_name = apply_filters(
                 'FHEE__EEH_Venue__venue_name__append_private_venue_name',
                 EEH_Venue_View::is_venue_private()
-                    ? EEH_Venue_View::$_venue->name() . "&nbsp;" . esc_html__('(Private)', 'event_espresso')
+                    ? EEH_Venue_View::$_venue->name()."&nbsp;".esc_html__('(Private)', 'event_espresso')
                     : EEH_Venue_View::$_venue->name(),
                 EEH_Venue_View::$_venue
             );
@@ -480,7 +480,7 @@ 
                 $options      = [];
 
                 $options['map_ID'] = $map_ID && $map_ID != $venue->ID()
-                    ? $map_ID . '-' . $venue->ID()
+                    ? $map_ID.'-'.$venue->ID()
                     : $venue->ID();
 
                 $options['location'] = EEH_Address::format($venue, 'inline', false, false);
@@ -627,11 +627,11 @@ 
                 $post_type_obj = get_post_type_object('espresso_venues');
                 // build final link html
                 $link =
-                    '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr(
+                    '<a class="post-edit-link" href="'.$url.'" title="'.esc_attr(
                         $post_type_obj->labels->edit_item
-                    ) . '">' . $link . '</a>';
+                    ).'">'.$link.'</a>';
                 // put it all together
-                return $before . apply_filters('edit_post_link', $link, $venue->ID()) . $after;
+                return $before.apply_filters('edit_post_link', $link, $venue->ID()).$after;
             }
         }
         return '';

Indentation +626 added lines, -626 removed lines

@@ -10,630 +10,630 @@
 class EEH_Venue_View extends EEH_Base
 {
 
-    /**
-     * @access    private
-     * @var EE_Venue
-     */
-    private static $_venue = null;
-
-
-    /**
-     *    get_venue
-     *    attempts to retrieve an EE_Venue object any way it can
-     *
-     * @access    public
-     * @param int  $VNU_ID
-     * @param bool $look_in_event
-     * @param bool $privacy_check   Defaults to true.
-     *                              When false, means even if the venue is private we return it regardless of access.
-     * @param bool $password_check
-     * @return EE_Venue|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_venue($VNU_ID = 0, $look_in_event = true, $privacy_check = true, $password_check = true)
-    {
-        $VNU_ID = absint($VNU_ID);
-        // do we already have the Venue you are looking for?
-        if (EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
-            // If the Venue ID matches $VNU_ID, return the venue.
-            if (EEH_Venue_View::$_venue->ID() === $VNU_ID) {
-                return EEH_Venue_View::_get_venue($privacy_check);
-            }
-            // If the Venue ID does not match, try pulling a venue using $VNU_ID.
-            $venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-            if ($venue instanceof EE_Venue) {
-                EEH_Venue_View::$_venue = $venue;
-                return EEH_Venue_View::_get_venue($privacy_check);
-            }
-        }
-        // international newspaper?
-        global $post;
-        if ($post instanceof WP_Post) {
-            switch ($post->post_type) {
-                // if this is being called from an EE_Venue post,
-                // and the EE_Venue post corresponds to the EE_Venue that is being asked for,
-                // then we can try to just grab the attached EE_Venue object
-                case 'espresso_venues':
-                    // the post already contains the related EE_Venue object AND one of the following is TRUE:
-                    // the requested Venue ID matches the post ID OR...
-                    // there was no specific Venue ID requested
-                    if (isset($post->EE_Venue) && ($VNU_ID == $post->ID || ! $VNU_ID)) {
-                        // use existing related EE_Venue object
-                        EEH_Venue_View::$_venue = $post->EE_Venue;
-                    } elseif ($VNU_ID) {
-                        // there WAS a specific Venue ID requested, but it's NOT the current post object
-                        EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-                    } else {
-                        // no specific Venue ID requested, so use post ID to generate EE_Venue object
-                        EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($post->ID);
-                    }
-                    break;
-
-                case 'espresso_events':
-                    if ($look_in_event) {
-                        // grab the events related venues
-                        $venues = EEH_Venue_View::get_event_venues();
-                        // make sure the result is an array
-                        $venues = is_array($venues) ? $venues : [];
-                        // do we have an ID for a specific venue?
-                        if ($VNU_ID) {
-                            // loop thru the related venues
-                            foreach ($venues as $venue) {
-                                if ($venue instanceof EE_Venue) {
-                                    // until we find the venue we're looking for
-                                    if ($venue->ID() == $VNU_ID) {
-                                        EEH_Venue_View::$_venue = $venue;
-                                        break;
-                                    }
-                                }
-                            }
-                            // no venue ID ?
-                            // then the global post is an events post and this function was called with no argument
-                        } else {
-                            // just grab the first related event venue
-                            EEH_Venue_View::$_venue = reset($venues);
-                        }
-                    }
-                    break;
-            }
-        }
-        // now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
-        if (! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
-            // sigh... pull it from the db
-            EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
-        }
-        return EEH_Venue_View::_get_venue($privacy_check, $password_check);
-    }
-
-
-    /**
-     * return a single venue
-     *
-     * @param bool $privacy_check   Defaults to true.
-     *                              When false, means even if the venue is private we return it regardless of access.
-     * @param bool $password_check
-     * @return  EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _get_venue($privacy_check = true, $password_check = true)
-    {
-        // check for private venues.
-        if (
-            EEH_Venue_View::$_venue instanceof EE_Venue
-            && EEH_Venue_View::$_venue->status() == 'private'
-            && $privacy_check
-            && ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')
-        ) {
-            return null;
-        }
-        // check for password protected venues
-        if (
-            EEH_Venue_View::$_venue instanceof EE_Venue
-            && $password_check
-            && post_password_required(EEH_Venue_View::$_venue->ID())
-        ) {
-            return null;
-        }
-        return EEH_Venue_View::$_venue instanceof EE_Venue ? EEH_Venue_View::$_venue : null;
-    }
-
-
-    /**
-     *  get_event_venues
-     *
-     * @access     public
-     * @return     EE_Venue[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event_venues()
-    {
-        global $post;
-        if ($post->post_type == 'espresso_events') {
-            if (isset($post->EE_Event) && $post->EE_Event instanceof EE_Event) {
-                return $post->EE_Event->venues();
-            }
-        }
-        return [];
-    }
-
-
-    /**
-     * Simply checks whether a venue for the given ID (or the internally derived venue is private).
-     *
-     * Note: This will return true if its private, null if the venue doesn't exist, and false, if the venue exists but
-     * is not private.  So it is important to do explicit boolean checks when using this conditional.
-     *
-     * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
-     *
-     * @return bool|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_venue_private($VNU_ID = false)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if (! $venue instanceof EE_Venue) {
-            return null;
-        }
-
-        return $venue->status() == 'private';
-    }
-
-
-    /**
-     * returns true or false if a venue is password protected or not
-     *
-     * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_venue_password_protected($VNU_ID = false)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
-        if (
-            $venue instanceof EE_Venue
-            && post_password_required($venue->ID())
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * If a venue is password protected, this will return the password form for gaining access
-     * returns an empty string otherwise
-     *
-     * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function password_protected_venue_form($VNU_ID = false)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
-        if (
-            $venue instanceof EE_Venue
-            && post_password_required($venue->ID())
-        ) {
-            return get_the_password_form($venue->ID());
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_description
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_description($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return $venue->get_pretty('VNU_desc');
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_excerpt
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_excerpt($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            $excerpt    = $venue->excerpt() != null && $venue->excerpt() ? $venue->excerpt() : $venue->description();
-            $venue_link = ' ' . EEH_Venue_View::venue_details_link(
-                $venue->ID(),
-                esc_html__('more', 'event_espresso') . '…'
-            );
-            return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '') . $venue_link : '';
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_categories
-     *
-     * @access    public
-     * @param int  $VNU_ID
-     * @param bool $hide_uncategorized
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_categories($VNU_ID = 0, $hide_uncategorized = true)
-    {
-        $category_links = [];
-        $venue          = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            // get category terms
-            if ($venue_categories = get_the_terms($venue->ID(), 'espresso_venue_categories')) {
-                // loop thru terms and create links
-                foreach ($venue_categories as $term) {
-                    $url = get_term_link($term, 'espresso_venue_categories');
-                    if (
-                        ! is_wp_error($url)
-                        && (($hide_uncategorized
-                             && strtolower($term->name) != esc_html__(
-                                 'uncategorized',
-                                 'event_espresso'
-                             ))
-                            || ! $hide_uncategorized)
-                    ) {
-                        $category_links[] = '<a href="' . esc_url($url) . '" rel="tag">' . $term->name . '</a> ';
-                    }
-                }
-            }
-        }
-        return implode(', ', $category_links);
-    }
-
-
-    /**
-     *    venue_address
-     *
-     * @access    public
-     * @param string $type
-     * @param int    $VNU_ID
-     * @param bool   $use_schema
-     * @param bool   $add_wrapper
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_address($type = 'multiline', $VNU_ID = 0, $use_schema = true, $add_wrapper = true)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Address::format($venue, $type, $use_schema, $add_wrapper);
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_has_address
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return bool|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_has_address($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Address::format($venue, 'inline', false, false);
-        }
-        return false;
-    }
-
-
-    /**
-     *    venue_name
-     *
-     * @access    public
-     * @param string $link_to - options( details, website, none ) whether to turn Venue name into a clickable link to
-     *                        the Venue's details page or website
-     * @param int    $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_name($link_to = 'details', $VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            $venue_name = apply_filters(
-                'FHEE__EEH_Venue__venue_name__append_private_venue_name',
-                EEH_Venue_View::is_venue_private()
-                    ? EEH_Venue_View::$_venue->name() . "&nbsp;" . esc_html__('(Private)', 'event_espresso')
-                    : EEH_Venue_View::$_venue->name(),
-                EEH_Venue_View::$_venue
-            );
-            $venue_name = EEH_Schema::name($venue_name);
-
-            // if venue is trashed then ignore the "link to" setting because the venue is trashed.
-            if ($venue->get('status') == 'trash') {
-                $link_to = '';
-            }
-            switch ($link_to) {
-                case 'details':
-                    return EEH_Venue_View::venue_details_link($venue->ID(), $venue_name);
-
-                case 'website':
-                    return EEH_Venue_View::venue_website_link($venue->ID(), $venue_name);
-
-                default:
-                    return $venue_name;
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_details_link
-     *
-     * @access    public
-     * @param int    $VNU_ID
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_details_link($VNU_ID = 0, $text = '')
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Schema::url(get_permalink($venue->ID()), $text);
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_website_link
-     *
-     * @access    public
-     * @param int    $VNU_ID
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_website_link($VNU_ID = 0, $text = '')
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            $url  = $venue->venue_url();
-            $text = ! empty($text) ? $text : $url;
-            return ! empty($url) ? EEH_Schema::url($url, $text, ['target' => '_blank']) : '';
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_phone
-     *
-     * @access    public
-     * @param int $VNU_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_phone($VNU_ID = 0)
-    {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            return EEH_Schema::telephone($venue->phone());
-        }
-        return '';
-    }
-
-
-    /**
-     *    venue_gmap
-     *
-     * @access    public
-     * @param int         $VNU_ID
-     * @param bool|string $map_ID a unique identifier for this map
-     * @param array       $gmap   map options
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function venue_gmap($VNU_ID = 0, $map_ID = false, $gmap = [])
-    {
-
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            // check for global espresso_events post and use it's ID if no map_ID is set
-            global $post;
-            $map_ID = empty($map_ID) && $post->post_type == 'espresso_events' ? $post->ID : $map_ID;
-            // grab map settings
-            $map_cfg = EE_Registry::instance()->CFG->map_settings;
-            // are maps enabled ?
-            if ($map_cfg->use_google_maps && $venue->enable_for_gmap()) {
-                $details_page = is_single();
-                $options      = [];
-
-                $options['map_ID'] = $map_ID && $map_ID != $venue->ID()
-                    ? $map_ID . '-' . $venue->ID()
-                    : $venue->ID();
-
-                $options['location'] = EEH_Address::format($venue, 'inline', false, false);
-
-                $options['ee_map_width'] = $details_page
-                    ? $map_cfg->event_details_map_width
-                    : $map_cfg->event_list_map_width;
-
-                $options['ee_map_width'] = isset($gmap['ee_map_width']) && ! empty($gmap['ee_map_width'])
-                    ? $gmap['ee_map_width']
-                    : $options['ee_map_width'];
-
-                $options['ee_map_height'] = $details_page
-                    ? $map_cfg->event_details_map_height
-                    : $map_cfg->event_list_map_height;
-
-                $options['ee_map_height'] = isset($gmap['ee_map_height']) && ! empty($gmap['ee_map_height'])
-                    ? $gmap['ee_map_height']
-                    : $options['ee_map_height'];
-
-                $options['ee_map_zoom'] = $details_page
-                    ? $map_cfg->event_details_map_zoom
-                    : $map_cfg->event_list_map_zoom;
-
-                $options['ee_map_zoom'] = isset($gmap['ee_map_zoom']) && ! empty($gmap['ee_map_zoom'])
-                    ? $gmap['ee_map_zoom']
-                    : $options['ee_map_zoom'];
-
-                $options['ee_map_nav_display'] = $details_page
-                    ? $map_cfg->event_details_display_nav
-                    : $map_cfg->event_list_display_nav;
-
-                $options['ee_map_nav_display'] =
-                    isset($gmap['ee_map_nav_display']) && ! empty($gmap['ee_map_nav_display'])
-                        ? 'true'
-                        : $options['ee_map_nav_display'];
-
-                $options['ee_map_nav_size'] = $details_page
-                    ? $map_cfg->event_details_nav_size
-                    : $map_cfg->event_list_nav_size;
-
-                $options['ee_map_nav_size'] = isset($gmap['ee_map_nav_size']) && ! empty($gmap['ee_map_nav_size'])
-                    ? $gmap['ee_map_nav_size']
-                    : $options['ee_map_nav_size'];
-
-                $options['ee_map_type_control'] = $details_page
-                    ? $map_cfg->event_details_control_type
-                    : $map_cfg->event_list_control_type;
-
-                $options['ee_map_type_control'] =
-                    isset($gmap['ee_map_type_control']) && ! empty($gmap['ee_map_type_control'])
-                        ? $gmap['ee_map_type_control']
-                        : $options['ee_map_type_control'];
-
-                $options['ee_map_align'] = $details_page
-                    ? $map_cfg->event_details_map_align
-                    : $map_cfg->event_list_map_align;
-
-                $options['ee_map_align'] = isset($gmap['ee_map_align']) && ! empty($gmap['ee_map_align'])
-                    ? $gmap['ee_map_align']
-                    : $options['ee_map_align'];
-
-                $options['ee_static_url'] = isset($gmap['ee_static_url']) && ! empty($gmap['ee_static_url'])
-                    ? (bool) absint($gmap['ee_static_url'])
-                    : $venue->google_map_link();
-
-                return EEH_Maps::google_map($options);
-            }
-        }
-
-        return '';
-    }
-
-
-    /**
-     * Gets the HTML to display a static map of the venue
-     *
-     * @param EE_Venue $venue
-     * @param array    $attributes like EEH_Maps::google_map_link
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function espresso_google_static_map(EE_Venue $venue, $attributes = [])
-    {
-        $state      = $venue->state_obj();
-        $country    = $venue->country_obj();
-        $attributes = shortcode_atts(
-            [
-                'id'      => $venue->ID(),
-                'address' => $venue->get('VNU_address'),
-                'city'    => $venue->get('VNU_city'),
-                'state'   => $state instanceof EE_State ? $state->name() : '',
-                'zip'     => $venue->get('VNU_zip'),
-                'country' => $country instanceof EE_Country ? $country->name() : '',
-                'type'    => 'map',
-                'map_w'   => 200,
-                'map_h'   => 200,
-            ],
-            $attributes
-        );
-        return EEH_Maps::google_map_link($attributes);
-    }
-
-
-    /**
-     *    edit_venue_link
-     *
-     * @access    public
-     * @param int    $VNU_ID
-     * @param string $link
-     * @param string $before
-     * @param string $after
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function edit_venue_link(
-        $VNU_ID = 0,
-        $link = '',
-        $before = '<p class="edit-venue-lnk small-txt">',
-        $after = '</p>'
-    ) {
-        $venue = EEH_Venue_View::get_venue($VNU_ID);
-        if ($venue instanceof EE_Venue) {
-            // can the user edit this post ?
-            if (current_user_can('edit_post', $venue->ID())) {
-                // set link text
-                $link = ! empty($link) ? $link : esc_html__('edit this venue', 'event_espresso');
-                // generate nonce
-                $nonce = wp_create_nonce('edit_nonce');
-                // generate url to venue editor for this venue
-                $url =
-                    add_query_arg(
-                        [
-                            'page'       => 'espresso_venues',
-                            'action'     => 'edit',
-                            'post'       => $venue->ID(),
-                            'edit_nonce' => $nonce,
-                        ],
-                        admin_url('admin.php')
-                    );
-                // get edit CPT text
-                $post_type_obj = get_post_type_object('espresso_venues');
-                // build final link html
-                $link =
-                    '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr(
-                        $post_type_obj->labels->edit_item
-                    ) . '">' . $link . '</a>';
-                // put it all together
-                return $before . apply_filters('edit_post_link', $link, $venue->ID()) . $after;
-            }
-        }
-        return '';
-    }
+	/**
+	 * @access    private
+	 * @var EE_Venue
+	 */
+	private static $_venue = null;
+
+
+	/**
+	 *    get_venue
+	 *    attempts to retrieve an EE_Venue object any way it can
+	 *
+	 * @access    public
+	 * @param int  $VNU_ID
+	 * @param bool $look_in_event
+	 * @param bool $privacy_check   Defaults to true.
+	 *                              When false, means even if the venue is private we return it regardless of access.
+	 * @param bool $password_check
+	 * @return EE_Venue|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_venue($VNU_ID = 0, $look_in_event = true, $privacy_check = true, $password_check = true)
+	{
+		$VNU_ID = absint($VNU_ID);
+		// do we already have the Venue you are looking for?
+		if (EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
+			// If the Venue ID matches $VNU_ID, return the venue.
+			if (EEH_Venue_View::$_venue->ID() === $VNU_ID) {
+				return EEH_Venue_View::_get_venue($privacy_check);
+			}
+			// If the Venue ID does not match, try pulling a venue using $VNU_ID.
+			$venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+			if ($venue instanceof EE_Venue) {
+				EEH_Venue_View::$_venue = $venue;
+				return EEH_Venue_View::_get_venue($privacy_check);
+			}
+		}
+		// international newspaper?
+		global $post;
+		if ($post instanceof WP_Post) {
+			switch ($post->post_type) {
+				// if this is being called from an EE_Venue post,
+				// and the EE_Venue post corresponds to the EE_Venue that is being asked for,
+				// then we can try to just grab the attached EE_Venue object
+				case 'espresso_venues':
+					// the post already contains the related EE_Venue object AND one of the following is TRUE:
+					// the requested Venue ID matches the post ID OR...
+					// there was no specific Venue ID requested
+					if (isset($post->EE_Venue) && ($VNU_ID == $post->ID || ! $VNU_ID)) {
+						// use existing related EE_Venue object
+						EEH_Venue_View::$_venue = $post->EE_Venue;
+					} elseif ($VNU_ID) {
+						// there WAS a specific Venue ID requested, but it's NOT the current post object
+						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+					} else {
+						// no specific Venue ID requested, so use post ID to generate EE_Venue object
+						EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($post->ID);
+					}
+					break;
+
+				case 'espresso_events':
+					if ($look_in_event) {
+						// grab the events related venues
+						$venues = EEH_Venue_View::get_event_venues();
+						// make sure the result is an array
+						$venues = is_array($venues) ? $venues : [];
+						// do we have an ID for a specific venue?
+						if ($VNU_ID) {
+							// loop thru the related venues
+							foreach ($venues as $venue) {
+								if ($venue instanceof EE_Venue) {
+									// until we find the venue we're looking for
+									if ($venue->ID() == $VNU_ID) {
+										EEH_Venue_View::$_venue = $venue;
+										break;
+									}
+								}
+							}
+							// no venue ID ?
+							// then the global post is an events post and this function was called with no argument
+						} else {
+							// just grab the first related event venue
+							EEH_Venue_View::$_venue = reset($venues);
+						}
+					}
+					break;
+			}
+		}
+		// now if we STILL do NOT have an EE_Venue model object, BUT we have a Venue ID...
+		if (! EEH_Venue_View::$_venue instanceof EE_Venue && $VNU_ID) {
+			// sigh... pull it from the db
+			EEH_Venue_View::$_venue = EEM_Venue::instance()->get_one_by_ID($VNU_ID);
+		}
+		return EEH_Venue_View::_get_venue($privacy_check, $password_check);
+	}
+
+
+	/**
+	 * return a single venue
+	 *
+	 * @param bool $privacy_check   Defaults to true.
+	 *                              When false, means even if the venue is private we return it regardless of access.
+	 * @param bool $password_check
+	 * @return  EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _get_venue($privacy_check = true, $password_check = true)
+	{
+		// check for private venues.
+		if (
+			EEH_Venue_View::$_venue instanceof EE_Venue
+			&& EEH_Venue_View::$_venue->status() == 'private'
+			&& $privacy_check
+			&& ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_venues', 'get_venues')
+		) {
+			return null;
+		}
+		// check for password protected venues
+		if (
+			EEH_Venue_View::$_venue instanceof EE_Venue
+			&& $password_check
+			&& post_password_required(EEH_Venue_View::$_venue->ID())
+		) {
+			return null;
+		}
+		return EEH_Venue_View::$_venue instanceof EE_Venue ? EEH_Venue_View::$_venue : null;
+	}
+
+
+	/**
+	 *  get_event_venues
+	 *
+	 * @access     public
+	 * @return     EE_Venue[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event_venues()
+	{
+		global $post;
+		if ($post->post_type == 'espresso_events') {
+			if (isset($post->EE_Event) && $post->EE_Event instanceof EE_Event) {
+				return $post->EE_Event->venues();
+			}
+		}
+		return [];
+	}
+
+
+	/**
+	 * Simply checks whether a venue for the given ID (or the internally derived venue is private).
+	 *
+	 * Note: This will return true if its private, null if the venue doesn't exist, and false, if the venue exists but
+	 * is not private.  So it is important to do explicit boolean checks when using this conditional.
+	 *
+	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
+	 *
+	 * @return bool|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_venue_private($VNU_ID = false)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if (! $venue instanceof EE_Venue) {
+			return null;
+		}
+
+		return $venue->status() == 'private';
+	}
+
+
+	/**
+	 * returns true or false if a venue is password protected or not
+	 *
+	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_venue_password_protected($VNU_ID = false)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
+		if (
+			$venue instanceof EE_Venue
+			&& post_password_required($venue->ID())
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * If a venue is password protected, this will return the password form for gaining access
+	 * returns an empty string otherwise
+	 *
+	 * @param bool $VNU_ID venue to check (optional). If not included will use internally derived venue object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function password_protected_venue_form($VNU_ID = false)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID, true, true, false);
+		if (
+			$venue instanceof EE_Venue
+			&& post_password_required($venue->ID())
+		) {
+			return get_the_password_form($venue->ID());
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_description
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_description($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return $venue->get_pretty('VNU_desc');
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_excerpt
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_excerpt($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			$excerpt    = $venue->excerpt() != null && $venue->excerpt() ? $venue->excerpt() : $venue->description();
+			$venue_link = ' ' . EEH_Venue_View::venue_details_link(
+				$venue->ID(),
+				esc_html__('more', 'event_espresso') . '&hellip;'
+			);
+			return ! empty($excerpt) ? wp_trim_words($excerpt, 25, '') . $venue_link : '';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_categories
+	 *
+	 * @access    public
+	 * @param int  $VNU_ID
+	 * @param bool $hide_uncategorized
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_categories($VNU_ID = 0, $hide_uncategorized = true)
+	{
+		$category_links = [];
+		$venue          = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			// get category terms
+			if ($venue_categories = get_the_terms($venue->ID(), 'espresso_venue_categories')) {
+				// loop thru terms and create links
+				foreach ($venue_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if (
+						! is_wp_error($url)
+						&& (($hide_uncategorized
+							 && strtolower($term->name) != esc_html__(
+								 'uncategorized',
+								 'event_espresso'
+							 ))
+							|| ! $hide_uncategorized)
+					) {
+						$category_links[] = '<a href="' . esc_url($url) . '" rel="tag">' . $term->name . '</a> ';
+					}
+				}
+			}
+		}
+		return implode(', ', $category_links);
+	}
+
+
+	/**
+	 *    venue_address
+	 *
+	 * @access    public
+	 * @param string $type
+	 * @param int    $VNU_ID
+	 * @param bool   $use_schema
+	 * @param bool   $add_wrapper
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_address($type = 'multiline', $VNU_ID = 0, $use_schema = true, $add_wrapper = true)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Address::format($venue, $type, $use_schema, $add_wrapper);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_has_address
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return bool|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_has_address($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Address::format($venue, 'inline', false, false);
+		}
+		return false;
+	}
+
+
+	/**
+	 *    venue_name
+	 *
+	 * @access    public
+	 * @param string $link_to - options( details, website, none ) whether to turn Venue name into a clickable link to
+	 *                        the Venue's details page or website
+	 * @param int    $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_name($link_to = 'details', $VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			$venue_name = apply_filters(
+				'FHEE__EEH_Venue__venue_name__append_private_venue_name',
+				EEH_Venue_View::is_venue_private()
+					? EEH_Venue_View::$_venue->name() . "&nbsp;" . esc_html__('(Private)', 'event_espresso')
+					: EEH_Venue_View::$_venue->name(),
+				EEH_Venue_View::$_venue
+			);
+			$venue_name = EEH_Schema::name($venue_name);
+
+			// if venue is trashed then ignore the "link to" setting because the venue is trashed.
+			if ($venue->get('status') == 'trash') {
+				$link_to = '';
+			}
+			switch ($link_to) {
+				case 'details':
+					return EEH_Venue_View::venue_details_link($venue->ID(), $venue_name);
+
+				case 'website':
+					return EEH_Venue_View::venue_website_link($venue->ID(), $venue_name);
+
+				default:
+					return $venue_name;
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_details_link
+	 *
+	 * @access    public
+	 * @param int    $VNU_ID
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_details_link($VNU_ID = 0, $text = '')
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Schema::url(get_permalink($venue->ID()), $text);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_website_link
+	 *
+	 * @access    public
+	 * @param int    $VNU_ID
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_website_link($VNU_ID = 0, $text = '')
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			$url  = $venue->venue_url();
+			$text = ! empty($text) ? $text : $url;
+			return ! empty($url) ? EEH_Schema::url($url, $text, ['target' => '_blank']) : '';
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_phone
+	 *
+	 * @access    public
+	 * @param int $VNU_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_phone($VNU_ID = 0)
+	{
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			return EEH_Schema::telephone($venue->phone());
+		}
+		return '';
+	}
+
+
+	/**
+	 *    venue_gmap
+	 *
+	 * @access    public
+	 * @param int         $VNU_ID
+	 * @param bool|string $map_ID a unique identifier for this map
+	 * @param array       $gmap   map options
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function venue_gmap($VNU_ID = 0, $map_ID = false, $gmap = [])
+	{
+
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			// check for global espresso_events post and use it's ID if no map_ID is set
+			global $post;
+			$map_ID = empty($map_ID) && $post->post_type == 'espresso_events' ? $post->ID : $map_ID;
+			// grab map settings
+			$map_cfg = EE_Registry::instance()->CFG->map_settings;
+			// are maps enabled ?
+			if ($map_cfg->use_google_maps && $venue->enable_for_gmap()) {
+				$details_page = is_single();
+				$options      = [];
+
+				$options['map_ID'] = $map_ID && $map_ID != $venue->ID()
+					? $map_ID . '-' . $venue->ID()
+					: $venue->ID();
+
+				$options['location'] = EEH_Address::format($venue, 'inline', false, false);
+
+				$options['ee_map_width'] = $details_page
+					? $map_cfg->event_details_map_width
+					: $map_cfg->event_list_map_width;
+
+				$options['ee_map_width'] = isset($gmap['ee_map_width']) && ! empty($gmap['ee_map_width'])
+					? $gmap['ee_map_width']
+					: $options['ee_map_width'];
+
+				$options['ee_map_height'] = $details_page
+					? $map_cfg->event_details_map_height
+					: $map_cfg->event_list_map_height;
+
+				$options['ee_map_height'] = isset($gmap['ee_map_height']) && ! empty($gmap['ee_map_height'])
+					? $gmap['ee_map_height']
+					: $options['ee_map_height'];
+
+				$options['ee_map_zoom'] = $details_page
+					? $map_cfg->event_details_map_zoom
+					: $map_cfg->event_list_map_zoom;
+
+				$options['ee_map_zoom'] = isset($gmap['ee_map_zoom']) && ! empty($gmap['ee_map_zoom'])
+					? $gmap['ee_map_zoom']
+					: $options['ee_map_zoom'];
+
+				$options['ee_map_nav_display'] = $details_page
+					? $map_cfg->event_details_display_nav
+					: $map_cfg->event_list_display_nav;
+
+				$options['ee_map_nav_display'] =
+					isset($gmap['ee_map_nav_display']) && ! empty($gmap['ee_map_nav_display'])
+						? 'true'
+						: $options['ee_map_nav_display'];
+
+				$options['ee_map_nav_size'] = $details_page
+					? $map_cfg->event_details_nav_size
+					: $map_cfg->event_list_nav_size;
+
+				$options['ee_map_nav_size'] = isset($gmap['ee_map_nav_size']) && ! empty($gmap['ee_map_nav_size'])
+					? $gmap['ee_map_nav_size']
+					: $options['ee_map_nav_size'];
+
+				$options['ee_map_type_control'] = $details_page
+					? $map_cfg->event_details_control_type
+					: $map_cfg->event_list_control_type;
+
+				$options['ee_map_type_control'] =
+					isset($gmap['ee_map_type_control']) && ! empty($gmap['ee_map_type_control'])
+						? $gmap['ee_map_type_control']
+						: $options['ee_map_type_control'];
+
+				$options['ee_map_align'] = $details_page
+					? $map_cfg->event_details_map_align
+					: $map_cfg->event_list_map_align;
+
+				$options['ee_map_align'] = isset($gmap['ee_map_align']) && ! empty($gmap['ee_map_align'])
+					? $gmap['ee_map_align']
+					: $options['ee_map_align'];
+
+				$options['ee_static_url'] = isset($gmap['ee_static_url']) && ! empty($gmap['ee_static_url'])
+					? (bool) absint($gmap['ee_static_url'])
+					: $venue->google_map_link();
+
+				return EEH_Maps::google_map($options);
+			}
+		}
+
+		return '';
+	}
+
+
+	/**
+	 * Gets the HTML to display a static map of the venue
+	 *
+	 * @param EE_Venue $venue
+	 * @param array    $attributes like EEH_Maps::google_map_link
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function espresso_google_static_map(EE_Venue $venue, $attributes = [])
+	{
+		$state      = $venue->state_obj();
+		$country    = $venue->country_obj();
+		$attributes = shortcode_atts(
+			[
+				'id'      => $venue->ID(),
+				'address' => $venue->get('VNU_address'),
+				'city'    => $venue->get('VNU_city'),
+				'state'   => $state instanceof EE_State ? $state->name() : '',
+				'zip'     => $venue->get('VNU_zip'),
+				'country' => $country instanceof EE_Country ? $country->name() : '',
+				'type'    => 'map',
+				'map_w'   => 200,
+				'map_h'   => 200,
+			],
+			$attributes
+		);
+		return EEH_Maps::google_map_link($attributes);
+	}
+
+
+	/**
+	 *    edit_venue_link
+	 *
+	 * @access    public
+	 * @param int    $VNU_ID
+	 * @param string $link
+	 * @param string $before
+	 * @param string $after
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function edit_venue_link(
+		$VNU_ID = 0,
+		$link = '',
+		$before = '<p class="edit-venue-lnk small-txt">',
+		$after = '</p>'
+	) {
+		$venue = EEH_Venue_View::get_venue($VNU_ID);
+		if ($venue instanceof EE_Venue) {
+			// can the user edit this post ?
+			if (current_user_can('edit_post', $venue->ID())) {
+				// set link text
+				$link = ! empty($link) ? $link : esc_html__('edit this venue', 'event_espresso');
+				// generate nonce
+				$nonce = wp_create_nonce('edit_nonce');
+				// generate url to venue editor for this venue
+				$url =
+					add_query_arg(
+						[
+							'page'       => 'espresso_venues',
+							'action'     => 'edit',
+							'post'       => $venue->ID(),
+							'edit_nonce' => $nonce,
+						],
+						admin_url('admin.php')
+					);
+				// get edit CPT text
+				$post_type_obj = get_post_type_object('espresso_venues');
+				// build final link html
+				$link =
+					'<a class="post-edit-link" href="' . $url . '" title="' . esc_attr(
+						$post_type_obj->labels->edit_item
+					) . '">' . $link . '</a>';
+				// put it all together
+				return $before . apply_filters('edit_post_link', $link, $venue->ID()) . $after;
+			}
+		}
+		return '';
+	}
 }

core/helpers/EEH_Event_View.helper.php

Indentation +614 added lines, -614 removed lines

@@ -10,364 +10,364 @@ 
 class EEH_Event_View extends EEH_Base
 {
 
-    /**
-     * @var EE_Event $_event
-     */
-    private static $_event = null;
-
-
-    /**
-     * get_event
-     * attempts to retrieve an EE_Event object any way it can
-     *
-     * @param int|WP_Post $EVT_ID
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_event($EVT_ID = 0)
-    {
-        // international newspaper?
-        global $post;
-        $EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
-            ? $EVT_ID->ID
-            : absint($EVT_ID);
-        // do we already have the Event  you are looking for?
-        if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
-            return EEH_Event_View::$_event;
-        }
-        // reset property so that the new event is cached.
-        EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
-            EEH_Event_View::$_event = $post;
-            return EEH_Event_View::$_event;
-        }
-        // if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
-        // then let's just use that cached event on the $post object.
-        if (
-            $post instanceof WP_Post
-            && $post->post_type === 'espresso_events'
-            && isset($post->EE_Event)
-            && (
-                $EVT_ID === 0
-                || $EVT_ID === $post->ID
-            )
-        ) {
-            EEH_Event_View::$_event = $post->EE_Event;
-            return EEH_Event_View::$_event;
-        }
-        // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
-            EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        }
-        return EEH_Event_View::$_event;
-    }
-
-
-    /**
-     *    display_ticket_selector
-     *
-     * @param int $EVT_ID
-     * @return    boolean
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_ticket_selector($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event && $event->display_ticket_selector();
-    }
-
-
-    /**
-     *    event_status
-     *
-     * @param int $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_status($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
-    }
-
-
-    /**
-     *  event_active_status
-     *
-     * @param int $EVT_ID
-     * @return     string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_active_status($EVT_ID = 0, $echo = true)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        return $event instanceof EE_Event ? $event->pretty_active_status($echo) : 'inactive';
-    }
-
-
-    /**
-     *  event_has_content_or_excerpt
-     *
-     * @param int $EVT_ID
-     * @return     bool
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_has_content_or_excerpt($EVT_ID = 0)
-    {
-        $event                  = EEH_Event_View::get_event($EVT_ID);
-        $has_content_or_excerpt = false;
-        if ($event instanceof EE_Event) {
-            $has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '';
-        }
-        if (
-            is_archive()
-            && ! (espresso_display_full_description_in_event_list()
-                  || espresso_display_excerpt_in_event_list())
-        ) {
-            $has_content_or_excerpt = false;
-        }
-        return $has_content_or_excerpt;
-    }
-
-
-    /**
-     *    event_active_status
-     *
-     * @param null $num_words
-     * @param null $more
-     * @return    string
-     */
-    public static function event_content_or_excerpt($num_words = null, $more = null)
-    {
-        global $post;
-        ob_start();
-        if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
-            // admin has chosen "full description"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            the_content();
-        } elseif ((is_archive() && espresso_display_excerpt_in_event_list())) {
-            if (has_excerpt($post->ID)) {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // AND an excerpt actually exists
-                the_excerpt();
-            } else {
-                // admin has chosen "excerpt (short desc)"
-                // for the "Event Espresso - Events > Templates > Display Description" option
-                // but NO excerpt actually exists, so we need to create one
-                if (! empty($num_words)) {
-                    if (empty($more)) {
-                        $more_link_text = esc_html__('(more…)', 'event_espresso');
-                        $more           = ' <a href="' . get_permalink() . '"';
-                        $more           .= ' class="more-link"';
-                        $more           .= EED_Events_Archive::link_target();
-                        $more           .= '>' . $more_link_text . '</a>';
-                        $more           = apply_filters('the_content_more_link', $more, $more_link_text);
-                    }
-                    $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
-
-                    $content = wp_trim_words($content, $num_words, ' ') . $more;
-                } else {
-                    $content = get_the_content();
-                }
-                global $allowedtags;
-                // make sure links are allowed
-                $allowedtags['a'] = isset($allowedtags['a'])
-                    ? $allowedtags['a']
-                    : [];
-                // as well as target attribute
-                $allowedtags['a']['target'] = isset($allowedtags['a']['target'])
-                    ? $allowedtags['a']['target']
-                    : false;
-                // but get previous value so we can reset it
-                $prev_value                 = $allowedtags['a']['target'];
-                $allowedtags['a']['target'] = true;
-                $content                    = wp_kses($content, $allowedtags);
-                $content                    = strip_shortcodes($content);
-                echo apply_filters('the_content', $content);
-                $allowedtags['a']['target'] = $prev_value;
-            }
-        } else {
-            // admin has chosen "none"
-            // for the "Event Espresso - Events > Templates > Display Description" option
-            echo apply_filters('the_content', '');
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     *  event_tickets_available
-     *
-     * @param int $EVT_ID
-     * @return     EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_tickets_available($EVT_ID = 0)
-    {
-        $event                          = EEH_Event_View::get_event($EVT_ID);
-        $tickets_available_for_purchase = [];
-        if ($event instanceof EE_Event) {
-            $datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
-            foreach ($datetimes as $datetime) {
-                $tickets_available_for_purchase =
-                    array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
-            }
-        }
-        return $tickets_available_for_purchase;
-    }
-
-
-    /**
-     *    the_event_date
-     *
-     * @param int  $EVT_ID
-     * @param bool $hide_uncategorized
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
-    {
-        $category_links = [];
-        $event          = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
-            if ($event_categories) {
-                // loop thru terms and create links
-                foreach ($event_categories as $term) {
-                    $url = get_term_link($term, 'espresso_venue_categories');
-                    if (
-                        ! is_wp_error($url)
-                        && (
-                            (
-                                $hide_uncategorized
-                                && strtolower($term->name) != esc_html__('uncategorized', 'event_espresso')
-                            )
-                            || ! $hide_uncategorized
-                        )
-                    ) {
-                        $category_links[] = '<a href="' . esc_url_raw($url) . '" '
-                                            . 'rel="tag" ' . EED_Events_Archive::link_target() . '>'
-                                            . esc_html($term->name)
-                                            . '</a>';
-                    }
-                }
-            }
-        }
-        return implode(', ', $category_links);
-    }
-
-
-    /**
-     *    the_event_date - first date by date order
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        $format   = ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
-    }
-
-
-    /**
-     *    the_event_end_date - last date by date order
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_event_end_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
-        $format   =
-            ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format
-                  . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-    /**
-     *    the_earliest_event_date - first date chronologically
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_earliest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
-        $format   =
-            ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format
-                  . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
-    }
-
-
-    /**
-     *    the_latest_event_date - latest date chronologically
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @param int    $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_latest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
-        $format   =
-            ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format
-                  . $time_format;
-        return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
-    }
-
-
-    /**
-     *    event_date_as_calendar_page
-     *
-     * @param int $EVT_ID
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_date_as_calendar_page($EVT_ID = 0)
-    {
-        $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            ?>
+	/**
+	 * @var EE_Event $_event
+	 */
+	private static $_event = null;
+
+
+	/**
+	 * get_event
+	 * attempts to retrieve an EE_Event object any way it can
+	 *
+	 * @param int|WP_Post $EVT_ID
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_event($EVT_ID = 0)
+	{
+		// international newspaper?
+		global $post;
+		$EVT_ID = $EVT_ID instanceof WP_Post && $EVT_ID->post_type === 'espresso_events'
+			? $EVT_ID->ID
+			: absint($EVT_ID);
+		// do we already have the Event  you are looking for?
+		if (EEH_Event_View::$_event instanceof EE_Event && $EVT_ID && EEH_Event_View::$_event->ID() === $EVT_ID) {
+			return EEH_Event_View::$_event;
+		}
+		// reset property so that the new event is cached.
+		EEH_Event_View::$_event = null;
+		if (! $EVT_ID && $post instanceof EE_Event) {
+			EEH_Event_View::$_event = $post;
+			return EEH_Event_View::$_event;
+		}
+		// if the post type is for an event and it has a cached event and we don't have a different incoming $EVT_ID
+		// then let's just use that cached event on the $post object.
+		if (
+			$post instanceof WP_Post
+			&& $post->post_type === 'espresso_events'
+			&& isset($post->EE_Event)
+			&& (
+				$EVT_ID === 0
+				|| $EVT_ID === $post->ID
+			)
+		) {
+			EEH_Event_View::$_event = $post->EE_Event;
+			return EEH_Event_View::$_event;
+		}
+		// If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
+		if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+			EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		}
+		return EEH_Event_View::$_event;
+	}
+
+
+	/**
+	 *    display_ticket_selector
+	 *
+	 * @param int $EVT_ID
+	 * @return    boolean
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_ticket_selector($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event && $event->display_ticket_selector();
+	}
+
+
+	/**
+	 *    event_status
+	 *
+	 * @param int $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_status($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status(false) : '';
+	}
+
+
+	/**
+	 *  event_active_status
+	 *
+	 * @param int $EVT_ID
+	 * @return     string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_active_status($EVT_ID = 0, $echo = true)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		return $event instanceof EE_Event ? $event->pretty_active_status($echo) : 'inactive';
+	}
+
+
+	/**
+	 *  event_has_content_or_excerpt
+	 *
+	 * @param int $EVT_ID
+	 * @return     bool
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_has_content_or_excerpt($EVT_ID = 0)
+	{
+		$event                  = EEH_Event_View::get_event($EVT_ID);
+		$has_content_or_excerpt = false;
+		if ($event instanceof EE_Event) {
+			$has_content_or_excerpt = $event->description() != '' || $event->short_description(null, null, true) != '';
+		}
+		if (
+			is_archive()
+			&& ! (espresso_display_full_description_in_event_list()
+				  || espresso_display_excerpt_in_event_list())
+		) {
+			$has_content_or_excerpt = false;
+		}
+		return $has_content_or_excerpt;
+	}
+
+
+	/**
+	 *    event_active_status
+	 *
+	 * @param null $num_words
+	 * @param null $more
+	 * @return    string
+	 */
+	public static function event_content_or_excerpt($num_words = null, $more = null)
+	{
+		global $post;
+		ob_start();
+		if ((is_single()) || (is_archive() && espresso_display_full_description_in_event_list())) {
+			// admin has chosen "full description"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			the_content();
+		} elseif ((is_archive() && espresso_display_excerpt_in_event_list())) {
+			if (has_excerpt($post->ID)) {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// AND an excerpt actually exists
+				the_excerpt();
+			} else {
+				// admin has chosen "excerpt (short desc)"
+				// for the "Event Espresso - Events > Templates > Display Description" option
+				// but NO excerpt actually exists, so we need to create one
+				if (! empty($num_words)) {
+					if (empty($more)) {
+						$more_link_text = esc_html__('(more&hellip;)', 'event_espresso');
+						$more           = ' <a href="' . get_permalink() . '"';
+						$more           .= ' class="more-link"';
+						$more           .= EED_Events_Archive::link_target();
+						$more           .= '>' . $more_link_text . '</a>';
+						$more           = apply_filters('the_content_more_link', $more, $more_link_text);
+					}
+					$content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
+
+					$content = wp_trim_words($content, $num_words, ' ') . $more;
+				} else {
+					$content = get_the_content();
+				}
+				global $allowedtags;
+				// make sure links are allowed
+				$allowedtags['a'] = isset($allowedtags['a'])
+					? $allowedtags['a']
+					: [];
+				// as well as target attribute
+				$allowedtags['a']['target'] = isset($allowedtags['a']['target'])
+					? $allowedtags['a']['target']
+					: false;
+				// but get previous value so we can reset it
+				$prev_value                 = $allowedtags['a']['target'];
+				$allowedtags['a']['target'] = true;
+				$content                    = wp_kses($content, $allowedtags);
+				$content                    = strip_shortcodes($content);
+				echo apply_filters('the_content', $content);
+				$allowedtags['a']['target'] = $prev_value;
+			}
+		} else {
+			// admin has chosen "none"
+			// for the "Event Espresso - Events > Templates > Display Description" option
+			echo apply_filters('the_content', '');
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 *  event_tickets_available
+	 *
+	 * @param int $EVT_ID
+	 * @return     EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_tickets_available($EVT_ID = 0)
+	{
+		$event                          = EEH_Event_View::get_event($EVT_ID);
+		$tickets_available_for_purchase = [];
+		if ($event instanceof EE_Event) {
+			$datetimes = EEH_Event_View::get_all_date_obj($EVT_ID, false);
+			foreach ($datetimes as $datetime) {
+				$tickets_available_for_purchase =
+					array_merge($tickets_available_for_purchase, $datetime->ticket_types_available_for_purchase());
+			}
+		}
+		return $tickets_available_for_purchase;
+	}
+
+
+	/**
+	 *    the_event_date
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $hide_uncategorized
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_categories($EVT_ID = 0, $hide_uncategorized = true)
+	{
+		$category_links = [];
+		$event          = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$event_categories = get_the_terms($event->ID(), 'espresso_event_categories');
+			if ($event_categories) {
+				// loop thru terms and create links
+				foreach ($event_categories as $term) {
+					$url = get_term_link($term, 'espresso_venue_categories');
+					if (
+						! is_wp_error($url)
+						&& (
+							(
+								$hide_uncategorized
+								&& strtolower($term->name) != esc_html__('uncategorized', 'event_espresso')
+							)
+							|| ! $hide_uncategorized
+						)
+					) {
+						$category_links[] = '<a href="' . esc_url_raw($url) . '" '
+											. 'rel="tag" ' . EED_Events_Archive::link_target() . '>'
+											. esc_html($term->name)
+											. '</a>';
+					}
+				}
+			}
+		}
+		return implode(', ', $category_links);
+	}
+
+
+	/**
+	 *    the_event_date - first date by date order
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		$format   = ! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+	}
+
+
+	/**
+	 *    the_event_end_date - last date by date order
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_event_end_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
+		$format   =
+			! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format
+				  . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+	/**
+	 *    the_earliest_event_date - first date chronologically
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_earliest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
+		$format   =
+			! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format
+				  . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
+	}
+
+
+	/**
+	 *    the_latest_event_date - latest date chronologically
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @param int    $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_latest_event_date($date_format = 'D M jS', $time_format = 'g:i a', $EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
+		$format   =
+			! empty($date_format) && ! empty($time_format)
+				? $date_format . ' ' . $time_format
+				: $date_format
+				  . $time_format;
+		return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
+	}
+
+
+	/**
+	 *    event_date_as_calendar_page
+	 *
+	 * @param int $EVT_ID
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_date_as_calendar_page($EVT_ID = 0)
+	{
+		$datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			?>
             <div class="event-date-calendar-page-dv">
                 <div class="event-date-calendar-page-month-dv">
                     <?php echo $datetime->get_i18n_datetime('DTT_EVT_start', 'M'); // already escaped ?>
@@ -377,260 +377,260 @@ 
                 </div>
             </div>
             <?php
-        }
-    }
-
-
-    /**
-     *    get_primary_date_obj - orders date by DTT_order
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_primary_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_order' => 'ASC'],
-                ]
-            );
-            return reset($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_last_date_obj - orders date by DTT_order
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_last_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_order' => 'DESC'],
-                ]
-            );
-            return end($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_earliest_date_obj - orders date chronologically
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_earliest_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_EVT_start' => 'ASC'],
-                ]
-            );
-            return reset($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_latest_date_obj - orders date chronologically
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_latest_date_obj($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $datetimes = $event->get_many_related(
-                'Datetime',
-                [
-                    'limit'    => 1,
-                    'order_by' => ['DTT_EVT_start' => 'DESC'],
-                ]
-            );
-            return end($datetimes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_next_upcoming_date_obj - return the next upcoming datetime
-     *
-     * @param int $EVT_ID
-     * @return    EE_Datetime|null
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function get_next_upcoming_date_obj($EVT_ID = 0)
-    {
-        $datetime = EEM_Datetime::instance()->get_one(
-            [
-                [
-                    'Event.EVT_ID'  => $EVT_ID,
-                    'DTT_EVT_start' => ['>=', current_time('mysql', true)],
-                ],
-                'order_by' => ['DTT_EVT_start' => 'asc'],
-            ]
-        );
-        return $datetime instanceof EE_Datetime ? $datetime : null;
-    }
-
-
-    /**
-     *    get_all_date_obj
-     *
-     * @param int  $EVT_ID
-     * @param null $include_expired
-     * @param bool $include_deleted
-     * @param null $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_all_date_obj(
-        $EVT_ID = 0,
-        $include_expired = null,
-        $include_deleted = false,
-        $limit = null
-    ) {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($include_expired === null) {
-            if ($event instanceof EE_Event && $event->is_expired()) {
-                $include_expired = true;
-            } else {
-                $include_expired = false;
-            }
-        }
-
-        if ($event instanceof EE_Event) {
-            return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
-        }
-        return [];
-    }
-
-
-    /**
-     *    event_link_url
-     *
-     * @param int $EVT_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_link_url($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            $url = $event->external_url() !== null && $event->external_url() !== ''
-                ? $event->external_url()
-                : get_permalink($event->ID());
-            $url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://' . $url;
-            return esc_url_raw($url);
-        }
-        return '';
-    }
-
-
-    /**
-     *    event_phone
-     *
-     * @param int $EVT_ID
-     * @return    string
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_phone($EVT_ID = 0)
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            return EEH_Schema::telephone($event->phone());
-        }
-        return null;
-    }
-
-
-    /**
-     *    edit_event_link
-     *
-     * @param int    $EVT_ID
-     * @param string $link
-     * @param string $before
-     * @param string $after
-     * @return    string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
-    {
-        $event = EEH_Event_View::get_event($EVT_ID);
-        if ($event instanceof EE_Event) {
-            // can the user edit this post ?
-            if (current_user_can('edit_post', $event->ID())) {
-                // set link text
-                $link_text = ! empty($link) ? $link : esc_html__('edit this event', 'event_espresso');
-                // generate nonce
-                $nonce = wp_create_nonce('edit_nonce');
-                // generate url to event editor for this event
-                $url =
-                    add_query_arg(
-                        [
-                            'page'       => 'espresso_events',
-                            'action'     => 'edit',
-                            'post'       => $event->ID(),
-                            'edit_nonce' => $nonce,
-                        ],
-                        admin_url()
-                    );
-                // get edit CPT text
-                $post_type_obj = get_post_type_object('espresso_events');
-                // build final link html
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
-                $link .= EED_Events_Archive::link_target();
-                $link .= '>' . $link_text . '</a>';
-                // put it all together
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function event_archive_url()
-    {
-        return get_post_type_archive_link('espresso_events');
-    }
+		}
+	}
+
+
+	/**
+	 *    get_primary_date_obj - orders date by DTT_order
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_primary_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_order' => 'ASC'],
+				]
+			);
+			return reset($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_last_date_obj - orders date by DTT_order
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_last_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_order' => 'DESC'],
+				]
+			);
+			return end($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_earliest_date_obj - orders date chronologically
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_earliest_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_EVT_start' => 'ASC'],
+				]
+			);
+			return reset($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_latest_date_obj - orders date chronologically
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_latest_date_obj($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$datetimes = $event->get_many_related(
+				'Datetime',
+				[
+					'limit'    => 1,
+					'order_by' => ['DTT_EVT_start' => 'DESC'],
+				]
+			);
+			return end($datetimes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_next_upcoming_date_obj - return the next upcoming datetime
+	 *
+	 * @param int $EVT_ID
+	 * @return    EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function get_next_upcoming_date_obj($EVT_ID = 0)
+	{
+		$datetime = EEM_Datetime::instance()->get_one(
+			[
+				[
+					'Event.EVT_ID'  => $EVT_ID,
+					'DTT_EVT_start' => ['>=', current_time('mysql', true)],
+				],
+				'order_by' => ['DTT_EVT_start' => 'asc'],
+			]
+		);
+		return $datetime instanceof EE_Datetime ? $datetime : null;
+	}
+
+
+	/**
+	 *    get_all_date_obj
+	 *
+	 * @param int  $EVT_ID
+	 * @param null $include_expired
+	 * @param bool $include_deleted
+	 * @param null $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_all_date_obj(
+		$EVT_ID = 0,
+		$include_expired = null,
+		$include_deleted = false,
+		$limit = null
+	) {
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($include_expired === null) {
+			if ($event instanceof EE_Event && $event->is_expired()) {
+				$include_expired = true;
+			} else {
+				$include_expired = false;
+			}
+		}
+
+		if ($event instanceof EE_Event) {
+			return $event->datetimes_ordered($include_expired, $include_deleted, $limit);
+		}
+		return [];
+	}
+
+
+	/**
+	 *    event_link_url
+	 *
+	 * @param int $EVT_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_link_url($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			$url = $event->external_url() !== null && $event->external_url() !== ''
+				? $event->external_url()
+				: get_permalink($event->ID());
+			$url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://' . $url;
+			return esc_url_raw($url);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    event_phone
+	 *
+	 * @param int $EVT_ID
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_phone($EVT_ID = 0)
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			return EEH_Schema::telephone($event->phone());
+		}
+		return null;
+	}
+
+
+	/**
+	 *    edit_event_link
+	 *
+	 * @param int    $EVT_ID
+	 * @param string $link
+	 * @param string $before
+	 * @param string $after
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function edit_event_link($EVT_ID = 0, $link = '', $before = '', $after = '')
+	{
+		$event = EEH_Event_View::get_event($EVT_ID);
+		if ($event instanceof EE_Event) {
+			// can the user edit this post ?
+			if (current_user_can('edit_post', $event->ID())) {
+				// set link text
+				$link_text = ! empty($link) ? $link : esc_html__('edit this event', 'event_espresso');
+				// generate nonce
+				$nonce = wp_create_nonce('edit_nonce');
+				// generate url to event editor for this event
+				$url =
+					add_query_arg(
+						[
+							'page'       => 'espresso_events',
+							'action'     => 'edit',
+							'post'       => $event->ID(),
+							'edit_nonce' => $nonce,
+						],
+						admin_url()
+					);
+				// get edit CPT text
+				$post_type_obj = get_post_type_object('espresso_events');
+				// build final link html
+				$link = '<a class="post-edit-link" href="' . $url . '" ';
+				$link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
+				$link .= EED_Events_Archive::link_target();
+				$link .= '>' . $link_text . '</a>';
+				// put it all together
+				return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function event_archive_url()
+	{
+		return get_post_type_archive_link('espresso_events');
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -38,7 +38,7 @@ 
         }
         // reset property so that the new event is cached.
         EEH_Event_View::$_event = null;
-        if (! $EVT_ID && $post instanceof EE_Event) {
+        if ( ! $EVT_ID && $post instanceof EE_Event) {
             EEH_Event_View::$_event = $post;
             return EEH_Event_View::$_event;
         }
@@ -57,7 +57,7 @@ 
             return EEH_Event_View::$_event;
         }
         // If the event we have isn't an event but we do have an EVT_ID, let's try getting the event using the ID.
-        if (! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
+        if ( ! EEH_Event_View::$_event instanceof EE_Event && $EVT_ID) {
             EEH_Event_View::$_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
         }
         return EEH_Event_View::$_event;
@@ -164,18 +164,18 @@ 
                 // admin has chosen "excerpt (short desc)"
                 // for the "Event Espresso - Events > Templates > Display Description" option
                 // but NO excerpt actually exists, so we need to create one
-                if (! empty($num_words)) {
+                if ( ! empty($num_words)) {
                     if (empty($more)) {
                         $more_link_text = esc_html__('(more…)', 'event_espresso');
-                        $more           = ' <a href="' . get_permalink() . '"';
+                        $more           = ' <a href="'.get_permalink().'"';
                         $more           .= ' class="more-link"';
                         $more           .= EED_Events_Archive::link_target();
-                        $more           .= '>' . $more_link_text . '</a>';
-                        $more           = apply_filters('the_content_more_link', $more, $more_link_text);
+                        $more           .= '>'.$more_link_text.'</a>';
+                        $more = apply_filters('the_content_more_link', $more, $more_link_text);
                     }
                     $content = str_replace('NOMORELINK', '', get_the_content('NOMORELINK'));
 
-                    $content = wp_trim_words($content, $num_words, ' ') . $more;
+                    $content = wp_trim_words($content, $num_words, ' ').$more;
                 } else {
                     $content = get_the_content();
                 }
@@ -257,8 +257,8 @@ 
                             || ! $hide_uncategorized
                         )
                     ) {
-                        $category_links[] = '<a href="' . esc_url_raw($url) . '" '
-                                            . 'rel="tag" ' . EED_Events_Archive::link_target() . '>'
+                        $category_links[] = '<a href="'.esc_url_raw($url).'" '
+                                            . 'rel="tag" '.EED_Events_Archive::link_target().'>'
                                             . esc_html($term->name)
                                             . '</a>';
                     }
@@ -283,8 +283,8 @@ 
     {
         $datetime = EEH_Event_View::get_primary_date_obj($EVT_ID);
         $format   = ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
-                : $date_format . $time_format;
+                ? $date_format.' '.$time_format
+                : $date_format.$time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
     }
 
@@ -304,7 +304,7 @@ 
         $datetime = EEH_Event_View::get_last_date_obj($EVT_ID);
         $format   =
             ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
+                ? $date_format.' '.$time_format
                 : $date_format
                   . $time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
@@ -326,7 +326,7 @@ 
         $datetime = EEH_Event_View::get_earliest_date_obj($EVT_ID);
         $format   =
             ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
+                ? $date_format.' '.$time_format
                 : $date_format
                   . $time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_start', $format) : '';
@@ -348,7 +348,7 @@ 
         $datetime = EEH_Event_View::get_latest_date_obj($EVT_ID);
         $format   =
             ! empty($date_format) && ! empty($time_format)
-                ? $date_format . ' ' . $time_format
+                ? $date_format.' '.$time_format
                 : $date_format
                   . $time_format;
         return $datetime instanceof EE_Datetime ? $datetime->get_i18n_datetime('DTT_EVT_end', $format) : '';
@@ -553,7 +553,7 @@ 
             $url = $event->external_url() !== null && $event->external_url() !== ''
                 ? $event->external_url()
                 : get_permalink($event->ID());
-            $url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://' . $url;
+            $url = preg_match("~^(?:f|ht)tps?://~i", $url) ? $url : 'https://'.$url;
             return esc_url_raw($url);
         }
         return '';
@@ -614,12 +614,12 @@ 
                 // get edit CPT text
                 $post_type_obj = get_post_type_object('espresso_events');
                 // build final link html
-                $link = '<a class="post-edit-link" href="' . $url . '" ';
-                $link .= ' title="' . esc_attr($post_type_obj->labels->edit_item) . '"';
+                $link = '<a class="post-edit-link" href="'.$url.'" ';
+                $link .= ' title="'.esc_attr($post_type_obj->labels->edit_item).'"';
                 $link .= EED_Events_Archive::link_target();
-                $link .= '>' . $link_text . '</a>';
+                $link .= '>'.$link_text.'</a>';
                 // put it all together
-                return $before . apply_filters('edit_post_link', $link, $event->ID()) . $after;
+                return $before.apply_filters('edit_post_link', $link, $event->ID()).$after;
             }
         }
         return '';

core/helpers/EEH_Maps.helper.php

Indentation +194 added lines, -194 removed lines

@@ -12,69 +12,69 @@ 
 class EEH_Maps
 {
 
-    // array of map settings
-    public static $gmap_vars = [];
-
-
-    /**
-     * google_map - creates a Google Map Link
-     *
-     * @param array $ee_gmaps_opts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map($ee_gmaps_opts)
-    {
-
-        $ee_map_width = ! empty($ee_gmaps_opts['ee_map_width'])
-            ? absint($ee_gmaps_opts['ee_map_width'])
-            : 300;
-
-        $ee_map_height = ! empty($ee_gmaps_opts['ee_map_height'])
-            ? absint($ee_gmaps_opts['ee_map_height'])
-            : 185;
-
-        $ee_map_zoom = ! empty($ee_gmaps_opts['ee_map_zoom'])
-            ? absint($ee_gmaps_opts['ee_map_zoom'])
-            : 12;
-
-        $ee_map_nav_display = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
-
-        $ee_map_nav_size = ! empty($ee_gmaps_opts['ee_map_nav_size'])
-            ? sanitize_text_field($ee_gmaps_opts['ee_map_nav_size'])
-            : 'default';
-
-        $ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
-            ? sanitize_text_field($ee_gmaps_opts['ee_map_type_control'])
-            : 'default';
-
-        $static_url = ! empty($ee_gmaps_opts['ee_static_url'])
-            ? esc_url_raw($ee_gmaps_opts['ee_static_url'])
-            : false;
-
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
-            switch ($ee_gmaps_opts['ee_map_align']) {
-                case "left":
-                    $map_align = 'ee-gmap-align-left left';
-                    break;
-                case "right":
-                    $map_align = 'ee-gmap-align-right right';
-                    break;
-                case "center":
-                    $map_align = 'ee-gmap-align-center center';
-                    break;
-                case "none":
-                default:
-                    $map_align = 'ee-gmap-align-none';
-            }
-        } else {
-            $map_align = 'ee-gmap-align-none';
-        }
-
-
-        // Determine whether user has set a hardcoded url to use and
-        // if so display a Google static iframe map else run V3 api
-        if ($static_url) {
-            $html = '
+	// array of map settings
+	public static $gmap_vars = [];
+
+
+	/**
+	 * google_map - creates a Google Map Link
+	 *
+	 * @param array $ee_gmaps_opts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map($ee_gmaps_opts)
+	{
+
+		$ee_map_width = ! empty($ee_gmaps_opts['ee_map_width'])
+			? absint($ee_gmaps_opts['ee_map_width'])
+			: 300;
+
+		$ee_map_height = ! empty($ee_gmaps_opts['ee_map_height'])
+			? absint($ee_gmaps_opts['ee_map_height'])
+			: 185;
+
+		$ee_map_zoom = ! empty($ee_gmaps_opts['ee_map_zoom'])
+			? absint($ee_gmaps_opts['ee_map_zoom'])
+			: 12;
+
+		$ee_map_nav_display = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
+
+		$ee_map_nav_size = ! empty($ee_gmaps_opts['ee_map_nav_size'])
+			? sanitize_text_field($ee_gmaps_opts['ee_map_nav_size'])
+			: 'default';
+
+		$ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
+			? sanitize_text_field($ee_gmaps_opts['ee_map_type_control'])
+			: 'default';
+
+		$static_url = ! empty($ee_gmaps_opts['ee_static_url'])
+			? esc_url_raw($ee_gmaps_opts['ee_static_url'])
+			: false;
+
+		if (! empty($ee_gmaps_opts['ee_map_align'])) {
+			switch ($ee_gmaps_opts['ee_map_align']) {
+				case "left":
+					$map_align = 'ee-gmap-align-left left';
+					break;
+				case "right":
+					$map_align = 'ee-gmap-align-right right';
+					break;
+				case "center":
+					$map_align = 'ee-gmap-align-center center';
+					break;
+				case "none":
+				default:
+					$map_align = 'ee-gmap-align-none';
+			}
+		} else {
+			$map_align = 'ee-gmap-align-none';
+		}
+
+
+		// Determine whether user has set a hardcoded url to use and
+		// if so display a Google static iframe map else run V3 api
+		if ($static_url) {
+			$html = '
             <div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">
                 <iframe src="' . $static_url . '&output=embed"
                         style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"
@@ -85,18 +85,18 @@ 
                 <a href="' . $static_url . '">' . esc_html__('View Large map', 'event_espresso') . '</a>
             </div>
 ';
-        } else {
-            EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = [
-                'map_ID'              => $ee_gmaps_opts['map_ID'],
-                'ee_map_zoom'         => $ee_map_zoom,
-                'ee_map_nav_display'  => $ee_map_nav_display,
-                'ee_map_nav_size'     => $ee_map_nav_size,
-                'ee_map_type_control' => $ee_map_type_control,
-                'location'            => $ee_gmaps_opts['location'],
-            ];
-
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html  = '
+		} else {
+			EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = [
+				'map_ID'              => $ee_gmaps_opts['map_ID'],
+				'ee_map_zoom'         => $ee_map_zoom,
+				'ee_map_nav_display'  => $ee_map_nav_display,
+				'ee_map_nav_size'     => $ee_map_nav_size,
+				'ee_map_type_control' => $ee_map_type_control,
+				'location'            => $ee_gmaps_opts['location'],
+			];
+
+			$style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+			$html  = '
             <div class="ee-gmap-wrapper ' . esc_attr($map_align) . '">
                 <div class="ee-gmap" 
                      id="map_canvas_' . esc_attr($ee_gmaps_opts['map_ID']) . '"
@@ -104,109 +104,109 @@ 
                  ></div>
             </div>';
 
-            wp_enqueue_script('gmap_api');
-            wp_enqueue_script('ee_gmap');
-            add_action('wp_footer', ['EEH_Maps', 'footer_enqueue_script']);
-        }
-        return $html; // end auto map or static url map check
-    }
-
-
-    /**
-     * enqueue_script
-     *
-     * @return void
-     */
-    public static function footer_enqueue_script()
-    {
-        wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
-    }
-
-
-    /**
-     * registers scripts for maps
-     */
-    public static function espresso_google_map_js()
-    {
-        $api_url = sprintf(
-            "https://maps.googleapis.com/maps/api/js?key=%s",
-            apply_filters(
-                'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                EE_Registry::instance()->CFG->map_settings->google_map_api_key
-            )
-        );
-        wp_register_script(
-            'gmap_api',
-            esc_url_raw($api_url),
-            ['jquery'],
-            null,
-            true
-        );
-        wp_register_script(
-            'ee_gmap',
-            plugin_dir_url(__FILE__) . 'assets/ee_gmap.js',
-            ['gmap_api'],
-            '1.0',
-            true
-        );
-    }
-
-
-    /**
-     * creates a Google Map Link
-     *
-     * @param array $atts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map_link($atts)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        extract($atts);
-        /** @var string $address */
-        /** @var string $city */
-        /** @var string $state */
-        /** @var string $zip */
-        /** @var string $country */
-        $address         = "{$address}";
-        $city            = "{$city}";
-        $state           = "{$state}";
-        $zip             = "{$zip}";
-        $country         = "{$country}";
-        $text            = isset($text) ? "{$text}" : "";
-        $type            = isset($type) ? "{$type}" : "";
-        $map_w           = isset($map_w) ? "{$map_w}" : 400;
-        $map_h           = isset($map_h) ? "{$map_h}" : 400;
-        $id              = isset($id) ? $id : 'not_set';
-        $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
-
-        $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
-
-        $google_map = htmlentities2('https://maps.google.com/maps?q=' . urlencode($address_string));
-
-        switch ($type) {
-            case 'text':
-            default:
-                $text = $text == '' ? esc_html__('Map and Directions', 'event_espresso') : $text;
-                break;
-
-            case 'url_only':
-            case 'url':
-                $text = $google_map;
-                break;
-
-            case 'map':
-                $scheme = is_ssl() ? 'https://' : 'http://';
-
-                $api_key = apply_filters(
-                    'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
-                    EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                );
-
-                return '
+			wp_enqueue_script('gmap_api');
+			wp_enqueue_script('ee_gmap');
+			add_action('wp_footer', ['EEH_Maps', 'footer_enqueue_script']);
+		}
+		return $html; // end auto map or static url map check
+	}
+
+
+	/**
+	 * enqueue_script
+	 *
+	 * @return void
+	 */
+	public static function footer_enqueue_script()
+	{
+		wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
+	}
+
+
+	/**
+	 * registers scripts for maps
+	 */
+	public static function espresso_google_map_js()
+	{
+		$api_url = sprintf(
+			"https://maps.googleapis.com/maps/api/js?key=%s",
+			apply_filters(
+				'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+				EE_Registry::instance()->CFG->map_settings->google_map_api_key
+			)
+		);
+		wp_register_script(
+			'gmap_api',
+			esc_url_raw($api_url),
+			['jquery'],
+			null,
+			true
+		);
+		wp_register_script(
+			'ee_gmap',
+			plugin_dir_url(__FILE__) . 'assets/ee_gmap.js',
+			['gmap_api'],
+			'1.0',
+			true
+		);
+	}
+
+
+	/**
+	 * creates a Google Map Link
+	 *
+	 * @param array $atts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map_link($atts)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		extract($atts);
+		/** @var string $address */
+		/** @var string $city */
+		/** @var string $state */
+		/** @var string $zip */
+		/** @var string $country */
+		$address         = "{$address}";
+		$city            = "{$city}";
+		$state           = "{$state}";
+		$zip             = "{$zip}";
+		$country         = "{$country}";
+		$text            = isset($text) ? "{$text}" : "";
+		$type            = isset($type) ? "{$type}" : "";
+		$map_w           = isset($map_w) ? "{$map_w}" : 400;
+		$map_h           = isset($map_h) ? "{$map_h}" : 400;
+		$id              = isset($id) ? $id : 'not_set';
+		$map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
+
+		$address_string = ($address != '' ? $address : '')
+						  . ($city != '' ? ',' . $city : '')
+						  . ($state != '' ? ',' . $state : '')
+						  . ($zip != '' ? ',' . $zip : '')
+						  . ($country != '' ? ',' . $country : '');
+
+		$google_map = htmlentities2('https://maps.google.com/maps?q=' . urlencode($address_string));
+
+		switch ($type) {
+			case 'text':
+			default:
+				$text = $text == '' ? esc_html__('Map and Directions', 'event_espresso') : $text;
+				break;
+
+			case 'url_only':
+			case 'url':
+				$text = $google_map;
+				break;
+
+			case 'map':
+				$scheme = is_ssl() ? 'https://' : 'http://';
+
+				$api_key = apply_filters(
+					'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
+					EE_Registry::instance()->CFG->map_settings->google_map_api_key
+				);
+
+				return '
                 <a class="a_map_image_link" 
                    href="' . esc_url_raw($google_map) . '" 
                    target="_blank" 
@@ -216,23 +216,23 @@ 
                          class="map_image_link" 
                          id="venue_map_' . $id . '" ' . $map_image_class . ' 
                          src="'
-                       . htmlentities2(
-                           $scheme
-                           . 'maps.googleapis.com/maps/api/staticmap?center='
-                           . urlencode($address_string)
-                           . '&amp;zoom=14&amp;size='
-                           . $map_w . 'x' . $map_h
-                           . '&amp;markers=color:green|label:|'
-                           . urlencode($address_string)
-                           . '&amp;sensor=false&amp;key='
-                           . $api_key
-                       ) . '"
+					   . htmlentities2(
+						   $scheme
+						   . 'maps.googleapis.com/maps/api/staticmap?center='
+						   . urlencode($address_string)
+						   . '&amp;zoom=14&amp;size='
+						   . $map_w . 'x' . $map_h
+						   . '&amp;markers=color:green|label:|'
+						   . urlencode($address_string)
+						   . '&amp;sensor=false&amp;key='
+						   . $api_key
+					   ) . '"
                      />
                  </a>';
-        }
+		}
 
-        return $type === 'url_only'
-            ? $text
-            : '<a href="' . esc_url_raw($google_map) . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
-    }
+		return $type === 'url_only'
+			? $text
+			: '<a href="' . esc_url_raw($google_map) . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -51,7 +51,7 @@ 
             ? esc_url_raw($ee_gmaps_opts['ee_static_url'])
             : false;
 
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
+        if ( ! empty($ee_gmaps_opts['ee_map_align'])) {
             switch ($ee_gmaps_opts['ee_map_align']) {
                 case "left":
                     $map_align = 'ee-gmap-align-left left';
@@ -75,18 +75,18 @@ 
         // if so display a Google static iframe map else run V3 api
         if ($static_url) {
             $html = '
-            <div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">
-                <iframe src="' . $static_url . '&output=embed"
-                        style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"
+            <div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align.'">
+                <iframe src="' . $static_url.'&output=embed"
+                        style="width: ' . $ee_map_width.'px; height: '.$ee_map_height.'px;"
                         frameborder="0" 
                         scrolling="no"
                     >
                 </iframe>
-                <a href="' . $static_url . '">' . esc_html__('View Large map', 'event_espresso') . '</a>
+                <a href="' . $static_url.'">'.esc_html__('View Large map', 'event_espresso').'</a>
             </div>
 ';
         } else {
-            EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = [
+            EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = [
                 'map_ID'              => $ee_gmaps_opts['map_ID'],
                 'ee_map_zoom'         => $ee_map_zoom,
                 'ee_map_nav_display'  => $ee_map_nav_display,
@@ -95,12 +95,12 @@ 
                 'location'            => $ee_gmaps_opts['location'],
             ];
 
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+            $style = 'width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;';
             $html  = '
-            <div class="ee-gmap-wrapper ' . esc_attr($map_align) . '">
+            <div class="ee-gmap-wrapper ' . esc_attr($map_align).'">
                 <div class="ee-gmap" 
-                     id="map_canvas_' . esc_attr($ee_gmaps_opts['map_ID']) . '"
-                     style="' . esc_attr($style) . '"
+                     id="map_canvas_' . esc_attr($ee_gmaps_opts['map_ID']).'"
+                     style="' . esc_attr($style).'"
                  ></div>
             </div>';
 
@@ -144,7 +144,7 @@ 
         );
         wp_register_script(
             'ee_gmap',
-            plugin_dir_url(__FILE__) . 'assets/ee_gmap.js',
+            plugin_dir_url(__FILE__).'assets/ee_gmap.js',
             ['gmap_api'],
             '1.0',
             true
@@ -180,12 +180,12 @@ 
         $map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
 
         $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
+                          . ($city != '' ? ','.$city : '')
+                          . ($state != '' ? ','.$state : '')
+                          . ($zip != '' ? ','.$zip : '')
+                          . ($country != '' ? ','.$country : '');
 
-        $google_map = htmlentities2('https://maps.google.com/maps?q=' . urlencode($address_string));
+        $google_map = htmlentities2('https://maps.google.com/maps?q='.urlencode($address_string));
 
         switch ($type) {
             case 'text':
@@ -208,31 +208,31 @@ 
 
                 return '
                 <a class="a_map_image_link" 
-                   href="' . esc_url_raw($google_map) . '" 
+                   href="' . esc_url_raw($google_map).'" 
                    target="_blank" 
                    rel="noopener noreferrer"
                 >
-                    <img alt="' . esc_html__('Map and Directions', 'event_espresso') . '"
+                    <img alt="' . esc_html__('Map and Directions', 'event_espresso').'"
                          class="map_image_link" 
-                         id="venue_map_' . $id . '" ' . $map_image_class . ' 
+                         id="venue_map_' . $id.'" '.$map_image_class.' 
                          src="'
                        . htmlentities2(
                            $scheme
                            . 'maps.googleapis.com/maps/api/staticmap?center='
                            . urlencode($address_string)
                            . '&amp;zoom=14&amp;size='
-                           . $map_w . 'x' . $map_h
+                           . $map_w.'x'.$map_h
                            . '&amp;markers=color:green|label:|'
                            . urlencode($address_string)
                            . '&amp;sensor=false&amp;key='
                            . $api_key
-                       ) . '"
+                       ).'"
                      />
                  </a>';
         }
 
         return $type === 'url_only'
             ? $text
-            : '<a href="' . esc_url_raw($google_map) . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
+            : '<a href="'.esc_url_raw($google_map).'" target="_blank" rel="noopener noreferrer">'.$text.'</a>';
     }
 }

core/helpers/EEH_Debug_Tools.helper.php

Indentation +682 added lines, -682 removed lines

@@ -15,673 +15,673 @@ 
 class EEH_Debug_Tools
 {
 
-    /**
-     *    instance of the EEH_Autoloader object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    protected $_memory_usage_points = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EEH_Debug_Tools
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private class constructor
-     */
-    private function __construct()
-    {
-        // load Kint PHP debugging library
-        if (
-            defined('EE_LOAD_KINT')
-            && ! class_exists('Kint')
-            && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
-        ) {
-            // despite EE4 having a check for an existing copy of the Kint debugging class,
-            // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
-            // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
-            // so we've moved it to our test folder so that it is not included with production releases
-            // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
-        }
-        $plugin = basename(EE_PLUGIN_DIR_PATH);
-        add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
-    }
-
-
-
-    /**
-     *    show_db_name
-     *
-     * @return void
-     */
-    public static function show_db_name()
-    {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
-            echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
-                 . DB_NAME
-                 . '</p>';
-        }
-        if (EE_DEBUG) {
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    dump EE_Session object at bottom of page after everything else has happened
-     *
-     * @return void
-     */
-    public function espresso_session_footer_dump()
-    {
-        if (
-            (defined('WP_DEBUG') && WP_DEBUG)
-            && ! defined('DOING_AJAX')
-            && class_exists('Kint')
-            && function_exists('wp_get_current_user')
-            && current_user_can('update_core')
-            && class_exists('EE_Registry')
-        ) {
-            Kint::dump(EE_Registry::instance()->SSN->id());
-            Kint::dump(EE_Registry::instance()->SSN);
-            //          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
-            $this->espresso_list_hooked_functions();
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    List All Hooked Functions
-     *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
-     *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
-     *
-     * @param string $tag
-     * @return void
-     */
-    public function espresso_list_hooked_functions($tag = '')
-    {
-        global $wp_filter;
-        echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-        if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
-                trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
-                return;
-            }
-            echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
-        } else {
-            $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
-            ksort($hook);
-        }
-        foreach ($hook as $tag_name => $priorities) {
-            echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>esc_html($tag_name)</strong><br />";
-            ksort($priorities);
-            foreach ($priorities as $priority => $function) {
-                echo esc_html($priority);
-                foreach ($function as $name => $properties) {
-                    $name = esc_html($name);
-                    echo "\t$name<br />";
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    registered_filter_callbacks
-     *
-     * @param string $hook_name
-     * @return array
-     */
-    public static function registered_filter_callbacks($hook_name = '')
-    {
-        $filters = array();
-        global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
-                foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
-                }
-            }
-        }
-        return $filters;
-    }
-
-
-
-    /**
-     *    captures plugin activation errors for debugging
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ee_plugin_activation_errors()
-    {
-        if (WP_DEBUG) {
-            $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
-            if (class_exists('EEH_File')) {
-                try {
-                    EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
-                    );
-                    EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                        $activation_errors
-                    );
-                } catch (EE_Error $e) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The Event Espresso activation errors file could not be setup because: %s',
-                                'event_espresso'
-                            ),
-                            $e->getMessage()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // old school attempt
-                file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                    $activation_errors
-                );
-            }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
-            update_option('ee_plugin_activation_errors', $activation_errors);
-        }
-    }
-
-
-
-    /**
-     * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
-     * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
-     * or we want to make sure they use something the right way.
-     *
-     * @access public
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     * @uses   trigger_error()
-     */
-    public function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        $applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
-        $error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
-        // because we swapped the parameter order around for the last two params,
-        // let's verify that some third party isn't still passing an error type value for the third param
-        if (is_int($applies_when)) {
-            $error_type = $applies_when;
-            $applies_when = espresso_version();
-        }
-        // if not displaying notices yet, then just leave
-        if (version_compare(espresso_version(), $applies_when, '<')) {
-            return;
-        }
-        do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-        $version = $version === null
-            ? ''
-            : sprintf(
-                esc_html__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
-                $version
-            );
-        $error_message = sprintf(
-            esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
-            $function,
-            '<strong>',
-            '</strong>',
-            $message,
-            $version
-        );
-        // don't trigger error if doing ajax,
-        // instead we'll add a transient EE_Error notice that in theory should show on the next request.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
-                'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
-                'event_espresso'
-            );
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $error_message .= '<ul><li>';
-            $error_message .= implode('</li><li>', $request->requestParams());
-            $error_message .= '</ul>';
-            EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
-            // now we set this on the transient so it shows up on the next request.
-            EE_Error::get_notices(false, true);
-        } else {
-            trigger_error($error_message, $error_type);
-        }
-    }
-
-
-
-
-    /**
-     * Logger helpers
-     */
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @param string $debug_index
-     * @param string $debug_key
-     */
-    public static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        $info = array(),
-        $display_request = false,
-        $debug_index = '',
-        $debug_key = 'EE_DEBUG_SPCO'
-    ) {
-        if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
-            $debug_data = get_option($debug_key, array());
-            $default_data = array(
-                $class => $func . '() : ' . $line,
-            );
-            // don't serialize objects
-            $info = self::strip_objects($info);
-            $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
-            }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
-            update_option($debug_key, $debug_data);
-        }
-    }
-
-
-
-    /**
-     * strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public static function strip_objects($info = array())
-    {
-        foreach ($info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
-                if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
-                }
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     * @param string     $margin
-     */
-    public static function printv(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false,
-        $margin = ''
-    ) {
-        $var_name = ! $var_name ? 'string' : $var_name;
-        $var_name = ucwords(str_replace('$', '', $var_name));
-        $is_method = method_exists($var_name, $var);
-        $var_name = ucwords(str_replace('_', ' ', $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-    protected static function headingTag($heading_tag)
-    {
-        $heading_tag = absint($heading_tag);
-        return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
-    }
-
-    protected static function headingSpacer($heading_tag)
-    {
-        return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
-            ? self::lineBreak()
-            : '';
-    }
-
-
-    protected static function lineBreak()
-    {
-        return defined('DOING_AJAX') && DOING_AJAX ? '<br />' : "\n";
-    }
-
-
-    protected static function plainOutput()
-    {
-        return defined('EE_TESTS_DIR')
-               || (defined('DOING_AJAX') && DOING_AJAX)
-               || (
-                   isset($_SERVER['REQUEST_URI'])
-                   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
-               );
-    }
-
-
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @param int    $line
-     * @return string
-     */
-    protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            $heading = '';
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                $heading .= self::lineBreak();
-            }
-            $heading .= self::lineBreak() . "{$line}) {$var_name}";
-            return $heading;
-        }
-        $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
-    }
-
-
-
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
-    protected static function headingX($heading_tag = 'h5')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return '';
-        }
-        return '</' . $heading_tag . '>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function grey_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
-    protected static function file_and_line($file, $line, $heading_tag)
-    {
-        if ($file === '' || $line === '') {
-            return '';
-        }
-        $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
-        if (EEH_Debug_Tools::plainOutput()) {
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})";
-            }
-            return '';
-        }
-        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
-               . $file
-               . '<br />line no: '
-               . $line
-               . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        ob_start();
-        var_dump($var);
-        $var = ob_get_clean();
-        if (EEH_Debug_Tools::plainOutput()) {
-            return str_replace("\n", '', $var);
-        }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     */
-    public static function printr(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false
-    ) {
-        // return;
-        $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
-        $margin = is_admin() ? ' 180px' : '0';
-        if (is_string($var)) {
-            EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
-            return;
-        }
-        if (is_object($var)) {
-            $var_name = ! $var_name ? 'object' : $var_name;
-        } elseif (is_array($var)) {
-            $var_name = ! $var_name ? 'array' : $var_name;
-        } elseif (is_numeric($var)) {
-            $var_name = ! $var_name ? 'numeric' : $var_name;
-        } elseif ($var === null) {
-            $var_name = ! $var_name ? 'null' : $var_name;
-        }
-        $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
-            EEH_Debug_Tools::pre_span($var)
-        );
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-
-    /******************** deprecated ********************/
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     */
-    public function reset_times()
-    {
-        Benchmark::resetTimes();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
-     */
-    public function start_timer($timer_name = null)
-    {
-        Benchmark::startTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     */
-    public function stop_timer($timer_name = '')
-    {
-        Benchmark::stopTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public function measure_memory($label, $output_now = false)
-    {
-        Benchmark::measureMemory($label, $output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param int $size
-     * @return string
-     */
-    public function convert($size)
-    {
-        return Benchmark::convert($size);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param bool $output_now
-     * @return string
-     */
-    public function show_times($output_now = true)
-    {
-        return Benchmark::displayResults($output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public function format_time($timer_name, $total_time)
-    {
-        return Benchmark::formatTime($timer_name, $total_time);
-    }
+	/**
+	 *    instance of the EEH_Autoloader object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	protected $_memory_usage_points = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EEH_Debug_Tools
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_Debug_Tools) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private class constructor
+	 */
+	private function __construct()
+	{
+		// load Kint PHP debugging library
+		if (
+			defined('EE_LOAD_KINT')
+			&& ! class_exists('Kint')
+			&& file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
+		) {
+			// despite EE4 having a check for an existing copy of the Kint debugging class,
+			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
+			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
+			// so we've moved it to our test folder so that it is not included with production releases
+			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
+			require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+		}
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
+	}
+
+
+
+	/**
+	 *    show_db_name
+	 *
+	 * @return void
+	 */
+	public static function show_db_name()
+	{
+		if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
+				 . DB_NAME
+				 . '</p>';
+		}
+		if (EE_DEBUG) {
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    dump EE_Session object at bottom of page after everything else has happened
+	 *
+	 * @return void
+	 */
+	public function espresso_session_footer_dump()
+	{
+		if (
+			(defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
+		) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
+			//          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
+			$this->espresso_list_hooked_functions();
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    List All Hooked Functions
+	 *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
+	 *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
+	 *
+	 * @param string $tag
+	 * @return void
+	 */
+	public function espresso_list_hooked_functions($tag = '')
+	{
+		global $wp_filter;
+		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
+		if ($tag) {
+			$hook[ $tag ] = $wp_filter[ $tag ];
+			if (! is_array($hook[ $tag ])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
+				return;
+			}
+			echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
+		} else {
+			$hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
+			ksort($hook);
+		}
+		foreach ($hook as $tag_name => $priorities) {
+			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>esc_html($tag_name)</strong><br />";
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
+				echo esc_html($priority);
+				foreach ($function as $name => $properties) {
+					$name = esc_html($name);
+					echo "\t$name<br />";
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    registered_filter_callbacks
+	 *
+	 * @param string $hook_name
+	 * @return array
+	 */
+	public static function registered_filter_callbacks($hook_name = '')
+	{
+		$filters = array();
+		global $wp_filter;
+		if (isset($wp_filter[ $hook_name ])) {
+			$filters[ $hook_name ] = array();
+			foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
+				$filters[ $hook_name ][ $priority ] = array();
+				foreach ($callbacks as $callback) {
+					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+				}
+			}
+		}
+		return $filters;
+	}
+
+
+
+	/**
+	 *    captures plugin activation errors for debugging
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ee_plugin_activation_errors()
+	{
+		if (WP_DEBUG) {
+			$activation_errors = ob_get_contents();
+			if (! empty($activation_errors)) {
+				$activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+			}
+			espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
+				try {
+					EEH_File::ensure_file_exists_and_is_writable(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+					);
+					EEH_File::write_to_file(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+						$activation_errors
+					);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The Event Espresso activation errors file could not be setup because: %s',
+								'event_espresso'
+							),
+							$e->getMessage()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// old school attempt
+				file_put_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+					$activation_errors
+				);
+			}
+			$activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
+		}
+	}
+
+
+
+	/**
+	 * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
+	 * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
+	 * or we want to make sure they use something the right way.
+	 *
+	 * @access public
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 * @uses   trigger_error()
+	 */
+	public function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
+		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
+		// because we swapped the parameter order around for the last two params,
+		// let's verify that some third party isn't still passing an error type value for the third param
+		if (is_int($applies_when)) {
+			$error_type = $applies_when;
+			$applies_when = espresso_version();
+		}
+		// if not displaying notices yet, then just leave
+		if (version_compare(espresso_version(), $applies_when, '<')) {
+			return;
+		}
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null
+			? ''
+			: sprintf(
+				esc_html__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
+				$version
+			);
+		$error_message = sprintf(
+			esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
+			$function,
+			'<strong>',
+			'</strong>',
+			$message,
+			$version
+		);
+		// don't trigger error if doing ajax,
+		// instead we'll add a transient EE_Error notice that in theory should show on the next request.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' ' . esc_html__(
+				'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
+				'event_espresso'
+			);
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$error_message .= '<ul><li>';
+			$error_message .= implode('</li><li>', $request->requestParams());
+			$error_message .= '</ul>';
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
+			// now we set this on the transient so it shows up on the next request.
+			EE_Error::get_notices(false, true);
+		} else {
+			trigger_error($error_message, $error_type);
+		}
+	}
+
+
+
+
+	/**
+	 * Logger helpers
+	 */
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @param string $debug_index
+	 * @param string $debug_key
+	 */
+	public static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		$info = array(),
+		$display_request = false,
+		$debug_index = '',
+		$debug_key = 'EE_DEBUG_SPCO'
+	) {
+		if (WP_DEBUG) {
+			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
+			$default_data = array(
+				$class => $func . '() : ' . $line,
+			);
+			// don't serialize objects
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if (! isset($debug_data[ $index ])) {
+				$debug_data[ $index ] = array();
+			}
+			$debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
+		}
+	}
+
+
+
+	/**
+	 * strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public static function strip_objects($info = array())
+	{
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = self::strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[ $object_class ]['ID'] = $value->ID();
+				}
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 * @param string     $margin
+	 */
+	public static function printv(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false,
+		$margin = ''
+	) {
+		$var_name = ! $var_name ? 'string' : $var_name;
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= $is_method
+			? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
+			: EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+	protected static function headingTag($heading_tag)
+	{
+		$heading_tag = absint($heading_tag);
+		return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
+	}
+
+	protected static function headingSpacer($heading_tag)
+	{
+		return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
+			? self::lineBreak()
+			: '';
+	}
+
+
+	protected static function lineBreak()
+	{
+		return defined('DOING_AJAX') && DOING_AJAX ? '<br />' : "\n";
+	}
+
+
+	protected static function plainOutput()
+	{
+		return defined('EE_TESTS_DIR')
+			   || (defined('DOING_AJAX') && DOING_AJAX)
+			   || (
+				   isset($_SERVER['REQUEST_URI'])
+				   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			$heading = '';
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				$heading .= self::lineBreak();
+			}
+			$heading .= self::lineBreak() . "{$line}) {$var_name}";
+			return $heading;
+		}
+		$margin = "25px 0 0 {$margin}";
+		return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+	}
+
+
+
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
+	protected static function headingX($heading_tag = 'h5')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return '';
+		}
+		return '</' . $heading_tag . '>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function grey_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function file_and_line($file, $line, $heading_tag)
+	{
+		if ($file === '' || $line === '') {
+			return '';
+		}
+		$file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
+		if (EEH_Debug_Tools::plainOutput()) {
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				return " ({$file})";
+			}
+			return '';
+		}
+		return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
+			   . $file
+			   . '<br />line no: '
+			   . $line
+			   . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		ob_start();
+		var_dump($var);
+		$var = ob_get_clean();
+		if (EEH_Debug_Tools::plainOutput()) {
+			return str_replace("\n", '', $var);
+		}
+		return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 */
+	public static function printr(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false
+	) {
+		// return;
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
+		$margin = is_admin() ? ' 180px' : '0';
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
+			return;
+		}
+		if (is_object($var)) {
+			$var_name = ! $var_name ? 'object' : $var_name;
+		} elseif (is_array($var)) {
+			$var_name = ! $var_name ? 'array' : $var_name;
+		} elseif (is_numeric($var)) {
+			$var_name = ! $var_name ? 'numeric' : $var_name;
+		} elseif ($var === null) {
+			$var_name = ! $var_name ? 'null' : $var_name;
+		}
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+			EEH_Debug_Tools::pre_span($var)
+		);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+
+	/******************** deprecated ********************/
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 */
+	public function reset_times()
+	{
+		Benchmark::resetTimes();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param null $timer_name
+	 */
+	public function start_timer($timer_name = null)
+	{
+		Benchmark::startTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 */
+	public function stop_timer($timer_name = '')
+	{
+		Benchmark::stopTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public function measure_memory($label, $output_now = false)
+	{
+		Benchmark::measureMemory($label, $output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param int $size
+	 * @return string
+	 */
+	public function convert($size)
+	{
+		return Benchmark::convert($size);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param bool $output_now
+	 * @return string
+	 */
+	public function show_times($output_now = true)
+	{
+		return Benchmark::displayResults($output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public function format_time($timer_name, $total_time)
+	{
+		return Benchmark::formatTime($timer_name, $total_time);
+	}
 }
 
 
@@ -691,31 +691,31 @@ 
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
-    function dump_wp_query()
-    {
-        global $wp_query;
-        d($wp_query);
-    }
+	function dump_wp_query()
+	{
+		global $wp_query;
+		d($wp_query);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp')) {
-    function dump_wp()
-    {
-        global $wp;
-        d($wp);
-    }
+	function dump_wp()
+	{
+		global $wp;
+		d($wp);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_post')) {
-    function dump_post()
-    {
-        global $post;
-        d($post);
-    }
+	function dump_post()
+	{
+		global $post;
+		d($post);
+	}
 }

Spacing +41 added lines, -41 removed lines

@@ -38,7 +38,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
+        if ( ! self::$_instance instanceof EEH_Debug_Tools) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -55,14 +55,14 @@ 
         if (
             defined('EE_LOAD_KINT')
             && ! class_exists('Kint')
-            && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
+            && file_exists(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php')
         ) {
             // despite EE4 having a check for an existing copy of the Kint debugging class,
             // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
             // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
             // so we've moved it to our test folder so that it is not included with production releases
             // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+            require_once(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php');
         }
         $plugin = basename(EE_PLUGIN_DIR_PATH);
         add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
@@ -79,7 +79,7 @@ 
      */
     public static function show_db_name()
     {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+        if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
             echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
                  . DB_NAME
                  . '</p>';
@@ -129,12 +129,12 @@ 
         global $wp_filter;
         echo '<br/><br/><br/><h3>Hooked Functions</h3>';
         if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
+            $hook[$tag] = $wp_filter[$tag];
+            if ( ! is_array($hook[$tag])) {
                 trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
                 return;
             }
-            echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
+            echo '<h5>For Tag: '.esc_html($tag).'</h5>';
         } else {
             $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
             ksort($hook);
@@ -164,12 +164,12 @@ 
     {
         $filters = array();
         global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
+        if (isset($wp_filter[$hook_name])) {
+            $filters[$hook_name] = array();
+            foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+                $filters[$hook_name][$priority] = array();
                 foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
+                    $filters[$hook_name][$priority][] = $callback['function'];
                 }
             }
         }
@@ -188,17 +188,17 @@ 
     {
         if (WP_DEBUG) {
             $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+            if ( ! empty($activation_errors)) {
+                $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
             }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+            espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
             if (class_exists('EEH_File')) {
                 try {
                     EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html'
                     );
                     EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                         $activation_errors
                     );
                 } catch (EE_Error $e) {
@@ -218,11 +218,11 @@ 
             } else {
                 // old school attempt
                 file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                    EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                     $activation_errors
                 );
             }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+            $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
             update_option('ee_plugin_activation_errors', $activation_errors);
         }
     }
@@ -282,7 +282,7 @@ 
         // don't trigger error if doing ajax,
         // instead we'll add a transient EE_Error notice that in theory should show on the next request.
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
+            $error_message .= ' '.esc_html__(
                 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
                 'event_espresso'
             );
@@ -325,18 +325,18 @@ 
         $debug_key = 'EE_DEBUG_SPCO'
     ) {
         if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
+            $debug_key = $debug_key.'_'.EE_Session::instance()->id();
             $debug_data = get_option($debug_key, array());
             $default_data = array(
-                $class => $func . '() : ' . $line,
+                $class => $func.'() : '.$line,
             );
             // don't serialize objects
             $info = self::strip_objects($info);
             $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
+            if ( ! isset($debug_data[$index])) {
+                $debug_data[$index] = array();
             }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+            $debug_data[$index][microtime()] = array_merge($default_data, $info);
             update_option($debug_key, $debug_data);
         }
     }
@@ -353,20 +353,20 @@ 
     {
         foreach ($info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
+                $info[$key] = self::strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
                 if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
+                    $info[$object_class]['ID'] = $value->ID();
                 }
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;
@@ -400,8 +400,8 @@ 
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
         $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+            ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()')
+            : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var);
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
         $result .= EEH_Debug_Tools::headingX($heading_tag);
         if ($die) {
@@ -456,11 +456,11 @@ 
             if ($heading_tag === 'h1' || $heading_tag === 'h2') {
                 $heading .= self::lineBreak();
             }
-            $heading .= self::lineBreak() . "{$line}) {$var_name}";
+            $heading .= self::lineBreak()."{$line}) {$var_name}";
             return $heading;
         }
         $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+        return '<'.$heading_tag.' style="color:#2EA2CC; margin:'.$margin.';"><b>'.$var_name.'</b>';
     }
 
 
@@ -474,7 +474,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return '';
         }
-        return '</' . $heading_tag . '>';
+        return '</'.$heading_tag.'>';
     }
 
 
@@ -488,7 +488,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -528,7 +528,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -545,7 +545,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return str_replace("\n", '', $var);
         }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+        return '<pre style="color:#999; padding:1em; background: #fff">'.$var.'</pre>';
     }
 
 
@@ -586,7 +586,7 @@ 
         $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+        $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span(
             EEH_Debug_Tools::pre_span($var)
         );
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);

core/db_classes/EE_Event.class.php

Indentation +1439 added lines, -1439 removed lines

@@ -15,1443 +15,1443 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $new_status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes($query_params = array())
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function first_datetime()
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _has_ID_and_is_published()
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_upcoming()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_active()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function is_expired()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive()
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws ReflectionException
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all tickets
-        $tickets = $this->tickets(
-            array(
-                'default_where_conditions' => 'none',
-                'order_by' => array('TKT_qty' => 'ASC'),
-            )
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param  bool $actual whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_sold_out($actual = false)
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_status($reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (
-                EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::active,
-                    $where_params_for_event
-                ) > 0
-            ) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (
-                    EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::upcoming,
-                        $where_params_for_event
-                    ) > 0
-                ) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (
-                        EEM_Datetime::instance()->get_datetime_count_for_status(
-                            EE_Datetime::expired,
-                            $where_params_for_event
-                        ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-' . esc_attr($active_status) . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status; // already escaped
-            return '';
-        }
-        return $status; // already escaped
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function first_event_category($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_categories($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        // If the row already exists, it will be updated. If it doesn't, it will be inserted.
-        // That's in EE_HABTM_Relation::add_relation_to().
-        return $this->_add_relation_to(
-            $question_group_id_or_obj,
-            'Question_Group',
-            [
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true
-            ]
-        );
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        // If the question group is used for the other type (primary or additional)
-        // then just update it. If not, delete it outright.
-        $existing_relation = $this->get_first_related(
-            'Event_Question_Group',
-            [
-                [
-                    'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj)
-                ]
-            ]
-        );
-        $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
-        if ($existing_relation->get($other_field) === false) {
-            // Delete it. It's now no longer for primary or additional question groups.
-            return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
-        }
-        // Just update it. They'll still use this question group for the other category
-        $existing_relation->save(
-            [
-                $field_to_update => false
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @return string
-     * @throws EE_Error*@throws ReflectionException
-     * @see EEI_Admin_Links for comments
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $new_status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes($query_params = array())
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function first_datetime()
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_upcoming()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_active()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function is_expired()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive()
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws ReflectionException
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all tickets
+		$tickets = $this->tickets(
+			array(
+				'default_where_conditions' => 'none',
+				'order_by' => array('TKT_qty' => 'ASC'),
+			)
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param  bool $actual whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_sold_out($actual = false)
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_status($reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (
+				EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::active,
+					$where_params_for_event
+				) > 0
+			) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (
+					EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::upcoming,
+						$where_params_for_event
+					) > 0
+				) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (
+						EEM_Datetime::instance()->get_datetime_count_for_status(
+							EE_Datetime::expired,
+							$where_params_for_event
+						) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-' . esc_attr($active_status) . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status; // already escaped
+			return '';
+		}
+		return $status; // already escaped
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function first_event_category($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_categories($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		// If the row already exists, it will be updated. If it doesn't, it will be inserted.
+		// That's in EE_HABTM_Relation::add_relation_to().
+		return $this->_add_relation_to(
+			$question_group_id_or_obj,
+			'Question_Group',
+			[
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary) => true
+			]
+		);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		// If the question group is used for the other type (primary or additional)
+		// then just update it. If not, delete it outright.
+		$existing_relation = $this->get_first_related(
+			'Event_Question_Group',
+			[
+				[
+					'QSG_ID' => EEM_Question_Group::instance()->ensure_is_ID($question_group_id_or_obj)
+				]
+			]
+		);
+		$field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
+		$other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+		if ($existing_relation->get($other_field) === false) {
+			// Delete it. It's now no longer for primary or additional question groups.
+			return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');
+		}
+		// Just update it. They'll still use this question group for the other category
+		$existing_relation->save(
+			[
+				$field_to_update => false
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @return string
+	 * @throws EE_Error*@throws ReflectionException
+	 * @see EEI_Admin_Links for comments
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -73,7 +73,7 @@ 
      */
     public function getAvailableSpacesCalculator()
     {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+        if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
             $this->available_spaces_calculator = new EventSpacesCalculator($this);
         }
         return $this->available_spaces_calculator;
@@ -223,7 +223,7 @@ 
      */
     public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
     {
-        if (! empty($this->_Primary_Datetime)) {
+        if ( ! empty($this->_Primary_Datetime)) {
             return $this->_Primary_Datetime;
         }
         $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
@@ -248,7 +248,7 @@ 
     {
         // first get all datetimes
         $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
+        if ( ! $datetimes) {
             return array();
         }
         $datetime_ids = array();
@@ -456,7 +456,7 @@ 
     public function short_description($num_words = 55, $more = null, $not_full_desc = false)
     {
         $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
+        if ( ! empty($short_desc) || $not_full_desc) {
             return $short_desc;
         }
         $full_desc = $this->get('EVT_desc');
@@ -924,7 +924,7 @@ 
         );
         $all_expired = true;
         foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
+            if ( ! $ticket->is_expired()) {
                 $all_expired = false;
                 break;
             }
@@ -1015,7 +1015,7 @@ 
      */
     public function is_sold_out($actual = false)
     {
-        if (! $actual) {
+        if ( ! $actual) {
             return $this->status() === EEM_Event::sold_out;
         }
         return $this->perform_sold_out_status_check();
@@ -1061,11 +1061,11 @@ 
     public function get_active_status($reset = false)
     {
         // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
+        if ( ! empty($this->_active_status) && ! $reset) {
             return $this->_active_status;
         }
         // first check if event id is present on this object
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return false;
         }
         $where_params_for_event = array(array('EVT_ID' => $this->ID()));
@@ -1136,7 +1136,7 @@ 
     public function pretty_active_status($echo = true)
     {
         $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-' . esc_attr($active_status) . '">'
+        $status = '<span class="ee-status event-active-status-'.esc_attr($active_status).'">'
                   . EEH_Template::pretty_status($active_status, false, 'sentence')
                   . '</span>';
         if ($echo) {
@@ -1155,7 +1155,7 @@ 
     public function get_number_of_tickets_sold()
     {
         $tkt_sold = 0;
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return 0;
         }
         $datetimes = $this->datetimes();
@@ -1345,7 +1345,7 @@ 
             ]
         );
         $field_to_update = EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary);
-        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext(! $for_primary);
+        $other_field = EEM_Event_Question_Group::instance()->fieldNameForContext( ! $for_primary);
         if ($existing_relation->get($other_field) === false) {
             // Delete it. It's now no longer for primary or additional question groups.
             return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group');

core/services/helpers/datetime/AbstractHelper.php

Indentation +245 added lines, -245 removed lines

@@ -13,136 +13,136 @@ 
 {
 
 
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @return string
-     * @throws EE_Error
-     */
-    public function getValidTimezoneString($timezone_string = '')
-    {
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        $timezone_string = ! empty($timezone_string)
-            ? $timezone_string
-            : $this->getTimezoneStringFromGmtOffset();
-        $this->validateTimezone($timezone_string);
-        return $timezone_string;
-    }
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getValidTimezoneString($timezone_string = '')
+	{
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		$timezone_string = ! empty($timezone_string)
+			? $timezone_string
+			: $this->getTimezoneStringFromGmtOffset();
+		$this->validateTimezone($timezone_string);
+		return $timezone_string;
+	}
 
 
 
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     * @throws EE_Error
-     */
-    public function validateTimezone($timezone_string, $throw_error = true)
-    {
-        // easiest way to test a timezone string is just see if it throws an error when you try to create a
-        // DateTimeZone object with it
-        try {
-            new DateTimeZone($timezone_string);
-        } catch (Exception $e) {
-            // sometimes we take exception to exceptions
-            if (! $throw_error) {
-                return false;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                        'event_espresso'
-                    ),
-                    $timezone_string,
-                    '<a href="http://www.php.net/manual/en/timezones.php">',
-                    '</a>'
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true)
+	{
+		// easiest way to test a timezone string is just see if it throws an error when you try to create a
+		// DateTimeZone object with it
+		try {
+			new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
+			// sometimes we take exception to exceptions
+			if (! $throw_error) {
+				return false;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+						'event_espresso'
+					),
+					$timezone_string,
+					'<a href="http://www.php.net/manual/en/timezones.php">',
+					'</a>'
+				)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset()
-    {
-        $timezone_string = (string) get_option('timezone_string');
-        if ($timezone_string) {
-            try {
-                $timezone = new DateTimeZone($timezone_string);
-                return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
-            } catch (Exception $e) {
-            }
-        }
-        $offset = get_option('gmt_offset');
-        return (int) ($offset * HOUR_IN_SECONDS);
-    }
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset()
+	{
+		$timezone_string = (string) get_option('timezone_string');
+		if ($timezone_string) {
+			try {
+				$timezone = new DateTimeZone($timezone_string);
+				return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
+			} catch (Exception $e) {
+			}
+		}
+		$offset = get_option('gmt_offset');
+		return (int) ($offset * HOUR_IN_SECONDS);
+	}
 
 
-    /**
-     * Get Timezone offset for given timezone object
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null|int     $time
-     * @return int
-     * @throws DomainException
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
-    {
-        $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
-                    print_r($transition, true)
-                )
-            );
-        }
-        return $transition['offset'];
-    }
+	/**
+	 * Get Timezone offset for given timezone object
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int     $time
+	 * @return int
+	 * @throws DomainException
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
+	{
+		$transition = $this->getTimezoneTransitions($date_time_zone, $time);
+		if (! isset($transition['offset'])) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
+					print_r($transition, true)
+				)
+			);
+		}
+		return $transition['offset'];
+	}
 
 
-    /**
-     * Provide a timezone select input
-     *
-     * @param string $timezone_string
-     * @return string
-     * @throws EE_Error
-     */
-    public function timezoneSelectInput($timezone_string = '')
-    {
-        // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
-        // if passed a value, then use that, else get WP option
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        // check if the timezone is valid but don't throw any errors if it isn't
-        $timezone_string = $this->validateTimezone($timezone_string, false)
-            ? $timezone_string
-            : '';
-        $gmt_offset      = get_option('gmt_offset');
-        $check_zone_info = true;
-        if (empty($timezone_string)) {
-            // Create a UTC+- zone if no timezone string exists
-            $timezone_string = 'UTC';
-            $check_zone_info = false;
-            if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
-            } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
-            }
-        }
-        ?>
+	/**
+	 * Provide a timezone select input
+	 *
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function timezoneSelectInput($timezone_string = '')
+	{
+		// get WP date time format
+		$datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+		// if passed a value, then use that, else get WP option
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		// check if the timezone is valid but don't throw any errors if it isn't
+		$timezone_string = $this->validateTimezone($timezone_string, false)
+			? $timezone_string
+			: '';
+		$gmt_offset      = get_option('gmt_offset');
+		$check_zone_info = true;
+		if (empty($timezone_string)) {
+			// Create a UTC+- zone if no timezone string exists
+			$timezone_string = 'UTC';
+			$check_zone_info = false;
+			if ($gmt_offset > 0) {
+				$timezone_string = 'UTC+' . $gmt_offset;
+			} elseif ($gmt_offset < 0) {
+				$timezone_string = 'UTC' . $gmt_offset;
+			}
+		}
+		?>
         <p>
             <label for="timezone_string"><?php esc_html_e('timezone', 'event_espresso'); ?></label>
             <select id="timezone_string" name="timezone_string">
@@ -155,150 +155,150 @@ 
         <p>
         <span>
             <?php
-            printf(
-                esc_html__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
-                '<abbr title="Coordinated Universal Time">',
-                '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
-            );
-            ?></span>
+			printf(
+				esc_html__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
+				'<abbr title="Coordinated Universal Time">',
+				'</abbr>',
+				'<code>' . date_i18n($datetime_format, false, true) . '</code>'
+			);
+			?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+		if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
         <br/><span><?php printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
             <?php
-        endif; ?>
+		endif; ?>
 
         <?php
-        if ($check_zone_info && $timezone_string) : ?>
+		if ($check_zone_info && $timezone_string) : ?>
         <br/>
         <span>
                 <?php
-                // Set TZ so localtime works.
-                date_default_timezone_set($timezone_string);
-                $now = localtime(time(), true);
-                if ($now['tm_isdst']) {
-                    esc_html_e('This timezone is currently in daylight saving time.', 'event_espresso');
-                } else {
-                    esc_html_e('This timezone is currently in standard time.', 'event_espresso');
-                }
-                ?>
+				// Set TZ so localtime works.
+				date_default_timezone_set($timezone_string);
+				$now = localtime(time(), true);
+				if ($now['tm_isdst']) {
+					esc_html_e('This timezone is currently in daylight saving time.', 'event_espresso');
+				} else {
+					esc_html_e('This timezone is currently in standard time.', 'event_espresso');
+				}
+				?>
             <br/>
             <?php
-            if (function_exists('timezone_transitions_get')) {
-                $found                   = false;
-                $date_time_zone_selected = new DateTimeZone($timezone_string);
-                $tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
-                $right_now               = time();
-                $tr['isdst']             = false;
-                foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
-                    if ($tr['ts'] > $right_now) {
-                        $found = true;
-                        break;
-                    }
-                }
-                if ($found) {
-                    $message = $tr['isdst']
-                        ? esc_html__(' Daylight saving time begins on: %s.', 'event_espresso')
-                        : esc_html__(' Standard time begins  on: %s.', 'event_espresso');
-                    // Add the difference between the current offset and the new offset to ts to get the correct
-                    // transition time from date_i18n().
-                    printf(
-                        $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
-                    );
-                } else {
-                    esc_html_e('This timezone does not observe daylight saving time.', 'event_espresso');
-                }
-            }
-            // Set back to UTC.
-            date_default_timezone_set('UTC');
-            ?>
+			if (function_exists('timezone_transitions_get')) {
+				$found                   = false;
+				$date_time_zone_selected = new DateTimeZone($timezone_string);
+				$tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
+				$right_now               = time();
+				$tr['isdst']             = false;
+				foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
+					if ($tr['ts'] > $right_now) {
+						$found = true;
+						break;
+					}
+				}
+				if ($found) {
+					$message = $tr['isdst']
+						? esc_html__(' Daylight saving time begins on: %s.', 'event_espresso')
+						: esc_html__(' Standard time begins  on: %s.', 'event_espresso');
+					// Add the difference between the current offset and the new offset to ts to get the correct
+					// transition time from date_i18n().
+					printf(
+						$message,
+						'<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+					);
+				} else {
+					esc_html_e('This timezone does not observe daylight saving time.', 'event_espresso');
+				}
+			}
+			// Set back to UTC.
+			date_default_timezone_set('UTC');
+			?>
         </span></p>
             <?php
-        endif;
-    }
+		endif;
+	}
 
 
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp  if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     * @throws EE_Error
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
-    {
-        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
-        $timezone_string = $this->getValidTimezoneString($timezone_string);
-        $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
-        $offset          = timezone_offset_get($TimeZone, $DateTime);
-        return (int) $DateTime->format('U') + (int) $offset;
-    }
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp  if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 * @throws EE_Error
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
+	{
+		$unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
+		$timezone_string = $this->getValidTimezoneString($timezone_string);
+		$TimeZone        = new DateTimeZone($timezone_string);
+		$DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+		$offset          = timezone_offset_get($TimeZone, $DateTime);
+		return (int) $DateTime->format('U') + (int) $offset;
+	}
 
 
-    /**
-     * Get Timezone Transitions
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array|mixed
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        $time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
-        $time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        $transitions = $date_time_zone->getTransitions($time);
-        return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
-    }
+	/**
+	 * Get Timezone Transitions
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array|mixed
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		$time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
+		$time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		$transitions = $date_time_zone->getTransitions($time);
+		return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
+	}
 
 
 
-    /**
-     * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
-    {
-        return $gmt_offset;
-    }
+	/**
+	 * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
+	{
+		return $gmt_offset;
+	}
 
 
 
-    /**
-     * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
-     * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
-     * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
-     * offset.
-     * @param  float|string $gmt_offset
-     * @return float|string
-     */
-    protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
-    {
-        // if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
-        // set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
-        // that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
-        if ($gmt_offset === '') {
-            // autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
-            if (get_option('timezone_string')) {
-                return (string) get_option('timezone_string');
-            }
-        }
-        $gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
-        $gmt_offset = (float) $gmt_offset;
-        // if $gmt_offset is 0 or is still an empty string, then just return UTC
-        if ($gmt_offset === (float) 0) {
-            return 'UTC';
-        }
-        return $gmt_offset;
-    }
+	/**
+	 * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
+	 * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
+	 * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
+	 * offset.
+	 * @param  float|string $gmt_offset
+	 * @return float|string
+	 */
+	protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
+	{
+		// if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
+		// set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
+		// that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
+		if ($gmt_offset === '') {
+			// autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
+			if (get_option('timezone_string')) {
+				return (string) get_option('timezone_string');
+			}
+		}
+		$gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
+		$gmt_offset = (float) $gmt_offset;
+		// if $gmt_offset is 0 or is still an empty string, then just return UTC
+		if ($gmt_offset === (float) 0) {
+			return 'UTC';
+		}
+		return $gmt_offset;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -49,7 +49,7 @@ 
             new DateTimeZone($timezone_string);
         } catch (Exception $e) {
             // sometimes we take exception to exceptions
-            if (! $throw_error) {
+            if ( ! $throw_error) {
                 return false;
             }
             throw new EE_Error(
@@ -101,7 +101,7 @@ 
     public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
     {
         $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
+        if ( ! isset($transition['offset'])) {
             throw new DomainException(
                 sprintf(
                     esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
@@ -123,7 +123,7 @@ 
     public function timezoneSelectInput($timezone_string = '')
     {
         // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+        $datetime_format = get_option('date_format').' '.get_option('time_format');
         // if passed a value, then use that, else get WP option
         $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
         // check if the timezone is valid but don't throw any errors if it isn't
@@ -137,9 +137,9 @@ 
             $timezone_string = 'UTC';
             $check_zone_info = false;
             if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
+                $timezone_string = 'UTC+'.$gmt_offset;
             } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
+                $timezone_string = 'UTC'.$gmt_offset;
             }
         }
         ?>
@@ -159,12 +159,12 @@ 
                 esc_html__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
                 '<abbr title="Coordinated Universal Time">',
                 '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
+                '<code>'.date_i18n($datetime_format, false, true).'</code>'
             );
             ?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
-        <br/><span><?php printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>'); ?></span>
+        if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+        <br/><span><?php printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>'.date_i18n($datetime_format).'</code>'); ?></span>
             <?php
         endif; ?>
 
@@ -204,7 +204,7 @@ 
                     // transition time from date_i18n().
                     printf(
                         $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+                        '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >'
                     );
                 } else {
                     esc_html_e('This timezone does not observe daylight saving time.', 'event_espresso');
@@ -237,7 +237,7 @@ 
         $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
         $timezone_string = $this->getValidTimezoneString($timezone_string);
         $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+        $DateTime        = new DateTime('@'.$unix_timestamp, $TimeZone);
         $offset          = timezone_offset_get($TimeZone, $DateTime);
         return (int) $DateTime->format('U') + (int) $offset;
     }

core/services/request/ServerParams.php

Indentation +180 added lines, -180 removed lines

@@ -7,184 +7,184 @@
 class ServerParams
 {
 
-    /**
-     * IP address for request
-     *
-     * @var string
-     */
-    protected $ip_address;
-
-
-    /**
-     * @var ServerSanitizer
-     */
-    protected $sanitizer;
-
-    /**
-     * sanitized $_SERVER parameters
-     *
-     * @var array
-     */
-    protected $server;
-
-    /**
-     * @var string
-     */
-    protected $request_uri;
-
-    /**
-     * @var string
-     */
-    protected $user_agent;
-
-
-    /**
-     * ServerParams constructor.
-     *
-     * @param ServerSanitizer $sanitizer
-     * @param array           $server
-     */
-    public function __construct(ServerSanitizer $sanitizer, array $server = [])
-    {
-        $this->sanitizer  = $sanitizer;
-        $this->server     = $this->cleanServerParams($server);
-        $this->ip_address = $this->setVisitorIp();
-    }
-
-
-    /**
-     * @return array
-     */
-    private function cleanServerParams(array $server)
-    {
-        $cleaned = [];
-        $server  = ! empty($server) ? $server : $_SERVER;
-        foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
-        }
-        return $cleaned;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getAllServerParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null)
-    {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $this->server[ $key ] = $this->sanitizer->clean($key, $value);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return isset($this->server[ $key ]);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function setVisitorIp()
-    {
-        $visitor_ip  = '0.0.0.0';
-        $server_keys = [
-            'HTTP_CLIENT_IP',
-            'HTTP_FORWARDED',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_FORWARDED_FOR',
-            'REMOTE_ADDR',
-        ];
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                $potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
-                foreach ($potential_ip as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     *
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        if ($relativeToWpRoot) {
-            $home_path = untrailingslashit(parse_url(home_url(), PHP_URL_PATH));
-            return str_replace($home_path, '', $this->server['REQUEST_URI']);
-        }
-        return $this->server['REQUEST_URI'];
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        if (empty($this->user_agent)) {
-            $this->setUserAgent();
-        }
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->user_agent = $user_agent === '' || ! is_string($user_agent)
-            ? $this->getServerParam('HTTP_USER_AGENT')
-            : esc_attr($user_agent);
-    }
+	/**
+	 * IP address for request
+	 *
+	 * @var string
+	 */
+	protected $ip_address;
+
+
+	/**
+	 * @var ServerSanitizer
+	 */
+	protected $sanitizer;
+
+	/**
+	 * sanitized $_SERVER parameters
+	 *
+	 * @var array
+	 */
+	protected $server;
+
+	/**
+	 * @var string
+	 */
+	protected $request_uri;
+
+	/**
+	 * @var string
+	 */
+	protected $user_agent;
+
+
+	/**
+	 * ServerParams constructor.
+	 *
+	 * @param ServerSanitizer $sanitizer
+	 * @param array           $server
+	 */
+	public function __construct(ServerSanitizer $sanitizer, array $server = [])
+	{
+		$this->sanitizer  = $sanitizer;
+		$this->server     = $this->cleanServerParams($server);
+		$this->ip_address = $this->setVisitorIp();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	private function cleanServerParams(array $server)
+	{
+		$cleaned = [];
+		$server  = ! empty($server) ? $server : $_SERVER;
+		foreach ($server as $key => $value) {
+			$cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+		}
+		return $cleaned;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getAllServerParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null)
+	{
+		return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$this->server[ $key ] = $this->sanitizer->clean($key, $value);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return isset($this->server[ $key ]);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function setVisitorIp()
+	{
+		$visitor_ip  = '0.0.0.0';
+		$server_keys = [
+			'HTTP_CLIENT_IP',
+			'HTTP_FORWARDED',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_FORWARDED_FOR',
+			'REMOTE_ADDR',
+		];
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				$potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
+				foreach ($potential_ip as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 *
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		if ($relativeToWpRoot) {
+			$home_path = untrailingslashit(parse_url(home_url(), PHP_URL_PATH));
+			return str_replace($home_path, '', $this->server['REQUEST_URI']);
+		}
+		return $this->server['REQUEST_URI'];
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		if (empty($this->user_agent)) {
+			$this->setUserAgent();
+		}
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->user_agent = $user_agent === '' || ! is_string($user_agent)
+			? $this->getServerParam('HTTP_USER_AGENT')
+			: esc_attr($user_agent);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -60,7 +60,7 @@ 
         $cleaned = [];
         $server  = ! empty($server) ? $server : $_SERVER;
         foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+            $cleaned[$key] = $this->sanitizer->clean($key, $value);
         }
         return $cleaned;
     }
@@ -82,7 +82,7 @@ 
      */
     public function getServerParam($key, $default = null)
     {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
+        return $this->serverParamIsSet($key) ? $this->server[$key] : $default;
     }
 
 
@@ -93,7 +93,7 @@ 
      */
     public function setServerParam($key, $value)
     {
-        $this->server[ $key ] = $this->sanitizer->clean($key, $value);
+        $this->server[$key] = $this->sanitizer->clean($key, $value);
     }
 
 
@@ -102,7 +102,7 @@ 
      */
     public function serverParamIsSet($key)
     {
-        return isset($this->server[ $key ]);
+        return isset($this->server[$key]);
     }
 
 
@@ -135,8 +135,8 @@ 
             'REMOTE_ADDR',
         ];
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                $potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
+            if (isset($this->server[$key])) {
+                $potential_ip = array_map('trim', explode(',', $this->server[$key]));
                 foreach ($potential_ip as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;

core/services/progress_steps/ProgressStep.php

Indentation +186 added lines, -186 removed lines

@@ -18,190 +18,190 @@
 {
 
 
-    /**
-     * @var boolean $current
-     */
-    private $current = false;
-
-
-    /**
-     * @var boolean $completed
-     */
-    private $completed = false;
-
-
-    /**
-     * @var string $html_class
-     */
-    private $html_class;
-
-    /**
-     * @var string $id
-     */
-    private $id = '';
-
-    /**
-     * @var int $order
-     */
-    private $order = 0;
-
-    /**
-     * @var string $text
-     */
-    private $text = '';
-
-
-    /**
-     * ProgressStep constructor
-     *
-     * @param int    $order
-     * @param string $id
-     * @param string $html_class
-     * @param string $text
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($order, $id, $html_class, $text)
-    {
-        $this->setOrder($order);
-        $this->setId($id);
-        $this->setHtmlClass($html_class);
-        $this->setText($text);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isCurrent()
-    {
-        return $this->current;
-    }
-
-
-    /**
-     * @param boolean $current
-     */
-    public function setIsCurrent($current = true)
-    {
-        $this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function isCompleted()
-    {
-        return $this->completed;
-    }
-
-
-    /**
-     * @param boolean $completed
-     */
-    public function setIsCompleted($completed = true)
-    {
-        $this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function id()
-    {
-        return $this->id;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $id
-     * @throws InvalidDataTypeException
-     */
-    protected function setId($id = '')
-    {
-        if (! is_string($id)) {
-            throw new InvalidDataTypeException('$id', $id, 'string');
-        }
-        $this->id = $id;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->order;
-    }
-
-
-    /**
-     * @access protected
-     * @param int $order
-     * @throws InvalidDataTypeException
-     */
-    protected function setOrder($order = 0)
-    {
-        if (! is_int($order)) {
-            throw new InvalidDataTypeException('$order', $order, 'integer');
-        }
-        $this->order = absint($order);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function htmlClass()
-    {
-        $html_class = $this->html_class;
-        if ($this->isCurrent()) {
-            $html_class .= ' progress-step-active';
-        } elseif ($this->isCompleted()) {
-            $html_class .= ' progress-step-completed';
-        }
-        return $html_class;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $html_class
-     * @throws InvalidDataTypeException
-     */
-    protected function setHtmlClass($html_class)
-    {
-        if (! is_string($html_class)) {
-            throw new InvalidDataTypeException('$html_class', $html_class, 'string');
-        }
-        if (strpos($html_class, 'progress-step-') === false) {
-            $html_class = 'progress-step-' . $html_class;
-        }
-        $this->html_class = $html_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function text()
-    {
-        return $this->text;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $text
-     * @throws InvalidDataTypeException
-     */
-    protected function setText($text)
-    {
-        if (! is_string($text)) {
-            throw new InvalidDataTypeException('$text', $text, 'string');
-        }
-        $this->text = sanitize_text_field($text);
-    }
+	/**
+	 * @var boolean $current
+	 */
+	private $current = false;
+
+
+	/**
+	 * @var boolean $completed
+	 */
+	private $completed = false;
+
+
+	/**
+	 * @var string $html_class
+	 */
+	private $html_class;
+
+	/**
+	 * @var string $id
+	 */
+	private $id = '';
+
+	/**
+	 * @var int $order
+	 */
+	private $order = 0;
+
+	/**
+	 * @var string $text
+	 */
+	private $text = '';
+
+
+	/**
+	 * ProgressStep constructor
+	 *
+	 * @param int    $order
+	 * @param string $id
+	 * @param string $html_class
+	 * @param string $text
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($order, $id, $html_class, $text)
+	{
+		$this->setOrder($order);
+		$this->setId($id);
+		$this->setHtmlClass($html_class);
+		$this->setText($text);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isCurrent()
+	{
+		return $this->current;
+	}
+
+
+	/**
+	 * @param boolean $current
+	 */
+	public function setIsCurrent($current = true)
+	{
+		$this->current = filter_var($current, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function isCompleted()
+	{
+		return $this->completed;
+	}
+
+
+	/**
+	 * @param boolean $completed
+	 */
+	public function setIsCompleted($completed = true)
+	{
+		$this->completed = filter_var($completed, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function id()
+	{
+		return $this->id;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $id
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setId($id = '')
+	{
+		if (! is_string($id)) {
+			throw new InvalidDataTypeException('$id', $id, 'string');
+		}
+		$this->id = $id;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->order;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param int $order
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setOrder($order = 0)
+	{
+		if (! is_int($order)) {
+			throw new InvalidDataTypeException('$order', $order, 'integer');
+		}
+		$this->order = absint($order);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function htmlClass()
+	{
+		$html_class = $this->html_class;
+		if ($this->isCurrent()) {
+			$html_class .= ' progress-step-active';
+		} elseif ($this->isCompleted()) {
+			$html_class .= ' progress-step-completed';
+		}
+		return $html_class;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $html_class
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setHtmlClass($html_class)
+	{
+		if (! is_string($html_class)) {
+			throw new InvalidDataTypeException('$html_class', $html_class, 'string');
+		}
+		if (strpos($html_class, 'progress-step-') === false) {
+			$html_class = 'progress-step-' . $html_class;
+		}
+		$this->html_class = $html_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function text()
+	{
+		return $this->text;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $text
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setText($text)
+	{
+		if (! is_string($text)) {
+			throw new InvalidDataTypeException('$text', $text, 'string');
+		}
+		$this->text = sanitize_text_field($text);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -121,7 +121,7 @@ 
      */
     protected function setId($id = '')
     {
-        if (! is_string($id)) {
+        if ( ! is_string($id)) {
             throw new InvalidDataTypeException('$id', $id, 'string');
         }
         $this->id = $id;
@@ -144,7 +144,7 @@ 
      */
     protected function setOrder($order = 0)
     {
-        if (! is_int($order)) {
+        if ( ! is_int($order)) {
             throw new InvalidDataTypeException('$order', $order, 'integer');
         }
         $this->order = absint($order);
@@ -173,11 +173,11 @@ 
      */
     protected function setHtmlClass($html_class)
     {
-        if (! is_string($html_class)) {
+        if ( ! is_string($html_class)) {
             throw new InvalidDataTypeException('$html_class', $html_class, 'string');
         }
         if (strpos($html_class, 'progress-step-') === false) {
-            $html_class = 'progress-step-' . $html_class;
+            $html_class = 'progress-step-'.$html_class;
         }
         $this->html_class = $html_class;
     }
@@ -199,7 +199,7 @@ 
      */
     protected function setText($text)
     {
-        if (! is_string($text)) {
+        if ( ! is_string($text)) {
             throw new InvalidDataTypeException('$text', $text, 'string');
         }
         $this->text = sanitize_text_field($text);