eventespresso / event-espresso-core

core/helpers/EEH_Inflector.helper.php

Indentation +380 added lines, -380 removed lines

@@ -33,384 +33,384 @@
  */
 class EEH_Inflector
 {
-    // ------ CLASS METHODS ------ //
-    // ---- Public methods ---- //
-    // {{{ pluralize()
-
-    /**
-     * Just calls self::pluralize and strtolower on $word and returns it
-     * @param string $word
-     * @return string
-     */
-    public static function pluralize_and_lower($word)
-    {
-        return strtolower(self::pluralize($word));
-    }
-
-
-
-    /**
-     * @param string $word
-     * @return mixed
-     */
-    public static function singularize_and_upper($word)
-    {
-        return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
-    }
-
-
-
-    /**
-     * Pluralizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to pluralize
-     * @return string Plural noun
-     */
-    public static function pluralize($word)
-    {
-        $plural = array(
-            '/(quiz)$/i'               => '\1zes',
-            '/^(ox)$/i'                => '\1en',
-            '/([m|l])ouse$/i'          => '\1ice',
-            '/(matr|vert|ind)ix|ex$/i' => '\1ices',
-            '/(x|ch|ss|sh)$/i'         => '\1es',
-            '/([^aeiouy]|qu)ies$/i'    => '\1y',
-            '/([^aeiouy]|qu)y$/i'      => '\1ies',
-            '/(hive)$/i'               => '\1s',
-            '/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
-            '/sis$/i'                  => 'ses',
-            '/([ti])um$/i'             => '\1a',
-            '/(buffal|tomat)o$/i'      => '\1oes',
-            '/(bu)s$/i'                => '\1ses',
-            '/(alias|status)/i'        => '\1es',
-            '/(octop|vir)us$/i'        => '\1i',
-            '/(ax|test)is$/i'          => '\1es',
-            '/s$/i'                    => 's',
-            '/$/'                      => 's');
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-
-        foreach ($uncountable as $_uncountable) {
-            if (
-                substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-                    ! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ])
-            ) {
-                return $word;
-            }
-        }
-
-        foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
-            }
-        }
-
-        foreach ($plural as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-        return false;
-    }
-
-    // }}}
-    // {{{ singularize()
-
-    /**
-     * Singularizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to singularize
-     * @return string Singular noun.
-     */
-    public static function singularize($word)
-    {
-        $singular = array(
-            '/(quiz)zes$/i'                                                    => '\1',
-            '/(matr)ices$/i'                                                   => '\1ix',
-            '/(vert|ind)ices$/i'                                               => '\1ex',
-            '/^(ox)en/i'                                                       => '\1',
-            '/(alias|status)es$/i'                                             => '\1',
-            '/([octop|vir])i$/i'                                               => '\1us',
-            '/(cris|ax|test)es$/i'                                             => '\1is',
-            '/(shoe)s$/i'                                                      => '\1',
-            '/(o)es$/i'                                                        => '\1',
-            '/(bus)es$/i'                                                      => '\1',
-            '/([m|l])ice$/i'                                                   => '\1ouse',
-            '/(x|ch|ss|sh)es$/i'                                               => '\1',
-            '/(m)ovies$/i'                                                     => '\1ovie',
-            '/(s)eries$/i'                                                     => '\1eries',
-            '/([^aeiouy]|qu)ies$/i'                                            => '\1y',
-            '/([lr])ves$/i'                                                    => '\1f',
-            '/(tive)s$/i'                                                      => '\1',
-            '/(hive)s$/i'                                                      => '\1',
-            '/([^f])ves$/i'                                                    => '\1fe',
-            '/(^analy)ses$/i'                                                  => '\1sis',
-            '/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
-            '/([ti])a$/i'                                                      => '\1um',
-            '/(n)ews$/i'                                                       => '\1ews',
-            '/s$/i'                                                            => '',
-        );
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-        foreach ($uncountable as $_uncountable) {
-            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
-                return $word;
-            }
-        }
-
-        foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
-            }
-        }
-
-        foreach ($singular as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-
-        return $word;
-    }
-
-    // }}}
-    // {{{ titleize()
-
-    /**
-     * Converts an underscored or CamelCase word into a English
-     * sentence.
-     *
-     * The titleize static function converts text like "WelcomePage",
-     * "welcome_page" or  "welcome page" to this "Welcome
-     * Page".
-     * If second parameter is set to 'first' it will only
-     * capitalize the first character of the title.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to format as tile
-     * @param    string    $uppercase    If set to 'first' it will only uppercase the
-     * first character. Otherwise it will uppercase all
-     * the words in the title.
-     * @return string Text formatted as title
-     */
-    public static function titleize($word, $uppercase = '')
-    {
-        $uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
-        return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
-    }
-
-    // }}}
-    // {{{ camelize()
-
-    /**
-     * Returns given word as CamelCased
-     *
-     * Converts a word like "send_email" to "SendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "WhoSOnline"
-     *
-     * @access public
-     * @static
-     * @see variablize
-     * @param    string    $word    Word to convert to camel case
-     * @return string UpperCamelCasedWord
-     */
-    public static function camelize($word)
-    {
-        return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
-    }
-
-
-
-    /**
-     * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
-     * with the new PSR-based naming conventions
-     * @param $word
-     * @return string
-     */
-    public static function camelize_all_but_first($word)
-    {
-        return lcfirst(EEH_Inflector::camelize($word));
-    }
-    // }}}
-    // {{{ underscore()
-
-    /**
-     * Converts a word "into_it_s_underscored_version"
-     *
-     * Convert any "CamelCased" or "ordinary Word" into an
-     * "underscored_word".
-     *
-     * This can be really useful for creating friendly URLs.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to underscore
-     * @return string Underscored word
-     */
-    public static function underscore($word)
-    {
-        return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
-    }
-
-    // }}}
-    // {{{ humanize()
-
-    /**
-     * Returns a human-readable string from $word
-     *
-     * Returns a human-readable string from $word, by replacing
-     * underscores with a space, and by upper-casing the initial
-     * character by default.
-     *
-     * If you need to uppercase all the words you just have to
-     * pass 'all' as a second parameter.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    String to "humanize"
-     * @param    string    $uppercase    If set to 'all' it will uppercase all the words
-     * instead of just the first one.
-     * @return string Human-readable word
-     */
-    public static function humanize($word, $uppercase = '')
-    {
-        // make special exceptions for acronyms
-        $word = str_replace('wp_', 'WP_', $word);
-        $uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
-        return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
-    }
-
-    // }}}
-    // {{{ variablize()
-
-    /**
-     * Same as camelize but first char is underscored
-     *
-     * Converts a word like "send_email" to "sendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "whoSOnline"
-     *
-     * @access public
-     * @static
-     * @see camelize
-     * @param    string    $word    Word to lowerCamelCase
-     * @return string Returns a lowerCamelCasedWord
-     */
-    public static function variablize($word)
-    {
-        $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
-    }
-
-    // }}}
-    // {{{ tableize()
-
-    /**
-     * Converts a class name to its table name according to rails
-     * naming conventions.
-     *
-     * Converts "Person" to "people"
-     *
-     * @access public
-     * @static
-     * @see classify
-     * @param    string    $class_name    Class name for getting related table_name.
-     * @return string plural_table_name
-     */
-    public static function tableize($class_name)
-    {
-        return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
-    }
-
-    // }}}
-    // {{{ classify()
-
-    /**
-     * Converts a table name to its class name according to rails
-     * naming conventions.
-     *
-     * Converts "people" to "Person"
-     *
-     * @access public
-     * @static
-     * @see tableize
-     * @param    string    $table_name    Table name for getting related ClassName.
-     * @return string SingularClassName
-     */
-    public static function classify($table_name)
-    {
-        return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
-    }
-
-    // }}}
-    // {{{ ordinalize()
-
-    /**
-     * Converts number to its ordinal English form.
-     *
-     * This method converts 13 to 13th, 2 to 2nd ...
-     *
-     * @access public
-     * @static
-     * @param    integer    $number    Number to get its ordinal value
-     * @return string Ordinal representation of given string.
-     */
-    public static function ordinalize($number)
-    {
-        if (in_array(($number % 100), range(11, 13))) {
-            return $number . 'th';
-        } else {
-            switch (($number % 10)) {
-                case 1:
-                    return $number . 'st';
-                    break;
-                case 2:
-                    return $number . 'nd';
-                    break;
-                case 3:
-                    return $number . 'rd';
-                default:
-                    return $number . 'th';
-                    break;
-            }
-        }
-    }
-
-
-
-    /**
-     * @param $string
-     * @return string
-     */
-    public static function add_indefinite_article($string)
-    {
-        if (strtolower($string) === 'null') {
-            return $string;
-        }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
-    }
+	// ------ CLASS METHODS ------ //
+	// ---- Public methods ---- //
+	// {{{ pluralize()
+
+	/**
+	 * Just calls self::pluralize and strtolower on $word and returns it
+	 * @param string $word
+	 * @return string
+	 */
+	public static function pluralize_and_lower($word)
+	{
+		return strtolower(self::pluralize($word));
+	}
+
+
+
+	/**
+	 * @param string $word
+	 * @return mixed
+	 */
+	public static function singularize_and_upper($word)
+	{
+		return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
+	}
+
+
+
+	/**
+	 * Pluralizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to pluralize
+	 * @return string Plural noun
+	 */
+	public static function pluralize($word)
+	{
+		$plural = array(
+			'/(quiz)$/i'               => '\1zes',
+			'/^(ox)$/i'                => '\1en',
+			'/([m|l])ouse$/i'          => '\1ice',
+			'/(matr|vert|ind)ix|ex$/i' => '\1ices',
+			'/(x|ch|ss|sh)$/i'         => '\1es',
+			'/([^aeiouy]|qu)ies$/i'    => '\1y',
+			'/([^aeiouy]|qu)y$/i'      => '\1ies',
+			'/(hive)$/i'               => '\1s',
+			'/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
+			'/sis$/i'                  => 'ses',
+			'/([ti])um$/i'             => '\1a',
+			'/(buffal|tomat)o$/i'      => '\1oes',
+			'/(bu)s$/i'                => '\1ses',
+			'/(alias|status)/i'        => '\1es',
+			'/(octop|vir)us$/i'        => '\1i',
+			'/(ax|test)is$/i'          => '\1es',
+			'/s$/i'                    => 's',
+			'/$/'                      => 's');
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+
+		foreach ($uncountable as $_uncountable) {
+			if (
+				substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
+					! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ])
+			) {
+				return $word;
+			}
+		}
+
+		foreach ($irregular as $_plural => $_singular) {
+			if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
+				return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+			}
+		}
+
+		foreach ($plural as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+		return false;
+	}
+
+	// }}}
+	// {{{ singularize()
+
+	/**
+	 * Singularizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to singularize
+	 * @return string Singular noun.
+	 */
+	public static function singularize($word)
+	{
+		$singular = array(
+			'/(quiz)zes$/i'                                                    => '\1',
+			'/(matr)ices$/i'                                                   => '\1ix',
+			'/(vert|ind)ices$/i'                                               => '\1ex',
+			'/^(ox)en/i'                                                       => '\1',
+			'/(alias|status)es$/i'                                             => '\1',
+			'/([octop|vir])i$/i'                                               => '\1us',
+			'/(cris|ax|test)es$/i'                                             => '\1is',
+			'/(shoe)s$/i'                                                      => '\1',
+			'/(o)es$/i'                                                        => '\1',
+			'/(bus)es$/i'                                                      => '\1',
+			'/([m|l])ice$/i'                                                   => '\1ouse',
+			'/(x|ch|ss|sh)es$/i'                                               => '\1',
+			'/(m)ovies$/i'                                                     => '\1ovie',
+			'/(s)eries$/i'                                                     => '\1eries',
+			'/([^aeiouy]|qu)ies$/i'                                            => '\1y',
+			'/([lr])ves$/i'                                                    => '\1f',
+			'/(tive)s$/i'                                                      => '\1',
+			'/(hive)s$/i'                                                      => '\1',
+			'/([^f])ves$/i'                                                    => '\1fe',
+			'/(^analy)ses$/i'                                                  => '\1sis',
+			'/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
+			'/([ti])a$/i'                                                      => '\1um',
+			'/(n)ews$/i'                                                       => '\1ews',
+			'/s$/i'                                                            => '',
+		);
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
+				return $word;
+			}
+		}
+
+		foreach ($irregular as $_plural => $_singular) {
+			if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
+				return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+			}
+		}
+
+		foreach ($singular as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+
+		return $word;
+	}
+
+	// }}}
+	// {{{ titleize()
+
+	/**
+	 * Converts an underscored or CamelCase word into a English
+	 * sentence.
+	 *
+	 * The titleize static function converts text like "WelcomePage",
+	 * "welcome_page" or  "welcome page" to this "Welcome
+	 * Page".
+	 * If second parameter is set to 'first' it will only
+	 * capitalize the first character of the title.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to format as tile
+	 * @param    string    $uppercase    If set to 'first' it will only uppercase the
+	 * first character. Otherwise it will uppercase all
+	 * the words in the title.
+	 * @return string Text formatted as title
+	 */
+	public static function titleize($word, $uppercase = '')
+	{
+		$uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
+		return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
+	}
+
+	// }}}
+	// {{{ camelize()
+
+	/**
+	 * Returns given word as CamelCased
+	 *
+	 * Converts a word like "send_email" to "SendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "WhoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see variablize
+	 * @param    string    $word    Word to convert to camel case
+	 * @return string UpperCamelCasedWord
+	 */
+	public static function camelize($word)
+	{
+		return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
+	}
+
+
+
+	/**
+	 * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
+	 * with the new PSR-based naming conventions
+	 * @param $word
+	 * @return string
+	 */
+	public static function camelize_all_but_first($word)
+	{
+		return lcfirst(EEH_Inflector::camelize($word));
+	}
+	// }}}
+	// {{{ underscore()
+
+	/**
+	 * Converts a word "into_it_s_underscored_version"
+	 *
+	 * Convert any "CamelCased" or "ordinary Word" into an
+	 * "underscored_word".
+	 *
+	 * This can be really useful for creating friendly URLs.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to underscore
+	 * @return string Underscored word
+	 */
+	public static function underscore($word)
+	{
+		return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
+	}
+
+	// }}}
+	// {{{ humanize()
+
+	/**
+	 * Returns a human-readable string from $word
+	 *
+	 * Returns a human-readable string from $word, by replacing
+	 * underscores with a space, and by upper-casing the initial
+	 * character by default.
+	 *
+	 * If you need to uppercase all the words you just have to
+	 * pass 'all' as a second parameter.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    String to "humanize"
+	 * @param    string    $uppercase    If set to 'all' it will uppercase all the words
+	 * instead of just the first one.
+	 * @return string Human-readable word
+	 */
+	public static function humanize($word, $uppercase = '')
+	{
+		// make special exceptions for acronyms
+		$word = str_replace('wp_', 'WP_', $word);
+		$uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
+		return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
+	}
+
+	// }}}
+	// {{{ variablize()
+
+	/**
+	 * Same as camelize but first char is underscored
+	 *
+	 * Converts a word like "send_email" to "sendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "whoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see camelize
+	 * @param    string    $word    Word to lowerCamelCase
+	 * @return string Returns a lowerCamelCasedWord
+	 */
+	public static function variablize($word)
+	{
+		$word = EEH_Inflector::camelize($word);
+		return strtolower($word[0]) . substr($word, 1);
+	}
+
+	// }}}
+	// {{{ tableize()
+
+	/**
+	 * Converts a class name to its table name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "Person" to "people"
+	 *
+	 * @access public
+	 * @static
+	 * @see classify
+	 * @param    string    $class_name    Class name for getting related table_name.
+	 * @return string plural_table_name
+	 */
+	public static function tableize($class_name)
+	{
+		return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
+	}
+
+	// }}}
+	// {{{ classify()
+
+	/**
+	 * Converts a table name to its class name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "people" to "Person"
+	 *
+	 * @access public
+	 * @static
+	 * @see tableize
+	 * @param    string    $table_name    Table name for getting related ClassName.
+	 * @return string SingularClassName
+	 */
+	public static function classify($table_name)
+	{
+		return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
+	}
+
+	// }}}
+	// {{{ ordinalize()
+
+	/**
+	 * Converts number to its ordinal English form.
+	 *
+	 * This method converts 13 to 13th, 2 to 2nd ...
+	 *
+	 * @access public
+	 * @static
+	 * @param    integer    $number    Number to get its ordinal value
+	 * @return string Ordinal representation of given string.
+	 */
+	public static function ordinalize($number)
+	{
+		if (in_array(($number % 100), range(11, 13))) {
+			return $number . 'th';
+		} else {
+			switch (($number % 10)) {
+				case 1:
+					return $number . 'st';
+					break;
+				case 2:
+					return $number . 'nd';
+					break;
+				case 3:
+					return $number . 'rd';
+				default:
+					return $number . 'th';
+					break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * @param $string
+	 * @return string
+	 */
+	public static function add_indefinite_article($string)
+	{
+		if (strtolower($string) === 'null') {
+			return $string;
+		}
+		return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -104,15 +104,15 @@ 
         foreach ($uncountable as $_uncountable) {
             if (
                 substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && // even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-                    ! ctype_alpha($lowercased_word[ strlen($lowercased_word) - strlen($_uncountable) ])
+                    ! ctype_alpha($lowercased_word[strlen($lowercased_word) - strlen($_uncountable)])
             ) {
                 return $word;
             }
         }
 
         foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_plural . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+            if (preg_match('/('.$_plural.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_plural.')$/i', substr($arr[0], 0, 1).substr($_singular, 1), $word);
             }
         }
 
@@ -181,8 +181,8 @@ 
         }
 
         foreach ($irregular as $_plural => $_singular) {
-            if (preg_match('/(' . $_singular . ')$/i', $word, $arr)) {
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+            if (preg_match('/('.$_singular.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_singular.')$/i', substr($arr[0], 0, 1).substr($_plural, 1), $word);
             }
         }
 
@@ -323,7 +323,7 @@ 
     public static function variablize($word)
     {
         $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
+        return strtolower($word[0]).substr($word, 1);
     }
 
     // }}}
@@ -382,19 +382,19 @@ 
     public static function ordinalize($number)
     {
         if (in_array(($number % 100), range(11, 13))) {
-            return $number . 'th';
+            return $number.'th';
         } else {
             switch (($number % 10)) {
                 case 1:
-                    return $number . 'st';
+                    return $number.'st';
                     break;
                 case 2:
-                    return $number . 'nd';
+                    return $number.'nd';
                     break;
                 case 3:
-                    return $number . 'rd';
+                    return $number.'rd';
                 default:
-                    return $number . 'th';
+                    return $number.'th';
                     break;
             }
         }
@@ -411,6 +411,6 @@ 
         if (strtolower($string) === 'null') {
             return $string;
         }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ').$string;
     }
 }

core/helpers/EEH_Parse_Shortcodes.helper.php

Spacing +4 added lines, -4 removed lines

@@ -208,14 +208,14 @@ 
                 if ($sc_obj instanceof EE_Shortcodes) {
                     // we need to setup any dynamic shortcodes so that they work with the array_key_exists
                     preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
-                    if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
+                    if ( ! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
                         continue; // the given shortcode isn't in this object
                     }
 
                     // if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                    if (! in_array($sc_to_verify, $list_type_shortcodes)) {
+                    if ( ! in_array($sc_to_verify, $list_type_shortcodes)) {
                         $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
                     } else {
                         $data_send = $this->_data;
@@ -271,7 +271,7 @@ 
         foreach ($valid_shortcodes as $shortcode_ref) {
             $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $this->_shortcode_objs[] = new $classname();
             }

Indentation +264 added lines, -264 removed lines

@@ -11,268 +11,268 @@
  */
 class EEH_Parse_Shortcodes
 {
-    /**
-     * holds the template
-     *
-     * @access private
-     * @var mixed (string|array)
-     */
-    private $_template;
-
-
-    /**
-     * holds the incoming data object
-     *
-     * @access private
-     * @var object
-     */
-    private $_data;
-
-
-    /**
-     * will hold an array of EE_Shortcodes library objects.
-     *
-     * @access private
-     * @var EE_Shortcodes[]
-     */
-    private $_shortcode_objs = array();
-
-
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * This kicks off the parsing of shortcodes in message templates
-     *
-     * @param  string                $template         This is the incoming string to be parsed
-     * @param  EE_Messages_Addressee $data             This is the incoming data object
-     * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
-     * @param EE_message_type        $message_type     The message type that called the parser
-     * @param EE_messenger           $messenger        The active messenger for this parsing session.
-     * @param EE_Message             $message
-     * @return string                   The parsed template string
-     */
-    public function parse_message_template(
-        $template,
-        EE_Messages_Addressee $data,
-        $valid_shortcodes,
-        EE_message_type $message_type,
-        EE_messenger $messenger,
-        EE_Message $message
-    ) {
-        $extra_data = array(
-            'messenger'    => $messenger,
-            'message_type' => $message_type,
-            'message'      => $message,
-        );
-        $this->_init_data($template, $data, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['main'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_attendee_list_template(
-        $template,
-        EE_Registration $registration,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['attendee_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-    public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $event, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['event_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_line_item_list_template(
-        $template,
-        EE_Line_Item $line_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_payment_list_template(
-        $template,
-        EE_Payment $payment_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['payment_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_datetime_list_template(
-        $template,
-        EE_Datetime $datetime,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['datetime_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['question_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_reset_props();
-        $this->_data['template']   = $template;
-        $this->_data['data']       = $data;
-        $this->_data['extra_data'] = $extra_data;
-        $this->_set_shortcodes($valid_shortcodes);
-    }
-
-
-    private function _reset_props()
-    {
-        $this->_template       = $this->_data = null;
-        $this->_shortcode_objs = array();
-    }
-
-
-    /**
-     * takes the given template and parses it with the $_shortcodes property
-     *
-     * @access private
-     * @return string
-     */
-    private function _parse_message_template()
-    {
-        // now let's get a list of shortcodes that are found in the given template
-        preg_match_all('/(\[.+?\])/', $this->_template, $matches);
-        $shortcodes = (array) $matches[0]; // this should be an array of shortcodes in the template string.
-
-        $matched_code = array();
-        $sc_values    = array();
-
-        $list_type_shortcodes = array(
-            '[ATTENDEE_LIST]',
-            '[EVENT_LIST]',
-            '[TICKET_LIST]',
-            '[DATETIME_LIST]',
-            '[QUESTION_LIST]',
-            '[RECIPIENT_QUESTION_LIST]',
-            '[PRIMARY_REGISTRANT_QUESTION_LIST]',
-            '[RECIPIENT_TICKET_LIST]',
-            '[PRIMARY_REGISTRANT_TICKET_LIST]',
-            '[RECIPIENT_DATETIME_LIST]',
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]',
-            '[TICKET_LINE_ITEM_LIST]',
-            '[TAX_LINE_ITEM_LIST]',
-            '[ADDITIONAL_LINE_ITEM_LIST]',
-            '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-            '[PAYMENT_LIST_*]',
-        );
-
-        $list_type_shortcodes = apply_filters(
-            'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-            $list_type_shortcodes
-        );
-
-        // now lets go ahead and loop through our parsers for each shortcode and setup the values
-        foreach ($shortcodes as $shortcode) {
-            foreach ($this->_shortcode_objs as $sc_obj) {
-                if ($sc_obj instanceof EE_Shortcodes) {
-                    // we need to setup any dynamic shortcodes so that they work with the array_key_exists
-                    preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-                    if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
-                        continue; // the given shortcode isn't in this object
-                    }
-
-                    // if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                    if (! in_array($sc_to_verify, $list_type_shortcodes)) {
-                        $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
-                    } else {
-                        $data_send = $this->_data;
-                    }
-
-                    // is this a conditional type shortcode?  If it is then we actually parse the template here.
-                    if ($this->_is_conditional_shortcode($shortcode)) {
-                        // most shortcode parsers are not going to have a match for this shortcode and will return an
-                        // empty string so we need to make sure that we're only replacing the template when there is a non empty string.
-                        $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-                        if ($parsed) {
-                            $this->_template = $parsed;
-                        }
-                    }
-
-                    $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-
-                    $matched_code[] = $shortcode;
-                    $sc_values[]    = $parsed;
-                }
-            }
-        }
-
-        // now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
-        $parsed = str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
-        return $parsed;
-    }
-
-
-    /**
-     * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
-     *
-     * Does it match this format: `[IF_`
-     *
-     * @param $shortcode
-     */
-    protected function _is_conditional_shortcode($shortcode)
-    {
-        return strpos($shortcode, '[IF_') === 0;
-    }
-
-
-    /**
-     * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
-     * various EE_Shortcode library objects
-     *
-     * @access private
-     * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
-     * @return void
-     */
-    private function _set_shortcodes($valid_shortcodes)
-    {
-        foreach ($valid_shortcodes as $shortcode_ref) {
-            $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $this->_shortcode_objs[] = new $classname();
-            }
-        }
-    }
+	/**
+	 * holds the template
+	 *
+	 * @access private
+	 * @var mixed (string|array)
+	 */
+	private $_template;
+
+
+	/**
+	 * holds the incoming data object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_data;
+
+
+	/**
+	 * will hold an array of EE_Shortcodes library objects.
+	 *
+	 * @access private
+	 * @var EE_Shortcodes[]
+	 */
+	private $_shortcode_objs = array();
+
+
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * This kicks off the parsing of shortcodes in message templates
+	 *
+	 * @param  string                $template         This is the incoming string to be parsed
+	 * @param  EE_Messages_Addressee $data             This is the incoming data object
+	 * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
+	 * @param EE_message_type        $message_type     The message type that called the parser
+	 * @param EE_messenger           $messenger        The active messenger for this parsing session.
+	 * @param EE_Message             $message
+	 * @return string                   The parsed template string
+	 */
+	public function parse_message_template(
+		$template,
+		EE_Messages_Addressee $data,
+		$valid_shortcodes,
+		EE_message_type $message_type,
+		EE_messenger $messenger,
+		EE_Message $message
+	) {
+		$extra_data = array(
+			'messenger'    => $messenger,
+			'message_type' => $message_type,
+			'message'      => $message,
+		);
+		$this->_init_data($template, $data, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['main'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_attendee_list_template(
+		$template,
+		EE_Registration $registration,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['attendee_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+	public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $event, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['event_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_line_item_list_template(
+		$template,
+		EE_Line_Item $line_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_payment_list_template(
+		$template,
+		EE_Payment $payment_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['payment_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_datetime_list_template(
+		$template,
+		EE_Datetime $datetime,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['datetime_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['question_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_reset_props();
+		$this->_data['template']   = $template;
+		$this->_data['data']       = $data;
+		$this->_data['extra_data'] = $extra_data;
+		$this->_set_shortcodes($valid_shortcodes);
+	}
+
+
+	private function _reset_props()
+	{
+		$this->_template       = $this->_data = null;
+		$this->_shortcode_objs = array();
+	}
+
+
+	/**
+	 * takes the given template and parses it with the $_shortcodes property
+	 *
+	 * @access private
+	 * @return string
+	 */
+	private function _parse_message_template()
+	{
+		// now let's get a list of shortcodes that are found in the given template
+		preg_match_all('/(\[.+?\])/', $this->_template, $matches);
+		$shortcodes = (array) $matches[0]; // this should be an array of shortcodes in the template string.
+
+		$matched_code = array();
+		$sc_values    = array();
+
+		$list_type_shortcodes = array(
+			'[ATTENDEE_LIST]',
+			'[EVENT_LIST]',
+			'[TICKET_LIST]',
+			'[DATETIME_LIST]',
+			'[QUESTION_LIST]',
+			'[RECIPIENT_QUESTION_LIST]',
+			'[PRIMARY_REGISTRANT_QUESTION_LIST]',
+			'[RECIPIENT_TICKET_LIST]',
+			'[PRIMARY_REGISTRANT_TICKET_LIST]',
+			'[RECIPIENT_DATETIME_LIST]',
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]',
+			'[TICKET_LINE_ITEM_LIST]',
+			'[TAX_LINE_ITEM_LIST]',
+			'[ADDITIONAL_LINE_ITEM_LIST]',
+			'[PRICE_MODIFIER_LINE_ITEM_LIST]',
+			'[PAYMENT_LIST_*]',
+		);
+
+		$list_type_shortcodes = apply_filters(
+			'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+			$list_type_shortcodes
+		);
+
+		// now lets go ahead and loop through our parsers for each shortcode and setup the values
+		foreach ($shortcodes as $shortcode) {
+			foreach ($this->_shortcode_objs as $sc_obj) {
+				if ($sc_obj instanceof EE_Shortcodes) {
+					// we need to setup any dynamic shortcodes so that they work with the array_key_exists
+					preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
+					$sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+					if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
+						continue; // the given shortcode isn't in this object
+					}
+
+					// if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
+					if (! in_array($sc_to_verify, $list_type_shortcodes)) {
+						$data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
+					} else {
+						$data_send = $this->_data;
+					}
+
+					// is this a conditional type shortcode?  If it is then we actually parse the template here.
+					if ($this->_is_conditional_shortcode($shortcode)) {
+						// most shortcode parsers are not going to have a match for this shortcode and will return an
+						// empty string so we need to make sure that we're only replacing the template when there is a non empty string.
+						$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+						if ($parsed) {
+							$this->_template = $parsed;
+						}
+					}
+
+					$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+
+					$matched_code[] = $shortcode;
+					$sc_values[]    = $parsed;
+				}
+			}
+		}
+
+		// now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
+		$parsed = str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
+		return $parsed;
+	}
+
+
+	/**
+	 * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
+	 *
+	 * Does it match this format: `[IF_`
+	 *
+	 * @param $shortcode
+	 */
+	protected function _is_conditional_shortcode($shortcode)
+	{
+		return strpos($shortcode, '[IF_') === 0;
+	}
+
+
+	/**
+	 * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
+	 * various EE_Shortcode library objects
+	 *
+	 * @access private
+	 * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
+	 * @return void
+	 */
+	private function _set_shortcodes($valid_shortcodes)
+	{
+		foreach ($valid_shortcodes as $shortcode_ref) {
+			$ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$this->_shortcode_objs[] = new $classname();
+			}
+		}
+	}
 }

core/helpers/EEH_Export.helper.php

Spacing +4 added lines, -4 removed lines

@@ -74,13 +74,13 @@ 
             ) {
                 // its associative, so we want to output its keys as column headers
                 $keys = array_keys($item_in_top_level_array);
-                $new_file_contents .=  EEH_Export::get_csv_row($keys);
+                $new_file_contents .= EEH_Export::get_csv_row($keys);
             }
             // start writing data
             foreach ($data as $data_row) {
                 $new_file_contents .= EEH_Export::get_csv_row($data_row);
             }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath).$new_file_contents);
         } else {
             // no data TO write... so we can assume that's a success
             return true;
@@ -118,10 +118,10 @@ 
             }
 
             $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+                ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure) : $field_value;
         }
 
-        return  implode($delimiter, $output) . PHP_EOL;
+        return  implode($delimiter, $output).PHP_EOL;
     }
 
 

Indentation +161 added lines, -161 removed lines

@@ -13,165 +13,165 @@
  */
 class EEH_Export
 {
-    /**
-     * Gets the 'normal' column named for fields
-     * @param EE_Model_Field_Base $field
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_column_name_for_field(EE_Model_Field_Base $field)
-    {
-        $column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
-        if (
-            apply_filters(
-                'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-                false,
-                $column_name,
-                $field
-            )
-        ) {
-            $column_name .= "["
-                . wp_specialchars_decode($field->get_name(), ENT_QUOTES)
-                . "]";
-        }
-        return $column_name;
-    }
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param string    $filepath
-     * @param array     $data 2D array,         first numerically-indexed,
-     *                                          and next-level-down preferably indexed by string
-     * @param boolean   $write_column_headers   whether or not we should add the keys in the bottom-most array
-     *                                          as a row for headers in the CSV.
-     *                                            Eg, if $data looked like:
-     *                                            array(
-     *                                                  0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
-     *                                                  1=>array(...,...)
-     *                                            )
-     *
-     * @return boolean      if we successfully wrote to the CSV or not. If there's no $data,
-     *                      we consider that a success (because we wrote everything there was...nothing)
-     * @throws EE_Error
-     */
-    public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true)
-    {
-
-        $new_file_contents = '';
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(sprintf(esc_html__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
-            }
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if (
-                $write_column_headers &&
-                    EEH_Array::is_associative_array($item_in_top_level_array)
-            ) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                $new_file_contents .=  EEH_Export::get_csv_row($keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                $new_file_contents .= EEH_Export::get_csv_row($data_row);
-            }
-            return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
-        } else {
-            // no data TO write... so we can assume that's a success
-            return true;
-        }
-    }
-
-
-
-     /**
-      *
-     *  Writes a row to the csv file
-     *  @param array $row - individual row of csv data
-     *  @param string $delimiter - csv delimiter
-     *  @param string $enclosure - csv enclosure
-     *  @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     *  @return string of text for teh csv file
-     */
-    public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = array();
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
-        }
-
-        return  implode($delimiter, $output) . PHP_EOL;
-    }
-
-
-
-    /**
-     * Shortcut for preparing a database result for display
-     * @param EEM_Base $model
-     * @param string $field_name
-     * @param string $raw_db_value
-     * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
-     * @return string
-     */
-    public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
-    {
-        $field_obj = $model->field_settings_for($field_name);
-        $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
-            $field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
-        }
-        if ($pretty_schema === true) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
-        } elseif (is_string($pretty_schema)) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
-        } else {
-            return $field_obj->prepare_for_get($value_on_model_obj);
-        }
-    }
-
-
-
-    /**
-     * Gets the date format to use in exports. filterable
-     * @param string $current_format
-     * @return string
-     */
-    public static function get_date_format_for_export($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-
-
-    /**
-     * Gets the time format we want to use in exports. Filterable
-     * @param string $current_format
-     * @return string
-     */
-    public static function get_time_format_for_export($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	/**
+	 * Gets the 'normal' column named for fields
+	 * @param EE_Model_Field_Base $field
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_column_name_for_field(EE_Model_Field_Base $field)
+	{
+		$column_name = wp_specialchars_decode($field->get_nicename(), ENT_QUOTES);
+		if (
+			apply_filters(
+				'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+				false,
+				$column_name,
+				$field
+			)
+		) {
+			$column_name .= "["
+				. wp_specialchars_decode($field->get_name(), ENT_QUOTES)
+				. "]";
+		}
+		return $column_name;
+	}
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param string    $filepath
+	 * @param array     $data 2D array,         first numerically-indexed,
+	 *                                          and next-level-down preferably indexed by string
+	 * @param boolean   $write_column_headers   whether or not we should add the keys in the bottom-most array
+	 *                                          as a row for headers in the CSV.
+	 *                                            Eg, if $data looked like:
+	 *                                            array(
+	 *                                                  0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...),
+	 *                                                  1=>array(...,...)
+	 *                                            )
+	 *
+	 * @return boolean      if we successfully wrote to the CSV or not. If there's no $data,
+	 *                      we consider that a success (because we wrote everything there was...nothing)
+	 * @throws EE_Error
+	 */
+	public static function write_data_array_to_csv($filepath, $data, $write_column_headers = true)
+	{
+
+		$new_file_contents = '';
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(sprintf(esc_html__("top-level array must be numerically indexed. Does these look like numbers to you? %s", "event_espresso"), implode(",", array_keys($data))));
+			}
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if (
+				$write_column_headers &&
+					EEH_Array::is_associative_array($item_in_top_level_array)
+			) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				$new_file_contents .=  EEH_Export::get_csv_row($keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				$new_file_contents .= EEH_Export::get_csv_row($data_row);
+			}
+			return EEH_File::write_to_file($filepath, EEH_File::get_file_contents($filepath) . $new_file_contents);
+		} else {
+			// no data TO write... so we can assume that's a success
+			return true;
+		}
+	}
+
+
+
+	 /**
+	  *
+	  *  Writes a row to the csv file
+	  *  @param array $row - individual row of csv data
+	  *  @param string $delimiter - csv delimiter
+	  *  @param string $enclosure - csv enclosure
+	  *  @param bool $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	  *  @return string of text for teh csv file
+	  */
+	public static function get_csv_row(array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = array();
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
+				( $enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure ) : $field_value;
+		}
+
+		return  implode($delimiter, $output) . PHP_EOL;
+	}
+
+
+
+	/**
+	 * Shortcut for preparing a database result for display
+	 * @param EEM_Base $model
+	 * @param string $field_name
+	 * @param string $raw_db_value
+	 * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to NOT display pretty
+	 * @return string
+	 */
+	public static function prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
+	{
+		$field_obj = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(EEH_Export::get_date_format_for_export($field_obj->get_date_format($pretty_schema)), $pretty_schema);
+			$field_obj->set_time_format(EEH_Export::get_time_format_for_export($field_obj->get_time_format($pretty_schema)), $pretty_schema);
+		}
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		} elseif (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		} else {
+			return $field_obj->prepare_for_get($value_on_model_obj);
+		}
+	}
+
+
+
+	/**
+	 * Gets the date format to use in exports. filterable
+	 * @param string $current_format
+	 * @return string
+	 */
+	public static function get_date_format_for_export($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+
+
+	/**
+	 * Gets the time format we want to use in exports. Filterable
+	 * @param string $current_format
+	 * @return string
+	 */
+	public static function get_time_format_for_export($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

core/domain/values/model/CustomSelects.php

Indentation +336 added lines, -336 removed lines

@@ -17,340 +17,340 @@
  */
 class CustomSelects
 {
-    const TYPE_SIMPLE = 'simple';
-    const TYPE_COMPLEX = 'complex';
-    const TYPE_STRUCTURED = 'structured';
-
-    private $valid_operators = array('COUNT', 'SUM');
-
-
-    /**
-     * Original incoming select array
-     *
-     * @var array
-     */
-    private $original_selects;
-
-    /**
-     * Select string that can be added to the query
-     *
-     * @var string
-     */
-    private $columns_to_select_expression;
-
-
-    /**
-     * An array of aliases for the columns included in the incoming select array.
-     *
-     * @var array
-     */
-    private $column_aliases_in_select;
-
-
-    /**
-     * Enum representation of the "type" of array coming into this value object.
-     *
-     * @var string
-     */
-    private $type = '';
-
-
-    /**
-     * CustomSelects constructor.
-     * Incoming selects can be in one of the following formats:
-     * ---- self::TYPE_SIMPLE array ----
-     * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
-     * multiple columns to select as the values.
-     * eg. array( 'ATT_ID', 'REG_ID' )
-     * eg. array( '*' )
-     * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
-     * "structured" method.
-     * ---- self::TYPE_COMPLEX array ----
-     * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
-     * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
-     * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
-     * EEM_Base::$_valid_wpdb_data_types.
-     * eg. array( 'count' => array('count(REG_ID)', '%d') )
-     * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
-     * ---- self::TYPE_STRUCTURED array ---
-     * This is considered the "structured" type. This type is similar to the complex type except that the array attached
-     * to the column alias contains three values.  The first value is the qualified column name (which can include
-     * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
-     * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
-     * the second value.
-     * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
-     * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
-     * NOTE: mixing array types in the incoming $select will cause errors.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    public function __construct(array $selects)
-    {
-        $this->original_selects = $selects;
-        $this->deriveType($selects);
-        $this->deriveParts($selects);
-    }
-
-
-    /**
-     * Derives what type of custom select has been sent in.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveType(array $selects)
-    {
-        // first if the first key for this array is an integer then its coming in as a simple format, so we'll also
-        // ensure all elements of the array are simple.
-        if (is_int(key($selects))) {
-            // let's ensure all keys are ints
-            $invalid_keys = array_filter(
-                array_keys($selects),
-                function ($value) {
-                    return ! is_int($value);
-                }
-            );
-            if (! empty($invalid_keys)) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
-                            'event_espresso'
-                        ),
-                        self::TYPE_SIMPLE
-                    )
-                );
-            }
-            $this->type = self::TYPE_SIMPLE;
-            return;
-        }
-        // made it here so that means we've got either complex or structured selects.  Let's find out which by popping
-        // the first array element off.
-        $first_element = reset($selects);
-
-        if (! is_array($first_element)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
-                        'event_espresso'
-                    ),
-                    self::TYPE_COMPLEX,
-                    self::TYPE_STRUCTURED
-                )
-            );
-        }
-        $this->type = count($first_element) === 2
-            ? self::TYPE_COMPLEX
-            : self::TYPE_STRUCTURED;
-    }
-
-
-    /**
-     * Sets up the various properties for the vo depending on type.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveParts(array $selects)
-    {
-        $column_parts = array();
-        switch ($this->type) {
-            case self::TYPE_SIMPLE:
-                $column_parts = $selects;
-                $this->column_aliases_in_select = $selects;
-                break;
-            case self::TYPE_COMPLEX:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-            case self::TYPE_STRUCTURED:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = $parts[1] !== ''
-                        ? $this->assembleSelectStringWithOperator($parts, $alias)
-                        : "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-        }
-        $this->columns_to_select_expression = implode(', ', $column_parts);
-    }
-
-
-    /**
-     * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
-     *
-     * @param array  $select_parts
-     * @param string $alias
-     * @throws InvalidArgumentException
-     */
-    private function validateSelectValueForType(array $select_parts, $alias)
-    {
-        $valid_data_types = array('%d', '%s', '%f');
-        if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
-                        'event_espresso'
-                    ),
-                    $alias,
-                    $this->expectedSelectPartCountForType(),
-                    $this->type,
-                    count($select_parts)
-                )
-            );
-        }
-        // validate data type.
-        $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
-        $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
-
-        if (! in_array($data_type, $valid_data_types, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
-                        'event_espresso'
-                    ),
-                    $data_type,
-                    $select_parts[0],
-                    $alias,
-                    implode(', ', $valid_data_types)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Each type will have an expected count of array elements, this returns what that expected count is.
-     *
-     * @param string $type
-     * @return int
-     */
-    private function expectedSelectPartCountForType($type = '')
-    {
-        $type = $type === '' ? $this->type : $type;
-        $types_count_map = array(
-            self::TYPE_COMPLEX    => 2,
-            self::TYPE_STRUCTURED => 3,
-        );
-        return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
-    }
-
-
-    /**
-     * Prepares the select statement part for for structured type selects.
-     *
-     * @param array  $select_parts
-     * @param string $alias
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    private function assembleSelectStringWithOperator(array $select_parts, $alias)
-    {
-        $operator = strtoupper($select_parts[1]);
-        // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $alias,
-                    implode(', ', $this->valid_operators)
-                )
-            );
-        }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
-    }
-
-
-    /**
-     * Return the datatype from the given select part.
-     * Remember the select_part has already been validated on object instantiation.
-     *
-     * @param array $select_part
-     * @return string
-     */
-    private function getDataTypeForSelectType(array $select_part)
-    {
-        switch ($this->type) {
-            case self::TYPE_COMPLEX:
-                return $select_part[1];
-            case self::TYPE_STRUCTURED:
-                return $select_part[2];
-            default:
-                return '';
-        }
-    }
-
-
-    /**
-     * Returns the original select array sent into the VO.
-     *
-     * @return array
-     */
-    public function originalSelects()
-    {
-        return $this->original_selects;
-    }
-
-
-    /**
-     * Returns the final assembled select expression derived from the incoming select array.
-     *
-     * @return string
-     */
-    public function columnsToSelectExpression()
-    {
-        return $this->columns_to_select_expression;
-    }
-
-
-    /**
-     * Returns all the column aliases derived from the incoming select array.
-     *
-     * @return array
-     */
-    public function columnAliases()
-    {
-        return $this->column_aliases_in_select;
-    }
-
-
-    /**
-     * Returns the enum type for the incoming select array.
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * Return the datatype for the given column_alias
-     *
-     * @param string $column_alias
-     * @return string  (if there's no data type we return string as the default).
-     */
-    public function getDataTypeForAlias($column_alias)
-    {
-        if (
-            isset($this->original_selects[ $column_alias ])
-            && in_array($column_alias, $this->columnAliases(), true)
-        ) {
-            return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
-        }
-        return '%s';
-    }
+	const TYPE_SIMPLE = 'simple';
+	const TYPE_COMPLEX = 'complex';
+	const TYPE_STRUCTURED = 'structured';
+
+	private $valid_operators = array('COUNT', 'SUM');
+
+
+	/**
+	 * Original incoming select array
+	 *
+	 * @var array
+	 */
+	private $original_selects;
+
+	/**
+	 * Select string that can be added to the query
+	 *
+	 * @var string
+	 */
+	private $columns_to_select_expression;
+
+
+	/**
+	 * An array of aliases for the columns included in the incoming select array.
+	 *
+	 * @var array
+	 */
+	private $column_aliases_in_select;
+
+
+	/**
+	 * Enum representation of the "type" of array coming into this value object.
+	 *
+	 * @var string
+	 */
+	private $type = '';
+
+
+	/**
+	 * CustomSelects constructor.
+	 * Incoming selects can be in one of the following formats:
+	 * ---- self::TYPE_SIMPLE array ----
+	 * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
+	 * multiple columns to select as the values.
+	 * eg. array( 'ATT_ID', 'REG_ID' )
+	 * eg. array( '*' )
+	 * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
+	 * "structured" method.
+	 * ---- self::TYPE_COMPLEX array ----
+	 * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
+	 * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
+	 * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
+	 * EEM_Base::$_valid_wpdb_data_types.
+	 * eg. array( 'count' => array('count(REG_ID)', '%d') )
+	 * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
+	 * ---- self::TYPE_STRUCTURED array ---
+	 * This is considered the "structured" type. This type is similar to the complex type except that the array attached
+	 * to the column alias contains three values.  The first value is the qualified column name (which can include
+	 * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
+	 * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
+	 * the second value.
+	 * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
+	 * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
+	 * NOTE: mixing array types in the incoming $select will cause errors.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(array $selects)
+	{
+		$this->original_selects = $selects;
+		$this->deriveType($selects);
+		$this->deriveParts($selects);
+	}
+
+
+	/**
+	 * Derives what type of custom select has been sent in.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveType(array $selects)
+	{
+		// first if the first key for this array is an integer then its coming in as a simple format, so we'll also
+		// ensure all elements of the array are simple.
+		if (is_int(key($selects))) {
+			// let's ensure all keys are ints
+			$invalid_keys = array_filter(
+				array_keys($selects),
+				function ($value) {
+					return ! is_int($value);
+				}
+			);
+			if (! empty($invalid_keys)) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
+							'event_espresso'
+						),
+						self::TYPE_SIMPLE
+					)
+				);
+			}
+			$this->type = self::TYPE_SIMPLE;
+			return;
+		}
+		// made it here so that means we've got either complex or structured selects.  Let's find out which by popping
+		// the first array element off.
+		$first_element = reset($selects);
+
+		if (! is_array($first_element)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
+						'event_espresso'
+					),
+					self::TYPE_COMPLEX,
+					self::TYPE_STRUCTURED
+				)
+			);
+		}
+		$this->type = count($first_element) === 2
+			? self::TYPE_COMPLEX
+			: self::TYPE_STRUCTURED;
+	}
+
+
+	/**
+	 * Sets up the various properties for the vo depending on type.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveParts(array $selects)
+	{
+		$column_parts = array();
+		switch ($this->type) {
+			case self::TYPE_SIMPLE:
+				$column_parts = $selects;
+				$this->column_aliases_in_select = $selects;
+				break;
+			case self::TYPE_COMPLEX:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+			case self::TYPE_STRUCTURED:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = $parts[1] !== ''
+						? $this->assembleSelectStringWithOperator($parts, $alias)
+						: "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+		}
+		$this->columns_to_select_expression = implode(', ', $column_parts);
+	}
+
+
+	/**
+	 * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
+	 *
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @throws InvalidArgumentException
+	 */
+	private function validateSelectValueForType(array $select_parts, $alias)
+	{
+		$valid_data_types = array('%d', '%s', '%f');
+		if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
+						'event_espresso'
+					),
+					$alias,
+					$this->expectedSelectPartCountForType(),
+					$this->type,
+					count($select_parts)
+				)
+			);
+		}
+		// validate data type.
+		$data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
+		$data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
+
+		if (! in_array($data_type, $valid_data_types, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
+						'event_espresso'
+					),
+					$data_type,
+					$select_parts[0],
+					$alias,
+					implode(', ', $valid_data_types)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Each type will have an expected count of array elements, this returns what that expected count is.
+	 *
+	 * @param string $type
+	 * @return int
+	 */
+	private function expectedSelectPartCountForType($type = '')
+	{
+		$type = $type === '' ? $this->type : $type;
+		$types_count_map = array(
+			self::TYPE_COMPLEX    => 2,
+			self::TYPE_STRUCTURED => 3,
+		);
+		return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
+	}
+
+
+	/**
+	 * Prepares the select statement part for for structured type selects.
+	 *
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	private function assembleSelectStringWithOperator(array $select_parts, $alias)
+	{
+		$operator = strtoupper($select_parts[1]);
+		// validate operator
+		if (! in_array($operator, $this->valid_operators, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
+						'event_espresso'
+					),
+					$operator,
+					$alias,
+					implode(', ', $this->valid_operators)
+				)
+			);
+		}
+		return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+	}
+
+
+	/**
+	 * Return the datatype from the given select part.
+	 * Remember the select_part has already been validated on object instantiation.
+	 *
+	 * @param array $select_part
+	 * @return string
+	 */
+	private function getDataTypeForSelectType(array $select_part)
+	{
+		switch ($this->type) {
+			case self::TYPE_COMPLEX:
+				return $select_part[1];
+			case self::TYPE_STRUCTURED:
+				return $select_part[2];
+			default:
+				return '';
+		}
+	}
+
+
+	/**
+	 * Returns the original select array sent into the VO.
+	 *
+	 * @return array
+	 */
+	public function originalSelects()
+	{
+		return $this->original_selects;
+	}
+
+
+	/**
+	 * Returns the final assembled select expression derived from the incoming select array.
+	 *
+	 * @return string
+	 */
+	public function columnsToSelectExpression()
+	{
+		return $this->columns_to_select_expression;
+	}
+
+
+	/**
+	 * Returns all the column aliases derived from the incoming select array.
+	 *
+	 * @return array
+	 */
+	public function columnAliases()
+	{
+		return $this->column_aliases_in_select;
+	}
+
+
+	/**
+	 * Returns the enum type for the incoming select array.
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * Return the datatype for the given column_alias
+	 *
+	 * @param string $column_alias
+	 * @return string  (if there's no data type we return string as the default).
+	 */
+	public function getDataTypeForAlias($column_alias)
+	{
+		if (
+			isset($this->original_selects[ $column_alias ])
+			&& in_array($column_alias, $this->columnAliases(), true)
+		) {
+			return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
+		}
+		return '%s';
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -107,11 +107,11 @@ 
             // let's ensure all keys are ints
             $invalid_keys = array_filter(
                 array_keys($selects),
-                function ($value) {
+                function($value) {
                     return ! is_int($value);
                 }
             );
-            if (! empty($invalid_keys)) {
+            if ( ! empty($invalid_keys)) {
                 throw new InvalidArgumentException(
                     sprintf(
                         esc_html__(
@@ -129,7 +129,7 @@ 
         // the first array element off.
         $first_element = reset($selects);
 
-        if (! is_array($first_element)) {
+        if ( ! is_array($first_element)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -210,7 +210,7 @@ 
         $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
         $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
 
-        if (! in_array($data_type, $valid_data_types, true)) {
+        if ( ! in_array($data_type, $valid_data_types, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -240,7 +240,7 @@ 
             self::TYPE_COMPLEX    => 2,
             self::TYPE_STRUCTURED => 3,
         );
-        return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
+        return isset($types_count_map[$type]) ? $types_count_map[$type] : 0;
     }
 
 
@@ -256,7 +256,7 @@ 
     {
         $operator = strtoupper($select_parts[1]);
         // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
+        if ( ! in_array($operator, $this->valid_operators, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -269,7 +269,7 @@ 
                 )
             );
         }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+        return $operator.'('.$select_parts[0].') AS '.$alias;
     }
 
 
@@ -346,10 +346,10 @@ 
     public function getDataTypeForAlias($column_alias)
     {
         if (
-            isset($this->original_selects[ $column_alias ])
+            isset($this->original_selects[$column_alias])
             && in_array($column_alias, $this->columnAliases(), true)
         ) {
-            return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
+            return $this->getDataTypeForSelectType($this->original_selects[$column_alias]);
         }
         return '%s';
     }

core/domain/services/capabilities/CapabilitiesChecker.php

Spacing +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
             return true;
         }
         // at this point, $cap_check should be an individual instance of CapCheck
-        if (! $cap_check instanceof CapCheckInterface) {
+        if ( ! $cap_check instanceof CapCheckInterface) {
             throw new InvalidClassException(
                 '\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
             );

Indentation +74 added lines, -74 removed lines

@@ -17,86 +17,86 @@
  */
 class CapabilitiesChecker implements CapabilitiesCheckerInterface
 {
-    /**
-     * @type EE_Capabilities $capabilities
-     */
-    private $capabilities;
+	/**
+	 * @type EE_Capabilities $capabilities
+	 */
+	private $capabilities;
 
 
-    /**
-     * CapabilitiesChecker constructor
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-    }
+	/**
+	 * CapabilitiesChecker constructor
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+	}
 
 
-    /**
-     * @return EE_Capabilities
-     */
-    protected function capabilities()
-    {
-        return $this->capabilities;
-    }
+	/**
+	 * @return EE_Capabilities
+	 */
+	protected function capabilities()
+	{
+		return $this->capabilities;
+	}
 
 
-    /**
-     * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
-     * If any of the individual capability checks fails, then the command will NOT be executed.
-     *
-     * @param CapCheckInterface|CapCheckInterface[] $cap_check
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InsufficientPermissionsException
-     */
-    public function processCapCheck($cap_check)
-    {
-        if (is_array($cap_check)) {
-            foreach ($cap_check as $check) {
-                $this->processCapCheck($check);
-            }
-            return true;
-        }
-        // at this point, $cap_check should be an individual instance of CapCheck
-        if (! $cap_check instanceof CapCheckInterface) {
-            throw new InvalidClassException(
-                '\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
-            );
-        }
-        // sometimes cap checks are conditional, and no capabilities are required
-        if ($cap_check instanceof PublicCapabilities) {
-            return true;
-        }
-        $capabilities = (array) $cap_check->capability();
-        foreach ($capabilities as $capability) {
-            if (
-                ! $this->capabilities()->current_user_can(
-                    $capability,
-                    $cap_check->context(),
-                    $cap_check->ID()
-                )
-            ) {
-                throw new InsufficientPermissionsException($cap_check->context());
-            }
-        }
-        return true;
-    }
+	/**
+	 * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
+	 * If any of the individual capability checks fails, then the command will NOT be executed.
+	 *
+	 * @param CapCheckInterface|CapCheckInterface[] $cap_check
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InsufficientPermissionsException
+	 */
+	public function processCapCheck($cap_check)
+	{
+		if (is_array($cap_check)) {
+			foreach ($cap_check as $check) {
+				$this->processCapCheck($check);
+			}
+			return true;
+		}
+		// at this point, $cap_check should be an individual instance of CapCheck
+		if (! $cap_check instanceof CapCheckInterface) {
+			throw new InvalidClassException(
+				'\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
+			);
+		}
+		// sometimes cap checks are conditional, and no capabilities are required
+		if ($cap_check instanceof PublicCapabilities) {
+			return true;
+		}
+		$capabilities = (array) $cap_check->capability();
+		foreach ($capabilities as $capability) {
+			if (
+				! $this->capabilities()->current_user_can(
+					$capability,
+					$cap_check->context(),
+					$cap_check->ID()
+				)
+			) {
+				throw new InsufficientPermissionsException($cap_check->context());
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param string $capability - the capability to be checked, like: 'ee_edit_registrations'
-     * @param string $context    - what the user is attempting to do, like: 'Edit Registration'
-     * @param int    $ID         - (optional) ID for item where current_user_can is being called from
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InsufficientPermissionsException
-     * @throws InvalidClassException
-     */
-    public function process($capability, $context, $ID = 0)
-    {
-        return $this->processCapCheck(new CapCheck($capability, $context, $ID));
-    }
+	/**
+	 * @param string $capability - the capability to be checked, like: 'ee_edit_registrations'
+	 * @param string $context    - what the user is attempting to do, like: 'Edit Registration'
+	 * @param int    $ID         - (optional) ID for item where current_user_can is being called from
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InsufficientPermissionsException
+	 * @throws InvalidClassException
+	 */
+	public function process($capability, $context, $ID = 0)
+	{
+		return $this->processCapCheck(new CapCheck($capability, $context, $ID));
+	}
 }

core/domain/services/event/EventSpacesCalculator.php

Spacing +46 added lines, -46 removed lines

@@ -181,14 +181,14 @@ 
      */
     public function setActiveTickets(array $active_tickets = array())
     {
-        if (! empty($active_tickets)) {
+        if ( ! empty($active_tickets)) {
             foreach ($active_tickets as $active_ticket) {
                 $this->validateTicket($active_ticket);
             }
             // sort incoming array by ticket quantity (asc)
             usort(
                 $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
+                function(EE_Ticket $a, EE_Ticket $b) {
                     if ($a->qty() === $b->qty()) {
                         return 0;
                     }
@@ -210,7 +210,7 @@ 
      */
     private function validateTicket($ticket)
     {
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new DomainException(
                 esc_html__(
                     'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
@@ -261,7 +261,7 @@ 
                 )
             );
         }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
+        $this->datetimes[$datetime->ID()] = $datetime;
     }
 
 
@@ -340,7 +340,7 @@ 
         $this->tickets_sold = array();
         $this->total_spaces = array();
         $active_tickets = $this->getActiveTickets();
-        if (! empty($active_tickets)) {
+        if ( ! empty($active_tickets)) {
             foreach ($active_tickets as $ticket) {
                 $this->validateTicket($ticket);
                 // we need to index our data arrays using strings for the purpose of sorting,
@@ -362,16 +362,16 @@ 
                     // we are going to move all of our data into the following arrays:
                     // datetime spaces initially represents the reg limit for each datetime,
                     // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+                    $this->datetime_spaces[$datetime_identifier] = $reg_limit;
                     // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+                    $this->datetime_tickets[$datetime_identifier][] = $ticket_identifier;
                     // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+                    $this->ticket_datetimes[$ticket_identifier][] = $datetime_identifier;
                 }
                 // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+                $this->tickets_sold[$ticket_identifier] = $ticket->sold() + $ticket->reserved();
                 // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+                $this->ticket_quantities[$ticket_identifier] = $max_tickets;
             }
         }
         // sort datetime spaces by reg limit, but maintain our string indexes
@@ -430,11 +430,11 @@ 
             \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
         }
         foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+            if (isset($this->ticket_quantities[$ticket_identifier])) {
+                $this->ticket_quantities[$ticket_identifier] -= $tickets_sold;
                 // don't let values go below zero
-                $this->ticket_quantities[ $ticket_identifier ] = max(
-                    $this->ticket_quantities[ $ticket_identifier ],
+                $this->ticket_quantities[$ticket_identifier] = max(
+                    $this->ticket_quantities[$ticket_identifier],
                     0
                 );
                 if ($this->debug) {
@@ -447,15 +447,15 @@ 
                 }
             }
             if (
-                isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
+                isset($this->ticket_datetimes[$ticket_identifier])
+                && is_array($this->ticket_datetimes[$ticket_identifier])
             ) {
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+                foreach ($this->ticket_datetimes[$ticket_identifier] as $ticket_datetime) {
+                    if (isset($this->ticket_quantities[$ticket_identifier])) {
+                        $this->datetime_spaces[$ticket_datetime] -= $tickets_sold;
                         // don't let values go below zero
-                        $this->datetime_spaces[ $ticket_datetime ] = max(
-                            $this->datetime_spaces[ $ticket_datetime ],
+                        $this->datetime_spaces[$ticket_datetime] = max(
+                            $this->datetime_spaces[$ticket_datetime],
                             0
                         );
                         if ($this->debug) {
@@ -480,11 +480,11 @@ 
     private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
     {
         // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
+        $reg_limit = isset($this->datetime_spaces[$datetime_identifier])
+            ? $this->datetime_spaces[$datetime_identifier]
             : 0;
         // and bail if it is not
-        if (! $reg_limit) {
+        if ( ! $reg_limit) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
             }
@@ -501,7 +501,7 @@ 
         }
         // number of allocated spaces always starts at zero
         $spaces_allocated = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
+        $this->total_spaces[$datetime_identifier] = 0;
         foreach ($tickets as $ticket_identifier) {
             $spaces_allocated = $this->calculateAvailableSpacesForTicket(
                 $datetime_identifier,
@@ -514,7 +514,7 @@ 
         $spaces_allocated = max($spaces_allocated, 0);
         if ($spaces_allocated) {
             // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+            $this->total_spaces[$datetime_identifier] += $spaces_allocated;
             if ($this->debug) {
                 \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
             }
@@ -525,7 +525,7 @@ 
         }
         if ($this->debug) {
             \EEH_Debug_Tools::printr(
-                $this->total_spaces[ $datetime_identifier ],
+                $this->total_spaces[$datetime_identifier],
                 '$total_spaces',
                 __FILE__,
                 __LINE__
@@ -550,8 +550,8 @@ 
         $spaces_allocated
     ) {
         // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
+        $ticket_quantity = isset($this->ticket_quantities[$ticket_identifier])
+            ? $this->ticket_quantities[$ticket_identifier]
             : 0;
         if ($this->debug) {
             \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
@@ -581,7 +581,7 @@ 
                 //  or the maximum ticket quantity
                 $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
                 // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+                $this->ticket_quantities[$ticket_identifier] -= $ticket_quantity;
                 // and increment spaces allocated for this datetime
                 $spaces_allocated += $ticket_quantity;
                 $at_capacity = $spaces_allocated >= $reg_limit;
@@ -638,15 +638,15 @@ 
                 $ticket_quantity
             );
             // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
+            if ( ! ($adjusted || $at_capacity)) {
                 continue;
             }
             // then all of it's tickets are now unavailable
             foreach ($datetime_tickets as $datetime_ticket) {
                 if (
                     ($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
+                    && isset($this->ticket_quantities[$datetime_ticket])
+                    && $this->ticket_quantities[$datetime_ticket] > 0
                 ) {
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
@@ -660,14 +660,14 @@ 
                     // otherwise just subtract the ticket quantity
                     $new_quantity = $at_capacity
                         ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+                        : $this->ticket_quantities[$datetime_ticket] - $ticket_quantity;
                     // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+                    $this->ticket_quantities[$datetime_ticket] = max($new_quantity, 0);
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
                             $at_capacity
                                 ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
+                                : "{$this->ticket_quantities[$datetime_ticket]}",
                             " . . . . {$datetime_ticket} quantity set to ",
                             __FILE__,
                             __LINE__
@@ -677,8 +677,8 @@ 
                 // but we also need to adjust spaces for any other datetimes this ticket has access to
                 if ($datetime_ticket === $ticket_identifier) {
                     if (
-                        isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
+                        isset($this->ticket_datetimes[$datetime_ticket])
+                        && is_array($this->ticket_datetimes[$datetime_ticket])
                     ) {
                         if ($this->debug) {
                             \EEH_Debug_Tools::printr(
@@ -688,7 +688,7 @@ 
                                 __LINE__
                             );
                         }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+                        foreach ($this->ticket_datetimes[$datetime_ticket] as $datetime) {
                             // don't adjust the current datetime twice
                             if ($datetime !== $datetime_identifier) {
                                 $this->adjustDatetimeSpaces(
@@ -709,24 +709,24 @@ 
         // does datetime have spaces available?
         // and does the supplied ticket have access to this datetime ?
         if (
-            $this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+            $this->datetime_spaces[$datetime_identifier] > 0
+            && isset($this->datetime_spaces[$datetime_identifier], $this->datetime_tickets[$datetime_identifier])
+            && in_array($ticket_identifier, $this->datetime_tickets[$datetime_identifier], true)
         ) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
                 \EEH_Debug_Tools::printr(
-                    "{$this->datetime_spaces[ $datetime_identifier ]}",
+                    "{$this->datetime_spaces[$datetime_identifier]}",
                     " . . current  {$datetime_identifier} spaces available",
                     __FILE__,
                     __LINE__
                 );
             }
             // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+            $this->datetime_spaces[$datetime_identifier] -= $ticket_quantity;
             // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
+            $this->datetime_spaces[$datetime_identifier] = max(
+                $this->datetime_spaces[$datetime_identifier],
                 0
             );
             if ($this->debug) {

Indentation +715 added lines, -715 removed lines

@@ -25,719 +25,719 @@
  */
 class EventSpacesCalculator
 {
-    /**
-     * @var EE_Event $event
-     */
-    private $event;
-
-    /**
-     * @var array $datetime_query_params
-     */
-    private $datetime_query_params;
-
-    /**
-     * @var EE_Ticket[] $active_tickets
-     */
-    private $active_tickets = array();
-
-    /**
-     * @var EE_Datetime[] $datetimes
-     */
-    private $datetimes = array();
-
-    /**
-     * Array of Ticket IDs grouped by Datetime
-     *
-     * @var array $datetimes
-     */
-    private $datetime_tickets = array();
-
-    /**
-     * Max spaces for each Datetime (reg limit - previous sold)
-     *
-     * @var array $datetime_spaces
-     */
-    private $datetime_spaces = array();
-
-    /**
-     * Array of Datetime IDs grouped by Ticket
-     *
-     * @var array[] $ticket_datetimes
-     */
-    private $ticket_datetimes = array();
-
-    /**
-     * maximum ticket quantities for each ticket (adjusted for reg limit)
-     *
-     * @var array $ticket_quantities
-     */
-    private $ticket_quantities = array();
-
-    /**
-     * total quantity of sold and reserved for each ticket
-     *
-     * @var array $tickets_sold
-     */
-    private $tickets_sold = array();
-
-    /**
-     * total spaces available across all datetimes
-     *
-     * @var array $total_spaces
-     */
-    private $total_spaces = array();
-
-    /**
-     * @var boolean $debug
-     */
-    private $debug = false; // true false
-
-    /**
-     * @var null|int $spaces_remaining
-     */
-    private $spaces_remaining;
-
-    /**
-     * @var null|int $total_spaces_available
-     */
-    private $total_spaces_available;
-
-
-    /**
-     * EventSpacesCalculator constructor.
-     *
-     * @param EE_Event $event
-     * @param array    $datetime_query_params
-     * @throws EE_Error
-     */
-    public function __construct(EE_Event $event, array $datetime_query_params = array())
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
-            \EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__);
-        }
-        $this->event = $event;
-        $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC'));
-        $this->setHooks();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function setHooks()
-    {
-        add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function clearResults()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
-        }
-        $this->spaces_remaining = null;
-        $this->total_spaces_available = null;
-    }
-
-
-    /**
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function getActiveTickets()
-    {
-        if (empty($this->active_tickets)) {
-            $this->active_tickets = $this->event->tickets(
-                array(
-                    array('TKT_deleted' => false),
-                    'order_by' => array('TKT_qty' => 'ASC'),
-                )
-            );
-        }
-        return $this->active_tickets;
-    }
-
-
-    /**
-     * @param EE_Ticket[] $active_tickets
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function setActiveTickets(array $active_tickets = array())
-    {
-        if (! empty($active_tickets)) {
-            foreach ($active_tickets as $active_ticket) {
-                $this->validateTicket($active_ticket);
-            }
-            // sort incoming array by ticket quantity (asc)
-            usort(
-                $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
-                    if ($a->qty() === $b->qty()) {
-                        return 0;
-                    }
-                    return ($a->qty() < $b->qty())
-                        ? -1
-                        : 1;
-                }
-            );
-        }
-        $this->active_tickets = $active_tickets;
-    }
-
-
-    /**
-     * @param $ticket
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    private function validateTicket($ticket)
-    {
-        if (! $ticket instanceof EE_Ticket) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
-                    'event_espresso'
-                )
-            );
-        }
-        if ($ticket->get_event_ID() !== $this->event->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.',
-                        'event_espresso'
-                    ),
-                    $ticket->get_event_ID(),
-                    $this->event->ID()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return EE_Datetime[]
-     */
-    public function getDatetimes()
-    {
-        return $this->datetimes;
-    }
-
-
-    /**
-     * @param EE_Datetime $datetime
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function setDatetime(EE_Datetime $datetime)
-    {
-        if ($datetime->event()->ID() !== $this->event->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.',
-                        'event_espresso'
-                    ),
-                    $datetime->event()->ID(),
-                    $this->event->ID()
-                )
-            );
-        }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function spacesRemaining()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        if ($this->spaces_remaining === null) {
-            $this->initialize();
-            $this->spaces_remaining = $this->calculate();
-        }
-        return $this->spaces_remaining;
-    }
-
-
-    /**
-     * calculates total available spaces for an event with no regard for sold tickets
-     *
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function totalSpacesAvailable()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        if ($this->total_spaces_available === null) {
-            $this->initialize();
-            $this->total_spaces_available = $this->calculate(false);
-        }
-        return $this->total_spaces_available;
-    }
-
-
-    /**
-     * Loops through the active tickets for the event
-     * and builds a series of data arrays that will be used for calculating
-     * the total maximum available spaces, as well as the spaces remaining.
-     * Because ticket quantities affect datetime spaces and vice versa,
-     * we need to be constantly updating these data arrays as things change,
-     * which is the entire reason for their existence.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function initialize()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        $this->datetime_tickets = array();
-        $this->datetime_spaces = array();
-        $this->ticket_datetimes = array();
-        $this->ticket_quantities = array();
-        $this->tickets_sold = array();
-        $this->total_spaces = array();
-        $active_tickets = $this->getActiveTickets();
-        if (! empty($active_tickets)) {
-            foreach ($active_tickets as $ticket) {
-                $this->validateTicket($ticket);
-                // we need to index our data arrays using strings for the purpose of sorting,
-                // but we also need them to be unique, so  we'll just prepend a letter T to the ID
-                $ticket_identifier = "T{$ticket->ID()}";
-                // to start, we'll just consider the raw qty to be the maximum availability for this ticket,
-                // unless the ticket is past its "sell until" date, in which case the qty will be 0
-                $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty();
-                // but we'll adjust that after looping over each datetime for the ticket and checking reg limits
-                $ticket_datetimes = $ticket->datetimes($this->datetime_query_params);
-                foreach ($ticket_datetimes as $datetime) {
-                    // save all datetimes
-                    $this->setDatetime($datetime);
-                    $datetime_identifier = "D{$datetime->ID()}";
-                    $reg_limit = $datetime->reg_limit();
-                    // ticket quantity can not exceed datetime reg limit
-                    $max_tickets = min($max_tickets, $reg_limit);
-                    // as described earlier, because we need to be able to constantly adjust numbers for things,
-                    // we are going to move all of our data into the following arrays:
-                    // datetime spaces initially represents the reg limit for each datetime,
-                    // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
-                    // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
-                    // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
-                }
-                // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
-                // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
-            }
-        }
-        // sort datetime spaces by reg limit, but maintain our string indexes
-        asort($this->datetime_spaces, SORT_NUMERIC);
-        // datetime tickets need to be sorted in the SAME order as the above array...
-        // so we'll just use array_merge() to take the structure of datetime_spaces
-        // but overwrite all of the data with that from datetime_tickets
-        $this->datetime_tickets = array_merge(
-            $this->datetime_spaces,
-            $this->datetime_tickets
-        );
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__);
-        }
-    }
-
-
-    /**
-     * performs calculations on initialized data
-     *
-     * @param bool $consider_sold
-     * @return int|float
-     */
-    private function calculate($consider_sold = true)
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-            \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__);
-        }
-        if ($consider_sold) {
-            // subtract amounts sold from all ticket quantities and datetime spaces
-            $this->adjustTicketQuantitiesDueToSales();
-        }
-        foreach ($this->datetime_tickets as $datetime_identifier => $tickets) {
-            $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets);
-        }
-        // total spaces available is just the sum of the spaces available for each datetime
-        $spaces_remaining = array_sum($this->total_spaces);
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__);
-        }
-        return $spaces_remaining;
-    }
-
-
-    /**
-     * subtracts amount of  tickets sold from ticket quantities and datetime spaces
-     */
-    private function adjustTicketQuantitiesDueToSales()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
-                // don't let values go below zero
-                $this->ticket_quantities[ $ticket_identifier ] = max(
-                    $this->ticket_quantities[ $ticket_identifier ],
-                    0
-                );
-                if ($this->debug) {
-                    \EEH_Debug_Tools::printr(
-                        "{$tickets_sold} sales for ticket {$ticket_identifier} ",
-                        'subtracting',
-                        __FILE__,
-                        __LINE__
-                    );
-                }
-            }
-            if (
-                isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
-            ) {
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
-                        // don't let values go below zero
-                        $this->datetime_spaces[ $ticket_datetime ] = max(
-                            $this->datetime_spaces[ $ticket_datetime ],
-                            0
-                        );
-                        if ($this->debug) {
-                            \EEH_Debug_Tools::printr(
-                                "{$tickets_sold} sales for datetime {$ticket_datetime} ",
-                                'subtracting',
-                                __FILE__,
-                                __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param string $datetime_identifier
-     * @param array  $tickets
-     */
-    private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
-    {
-        // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
-            : 0;
-        // and bail if it is not
-        if (! $reg_limit) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
-            }
-            return;
-        }
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1);
-            \EEH_Debug_Tools::printr(
-                "{$reg_limit}",
-                'REG LIMIT',
-                __FILE__,
-                __LINE__
-            );
-        }
-        // number of allocated spaces always starts at zero
-        $spaces_allocated = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
-        foreach ($tickets as $ticket_identifier) {
-            $spaces_allocated = $this->calculateAvailableSpacesForTicket(
-                $datetime_identifier,
-                $reg_limit,
-                $ticket_identifier,
-                $spaces_allocated
-            );
-        }
-        // spaces can't be negative
-        $spaces_allocated = max($spaces_allocated, 0);
-        if ($spaces_allocated) {
-            // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
-            }
-        } else {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__);
-            }
-        }
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(
-                $this->total_spaces[ $datetime_identifier ],
-                '$total_spaces',
-                __FILE__,
-                __LINE__
-            );
-            \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
-        }
-    }
-
-
-    /**
-     * @param string $datetime_identifier
-     * @param int    $reg_limit
-     * @param string $ticket_identifier
-     * @param int    $spaces_allocated
-     * @return int
-     */
-    private function calculateAvailableSpacesForTicket(
-        $datetime_identifier,
-        $reg_limit,
-        $ticket_identifier,
-        $spaces_allocated
-    ) {
-        // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
-            : 0;
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr(
-                "{$ticket_quantity}",
-                "ticket $ticket_identifier quantity: ",
-                __FILE__,
-                __LINE__,
-                2
-            );
-        }
-        if ($ticket_quantity) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(
-                    ($spaces_allocated <= $reg_limit)
-                        ? 'true'
-                        : 'false',
-                    ' . spaces_allocated <= reg_limit = ',
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            // if the datetime is NOT at full capacity yet
-            if ($spaces_allocated <= $reg_limit) {
-                // then the maximum ticket quantity we can allocate is the lowest value of either:
-                //  the number of remaining spaces for the datetime, which is the limit - spaces already taken
-                //  or the maximum ticket quantity
-                $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
-                // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
-                // and increment spaces allocated for this datetime
-                $spaces_allocated += $ticket_quantity;
-                $at_capacity = $spaces_allocated >= $reg_limit;
-                if ($this->debug) {
-                    \EEH_Debug_Tools::printr(
-                        "{$ticket_quantity} {$ticket_identifier} tickets",
-                        ' > > allocate ',
-                        __FILE__,
-                        __LINE__,
-                        3
-                    );
-                    if ($at_capacity) {
-                        \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
-                    }
-                }
-                // now adjust all other datetimes that allow access to this ticket
-                $this->adjustDatetimes(
-                    $datetime_identifier,
-                    $ticket_identifier,
-                    $ticket_quantity,
-                    $at_capacity
-                );
-            }
-        }
-        return $spaces_allocated;
-    }
-
-
-    /**
-     * subtracts ticket amounts from all datetime reg limits
-     * that allow access to the ticket specified,
-     * because that ticket could be used
-     * to attend any of the datetimes it has access to
-     *
-     * @param string $datetime_identifier
-     * @param string $ticket_identifier
-     * @param bool   $at_capacity
-     * @param int    $ticket_quantity
-     */
-    private function adjustDatetimes(
-        $datetime_identifier,
-        $ticket_identifier,
-        $ticket_quantity,
-        $at_capacity
-    ) {
-        /** @var array $datetime_tickets */
-        foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) {
-            if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) {
-                continue;
-            }
-            $adjusted = $this->adjustDatetimeSpaces(
-                $datetime_ID,
-                $ticket_identifier,
-                $ticket_quantity
-            );
-            // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
-                continue;
-            }
-            // then all of it's tickets are now unavailable
-            foreach ($datetime_tickets as $datetime_ticket) {
-                if (
-                    ($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
-                ) {
-                    if ($this->debug) {
-                        \EEH_Debug_Tools::printr(
-                            $datetime_ticket,
-                            ' . . . adjust ticket quantities for',
-                            __FILE__,
-                            __LINE__
-                        );
-                    }
-                    // if this datetime is at full capacity, set any tracked available quantities to zero
-                    // otherwise just subtract the ticket quantity
-                    $new_quantity = $at_capacity
-                        ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
-                    // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
-                    if ($this->debug) {
-                        \EEH_Debug_Tools::printr(
-                            $at_capacity
-                                ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
-                            " . . . . {$datetime_ticket} quantity set to ",
-                            __FILE__,
-                            __LINE__
-                        );
-                    }
-                }
-                // but we also need to adjust spaces for any other datetimes this ticket has access to
-                if ($datetime_ticket === $ticket_identifier) {
-                    if (
-                        isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
-                    ) {
-                        if ($this->debug) {
-                            \EEH_Debug_Tools::printr(
-                                $datetime_ticket,
-                                ' . . adjust other Datetimes for',
-                                __FILE__,
-                                __LINE__
-                            );
-                        }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
-                            // don't adjust the current datetime twice
-                            if ($datetime !== $datetime_identifier) {
-                                $this->adjustDatetimeSpaces(
-                                    $datetime,
-                                    $datetime_ticket,
-                                    $ticket_quantity
-                                );
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0)
-    {
-        // does datetime have spaces available?
-        // and does the supplied ticket have access to this datetime ?
-        if (
-            $this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
-        ) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
-                \EEH_Debug_Tools::printr(
-                    "{$this->datetime_spaces[ $datetime_identifier ]}",
-                    " . . current  {$datetime_identifier} spaces available",
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
-            // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
-                0
-            );
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(
-                    "{$ticket_quantity}",
-                    " . . . {$datetime_identifier} capacity reduced by",
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @var EE_Event $event
+	 */
+	private $event;
+
+	/**
+	 * @var array $datetime_query_params
+	 */
+	private $datetime_query_params;
+
+	/**
+	 * @var EE_Ticket[] $active_tickets
+	 */
+	private $active_tickets = array();
+
+	/**
+	 * @var EE_Datetime[] $datetimes
+	 */
+	private $datetimes = array();
+
+	/**
+	 * Array of Ticket IDs grouped by Datetime
+	 *
+	 * @var array $datetimes
+	 */
+	private $datetime_tickets = array();
+
+	/**
+	 * Max spaces for each Datetime (reg limit - previous sold)
+	 *
+	 * @var array $datetime_spaces
+	 */
+	private $datetime_spaces = array();
+
+	/**
+	 * Array of Datetime IDs grouped by Ticket
+	 *
+	 * @var array[] $ticket_datetimes
+	 */
+	private $ticket_datetimes = array();
+
+	/**
+	 * maximum ticket quantities for each ticket (adjusted for reg limit)
+	 *
+	 * @var array $ticket_quantities
+	 */
+	private $ticket_quantities = array();
+
+	/**
+	 * total quantity of sold and reserved for each ticket
+	 *
+	 * @var array $tickets_sold
+	 */
+	private $tickets_sold = array();
+
+	/**
+	 * total spaces available across all datetimes
+	 *
+	 * @var array $total_spaces
+	 */
+	private $total_spaces = array();
+
+	/**
+	 * @var boolean $debug
+	 */
+	private $debug = false; // true false
+
+	/**
+	 * @var null|int $spaces_remaining
+	 */
+	private $spaces_remaining;
+
+	/**
+	 * @var null|int $total_spaces_available
+	 */
+	private $total_spaces_available;
+
+
+	/**
+	 * EventSpacesCalculator constructor.
+	 *
+	 * @param EE_Event $event
+	 * @param array    $datetime_query_params
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Event $event, array $datetime_query_params = array())
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
+			\EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__);
+		}
+		$this->event = $event;
+		$this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC'));
+		$this->setHooks();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function setHooks()
+	{
+		add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function clearResults()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1);
+		}
+		$this->spaces_remaining = null;
+		$this->total_spaces_available = null;
+	}
+
+
+	/**
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function getActiveTickets()
+	{
+		if (empty($this->active_tickets)) {
+			$this->active_tickets = $this->event->tickets(
+				array(
+					array('TKT_deleted' => false),
+					'order_by' => array('TKT_qty' => 'ASC'),
+				)
+			);
+		}
+		return $this->active_tickets;
+	}
+
+
+	/**
+	 * @param EE_Ticket[] $active_tickets
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function setActiveTickets(array $active_tickets = array())
+	{
+		if (! empty($active_tickets)) {
+			foreach ($active_tickets as $active_ticket) {
+				$this->validateTicket($active_ticket);
+			}
+			// sort incoming array by ticket quantity (asc)
+			usort(
+				$active_tickets,
+				function (EE_Ticket $a, EE_Ticket $b) {
+					if ($a->qty() === $b->qty()) {
+						return 0;
+					}
+					return ($a->qty() < $b->qty())
+						? -1
+						: 1;
+				}
+			);
+		}
+		$this->active_tickets = $active_tickets;
+	}
+
+
+	/**
+	 * @param $ticket
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	private function validateTicket($ticket)
+	{
+		if (! $ticket instanceof EE_Ticket) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
+					'event_espresso'
+				)
+			);
+		}
+		if ($ticket->get_event_ID() !== $this->event->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.',
+						'event_espresso'
+					),
+					$ticket->get_event_ID(),
+					$this->event->ID()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return EE_Datetime[]
+	 */
+	public function getDatetimes()
+	{
+		return $this->datetimes;
+	}
+
+
+	/**
+	 * @param EE_Datetime $datetime
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function setDatetime(EE_Datetime $datetime)
+	{
+		if ($datetime->event()->ID() !== $this->event->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.',
+						'event_espresso'
+					),
+					$datetime->event()->ID(),
+					$this->event->ID()
+				)
+			);
+		}
+		$this->datetimes[ $datetime->ID() ] = $datetime;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function spacesRemaining()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		if ($this->spaces_remaining === null) {
+			$this->initialize();
+			$this->spaces_remaining = $this->calculate();
+		}
+		return $this->spaces_remaining;
+	}
+
+
+	/**
+	 * calculates total available spaces for an event with no regard for sold tickets
+	 *
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function totalSpacesAvailable()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		if ($this->total_spaces_available === null) {
+			$this->initialize();
+			$this->total_spaces_available = $this->calculate(false);
+		}
+		return $this->total_spaces_available;
+	}
+
+
+	/**
+	 * Loops through the active tickets for the event
+	 * and builds a series of data arrays that will be used for calculating
+	 * the total maximum available spaces, as well as the spaces remaining.
+	 * Because ticket quantities affect datetime spaces and vice versa,
+	 * we need to be constantly updating these data arrays as things change,
+	 * which is the entire reason for their existence.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function initialize()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		$this->datetime_tickets = array();
+		$this->datetime_spaces = array();
+		$this->ticket_datetimes = array();
+		$this->ticket_quantities = array();
+		$this->tickets_sold = array();
+		$this->total_spaces = array();
+		$active_tickets = $this->getActiveTickets();
+		if (! empty($active_tickets)) {
+			foreach ($active_tickets as $ticket) {
+				$this->validateTicket($ticket);
+				// we need to index our data arrays using strings for the purpose of sorting,
+				// but we also need them to be unique, so  we'll just prepend a letter T to the ID
+				$ticket_identifier = "T{$ticket->ID()}";
+				// to start, we'll just consider the raw qty to be the maximum availability for this ticket,
+				// unless the ticket is past its "sell until" date, in which case the qty will be 0
+				$max_tickets = $ticket->is_expired() ? 0 : $ticket->qty();
+				// but we'll adjust that after looping over each datetime for the ticket and checking reg limits
+				$ticket_datetimes = $ticket->datetimes($this->datetime_query_params);
+				foreach ($ticket_datetimes as $datetime) {
+					// save all datetimes
+					$this->setDatetime($datetime);
+					$datetime_identifier = "D{$datetime->ID()}";
+					$reg_limit = $datetime->reg_limit();
+					// ticket quantity can not exceed datetime reg limit
+					$max_tickets = min($max_tickets, $reg_limit);
+					// as described earlier, because we need to be able to constantly adjust numbers for things,
+					// we are going to move all of our data into the following arrays:
+					// datetime spaces initially represents the reg limit for each datetime,
+					// but this will get adjusted as tickets are accounted for
+					$this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+					// just an array of ticket IDs grouped by datetime
+					$this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+					// and an array of datetime IDs grouped by ticket
+					$this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+				}
+				// total quantity of sold and reserved for each ticket
+				$this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+				// and the maximum ticket quantities for each ticket (adjusted for reg limit)
+				$this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+			}
+		}
+		// sort datetime spaces by reg limit, but maintain our string indexes
+		asort($this->datetime_spaces, SORT_NUMERIC);
+		// datetime tickets need to be sorted in the SAME order as the above array...
+		// so we'll just use array_merge() to take the structure of datetime_spaces
+		// but overwrite all of the data with that from datetime_tickets
+		$this->datetime_tickets = array_merge(
+			$this->datetime_spaces,
+			$this->datetime_tickets
+		);
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * performs calculations on initialized data
+	 *
+	 * @param bool $consider_sold
+	 * @return int|float
+	 */
+	private function calculate($consider_sold = true)
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+			\EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__);
+		}
+		if ($consider_sold) {
+			// subtract amounts sold from all ticket quantities and datetime spaces
+			$this->adjustTicketQuantitiesDueToSales();
+		}
+		foreach ($this->datetime_tickets as $datetime_identifier => $tickets) {
+			$this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets);
+		}
+		// total spaces available is just the sum of the spaces available for each datetime
+		$spaces_remaining = array_sum($this->total_spaces);
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__);
+		}
+		return $spaces_remaining;
+	}
+
+
+	/**
+	 * subtracts amount of  tickets sold from ticket quantities and datetime spaces
+	 */
+	private function adjustTicketQuantitiesDueToSales()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
+			if (isset($this->ticket_quantities[ $ticket_identifier ])) {
+				$this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+				// don't let values go below zero
+				$this->ticket_quantities[ $ticket_identifier ] = max(
+					$this->ticket_quantities[ $ticket_identifier ],
+					0
+				);
+				if ($this->debug) {
+					\EEH_Debug_Tools::printr(
+						"{$tickets_sold} sales for ticket {$ticket_identifier} ",
+						'subtracting',
+						__FILE__,
+						__LINE__
+					);
+				}
+			}
+			if (
+				isset($this->ticket_datetimes[ $ticket_identifier ])
+				&& is_array($this->ticket_datetimes[ $ticket_identifier ])
+			) {
+				foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
+					if (isset($this->ticket_quantities[ $ticket_identifier ])) {
+						$this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+						// don't let values go below zero
+						$this->datetime_spaces[ $ticket_datetime ] = max(
+							$this->datetime_spaces[ $ticket_datetime ],
+							0
+						);
+						if ($this->debug) {
+							\EEH_Debug_Tools::printr(
+								"{$tickets_sold} sales for datetime {$ticket_datetime} ",
+								'subtracting',
+								__FILE__,
+								__LINE__
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $datetime_identifier
+	 * @param array  $tickets
+	 */
+	private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
+	{
+		// make sure a reg limit is set for the datetime
+		$reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
+			? $this->datetime_spaces[ $datetime_identifier ]
+			: 0;
+		// and bail if it is not
+		if (! $reg_limit) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
+			}
+			return;
+		}
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1);
+			\EEH_Debug_Tools::printr(
+				"{$reg_limit}",
+				'REG LIMIT',
+				__FILE__,
+				__LINE__
+			);
+		}
+		// number of allocated spaces always starts at zero
+		$spaces_allocated = 0;
+		$this->total_spaces[ $datetime_identifier ] = 0;
+		foreach ($tickets as $ticket_identifier) {
+			$spaces_allocated = $this->calculateAvailableSpacesForTicket(
+				$datetime_identifier,
+				$reg_limit,
+				$ticket_identifier,
+				$spaces_allocated
+			);
+		}
+		// spaces can't be negative
+		$spaces_allocated = max($spaces_allocated, 0);
+		if ($spaces_allocated) {
+			// track any non-zero values
+			$this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
+			}
+		} else {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__);
+			}
+		}
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(
+				$this->total_spaces[ $datetime_identifier ],
+				'$total_spaces',
+				__FILE__,
+				__LINE__
+			);
+			\EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * @param string $datetime_identifier
+	 * @param int    $reg_limit
+	 * @param string $ticket_identifier
+	 * @param int    $spaces_allocated
+	 * @return int
+	 */
+	private function calculateAvailableSpacesForTicket(
+		$datetime_identifier,
+		$reg_limit,
+		$ticket_identifier,
+		$spaces_allocated
+	) {
+		// make sure ticket quantity is set
+		$ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
+			? $this->ticket_quantities[ $ticket_identifier ]
+			: 0;
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr(
+				"{$ticket_quantity}",
+				"ticket $ticket_identifier quantity: ",
+				__FILE__,
+				__LINE__,
+				2
+			);
+		}
+		if ($ticket_quantity) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(
+					($spaces_allocated <= $reg_limit)
+						? 'true'
+						: 'false',
+					' . spaces_allocated <= reg_limit = ',
+					__FILE__,
+					__LINE__
+				);
+			}
+			// if the datetime is NOT at full capacity yet
+			if ($spaces_allocated <= $reg_limit) {
+				// then the maximum ticket quantity we can allocate is the lowest value of either:
+				//  the number of remaining spaces for the datetime, which is the limit - spaces already taken
+				//  or the maximum ticket quantity
+				$ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
+				// adjust the available quantity in our tracking array
+				$this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+				// and increment spaces allocated for this datetime
+				$spaces_allocated += $ticket_quantity;
+				$at_capacity = $spaces_allocated >= $reg_limit;
+				if ($this->debug) {
+					\EEH_Debug_Tools::printr(
+						"{$ticket_quantity} {$ticket_identifier} tickets",
+						' > > allocate ',
+						__FILE__,
+						__LINE__,
+						3
+					);
+					if ($at_capacity) {
+						\EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
+					}
+				}
+				// now adjust all other datetimes that allow access to this ticket
+				$this->adjustDatetimes(
+					$datetime_identifier,
+					$ticket_identifier,
+					$ticket_quantity,
+					$at_capacity
+				);
+			}
+		}
+		return $spaces_allocated;
+	}
+
+
+	/**
+	 * subtracts ticket amounts from all datetime reg limits
+	 * that allow access to the ticket specified,
+	 * because that ticket could be used
+	 * to attend any of the datetimes it has access to
+	 *
+	 * @param string $datetime_identifier
+	 * @param string $ticket_identifier
+	 * @param bool   $at_capacity
+	 * @param int    $ticket_quantity
+	 */
+	private function adjustDatetimes(
+		$datetime_identifier,
+		$ticket_identifier,
+		$ticket_quantity,
+		$at_capacity
+	) {
+		/** @var array $datetime_tickets */
+		foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) {
+			if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) {
+				continue;
+			}
+			$adjusted = $this->adjustDatetimeSpaces(
+				$datetime_ID,
+				$ticket_identifier,
+				$ticket_quantity
+			);
+			// skip to next ticket if nothing changed
+			if (! ($adjusted || $at_capacity)) {
+				continue;
+			}
+			// then all of it's tickets are now unavailable
+			foreach ($datetime_tickets as $datetime_ticket) {
+				if (
+					($ticket_identifier === $datetime_ticket || $at_capacity)
+					&& isset($this->ticket_quantities[ $datetime_ticket ])
+					&& $this->ticket_quantities[ $datetime_ticket ] > 0
+				) {
+					if ($this->debug) {
+						\EEH_Debug_Tools::printr(
+							$datetime_ticket,
+							' . . . adjust ticket quantities for',
+							__FILE__,
+							__LINE__
+						);
+					}
+					// if this datetime is at full capacity, set any tracked available quantities to zero
+					// otherwise just subtract the ticket quantity
+					$new_quantity = $at_capacity
+						? 0
+						: $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+					// don't let ticket quantity go below zero
+					$this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+					if ($this->debug) {
+						\EEH_Debug_Tools::printr(
+							$at_capacity
+								? "0 because Datetime {$datetime_identifier} is at capacity"
+								: "{$this->ticket_quantities[ $datetime_ticket ]}",
+							" . . . . {$datetime_ticket} quantity set to ",
+							__FILE__,
+							__LINE__
+						);
+					}
+				}
+				// but we also need to adjust spaces for any other datetimes this ticket has access to
+				if ($datetime_ticket === $ticket_identifier) {
+					if (
+						isset($this->ticket_datetimes[ $datetime_ticket ])
+						&& is_array($this->ticket_datetimes[ $datetime_ticket ])
+					) {
+						if ($this->debug) {
+							\EEH_Debug_Tools::printr(
+								$datetime_ticket,
+								' . . adjust other Datetimes for',
+								__FILE__,
+								__LINE__
+							);
+						}
+						foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+							// don't adjust the current datetime twice
+							if ($datetime !== $datetime_identifier) {
+								$this->adjustDatetimeSpaces(
+									$datetime,
+									$datetime_ticket,
+									$ticket_quantity
+								);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+	private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0)
+	{
+		// does datetime have spaces available?
+		// and does the supplied ticket have access to this datetime ?
+		if (
+			$this->datetime_spaces[ $datetime_identifier ] > 0
+			&& isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
+			&& in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+		) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
+				\EEH_Debug_Tools::printr(
+					"{$this->datetime_spaces[ $datetime_identifier ]}",
+					" . . current  {$datetime_identifier} spaces available",
+					__FILE__,
+					__LINE__
+				);
+			}
+			// then decrement the available spaces for the datetime
+			$this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+			// but don't let quantities go below zero
+			$this->datetime_spaces[ $datetime_identifier ] = max(
+				$this->datetime_spaces[ $datetime_identifier ],
+				0
+			);
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(
+					"{$ticket_quantity}",
+					" . . . {$datetime_identifier} capacity reduced by",
+					__FILE__,
+					__LINE__
+				);
+			}
+			return true;
+		}
+		return false;
+	}
 }

core/domain/entities/shortcodes/EspressoEventAttendees.php

Spacing +4 added lines, -4 removed lines

@@ -116,7 +116,7 @@ 
         $attributes['limit'] = (int) $attributes['limit'];
         $display_on_archives = filter_var($attributes['display_on_archives'], FILTER_VALIDATE_BOOLEAN);
         // don't display on archives unless 'display_on_archives' is true
-        if ($attributes['limit'] === 0 || (! $display_on_archives && is_archive())) {
+        if ($attributes['limit'] === 0 || ( ! $display_on_archives && is_archive())) {
             return '';
         }
         try {
@@ -317,7 +317,7 @@ 
      */
     private function getDatetime(array $attributes)
     {
-        if (! empty($attributes['datetime_id'])) {
+        if ( ! empty($attributes['datetime_id'])) {
             $datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
             if ($datetime instanceof EE_Datetime) {
                 return $datetime;
@@ -337,7 +337,7 @@ 
      */
     private function getTicket(array $attributes)
     {
-        if (! empty($attributes['ticket_id'])) {
+        if ( ! empty($attributes['ticket_id'])) {
             $ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
             if ($ticket instanceof EE_Ticket) {
                 return $ticket;
@@ -354,7 +354,7 @@ 
     private function setAdditionalQueryParams(array $attributes)
     {
         $reg_status_array = EEM_Registration::reg_status_array();
-        if (isset($reg_status_array[ $attributes['status'] ])) {
+        if (isset($reg_status_array[$attributes['status']])) {
             $this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
         }
         if (absint($attributes['limit'])) {

Indentation +310 added lines, -310 removed lines

@@ -30,339 +30,339 @@
  */
 class EspressoEventAttendees extends EspressoShortcode
 {
-    private $query_params = array(
-        0 => array(),
-    );
+	private $query_params = array(
+		0 => array(),
+	);
 
-    private $template_args = array(
-        'contacts' => array(),
-        'event'    => null,
-        'datetime' => null,
-        'ticket'   => null,
-    );
+	private $template_args = array(
+		'contacts' => array(),
+		'event'    => null,
+		'datetime' => null,
+		'ticket'   => null,
+	);
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENT_ATTENDEES';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENT_ATTENDEES';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * process_shortcode - ESPRESSO_EVENT_ATTENDEES - Returns a list of attendees to an event.
-     *  [ESPRESSO_EVENT_ATTENDEES]
-     *  - defaults to attendees for earliest active event, or earliest upcoming event.
-     *  [ESPRESSO_EVENT_ATTENDEES event_id=123]
-     *  - attendees for specific event.
-     *  [ESPRESSO_EVENT_ATTENDEES datetime_id=245]
-     *  - attendees for a specific datetime.
-     *  [ESPRESSO_EVENT_ATTENDEES ticket_id=123]
-     *  - attendees for a specific ticket.
-     *  [ESPRESSO_EVENT_ATTENDEES status=all]
-     *  - specific registration status (use status id) or all for all attendees regardless of status.
-     *  Note default is to only return approved attendees
-     *  [ESPRESSO_EVENT_ATTENDEES show_gravatar=true]
-     *  - default is to not return gravatar.  Otherwise if this is set then return gravatar for email address given.
-     *  [ESPRESSO_EVENT_ATTENDEES display_on_archives=true]
-     *  - default is to not display attendees list on archive pages.
-     * Note: because of the relationship between event_id, ticket_id, and datetime_id:
-     * If more than one of those params is included, then preference is given to the following:
-     *  - event_id is used whenever its present and any others are ignored.
-     *  - if no event_id then datetime is used whenever its present and any others are ignored.
-     *  - otherwise ticket_id is used if present.
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes((array) $attributes);
-        $attributes['limit'] = (int) $attributes['limit'];
-        $display_on_archives = filter_var($attributes['display_on_archives'], FILTER_VALIDATE_BOOLEAN);
-        // don't display on archives unless 'display_on_archives' is true
-        if ($attributes['limit'] === 0 || (! $display_on_archives && is_archive())) {
-            return '';
-        }
-        try {
-            $this->setBaseTemplateArguments($attributes);
-            $this->validateEntities($attributes);
-            $this->setBaseQueryParams();
-        } catch (EntityNotFoundException $e) {
-            if (WP_DEBUG) {
-                return '<div class="important-notice ee-error">'
-                       . $e->getMessage()
-                       . '</div>';
-            }
-            return '';
-        }
-        $this->setAdditionalQueryParams($attributes);
-        // get contacts!
-        $this->template_args['contacts'] = EEM_Attendee::instance()->get_all($this->query_params);
-        // all set let's load up the template and return.
-        return EEH_Template::locate_template(
-            'loop-espresso_event_attendees.php',
-            $this->template_args
-        );
-    }
+	/**
+	 * process_shortcode - ESPRESSO_EVENT_ATTENDEES - Returns a list of attendees to an event.
+	 *  [ESPRESSO_EVENT_ATTENDEES]
+	 *  - defaults to attendees for earliest active event, or earliest upcoming event.
+	 *  [ESPRESSO_EVENT_ATTENDEES event_id=123]
+	 *  - attendees for specific event.
+	 *  [ESPRESSO_EVENT_ATTENDEES datetime_id=245]
+	 *  - attendees for a specific datetime.
+	 *  [ESPRESSO_EVENT_ATTENDEES ticket_id=123]
+	 *  - attendees for a specific ticket.
+	 *  [ESPRESSO_EVENT_ATTENDEES status=all]
+	 *  - specific registration status (use status id) or all for all attendees regardless of status.
+	 *  Note default is to only return approved attendees
+	 *  [ESPRESSO_EVENT_ATTENDEES show_gravatar=true]
+	 *  - default is to not return gravatar.  Otherwise if this is set then return gravatar for email address given.
+	 *  [ESPRESSO_EVENT_ATTENDEES display_on_archives=true]
+	 *  - default is to not display attendees list on archive pages.
+	 * Note: because of the relationship between event_id, ticket_id, and datetime_id:
+	 * If more than one of those params is included, then preference is given to the following:
+	 *  - event_id is used whenever its present and any others are ignored.
+	 *  - if no event_id then datetime is used whenever its present and any others are ignored.
+	 *  - otherwise ticket_id is used if present.
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes((array) $attributes);
+		$attributes['limit'] = (int) $attributes['limit'];
+		$display_on_archives = filter_var($attributes['display_on_archives'], FILTER_VALIDATE_BOOLEAN);
+		// don't display on archives unless 'display_on_archives' is true
+		if ($attributes['limit'] === 0 || (! $display_on_archives && is_archive())) {
+			return '';
+		}
+		try {
+			$this->setBaseTemplateArguments($attributes);
+			$this->validateEntities($attributes);
+			$this->setBaseQueryParams();
+		} catch (EntityNotFoundException $e) {
+			if (WP_DEBUG) {
+				return '<div class="important-notice ee-error">'
+					   . $e->getMessage()
+					   . '</div>';
+			}
+			return '';
+		}
+		$this->setAdditionalQueryParams($attributes);
+		// get contacts!
+		$this->template_args['contacts'] = EEM_Attendee::instance()->get_all($this->query_params);
+		// all set let's load up the template and return.
+		return EEH_Template::locate_template(
+			'loop-espresso_event_attendees.php',
+			$this->template_args
+		);
+	}
 
 
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return (array) apply_filters(
-            'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
-            $attributes + array(
-                'event_id'            => null,
-                'datetime_id'         => null,
-                'ticket_id'           => null,
-                'status'              => EEM_Registration::status_id_approved,
-                'show_gravatar'       => false,
-                'display_on_archives' => false,
-                'limit'               => 999,
-            )
-        );
-    }
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return (array) apply_filters(
+			'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
+			$attributes + array(
+				'event_id'            => null,
+				'datetime_id'         => null,
+				'ticket_id'           => null,
+				'status'              => EEM_Registration::status_id_approved,
+				'show_gravatar'       => false,
+				'display_on_archives' => false,
+				'limit'               => 999,
+			)
+		);
+	}
 
 
-    /**
-     * Set all the base template arguments from the incoming attributes.
-     * * Note: because of the relationship between event_id, ticket_id, and datetime_id:
-     * If more than one of those params is included, then preference is given to the following:
-     *  - event_id is used whenever its present and any others are ignored.
-     *  - if no event_id then datetime is used whenever its present and any others are ignored.
-     *  - otherwise ticket_id is used if present.
-     *
-     * @param array $attributes
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function setBaseTemplateArguments(array $attributes)
-    {
-        $this->template_args['show_gravatar'] = $attributes['show_gravatar'];
-        $this->template_args['event'] = $this->getEvent($attributes);
-        $this->template_args['datetime'] = empty($attributes['event_id'])
-            ? $this->getDatetime($attributes)
-            : null;
-        $this->template_args['ticket'] = empty($attributes['datetime_id']) && empty($attributes['event_id'])
-            ? $this->getTicket($attributes)
-            : null;
-    }
+	/**
+	 * Set all the base template arguments from the incoming attributes.
+	 * * Note: because of the relationship between event_id, ticket_id, and datetime_id:
+	 * If more than one of those params is included, then preference is given to the following:
+	 *  - event_id is used whenever its present and any others are ignored.
+	 *  - if no event_id then datetime is used whenever its present and any others are ignored.
+	 *  - otherwise ticket_id is used if present.
+	 *
+	 * @param array $attributes
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function setBaseTemplateArguments(array $attributes)
+	{
+		$this->template_args['show_gravatar'] = $attributes['show_gravatar'];
+		$this->template_args['event'] = $this->getEvent($attributes);
+		$this->template_args['datetime'] = empty($attributes['event_id'])
+			? $this->getDatetime($attributes)
+			: null;
+		$this->template_args['ticket'] = empty($attributes['datetime_id']) && empty($attributes['event_id'])
+			? $this->getTicket($attributes)
+			: null;
+	}
 
 
-    /**
-     * Validates the presence of entities for the given attribute values.
-     *
-     * @param array $attributes
-     * @throws EntityNotFoundException
-     */
-    private function validateEntities(array $attributes)
-    {
-        if (
-            ! $this->template_args['event'] instanceof EE_Event
-            || (
-                empty($attributes['event_id'])
-                && $attributes['datetime_id']
-                && ! $this->template_args['datetime'] instanceof EE_Datetime
-            )
-            || (
-                empty($attributes['event_id'])
-                && empty($attributes['datetime_id'])
-                && $attributes['ticket_id']
-                && ! $this->template_args['ticket'] instanceof EE_Ticket
-            )
-        ) {
-            throw new EntityNotFoundException(
-                '',
-                '',
-                esc_html__(
-                    'The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.',
-                    'event_espresso'
-                )
-            );
-        }
-    }
+	/**
+	 * Validates the presence of entities for the given attribute values.
+	 *
+	 * @param array $attributes
+	 * @throws EntityNotFoundException
+	 */
+	private function validateEntities(array $attributes)
+	{
+		if (
+			! $this->template_args['event'] instanceof EE_Event
+			|| (
+				empty($attributes['event_id'])
+				&& $attributes['datetime_id']
+				&& ! $this->template_args['datetime'] instanceof EE_Datetime
+			)
+			|| (
+				empty($attributes['event_id'])
+				&& empty($attributes['datetime_id'])
+				&& $attributes['ticket_id']
+				&& ! $this->template_args['ticket'] instanceof EE_Ticket
+			)
+		) {
+			throw new EntityNotFoundException(
+				'',
+				'',
+				esc_html__(
+					'The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.',
+					'event_espresso'
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Sets the query params for the base query elements.
-     */
-    private function setBaseQueryParams()
-    {
-        switch (true) {
-            case $this->template_args['datetime'] instanceof EE_Datetime:
-                $this->query_params = array(
-                    0                          => array(
-                        'Registration.Ticket.Datetime.DTT_ID' => $this->template_args['datetime']->ID(),
-                    ),
-                    'default_where_conditions' => 'this_model_only',
-                );
-                break;
-            case $this->template_args['ticket'] instanceof EE_Ticket:
-                $this->query_params[0] = array(
-                    'Registration.TKT_ID' => $this->template_args['ticket']->ID(),
-                );
-                break;
-            case $this->template_args['event'] instanceof EE_Event:
-                $this->query_params[0] = array(
-                    'Registration.EVT_ID' => $this->template_args['event']->ID(),
-                );
-                break;
-        }
-    }
+	/**
+	 * Sets the query params for the base query elements.
+	 */
+	private function setBaseQueryParams()
+	{
+		switch (true) {
+			case $this->template_args['datetime'] instanceof EE_Datetime:
+				$this->query_params = array(
+					0                          => array(
+						'Registration.Ticket.Datetime.DTT_ID' => $this->template_args['datetime']->ID(),
+					),
+					'default_where_conditions' => 'this_model_only',
+				);
+				break;
+			case $this->template_args['ticket'] instanceof EE_Ticket:
+				$this->query_params[0] = array(
+					'Registration.TKT_ID' => $this->template_args['ticket']->ID(),
+				);
+				break;
+			case $this->template_args['event'] instanceof EE_Event:
+				$this->query_params[0] = array(
+					'Registration.EVT_ID' => $this->template_args['event']->ID(),
+				);
+				break;
+		}
+	}
 
 
-    /**
-     * @param array $attributes
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getEvent(array $attributes)
-    {
-        switch (true) {
-            case ! empty($attributes['event_id']):
-                $event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
-                break;
-            case ! empty($attributes['datetime_id']):
-                $event = EEM_Event::instance()->get_one(array(
-                    array(
-                        'Datetime.DTT_ID' => $attributes['datetime_id'],
-                    ),
-                ));
-                break;
-            case ! empty($attributes['ticket_id']):
-                $event = EEM_Event::instance()->get_one(array(
-                    array(
-                        'Datetime.Ticket.TKT_ID' => $attributes['ticket_id'],
-                    ),
-                    'default_where_conditions' => 'none'
-                ));
-                break;
-            case is_espresso_event():
-                $event = EEH_Event_View::get_event();
-                break;
-            default:
-                // one last shot...
-                // try getting the earliest active event
-                $events = EEM_Event::instance()->get_active_events(array(
-                    'limit'    => 1,
-                    'order_by' => array('Datetime.DTT_EVT_start' => 'ASC'),
-                ));
-                //  if none then get the next upcoming
-                $events = empty($events)
-                    ? EEM_Event::instance()->get_upcoming_events(array(
-                        'limit'    => 1,
-                        'order_by' => array('Datetime.DTT_EVT_start' => 'ASC'),
-                    ))
-                    : $events;
-                $event = reset($events);
-        }
+	/**
+	 * @param array $attributes
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getEvent(array $attributes)
+	{
+		switch (true) {
+			case ! empty($attributes['event_id']):
+				$event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
+				break;
+			case ! empty($attributes['datetime_id']):
+				$event = EEM_Event::instance()->get_one(array(
+					array(
+						'Datetime.DTT_ID' => $attributes['datetime_id'],
+					),
+				));
+				break;
+			case ! empty($attributes['ticket_id']):
+				$event = EEM_Event::instance()->get_one(array(
+					array(
+						'Datetime.Ticket.TKT_ID' => $attributes['ticket_id'],
+					),
+					'default_where_conditions' => 'none'
+				));
+				break;
+			case is_espresso_event():
+				$event = EEH_Event_View::get_event();
+				break;
+			default:
+				// one last shot...
+				// try getting the earliest active event
+				$events = EEM_Event::instance()->get_active_events(array(
+					'limit'    => 1,
+					'order_by' => array('Datetime.DTT_EVT_start' => 'ASC'),
+				));
+				//  if none then get the next upcoming
+				$events = empty($events)
+					? EEM_Event::instance()->get_upcoming_events(array(
+						'limit'    => 1,
+						'order_by' => array('Datetime.DTT_EVT_start' => 'ASC'),
+					))
+					: $events;
+				$event = reset($events);
+		}
 
-        return $event instanceof EE_Event ? $event : null;
-    }
+		return $event instanceof EE_Event ? $event : null;
+	}
 
 
-    /**
-     * @param array $attributes
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getDatetime(array $attributes)
-    {
-        if (! empty($attributes['datetime_id'])) {
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
-            if ($datetime instanceof EE_Datetime) {
-                return $datetime;
-            }
-        }
-        return null;
-    }
+	/**
+	 * @param array $attributes
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getDatetime(array $attributes)
+	{
+		if (! empty($attributes['datetime_id'])) {
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
+			if ($datetime instanceof EE_Datetime) {
+				return $datetime;
+			}
+		}
+		return null;
+	}
 
 
-    /**
-     * @param array $attributes
-     * @return \EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getTicket(array $attributes)
-    {
-        if (! empty($attributes['ticket_id'])) {
-            $ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
-            if ($ticket instanceof EE_Ticket) {
-                return $ticket;
-            }
-        }
-        return null;
-    }
+	/**
+	 * @param array $attributes
+	 * @return \EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getTicket(array $attributes)
+	{
+		if (! empty($attributes['ticket_id'])) {
+			$ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
+			if ($ticket instanceof EE_Ticket) {
+				return $ticket;
+			}
+		}
+		return null;
+	}
 
 
-    /**
-     * @param array $attributes
-     * @throws EE_Error
-     */
-    private function setAdditionalQueryParams(array $attributes)
-    {
-        $reg_status_array = EEM_Registration::reg_status_array();
-        if (isset($reg_status_array[ $attributes['status'] ])) {
-            $this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
-        }
-        if (absint($attributes['limit'])) {
-            $this->query_params['limit'] = $attributes['limit'];
-        }
-        $this->query_params['group_by'] = array('ATT_ID');
-        $this->query_params['order_by'] = (array) apply_filters(
-            'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by',
-            array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC')
-        );
-    }
+	/**
+	 * @param array $attributes
+	 * @throws EE_Error
+	 */
+	private function setAdditionalQueryParams(array $attributes)
+	{
+		$reg_status_array = EEM_Registration::reg_status_array();
+		if (isset($reg_status_array[ $attributes['status'] ])) {
+			$this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
+		}
+		if (absint($attributes['limit'])) {
+			$this->query_params['limit'] = $attributes['limit'];
+		}
+		$this->query_params['group_by'] = array('ATT_ID');
+		$this->query_params['order_by'] = (array) apply_filters(
+			'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by',
+			array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC')
+		);
+	}
 }

core/CPTs/EE_CPT_Strategy.core.php

Spacing +8 added lines, -8 removed lines

@@ -128,7 +128,7 @@ 
         if (is_array($this->_CPTs)) {
             foreach ($this->_CPTs as $CPT_type => $CPT) {
                 if (isset($CPT['plural_slug'])) {
-                    $_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
+                    $_CPT_endpoints [(string) $CPT['plural_slug']] = $CPT_type;
                 }
             }
         }
@@ -151,7 +151,7 @@ 
     public function pre_get_posts($WP_Query)
     {
         // check that post-type is set
-        if (! $WP_Query instanceof WP_Query) {
+        if ( ! $WP_Query instanceof WP_Query) {
             return;
         }
         // add our conditionals
@@ -195,7 +195,7 @@ 
             $terms = EEM_Term::instance()->get_all_CPT_post_tags();
             foreach ($terms as $term) {
                 if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
+                    $this->_CPT_terms[$term->slug()] = $term;
                 }
             }
         }
@@ -260,7 +260,7 @@ 
             // loop thru our taxonomies
             foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
                 // check if one of our taxonomies is set as a query var
-                if (isset($WP_Query->query[ $CPT_taxonomy ])) {
+                if (isset($WP_Query->query[$CPT_taxonomy])) {
                     // but which CPT does that correspond to??? hmmm... guess we gotta go looping
                     foreach ($this->_CPTs as $post_type => $CPT) {
                         // verify our CPT has args, is public and has taxonomies set
@@ -284,7 +284,7 @@ 
                                     break;
                                 default:
                                     do_action(
-                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_'.$post_type.'_post_type',
                                         $WP_Query,
                                         $this
                                     );
@@ -309,11 +309,11 @@ 
             // loop thru post_types as array
             foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
                 // is current query for an EE CPT ?
-                if (isset($this->_CPTs[ $post_type ])) {
+                if (isset($this->_CPTs[$post_type])) {
                     // is EE on or off ?
                     if (EE_Maintenance_Mode::instance()->level()) {
                         // reroute CPT template view to maintenance_mode.template.php
-                        if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
+                        if ( ! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
                             add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
                         }
                         if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
@@ -341,7 +341,7 @@ 
             'EventEspresso\core\CPTs\CptQueryModifier',
             array(
                 $post_type,
-                $this->_CPTs[ $post_type ],
+                $this->_CPTs[$post_type],
                 $WP_Query,
             )
         );

Indentation +445 added lines, -445 removed lines

@@ -15,449 +15,449 @@
  */
 class EE_CPT_Strategy extends EE_Base
 {
-    /**
-     * @var EE_CPT_Strategy $_instance
-     */
-    private static $_instance;
-
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var array $CPT
-     */
-    protected $CPT;
-
-    /**
-     * return value from CustomPostTypeDefinitions::getDefinitions()
-     *
-     * @var array $_CPTs
-     */
-    protected $_CPTs = array();
-
-    /**
-     * @var array $_CPT_taxonomies
-     */
-    protected $_CPT_taxonomies = array();
-
-    /**
-     * @var array $_CPT_terms
-     */
-    protected $_CPT_terms = array();
-
-    /**
-     * @var array $_CPT_endpoints
-     */
-    protected $_CPT_endpoints = array();
-
-    /**
-     * @var EEM_Base $CPT_model
-     */
-    protected $CPT_model;
-
-    /**
-     * @var EventEspresso\Core\CPTs\CptQueryModifier $query_modifier
-     */
-    protected $query_modifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CustomPostTypeDefinitions|null $custom_post_types
-     * @param CustomTaxonomyDefinitions|null $taxonomies
-     * @return EE_CPT_Strategy
-     */
-    public static function instance(
-        CustomPostTypeDefinitions $custom_post_types = null,
-        CustomTaxonomyDefinitions $taxonomies = null
-    ) {
-        // check if class object is instantiated
-        if (
-            ! self::$_instance instanceof EE_CPT_Strategy
-            && $custom_post_types instanceof CustomPostTypeDefinitions
-            && $taxonomies instanceof CustomTaxonomyDefinitions
-        ) {
-            self::$_instance = new self($custom_post_types, $taxonomies);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param CustomPostTypeDefinitions $custom_post_types
-     * @param CustomTaxonomyDefinitions $taxonomies
-     */
-    protected function __construct(
-        CustomPostTypeDefinitions $custom_post_types,
-        CustomTaxonomyDefinitions $taxonomies
-    ) {
-        // get CPT data
-        $this->_CPTs = $custom_post_types->getDefinitions();
-        $this->_CPT_endpoints = $this->_set_CPT_endpoints();
-        $this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 5);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_endpoints()
-    {
-        return $this->_CPT_endpoints;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_CPT_taxonomies()
-    {
-        return $this->_CPT_taxonomies;
-    }
-
-
-    /**
-     * add CPT "slugs" to array of default espresso "pages"
-     *
-     * @return array
-     */
-    private function _set_CPT_endpoints()
-    {
-        $_CPT_endpoints = array();
-        if (is_array($this->_CPTs)) {
-            foreach ($this->_CPTs as $CPT_type => $CPT) {
-                if (isset($CPT['plural_slug'])) {
-                    $_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
-                }
-            }
-        }
-        return $_CPT_endpoints;
-    }
-
-
-    /**
-     * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
-     * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
-     * adding EE objects to the post to facilitate further querying of related data etc)
-     *
-     * @param WP_Query $WP_Query
-     * @return void
-     * @throws \EE_Error
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // check that post-type is set
-        if (! $WP_Query instanceof WP_Query) {
-            return;
-        }
-        // add our conditionals
-        $this->_set_EE_tags_on_WP_Query($WP_Query);
-        // check for terms
-        $this->_set_post_type_for_terms($WP_Query);
-        // make sure paging is always set
-        $this->_set_paging($WP_Query);
-        // is a taxonomy set ?
-        $this->_set_CPT_taxonomies_on_WP_Query($WP_Query);
-        // loop thru post_types if set
-        $this->_process_WP_Query_post_types($WP_Query);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     */
-    private function _set_EE_tags_on_WP_Query(WP_Query $WP_Query)
-    {
-        $WP_Query->is_espresso_event_single = false;
-        $WP_Query->is_espresso_event_archive = false;
-        $WP_Query->is_espresso_event_taxonomy = false;
-        $WP_Query->is_espresso_venue_single = false;
-        $WP_Query->is_espresso_venue_archive = false;
-        $WP_Query->is_espresso_venue_taxonomy = false;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_CPT_terms()
-    {
-        if (empty($this->_CPT_terms)) {
-            $terms = EEM_Term::instance()->get_all_CPT_post_tags();
-            foreach ($terms as $term) {
-                if ($term instanceof EE_Term) {
-                    $this->_CPT_terms[ $term->slug() ] = $term;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _set_post_type_for_terms(WP_Query $WP_Query)
-    {
-        // is a tag set ?
-        if (isset($WP_Query->query['tag'])) {
-            // get term for tag
-            $term = EEM_Term::instance()->get_post_tag_for_event_or_venue($WP_Query->query['tag']);
-            // verify the term
-            if ($term instanceof EE_Term) {
-                $term->post_type = array_merge(array('post', 'page'), (array) $term->post_type);
-                $term->post_type = apply_filters(
-                    'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
-                    $term->post_type,
-                    $term
-                );
-                // if a post type is already set
-                if (isset($WP_Query->query_vars['post_type'])) {
-                    // add to existing array
-                    $term->post_type = array_merge((array) $WP_Query->query_vars['post_type'], $term->post_type);
-                }
-                // just set post_type to our CPT
-                $WP_Query->set('post_type', array_unique($term->post_type));
-            }
-        }
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return void
-     */
-    public function _set_paging($WP_Query)
-    {
-        if ($WP_Query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
-            $page = get_query_var('page') ? get_query_var('page') : null;
-            $paged = get_query_var('paged') ? get_query_var('paged') : $page;
-            $WP_Query->set('paged', $paged);
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     */
-    protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $WP_Query)
-    {
-        // is a taxonomy set ?
-        if ($WP_Query->is_tax) {
-            // loop thru our taxonomies
-            foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
-                // check if one of our taxonomies is set as a query var
-                if (isset($WP_Query->query[ $CPT_taxonomy ])) {
-                    // but which CPT does that correspond to??? hmmm... guess we gotta go looping
-                    foreach ($this->_CPTs as $post_type => $CPT) {
-                        // verify our CPT has args, is public and has taxonomies set
-                        if (
-                            isset($CPT['args']['public'])
-                            && $CPT['args']['public']
-                            && ! empty($CPT['args']['taxonomies'])
-                            && in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
-                        ) {
-                            // if so, then add this CPT post_type to the current query's array of post_types'
-                            $WP_Query->query_vars['post_type'] = isset($WP_Query->query_vars['post_type'])
-                                ? (array) $WP_Query->query_vars['post_type']
-                                : array();
-                            $WP_Query->query_vars['post_type'][] = $post_type;
-                            switch ($post_type) {
-                                case 'espresso_events':
-                                    $WP_Query->is_espresso_event_taxonomy = true;
-                                    break;
-                                case 'espresso_venues':
-                                    $WP_Query->is_espresso_venue_taxonomy = true;
-                                    break;
-                                default:
-                                    do_action(
-                                        'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
-                                        $WP_Query,
-                                        $this
-                                    );
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_WP_Query_post_types(WP_Query $WP_Query)
-    {
-        if (isset($WP_Query->query_vars['post_type'])) {
-            // loop thru post_types as array
-            foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
-                // is current query for an EE CPT ?
-                if (isset($this->_CPTs[ $post_type ])) {
-                    // is EE on or off ?
-                    if (EE_Maintenance_Mode::instance()->level()) {
-                        // reroute CPT template view to maintenance_mode.template.php
-                        if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
-                            add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
-                        }
-                        if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
-                            add_filter('the_content', array($this, 'inject_EE_shortcode_placeholder'), 1);
-                        }
-                        return;
-                    }
-                    $this->_generate_CptQueryModifier($WP_Query, $post_type);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param \WP_Query $WP_Query
-     * @param string    $post_type
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _generate_CptQueryModifier(WP_Query $WP_Query, $post_type)
-    {
-        $this->query_modifier = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\CPTs\CptQueryModifier',
-            array(
-                $post_type,
-                $this->_CPTs[ $post_type ],
-                $WP_Query,
-            )
-        );
-        $this->_CPT_taxonomies = $this->query_modifier->taxonomies();
-    }
-
-
-    /**
-     * inject_EE_shortcode_placeholder
-     * in order to display the M-Mode notice on our CPT routes,
-     * we need to first inject what looks like one of our shortcodes,
-     * so that it can be replaced with the actual M-Mode notice
-     *
-     * @return string
-     */
-    public function inject_EE_shortcode_placeholder()
-    {
-        return '[ESPRESSO_';
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @return void
-     */
-    public function _possibly_set_ee_request_var()
-    {
-        $this->query_modifier->setRequestVarsIfCpt();
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  $SQL
-     * @return string
-     */
-    public function posts_fields($SQL)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->postsFields($SQL);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  $SQL
-     * @return string
-     */
-    public function posts_join($SQL)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->postsJoin($SQL);
-        }
-        return $SQL;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param  \WP_Post[] $posts
-     * @return \WP_Post[]
-     */
-    public function the_posts($posts)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            $this->query_modifier->thePosts($posts);
-        }
-        return $posts;
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function get_edit_post_link($url, $ID)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->getEditPostLink($url, $ID);
-        }
-        return '';
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param null $WP_Query
-     */
-    protected function _do_template_filters($WP_Query = null)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            $this->query_modifier->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * @deprecated
-     * @since  4.8.41
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function single_cpt_template($current_template)
-    {
-        if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
-            return $this->query_modifier->singleCptTemplate($current_template);
-        }
-        return $current_template;
-    }
+	/**
+	 * @var EE_CPT_Strategy $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var array $CPT
+	 */
+	protected $CPT;
+
+	/**
+	 * return value from CustomPostTypeDefinitions::getDefinitions()
+	 *
+	 * @var array $_CPTs
+	 */
+	protected $_CPTs = array();
+
+	/**
+	 * @var array $_CPT_taxonomies
+	 */
+	protected $_CPT_taxonomies = array();
+
+	/**
+	 * @var array $_CPT_terms
+	 */
+	protected $_CPT_terms = array();
+
+	/**
+	 * @var array $_CPT_endpoints
+	 */
+	protected $_CPT_endpoints = array();
+
+	/**
+	 * @var EEM_Base $CPT_model
+	 */
+	protected $CPT_model;
+
+	/**
+	 * @var EventEspresso\Core\CPTs\CptQueryModifier $query_modifier
+	 */
+	protected $query_modifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CustomPostTypeDefinitions|null $custom_post_types
+	 * @param CustomTaxonomyDefinitions|null $taxonomies
+	 * @return EE_CPT_Strategy
+	 */
+	public static function instance(
+		CustomPostTypeDefinitions $custom_post_types = null,
+		CustomTaxonomyDefinitions $taxonomies = null
+	) {
+		// check if class object is instantiated
+		if (
+			! self::$_instance instanceof EE_CPT_Strategy
+			&& $custom_post_types instanceof CustomPostTypeDefinitions
+			&& $taxonomies instanceof CustomTaxonomyDefinitions
+		) {
+			self::$_instance = new self($custom_post_types, $taxonomies);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 * @param CustomTaxonomyDefinitions $taxonomies
+	 */
+	protected function __construct(
+		CustomPostTypeDefinitions $custom_post_types,
+		CustomTaxonomyDefinitions $taxonomies
+	) {
+		// get CPT data
+		$this->_CPTs = $custom_post_types->getDefinitions();
+		$this->_CPT_endpoints = $this->_set_CPT_endpoints();
+		$this->_CPT_taxonomies = $taxonomies->getCustomTaxonomyDefinitions();
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 5);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_endpoints()
+	{
+		return $this->_CPT_endpoints;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_CPT_taxonomies()
+	{
+		return $this->_CPT_taxonomies;
+	}
+
+
+	/**
+	 * add CPT "slugs" to array of default espresso "pages"
+	 *
+	 * @return array
+	 */
+	private function _set_CPT_endpoints()
+	{
+		$_CPT_endpoints = array();
+		if (is_array($this->_CPTs)) {
+			foreach ($this->_CPTs as $CPT_type => $CPT) {
+				if (isset($CPT['plural_slug'])) {
+					$_CPT_endpoints [ (string) $CPT['plural_slug'] ] = $CPT_type;
+				}
+			}
+		}
+		return $_CPT_endpoints;
+	}
+
+
+	/**
+	 * If this query (not just "main" queries (ie, for WP's infamous "loop")) is for an EE CPT, then we want to
+	 * supercharge the get_posts query to add our EE stuff (like joining to our tables, selecting extra columns, and
+	 * adding EE objects to the post to facilitate further querying of related data etc)
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 * @throws \EE_Error
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// check that post-type is set
+		if (! $WP_Query instanceof WP_Query) {
+			return;
+		}
+		// add our conditionals
+		$this->_set_EE_tags_on_WP_Query($WP_Query);
+		// check for terms
+		$this->_set_post_type_for_terms($WP_Query);
+		// make sure paging is always set
+		$this->_set_paging($WP_Query);
+		// is a taxonomy set ?
+		$this->_set_CPT_taxonomies_on_WP_Query($WP_Query);
+		// loop thru post_types if set
+		$this->_process_WP_Query_post_types($WP_Query);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 */
+	private function _set_EE_tags_on_WP_Query(WP_Query $WP_Query)
+	{
+		$WP_Query->is_espresso_event_single = false;
+		$WP_Query->is_espresso_event_archive = false;
+		$WP_Query->is_espresso_event_taxonomy = false;
+		$WP_Query->is_espresso_venue_single = false;
+		$WP_Query->is_espresso_venue_archive = false;
+		$WP_Query->is_espresso_venue_taxonomy = false;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_CPT_terms()
+	{
+		if (empty($this->_CPT_terms)) {
+			$terms = EEM_Term::instance()->get_all_CPT_post_tags();
+			foreach ($terms as $term) {
+				if ($term instanceof EE_Term) {
+					$this->_CPT_terms[ $term->slug() ] = $term;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _set_post_type_for_terms(WP_Query $WP_Query)
+	{
+		// is a tag set ?
+		if (isset($WP_Query->query['tag'])) {
+			// get term for tag
+			$term = EEM_Term::instance()->get_post_tag_for_event_or_venue($WP_Query->query['tag']);
+			// verify the term
+			if ($term instanceof EE_Term) {
+				$term->post_type = array_merge(array('post', 'page'), (array) $term->post_type);
+				$term->post_type = apply_filters(
+					'FHEE__EE_CPT_Strategy___set_post_type_for_terms__term_post_type',
+					$term->post_type,
+					$term
+				);
+				// if a post type is already set
+				if (isset($WP_Query->query_vars['post_type'])) {
+					// add to existing array
+					$term->post_type = array_merge((array) $WP_Query->query_vars['post_type'], $term->post_type);
+				}
+				// just set post_type to our CPT
+				$WP_Query->set('post_type', array_unique($term->post_type));
+			}
+		}
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return void
+	 */
+	public function _set_paging($WP_Query)
+	{
+		if ($WP_Query->is_main_query() && apply_filters('FHEE__EE_CPT_Strategy___set_paging', true)) {
+			$page = get_query_var('page') ? get_query_var('page') : null;
+			$paged = get_query_var('paged') ? get_query_var('paged') : $page;
+			$WP_Query->set('paged', $paged);
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 */
+	protected function _set_CPT_taxonomies_on_WP_Query(WP_Query $WP_Query)
+	{
+		// is a taxonomy set ?
+		if ($WP_Query->is_tax) {
+			// loop thru our taxonomies
+			foreach ($this->_CPT_taxonomies as $CPT_taxonomy => $CPT_taxonomy_details) {
+				// check if one of our taxonomies is set as a query var
+				if (isset($WP_Query->query[ $CPT_taxonomy ])) {
+					// but which CPT does that correspond to??? hmmm... guess we gotta go looping
+					foreach ($this->_CPTs as $post_type => $CPT) {
+						// verify our CPT has args, is public and has taxonomies set
+						if (
+							isset($CPT['args']['public'])
+							&& $CPT['args']['public']
+							&& ! empty($CPT['args']['taxonomies'])
+							&& in_array($CPT_taxonomy, $CPT['args']['taxonomies'], true)
+						) {
+							// if so, then add this CPT post_type to the current query's array of post_types'
+							$WP_Query->query_vars['post_type'] = isset($WP_Query->query_vars['post_type'])
+								? (array) $WP_Query->query_vars['post_type']
+								: array();
+							$WP_Query->query_vars['post_type'][] = $post_type;
+							switch ($post_type) {
+								case 'espresso_events':
+									$WP_Query->is_espresso_event_taxonomy = true;
+									break;
+								case 'espresso_venues':
+									$WP_Query->is_espresso_venue_taxonomy = true;
+									break;
+								default:
+									do_action(
+										'AHEE__EE_CPT_Strategy___set_CPT_taxonomies_on_WP_Query__for_' . $post_type . '_post_type',
+										$WP_Query,
+										$this
+									);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_WP_Query_post_types(WP_Query $WP_Query)
+	{
+		if (isset($WP_Query->query_vars['post_type'])) {
+			// loop thru post_types as array
+			foreach ((array) $WP_Query->query_vars['post_type'] as $post_type) {
+				// is current query for an EE CPT ?
+				if (isset($this->_CPTs[ $post_type ])) {
+					// is EE on or off ?
+					if (EE_Maintenance_Mode::instance()->level()) {
+						// reroute CPT template view to maintenance_mode.template.php
+						if (! has_filter('template_include', array('EE_Maintenance_Mode', 'template_include'))) {
+							add_filter('template_include', array('EE_Maintenance_Mode', 'template_include'), 99999);
+						}
+						if (has_filter('the_content', array(EE_Maintenance_Mode::instance(), 'the_content'))) {
+							add_filter('the_content', array($this, 'inject_EE_shortcode_placeholder'), 1);
+						}
+						return;
+					}
+					$this->_generate_CptQueryModifier($WP_Query, $post_type);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param \WP_Query $WP_Query
+	 * @param string    $post_type
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _generate_CptQueryModifier(WP_Query $WP_Query, $post_type)
+	{
+		$this->query_modifier = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\CPTs\CptQueryModifier',
+			array(
+				$post_type,
+				$this->_CPTs[ $post_type ],
+				$WP_Query,
+			)
+		);
+		$this->_CPT_taxonomies = $this->query_modifier->taxonomies();
+	}
+
+
+	/**
+	 * inject_EE_shortcode_placeholder
+	 * in order to display the M-Mode notice on our CPT routes,
+	 * we need to first inject what looks like one of our shortcodes,
+	 * so that it can be replaced with the actual M-Mode notice
+	 *
+	 * @return string
+	 */
+	public function inject_EE_shortcode_placeholder()
+	{
+		return '[ESPRESSO_';
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @return void
+	 */
+	public function _possibly_set_ee_request_var()
+	{
+		$this->query_modifier->setRequestVarsIfCpt();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function posts_fields($SQL)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->postsFields($SQL);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function posts_join($SQL)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->postsJoin($SQL);
+		}
+		return $SQL;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param  \WP_Post[] $posts
+	 * @return \WP_Post[]
+	 */
+	public function the_posts($posts)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			$this->query_modifier->thePosts($posts);
+		}
+		return $posts;
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function get_edit_post_link($url, $ID)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->getEditPostLink($url, $ID);
+		}
+		return '';
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param null $WP_Query
+	 */
+	protected function _do_template_filters($WP_Query = null)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			$this->query_modifier->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since  4.8.41
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function single_cpt_template($current_template)
+	{
+		if ($this->query_modifier instanceof EventEspresso\Core\CPTs\CptQueryModifier) {
+			return $this->query_modifier->singleCptTemplate($current_template);
+		}
+		return $current_template;
+	}
 }

core/CPTs/EE_CPT_Event_Strategy.core.php

Spacing +8 added lines, -8 removed lines

@@ -122,13 +122,13 @@ 
             )
         ) {
             // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+            $SQL .= ', '.EEM_Datetime::instance()->table().'.* ';
             if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
                 // because we only want to retrieve the next upcoming datetime for each event:
                 // add something like:
                 // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
                 // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+                $SQL .= ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
             }
         }
         return $SQL;
@@ -158,9 +158,9 @@ 
             // adds something like:
             // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
             // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
+            $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.EEM_Event::instance()->table()
+                    . '.ID = '.EEM_Datetime::instance()->table().'.'
+                    . EEM_Event::instance()->primary_key_name().' ) ';
         }
         return $SQL;
     }
@@ -190,8 +190,8 @@ 
                 || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
                 || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
             ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
+                $SQL .= ' AND '.EEM_Datetime::instance()->table().".DTT_EVT_end > '"
+                        . current_time('mysql', true)."' ";
             }
         }
         return $SQL;
@@ -239,7 +239,7 @@ 
             // but we want to only show each event only once
             // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
             global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
+            $SQL = $wpdb->posts.'.ID ';
         }
         return $SQL;
     }

Indentation +232 added lines, -232 removed lines

@@ -12,258 +12,258 @@
  */
 class EE_CPT_Event_Strategy
 {
-    /**
-     * the current page, if it utilizes CPTs
-     *
-     * @var object $CPT
-     */
-    protected $CPT;
+	/**
+	 * the current page, if it utilizes CPTs
+	 *
+	 * @var object $CPT
+	 */
+	protected $CPT;
 
 
-    /**
-     * @param WP_Query $wp_query
-     * @param array    $CPT
-     */
-    public function __construct($wp_query, $CPT = array())
-    {
-        if ($wp_query instanceof WP_Query) {
-            $WP_Query = $wp_query;
-            $this->CPT = $CPT;
-        } else {
-            $WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
-            $this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
-        }
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where'
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        $this->_add_filters();
-        if ($WP_Query instanceof WP_Query) {
-            $WP_Query->is_espresso_event_single = is_singular()
-                                                  && isset($WP_Query->query->post_type)
-                                                  && $WP_Query->query->post_type === 'espresso_events';
-            $WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
-            $WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
-        }
-    }
+	/**
+	 * @param WP_Query $wp_query
+	 * @param array    $CPT
+	 */
+	public function __construct($wp_query, $CPT = array())
+	{
+		if ($wp_query instanceof WP_Query) {
+			$WP_Query = $wp_query;
+			$this->CPT = $CPT;
+		} else {
+			$WP_Query = isset($wp_query['WP_Query']) ? $wp_query['WP_Query'] : null;
+			$this->CPT = isset($wp_query['CPT']) ? $wp_query['CPT'] : null;
+		}
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where'
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		$this->_add_filters();
+		if ($WP_Query instanceof WP_Query) {
+			$WP_Query->is_espresso_event_single = is_singular()
+												  && isset($WP_Query->query->post_type)
+												  && $WP_Query->query->post_type === 'espresso_events';
+			$WP_Query->is_espresso_event_archive = is_post_type_archive('espresso_events');
+			$WP_Query->is_espresso_event_taxonomy = is_tax('espresso_event_categories');
+		}
+	}
 
 
-    /**
-     * When an instance of this class is created, we add our filters
-     * (which will get removed in case the next call to get_posts ISN'T
-     * for event CPTs)
-     */
-    protected function _add_filters()
-    {
-        add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
-        add_filter('posts_join', array($this, 'posts_join'), 1, 2);
-        add_filter('posts_where', array($this, 'posts_where'), 10, 2);
-        // add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
-        add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
-        add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
-        add_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * When an instance of this class is created, we add our filters
+	 * (which will get removed in case the next call to get_posts ISN'T
+	 * for event CPTs)
+	 */
+	protected function _add_filters()
+	{
+		add_filter('posts_fields', array($this, 'posts_fields'), 1, 2);
+		add_filter('posts_join', array($this, 'posts_join'), 1, 2);
+		add_filter('posts_where', array($this, 'posts_where'), 10, 2);
+		// add_filter( 'the_posts', array( $this, 'the_posts' ), 1, 2 );
+		add_filter('posts_orderby', array($this, 'posts_orderby'), 1, 2);
+		add_filter('posts_groupby', array($this, 'posts_groupby'), 1, 2);
+		add_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * public access to _remove_filters()
-     *
-     * @since 4.9.63.p
-     */
-    public function remove_filters()
-    {
-        $this->_remove_filters();
-    }
+	/**
+	 * public access to _remove_filters()
+	 *
+	 * @since 4.9.63.p
+	 */
+	public function remove_filters()
+	{
+		$this->_remove_filters();
+	}
 
 
-    /**
-     * Should eb called when the last filter or hook is fired for this CPT strategy.
-     * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
-     * we don't want to join to the datetime table when querying for venues, do we!?)
-     */
-    protected function _remove_filters()
-    {
-        remove_filter('posts_fields', array($this, 'posts_fields'), 1);
-        remove_filter('posts_join', array($this, 'posts_join'), 1);
-        remove_filter('posts_where', array($this, 'posts_where'), 10);
-        // remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
-        remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
-        remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
-        remove_action('posts_selection', array($this, 'remove_filters'));
-    }
+	/**
+	 * Should eb called when the last filter or hook is fired for this CPT strategy.
+	 * This is to avoid applying this CPT strategy for other posts or CPTs (eg,
+	 * we don't want to join to the datetime table when querying for venues, do we!?)
+	 */
+	protected function _remove_filters()
+	{
+		remove_filter('posts_fields', array($this, 'posts_fields'), 1);
+		remove_filter('posts_join', array($this, 'posts_join'), 1);
+		remove_filter('posts_where', array($this, 'posts_where'), 10);
+		// remove_filter( 'the_posts', array( $this, 'the_posts' ), 1 );
+		remove_filter('posts_orderby', array($this, 'posts_orderby'), 1);
+		remove_filter('posts_groupby', array($this, 'posts_groupby'), 1);
+		remove_action('posts_selection', array($this, 'remove_filters'));
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return    string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
-            if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
-                // because we only want to retrieve the next upcoming datetime for each event:
-                // add something like:
-                // ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
-                // to WP Query SELECT statement
-                $SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return    string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= ', ' . EEM_Datetime::instance()->table() . '.* ';
+			if ($wp_query->is_espresso_event_archive || $wp_query->is_espresso_event_taxonomy) {
+				// because we only want to retrieve the next upcoming datetime for each event:
+				// add something like:
+				// ", MIN( wp_esp_datetime.DTT_EVT_start ) as event_start_date "
+				// to WP Query SELECT statement
+				$SQL .= ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_single
-                || $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // adds something like:
-            // " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
-            // to WP Query JOIN statement
-            $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
-                    . '.ID = ' . EEM_Datetime::instance()->table() . '.'
-                    . EEM_Event::instance()->primary_key_name() . ' ) ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_single
+				|| $wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// adds something like:
+			// " LEFT JOIN wp_esp_datetime ON ( wp_esp_datetime.EVT_ID = wp_posts.ID ) "
+			// to WP Query JOIN statement
+			$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . EEM_Event::instance()->table()
+					. '.ID = ' . EEM_Datetime::instance()->table() . '.'
+					. EEM_Event::instance()->primary_key_name() . ' ) ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            if (
-                ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
-                || ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
-                || ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
-            ) {
-                $SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
-                        . current_time('mysql', true) . "' ";
-            }
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			if (
+				! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive)
+				|| ! isset(EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events)
+				|| ! EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->display_expired_events
+			) {
+				$SQL .= ' AND ' . EEM_Datetime::instance()->table() . ".DTT_EVT_end > '"
+						. current_time('mysql', true) . "' ";
+			}
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            $SQL = ' event_start_date ASC ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			$SQL = ' event_start_date ASC ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     */
-    public function posts_groupby($SQL, WP_Query $wp_query)
-    {
-        if (
-            $wp_query instanceof WP_Query
-            &&
-            (
-                $wp_query->is_espresso_event_archive
-                || $wp_query->is_espresso_event_taxonomy
-            )
-        ) {
-            // TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
-            // we're joining to the datetimes table, where there can be MANY datetimes for a single event,
-            // but we want to only show each event only once
-            // (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
-            global $wpdb;
-            $SQL = $wpdb->posts . '.ID ';
-        }
-        return $SQL;
-    }
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 */
+	public function posts_groupby($SQL, WP_Query $wp_query)
+	{
+		if (
+			$wp_query instanceof WP_Query
+			&&
+			(
+				$wp_query->is_espresso_event_archive
+				|| $wp_query->is_espresso_event_taxonomy
+			)
+		) {
+			// TODO: add event list option for displaying ALL datetimes in event list or only primary datetime (default)
+			// we're joining to the datetimes table, where there can be MANY datetimes for a single event,
+			// but we want to only show each event only once
+			// (whereas if we didn't group them by the post's ID, then we would end up with many repeats)
+			global $wpdb;
+			$SQL = $wpdb->posts . '.ID ';
+		}
+		return $SQL;
+	}
 
 
-    /**
-     * @param array    $posts
-     * @param WP_Query $wp_query
-     * @return array
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 * @param array    $posts
+	 * @param WP_Query $wp_query
+	 * @return array
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 
 
-    /**
-     * @param null $meta_value
-     * @param      $post_id
-     * @param      $meta_key
-     * @param      $single
-     * @return    string
-     */
-    public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
-    {
-        return $meta_value;
-    }
+	/**
+	 * @param null $meta_value
+	 * @param      $post_id
+	 * @param      $meta_key
+	 * @param      $single
+	 * @return    string
+	 */
+	public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
+	{
+		return $meta_value;
+	}
 }