eventespresso / event-espresso-core

core/db_models/helpers/EE_Model_Parser.php

Indentation +144 added lines, -144 removed lines

@@ -9,153 +9,153 @@
  */
 class EE_Model_Parser
 {
-    const table_alias_model_relation_chain_separator = '__';
-    const table_alias_model_relation_chain_prefix_end = '___';
-    /**
-     * Adds a period onto the front and end of the string. This often helps in searching.
-     * For example, if we want to find the model name "Event", it can be tricky when the following are possible
-     * "","Event.EVT_ID","Event","Event_Venue.Venue.VNU_ID",etc. It's easier to look for ".Event." in
-     * "..",".Event.EVT_ID.", ".Event.", and ".Event_Venue.Venue.VNU_ID", especially when the last example should NOT
-     * be found because the "Event" model isn't mentioned- it's just a string that has a model name that coincidentally
-     * has it as a substring
-     * @param string $string_to_pad
-     * @return string
-     */
-    public static function pad_with_periods($string_to_pad)
-    {
-        return "." . $string_to_pad . ".";
-    }
-    /**
-     * Basically undoes _pad_with_periods
-     * @param string $string_to_trim
-     * @return string
-     */
-    public static function trim_periods($string_to_trim)
-    {
-        return trim($string_to_trim, '.');
-    }
+	const table_alias_model_relation_chain_separator = '__';
+	const table_alias_model_relation_chain_prefix_end = '___';
+	/**
+	 * Adds a period onto the front and end of the string. This often helps in searching.
+	 * For example, if we want to find the model name "Event", it can be tricky when the following are possible
+	 * "","Event.EVT_ID","Event","Event_Venue.Venue.VNU_ID",etc. It's easier to look for ".Event." in
+	 * "..",".Event.EVT_ID.", ".Event.", and ".Event_Venue.Venue.VNU_ID", especially when the last example should NOT
+	 * be found because the "Event" model isn't mentioned- it's just a string that has a model name that coincidentally
+	 * has it as a substring
+	 * @param string $string_to_pad
+	 * @return string
+	 */
+	public static function pad_with_periods($string_to_pad)
+	{
+		return "." . $string_to_pad . ".";
+	}
+	/**
+	 * Basically undoes _pad_with_periods
+	 * @param string $string_to_trim
+	 * @return string
+	 */
+	public static function trim_periods($string_to_trim)
+	{
+		return trim($string_to_trim, '.');
+	}
 
 
 
-    /**
-     * Gets the calculated table's alias
-     * @param string $model_relation_chain or query param
-     * @param        $this_model_name
-     * @return string which can be added onto table aliases to make them unique
-     */
-    public static function extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this_model_name)
-    {
-        // eg $model_relation_chain = 'Venue.Event_Venue.Event.Registration", and $this_model_name = 'Event'
-        $model_relation_chain = self::pad_with_periods($model_relation_chain);
-        $this_model_name = self::pad_with_periods($this_model_name);
-        // eg '.Venue.Event_Venue.Event.Registration." and '.Event.'
-        // remove this model name and everything afterwards
-        $pos_of_model_name = strpos($model_relation_chain, $this_model_name);
-        $model_relation_chain = substr($model_relation_chain, 0, $pos_of_model_name);
-        // eg '.Venue.Event_Venue.'
-        // trim periods
-        $model_relation_chain = self::trim_periods($model_relation_chain);
-        // eg 'Venue.Event_Venue'
-        // replace periods with double-underscores
-        $model_relation_chain = str_replace(".", self::table_alias_model_relation_chain_separator, $model_relation_chain);
-        // eg 'Venue__Event_Venue'
-        if ($model_relation_chain != '') {
-            $model_relation_chain = $model_relation_chain . self::table_alias_model_relation_chain_prefix_end;
-        }
-        // eg 'Venue_Event_Venue___'
-        return $model_relation_chain;
-    }
-    /**
-     * Gets the table's alias (without prefix or anything)
-     * @param string $table_alias_with_model_relation_chain_prefix which CAN have a table alias model relation chain prefix (or not)
-     * @return string
-     */
-    public static function remove_table_alias_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
-    {
-        // does this actually have a table alias model relation chain prefix?
-        $pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
-        if ($pos !== false) {
-            // yes
-            // find that triple underscore and remove it and everything before it
-            $table_alias = substr($table_alias_with_model_relation_chain_prefix, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
-        } else {
-            $table_alias = $table_alias_with_model_relation_chain_prefix;
-        }
-        return $table_alias;
-    }
-    /**
-     * Gets the table alias model relation chain prefix from the table alias already containing it
-     * @param string $table_alias_with_model_relation_chain_prefix
-     * @return string
-     */
-    public static function get_prefix_from_table_alias_with_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
-    {
-        // does this actually have a table alias model relation chain prefix?
-        $pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
-        if ($pos !== false) {
-            // yes
-            // find that triple underscore and remove it and everything before it
-            $prefix = substr($table_alias_with_model_relation_chain_prefix, 0, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
-        } else {
-            $prefix = '';
-        }
-        return $prefix;
-    }
+	/**
+	 * Gets the calculated table's alias
+	 * @param string $model_relation_chain or query param
+	 * @param        $this_model_name
+	 * @return string which can be added onto table aliases to make them unique
+	 */
+	public static function extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this_model_name)
+	{
+		// eg $model_relation_chain = 'Venue.Event_Venue.Event.Registration", and $this_model_name = 'Event'
+		$model_relation_chain = self::pad_with_periods($model_relation_chain);
+		$this_model_name = self::pad_with_periods($this_model_name);
+		// eg '.Venue.Event_Venue.Event.Registration." and '.Event.'
+		// remove this model name and everything afterwards
+		$pos_of_model_name = strpos($model_relation_chain, $this_model_name);
+		$model_relation_chain = substr($model_relation_chain, 0, $pos_of_model_name);
+		// eg '.Venue.Event_Venue.'
+		// trim periods
+		$model_relation_chain = self::trim_periods($model_relation_chain);
+		// eg 'Venue.Event_Venue'
+		// replace periods with double-underscores
+		$model_relation_chain = str_replace(".", self::table_alias_model_relation_chain_separator, $model_relation_chain);
+		// eg 'Venue__Event_Venue'
+		if ($model_relation_chain != '') {
+			$model_relation_chain = $model_relation_chain . self::table_alias_model_relation_chain_prefix_end;
+		}
+		// eg 'Venue_Event_Venue___'
+		return $model_relation_chain;
+	}
+	/**
+	 * Gets the table's alias (without prefix or anything)
+	 * @param string $table_alias_with_model_relation_chain_prefix which CAN have a table alias model relation chain prefix (or not)
+	 * @return string
+	 */
+	public static function remove_table_alias_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
+	{
+		// does this actually have a table alias model relation chain prefix?
+		$pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
+		if ($pos !== false) {
+			// yes
+			// find that triple underscore and remove it and everything before it
+			$table_alias = substr($table_alias_with_model_relation_chain_prefix, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
+		} else {
+			$table_alias = $table_alias_with_model_relation_chain_prefix;
+		}
+		return $table_alias;
+	}
+	/**
+	 * Gets the table alias model relation chain prefix from the table alias already containing it
+	 * @param string $table_alias_with_model_relation_chain_prefix
+	 * @return string
+	 */
+	public static function get_prefix_from_table_alias_with_model_relation_chain_prefix($table_alias_with_model_relation_chain_prefix)
+	{
+		// does this actually have a table alias model relation chain prefix?
+		$pos = strpos($table_alias_with_model_relation_chain_prefix, self::table_alias_model_relation_chain_prefix_end);
+		if ($pos !== false) {
+			// yes
+			// find that triple underscore and remove it and everything before it
+			$prefix = substr($table_alias_with_model_relation_chain_prefix, 0, $pos + strlen(self::table_alias_model_relation_chain_prefix_end));
+		} else {
+			$prefix = '';
+		}
+		return $prefix;
+	}
 
-    /**
-     * Gets the table alias model relation chain prefix (ie, what can be prepended onto
-     * EE_Model_Field::get_qualified_column() to get the proper column name for that field
-     * in a specific query) from teh query param (eg 'Registration.Event.EVT_ID').
-     *
-     * @param string $model_name of the model on which the related query param was found to be belong
-     * @param string $original_query_param
-     * @return string
-     */
-    public static function extract_table_alias_model_relation_chain_from_query_param($model_name, $original_query_param)
-    {
-        $relation_chain = self::extract_model_relation_chain($model_name, $original_query_param);
-        $table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($relation_chain, $model_name);
-        return $table_alias_with_model_relation_chain_prefix;
-    }
-    /**
-     * Gets the model relation chain to $model_name from the $original_query_param.
-     * Eg, if $model_name were 'Payment', and $original_query_param were 'Registration.Transaction.Payment.PAY_ID',
-     * this would return 'Registration.Transaction.Payment'. Also if the query param were 'Registration.Transaction.Payment'
-     * and $model_name were 'Payment', it should return 'Registration.Transaction.Payment'
-     * @param string $model_name
-     * @param string $original_query_param
-     * @return string
-     */
-    public static function extract_model_relation_chain($model_name, $original_query_param)
-    {
-        // prefix and postfix both with a period, as this facilitates searching
-        $model_name = EE_Model_Parser::pad_with_periods($model_name);
-        $original_query_param = EE_Model_Parser::pad_with_periods($original_query_param);
-        $pos_of_model_string = strpos($original_query_param, $model_name);
-        // eg, if we're looking for the model relation chain from Event to Payment, the original query param is probably something like
-        // "Registration.Transaction.Payment.PAY_ID", $pos_of_model_string points to the 'P' or Payment. We want the string
-        // "Registration.Transaction.Payment"
-        $model_relation_chain = substr($original_query_param, 0, $pos_of_model_string + strlen($model_name));
-        return EE_Model_Parser::trim_periods($model_relation_chain);
-    }
+	/**
+	 * Gets the table alias model relation chain prefix (ie, what can be prepended onto
+	 * EE_Model_Field::get_qualified_column() to get the proper column name for that field
+	 * in a specific query) from teh query param (eg 'Registration.Event.EVT_ID').
+	 *
+	 * @param string $model_name of the model on which the related query param was found to be belong
+	 * @param string $original_query_param
+	 * @return string
+	 */
+	public static function extract_table_alias_model_relation_chain_from_query_param($model_name, $original_query_param)
+	{
+		$relation_chain = self::extract_model_relation_chain($model_name, $original_query_param);
+		$table_alias_with_model_relation_chain_prefix = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($relation_chain, $model_name);
+		return $table_alias_with_model_relation_chain_prefix;
+	}
+	/**
+	 * Gets the model relation chain to $model_name from the $original_query_param.
+	 * Eg, if $model_name were 'Payment', and $original_query_param were 'Registration.Transaction.Payment.PAY_ID',
+	 * this would return 'Registration.Transaction.Payment'. Also if the query param were 'Registration.Transaction.Payment'
+	 * and $model_name were 'Payment', it should return 'Registration.Transaction.Payment'
+	 * @param string $model_name
+	 * @param string $original_query_param
+	 * @return string
+	 */
+	public static function extract_model_relation_chain($model_name, $original_query_param)
+	{
+		// prefix and postfix both with a period, as this facilitates searching
+		$model_name = EE_Model_Parser::pad_with_periods($model_name);
+		$original_query_param = EE_Model_Parser::pad_with_periods($original_query_param);
+		$pos_of_model_string = strpos($original_query_param, $model_name);
+		// eg, if we're looking for the model relation chain from Event to Payment, the original query param is probably something like
+		// "Registration.Transaction.Payment.PAY_ID", $pos_of_model_string points to the 'P' or Payment. We want the string
+		// "Registration.Transaction.Payment"
+		$model_relation_chain = substr($original_query_param, 0, $pos_of_model_string + strlen($model_name));
+		return EE_Model_Parser::trim_periods($model_relation_chain);
+	}
 
-    /**
-     * Replaces the specified model in teh model relation chain with teh join model.
-     * Eg EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
-     * "Ticket", "Datetime_Ticket", "Datetime.Ticket" ) will return
-     * "Datetime.Datetime_Ticket" which can be used to find the table alias model relation chain prefix
-     * using EE_Model_Parser::extract_table_alias_model_relation_chain_prefix
-     * @param string $model_name
-     * @param string $join_model_name
-     * @param string $model_relation_chain
-     * @return string
-     */
-    public static function replace_model_name_with_join_model_name_in_model_relation_chain($model_name, $join_model_name, $model_relation_chain)
-    {
-        $model_name = EE_Model_Parser::pad_with_periods($model_name);
-        $join_model_name = EE_Model_Parser::pad_with_periods($join_model_name);
-        $model_relation_chain = EE_Model_Parser::pad_with_periods($model_relation_chain);
-        $replaced_with_periods = str_replace($model_name, $join_model_name, $model_relation_chain);
-        return EE_Model_Parser::trim_periods($replaced_with_periods);
-    }
+	/**
+	 * Replaces the specified model in teh model relation chain with teh join model.
+	 * Eg EE_Model_Parser::replace_model_name_with_join_model_name_in_model_relation_chain(
+	 * "Ticket", "Datetime_Ticket", "Datetime.Ticket" ) will return
+	 * "Datetime.Datetime_Ticket" which can be used to find the table alias model relation chain prefix
+	 * using EE_Model_Parser::extract_table_alias_model_relation_chain_prefix
+	 * @param string $model_name
+	 * @param string $join_model_name
+	 * @param string $model_relation_chain
+	 * @return string
+	 */
+	public static function replace_model_name_with_join_model_name_in_model_relation_chain($model_name, $join_model_name, $model_relation_chain)
+	{
+		$model_name = EE_Model_Parser::pad_with_periods($model_name);
+		$join_model_name = EE_Model_Parser::pad_with_periods($join_model_name);
+		$model_relation_chain = EE_Model_Parser::pad_with_periods($model_relation_chain);
+		$replaced_with_periods = str_replace($model_name, $join_model_name, $model_relation_chain);
+		return EE_Model_Parser::trim_periods($replaced_with_periods);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      */
     public static function pad_with_periods($string_to_pad)
     {
-        return "." . $string_to_pad . ".";
+        return ".".$string_to_pad.".";
     }
     /**
      * Basically undoes _pad_with_periods
@@ -60,7 +60,7 @@ 
         $model_relation_chain = str_replace(".", self::table_alias_model_relation_chain_separator, $model_relation_chain);
         // eg 'Venue__Event_Venue'
         if ($model_relation_chain != '') {
-            $model_relation_chain = $model_relation_chain . self::table_alias_model_relation_chain_prefix_end;
+            $model_relation_chain = $model_relation_chain.self::table_alias_model_relation_chain_prefix_end;
         }
         // eg 'Venue_Event_Venue___'
         return $model_relation_chain;

core/db_models/helpers/EE_Index.php

Indentation +41 added lines, -41 removed lines

@@ -6,45 +6,45 @@
  */
 class EE_Index
 {
-    protected $_name;
-    protected $_field_names;
-    protected $_model_name;
-    public function __construct($fields)
-    {
-        $this->_field_names = $fields;
-    }
-    public function _construct_finalize($name, $model_name)
-    {
-        $this->_name = $name;
-        $this->_model_name = $model_name;
-    }
-    public function field_names()
-    {
-        return $this->_field_names;
-    }
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     */
-    protected function _get_model($model_name)
-    {
-        $modelInstance = call_user_func("EEM_" . $model_name . "::instance");
-        return $modelInstance;
-    }
-    /**
-     * Gets all the fields for this index
-     * @return EE_Model_Field_Base[]
-     */
-    public function fields()
-    {
-        $fields = array();
-        $model = $this->_get_model($this->_model_name);
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (in_array($field_name, $this->field_names())) {
-                $fields[ $field_name ] = $field_obj;
-            }
-        }
-        return $fields;
-    }
+	protected $_name;
+	protected $_field_names;
+	protected $_model_name;
+	public function __construct($fields)
+	{
+		$this->_field_names = $fields;
+	}
+	public function _construct_finalize($name, $model_name)
+	{
+		$this->_name = $name;
+		$this->_model_name = $model_name;
+	}
+	public function field_names()
+	{
+		return $this->_field_names;
+	}
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 */
+	protected function _get_model($model_name)
+	{
+		$modelInstance = call_user_func("EEM_" . $model_name . "::instance");
+		return $modelInstance;
+	}
+	/**
+	 * Gets all the fields for this index
+	 * @return EE_Model_Field_Base[]
+	 */
+	public function fields()
+	{
+		$fields = array();
+		$model = $this->_get_model($this->_model_name);
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (in_array($field_name, $this->field_names())) {
+				$fields[ $field_name ] = $field_obj;
+			}
+		}
+		return $fields;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     protected function _get_model($model_name)
     {
-        $modelInstance = call_user_func("EEM_" . $model_name . "::instance");
+        $modelInstance = call_user_func("EEM_".$model_name."::instance");
         return $modelInstance;
     }
     /**
@@ -42,7 +42,7 @@ 
         $model = $this->_get_model($this->_model_name);
         foreach ($model->field_settings() as $field_name => $field_obj) {
             if (in_array($field_name, $this->field_names())) {
-                $fields[ $field_name ] = $field_obj;
+                $fields[$field_name] = $field_obj;
             }
         }
         return $fields;

core/db_models/helpers/EE_Primary_Table.php

Spacing +1 added lines, -1 removed lines

@@ -25,6 +25,6 @@
      */
     public function get_table_sql()
     {
-        return " " . $this->get_table_name() . " AS " . $this->get_table_alias() . " ";
+        return " ".$this->get_table_name()." AS ".$this->get_table_alias()." ";
     }
 }

Indentation +20 added lines, -20 removed lines

@@ -6,24 +6,24 @@
  */
 class EE_Primary_Table extends EE_Table_Base
 {
-    /**
-     *
-     * @global wpdb $wpdb
-     * @param string $table_name with or without wpdb prefix
-     * @param string $pk_column name of primary key column
-     * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
-     *                  or whether each site on a multisite install has a copy of this table
-     */
-    public function __construct($table_name, $pk_column = null, $global = false)
-    {
-        parent::__construct($table_name, $pk_column, $global);
-    }
-    /**
-     * Gets SQL for this table and assigning it an alias. Eg " wp_esp_attendee AS Attendee "
-     * @return string
-     */
-    public function get_table_sql()
-    {
-        return " " . $this->get_table_name() . " AS " . $this->get_table_alias() . " ";
-    }
+	/**
+	 *
+	 * @global wpdb $wpdb
+	 * @param string $table_name with or without wpdb prefix
+	 * @param string $pk_column name of primary key column
+	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
+	 *                  or whether each site on a multisite install has a copy of this table
+	 */
+	public function __construct($table_name, $pk_column = null, $global = false)
+	{
+		parent::__construct($table_name, $pk_column, $global);
+	}
+	/**
+	 * Gets SQL for this table and assigning it an alias. Eg " wp_esp_attendee AS Attendee "
+	 * @return string
+	 */
+	public function get_table_sql()
+	{
+		return " " . $this->get_table_name() . " AS " . $this->get_table_alias() . " ";
+	}
 }

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

@@ -11,267 +11,267 @@
  */
 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.
-        return str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
-    }
-
-
-    /**
-     * 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.
+		return str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
+	}
+
+
+	/**
+	 * 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/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/services/address/CountrySubRegionDao.php

Spacing +4 added lines, -4 removed lines

@@ -80,7 +80,7 @@ 
         $data = [];
         if (empty($this->countries)) {
             $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+            $data = $this->retrieveJsonData(self::REPO_URL.'countries.json');
         }
         if (empty($data)) {
             EE_Error::add_error(
@@ -144,7 +144,7 @@ 
      */
     private function processCountryData($CNT_ISO, $countries = array())
     {
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $key => $country) {
                 if (
                     $country instanceof stdClass
@@ -153,7 +153,7 @@ 
                     && ! empty($country->filename)
                 ) {
                     $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
+                        self::REPO_URL.'countries/'.$country->filename.'.json'
                     );
                     return $this->saveSubRegionData($country, $country->sub_regions);
                 }
@@ -215,7 +215,7 @@ 
             foreach ($sub_regions as $sub_region) {
                 // remove country code from sub region code
                 $abbrev = str_replace(
-                    $country->code . '-',
+                    $country->code.'-',
                     '',
                     sanitize_text_field($sub_region->code)
                 );

Indentation +227 added lines, -227 removed lines

@@ -25,252 +25,252 @@
  */
 class CountrySubRegionDao
 {
-    const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
+	const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
 
-    const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
+	const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
 
-    /**
-     * @var EEM_State $state_model
-     */
-    private $state_model;
+	/**
+	 * @var EEM_State $state_model
+	 */
+	private $state_model;
 
-    /**
-     * @var JsonValidator $json_validator
-     */
-    private $json_validator;
+	/**
+	 * @var JsonValidator $json_validator
+	 */
+	private $json_validator;
 
-    /**
-     * @var string $data_version
-     */
-    private $data_version;
+	/**
+	 * @var string $data_version
+	 */
+	private $data_version;
 
-    /**
-     * @var array $countries
-     */
-    private $countries = array();
+	/**
+	 * @var array $countries
+	 */
+	private $countries = array();
 
 
-    /**
-     * CountrySubRegionDao constructor.
-     *
-     * @param EEM_State     $state_model
-     * @param JsonValidator $json_validator
-     */
-    public function __construct(EEM_State $state_model, JsonValidator $json_validator)
-    {
-        $this->state_model = $state_model;
-        $this->json_validator = $json_validator;
-    }
+	/**
+	 * CountrySubRegionDao constructor.
+	 *
+	 * @param EEM_State     $state_model
+	 * @param JsonValidator $json_validator
+	 */
+	public function __construct(EEM_State $state_model, JsonValidator $json_validator)
+	{
+		$this->state_model = $state_model;
+		$this->json_validator = $json_validator;
+	}
 
 
-    /**
-     * @param EE_Country $country_object
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function saveCountrySubRegions(EE_Country $country_object)
-    {
-        $CNT_ISO = $country_object->ID();
-        $has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
-        $data = [];
-        if (empty($this->countries)) {
-            $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
-        }
-        if (empty($data)) {
-            EE_Error::add_error(
-                'Country Subregion Data could not be retrieved',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-        }
-        if (
-            ! $has_sub_regions
-            || (isset($data->version) && version_compare($data->version, $this->data_version))
-        ) {
-            if (
-                isset($data->countries)
-                && $this->processCountryData($CNT_ISO, $data->countries) > 0
-            ) {
-                $this->countries = $data->countries;
-                $this->updateCountrySubRegionDataVersion($data->version);
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param EE_Country $country_object
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function saveCountrySubRegions(EE_Country $country_object)
+	{
+		$CNT_ISO = $country_object->ID();
+		$has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
+		$data = [];
+		if (empty($this->countries)) {
+			$this->data_version = $this->getCountrySubRegionDataVersion();
+			$data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+		}
+		if (empty($data)) {
+			EE_Error::add_error(
+				'Country Subregion Data could not be retrieved',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+		}
+		if (
+			! $has_sub_regions
+			|| (isset($data->version) && version_compare($data->version, $this->data_version))
+		) {
+			if (
+				isset($data->countries)
+				&& $this->processCountryData($CNT_ISO, $data->countries) > 0
+			) {
+				$this->countries = $data->countries;
+				$this->updateCountrySubRegionDataVersion($data->version);
+				return true;
+			}
+		}
+		return false;
+	}
 
 
-    /**
-     * @since 4.9.70.p
-     * @return string
-     */
-    private function getCountrySubRegionDataVersion()
-    {
-        return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
-    }
+	/**
+	 * @since 4.9.70.p
+	 * @return string
+	 */
+	private function getCountrySubRegionDataVersion()
+	{
+		return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
+	}
 
 
-    /**
-     * @param string $version
-     */
-    private function updateCountrySubRegionDataVersion($version = '')
-    {
-        // add version option if it has never been added before, or update existing
-        if ($this->data_version === null) {
-            add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
-        } else {
-            update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
-        }
-    }
+	/**
+	 * @param string $version
+	 */
+	private function updateCountrySubRegionDataVersion($version = '')
+	{
+		// add version option if it has never been added before, or update existing
+		if ($this->data_version === null) {
+			add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
+		} else {
+			update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
+		}
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @param array  $countries
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.70.p
-     */
-    private function processCountryData($CNT_ISO, $countries = array())
-    {
-        if (! empty($countries)) {
-            foreach ($countries as $key => $country) {
-                if (
-                    $country instanceof stdClass
-                    && $country->code === $CNT_ISO
-                    && empty($country->sub_regions)
-                    && ! empty($country->filename)
-                ) {
-                    $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
-                    );
-                    return $this->saveSubRegionData($country, $country->sub_regions);
-                }
-            }
-        }
-        return 0;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @param array  $countries
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.70.p
+	 */
+	private function processCountryData($CNT_ISO, $countries = array())
+	{
+		if (! empty($countries)) {
+			foreach ($countries as $key => $country) {
+				if (
+					$country instanceof stdClass
+					&& $country->code === $CNT_ISO
+					&& empty($country->sub_regions)
+					&& ! empty($country->filename)
+				) {
+					$country->sub_regions = $this->retrieveJsonData(
+						self::REPO_URL . 'countries/' . $country->filename . '.json'
+					);
+					return $this->saveSubRegionData($country, $country->sub_regions);
+				}
+			}
+		}
+		return 0;
+	}
 
 
-    /**
-     * @param string $url
-     * @return array
-     */
-    private function retrieveJsonData($url)
-    {
-        if (empty($url)) {
-            EE_Error::add_error(
-                'No URL was provided!',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $request = wp_safe_remote_get($url);
-        if ($request instanceof WP_Error) {
-            EE_Error::add_error(
-                $request->get_error_message(),
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $body = wp_remote_retrieve_body($request);
-        $json = json_decode($body);
-        if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
-            return $json;
-        }
-        return array();
-    }
+	/**
+	 * @param string $url
+	 * @return array
+	 */
+	private function retrieveJsonData($url)
+	{
+		if (empty($url)) {
+			EE_Error::add_error(
+				'No URL was provided!',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$request = wp_safe_remote_get($url);
+		if ($request instanceof WP_Error) {
+			EE_Error::add_error(
+				$request->get_error_message(),
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$body = wp_remote_retrieve_body($request);
+		$json = json_decode($body);
+		if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
+			return $json;
+		}
+		return array();
+	}
 
 
-    /**
-     * @param stdClass $country
-     * @param array    $sub_regions
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function saveSubRegionData(stdClass $country, $sub_regions = array())
-    {
-        $results = 0;
-        if (is_array($sub_regions)) {
-            $existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
-            foreach ($sub_regions as $sub_region) {
-                // remove country code from sub region code
-                $abbrev = str_replace(
-                    $country->code . '-',
-                    '',
-                    sanitize_text_field($sub_region->code)
-                );
-                // but NOT if sub region code results in only a number
-                if (absint($abbrev) !== 0) {
-                    $abbrev = sanitize_text_field($sub_region->code);
-                }
-                if (
-                    ! in_array($abbrev, $existing_sub_regions, true)
-                    && $this->state_model->insert(
-                        [
-                            // STA_ID CNT_ISO STA_abbrev STA_name STA_active
-                            'CNT_ISO'    => $country->code,
-                            'STA_abbrev' => $abbrev,
-                            'STA_name'   => sanitize_text_field($sub_region->name),
-                            'STA_active' => 1,
-                        ]
-                    )
-                ) {
-                    $results++;
-                }
-            }
-        }
-        return $results;
-    }
+	/**
+	 * @param stdClass $country
+	 * @param array    $sub_regions
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function saveSubRegionData(stdClass $country, $sub_regions = array())
+	{
+		$results = 0;
+		if (is_array($sub_regions)) {
+			$existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
+			foreach ($sub_regions as $sub_region) {
+				// remove country code from sub region code
+				$abbrev = str_replace(
+					$country->code . '-',
+					'',
+					sanitize_text_field($sub_region->code)
+				);
+				// but NOT if sub region code results in only a number
+				if (absint($abbrev) !== 0) {
+					$abbrev = sanitize_text_field($sub_region->code);
+				}
+				if (
+					! in_array($abbrev, $existing_sub_regions, true)
+					&& $this->state_model->insert(
+						[
+							// STA_ID CNT_ISO STA_abbrev STA_name STA_active
+							'CNT_ISO'    => $country->code,
+							'STA_abbrev' => $abbrev,
+							'STA_name'   => sanitize_text_field($sub_region->name),
+							'STA_active' => 1,
+						]
+					)
+				) {
+					$results++;
+				}
+			}
+		}
+		return $results;
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @since 4.9.76.p
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getExistingStateAbbreviations($CNT_ISO)
-    {
-        $existing_sub_region_IDs = [];
-        $existing_sub_regions = $this->state_model->get_all(array(
-            array(
-                'Country.CNT_ISO' => array(
-                    'IN',
-                    [$CNT_ISO]
-                )
-            ),
-            'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
-        ));
-        if (is_array($existing_sub_regions)) {
-            foreach ($existing_sub_regions as $existing_sub_region) {
-                if ($existing_sub_region instanceof EE_State) {
-                    $existing_sub_region_IDs[] = $existing_sub_region->abbrev();
-                }
-            }
-        }
-        return $existing_sub_region_IDs;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @since 4.9.76.p
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getExistingStateAbbreviations($CNT_ISO)
+	{
+		$existing_sub_region_IDs = [];
+		$existing_sub_regions = $this->state_model->get_all(array(
+			array(
+				'Country.CNT_ISO' => array(
+					'IN',
+					[$CNT_ISO]
+				)
+			),
+			'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
+		));
+		if (is_array($existing_sub_regions)) {
+			foreach ($existing_sub_regions as $existing_sub_region) {
+				if ($existing_sub_region instanceof EE_State) {
+					$existing_sub_region_IDs[] = $existing_sub_region->abbrev();
+				}
+			}
+		}
+		return $existing_sub_region_IDs;
+	}
 }

core/services/payment_methods/forms/PayPalSettingsForm.php

Indentation +191 added lines, -191 removed lines

@@ -20,202 +20,202 @@
  */
 class PayPalSettingsForm extends EE_Payment_Method_Form
 {
-    /**
-     * @var string of HTML being the help tab link
-     */
-    protected $helpTabLink;
+	/**
+	 * @var string of HTML being the help tab link
+	 */
+	protected $helpTabLink;
 
-    public function __construct(array $options_array = array(), $help_tab_link = '')
-    {
-        $this->helpTabLink = $help_tab_link;
-        $options_array = array_replace_recursive(
-            array(
-                'extra_meta_inputs' => array(
-                    'api_username' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Username %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_password' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Password %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_signature' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                // translators: %s link to help doc
-                                esc_html__('API Signature %s', 'event_espresso'),
-                                $help_tab_link
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                )
-            ),
-            $options_array
-        );
-        parent::__construct($options_array);
-    }
+	public function __construct(array $options_array = array(), $help_tab_link = '')
+	{
+		$this->helpTabLink = $help_tab_link;
+		$options_array = array_replace_recursive(
+			array(
+				'extra_meta_inputs' => array(
+					'api_username' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Username %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+					'api_password' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Password %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+					'api_signature' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								// translators: %s link to help doc
+								esc_html__('API Signature %s', 'event_espresso'),
+								$help_tab_link
+							),
+							'required'        => true,
+						)
+					),
+				)
+			),
+			$options_array
+		);
+		parent::__construct($options_array);
+	}
 
-    /**
-     * Tests the the PayPal API credentials work ok
-     * @return string of an error using the credentials, otherwise, if the credentials work, returns a blank string
-     * @throws EE_Error
-     */
-    protected function checkForCredentialsErrors()
-    {
-        $request_params = array(
-            'METHOD'    => 'GetBalance',
-            'VERSION'   => '204.0',
-            'USER'      => $this->get_input_value('api_username'),
-            'PWD'       => $this->get_input_value('api_password'),
-            'SIGNATURE' => $this->get_input_value('api_signature'),
-        );
-        $gateway_url = $this->get_input_value('PMD_debug_mode')
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-        // Request Customer Details.
-        $response = wp_remote_post(
-            $gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($request_params, '', '&'),
-            )
-        );
-        if (is_wp_error($response) || empty($response['body'])) {
-            // If we got here then there was an error in this request.
-            // maybe is turned off. We don't know the credentials are invalid
-            EE_Error::add_error(
-                sprintf(
-                    // translators: %1$s Error message received from PayPal
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Your PayPal credentials could not be verified. The following error occurred while communicating with PayPal: %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $response->get_error_message()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $response_args = array();
-        parse_str(urldecode($response['body']), $response_args);
+	/**
+	 * Tests the the PayPal API credentials work ok
+	 * @return string of an error using the credentials, otherwise, if the credentials work, returns a blank string
+	 * @throws EE_Error
+	 */
+	protected function checkForCredentialsErrors()
+	{
+		$request_params = array(
+			'METHOD'    => 'GetBalance',
+			'VERSION'   => '204.0',
+			'USER'      => $this->get_input_value('api_username'),
+			'PWD'       => $this->get_input_value('api_password'),
+			'SIGNATURE' => $this->get_input_value('api_signature'),
+		);
+		$gateway_url = $this->get_input_value('PMD_debug_mode')
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+		// Request Customer Details.
+		$response = wp_remote_post(
+			$gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($request_params, '', '&'),
+			)
+		);
+		if (is_wp_error($response) || empty($response['body'])) {
+			// If we got here then there was an error in this request.
+			// maybe is turned off. We don't know the credentials are invalid
+			EE_Error::add_error(
+				sprintf(
+					// translators: %1$s Error message received from PayPal
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'Your PayPal credentials could not be verified. The following error occurred while communicating with PayPal: %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$response->get_error_message()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$response_args = array();
+		parse_str(urldecode($response['body']), $response_args);
 
-        if (empty($response_args['ACK'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Your PayPal credentials could not be verified. Part of their response was missing.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (
-            in_array(
-                $response_args['ACK'],
-                array(
-                'Success',
-                'SuccessWithWarning'
-                ),
-                true
-            )
-        ) {
-            return '';
-        } else {
-            return sprintf(
-                // translators: %1$s: PayPal response message, %2$s: PayPal response code
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Your PayPal API credentials appear to be invalid. PayPal said "%1$s (%2$s)". Please see tips below.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                isset($response_args['L_LONGMESSAGE0'])
-                    ? $response_args['L_LONGMESSAGE0']
-                    : esc_html__('No error message received from PayPal', 'event_espresso'),
-                isset($response_args['L_ERRORCODE0']) ? $response_args['L_ERRORCODE0'] : 0
-            );
-        }
-    }
+		if (empty($response_args['ACK'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Your PayPal credentials could not be verified. Part of their response was missing.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (
+			in_array(
+				$response_args['ACK'],
+				array(
+				'Success',
+				'SuccessWithWarning'
+				),
+				true
+			)
+		) {
+			return '';
+		} else {
+			return sprintf(
+				// translators: %1$s: PayPal response message, %2$s: PayPal response code
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Your PayPal API credentials appear to be invalid. PayPal said "%1$s (%2$s)". Please see tips below.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				isset($response_args['L_LONGMESSAGE0'])
+					? $response_args['L_LONGMESSAGE0']
+					: esc_html__('No error message received from PayPal', 'event_espresso'),
+				isset($response_args['L_ERRORCODE0']) ? $response_args['L_ERRORCODE0'] : 0
+			);
+		}
+	}
 
-    /**
-     * Gets the HTML to show the link to the help tab
-     * @return string
-     */
-    protected function helpTabLink()
-    {
-        return $this->helpTabLink;
-    }
+	/**
+	 * Gets the HTML to show the link to the help tab
+	 * @return string
+	 */
+	protected function helpTabLink()
+	{
+		return $this->helpTabLink;
+	}
 
-    /**
-     * Does the normal validation, but also verifies the PayPal API credentials work.
-     * If they don't, sets a validation error on the entire form, and adds validation errors (which are really more
-     * tips) on each of the inputs that could be the cause of the problem.
-     * @throws EE_Error
-     */
-    public function _validate()
-    {
-        parent::_validate();
-        $credentials_message = $this->checkForCredentialsErrors();
-        if ($credentials_message !== '') {
-            $this->add_validation_error($credentials_message);
-            $this->get_input('PMD_debug_mode')->add_validation_error(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'If you are using PayPal Sandbox (test) credentials, Debug mode should be set to "Yes". Otherwise, if you are using live PayPal credentials, set this to "No".',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-            $this->get_input('api_username')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__(
-                        'Are you sure this is your API username, not your login username? %1$s',
-                        'event_espresso'
-                    ),
-                    $this->helpTabLink()
-                )
-            );
-            $this->get_input('api_password')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__(
-                        'Are you sure this is your API password, not your login password? %1$s',
-                        'event_espresso'
-                    ),
-                    $this->helpTabLink()
-                )
-            );
-            $this->get_input('api_signature')->add_validation_error(
-                sprintf(
-                    // translators: $1$s HTML for a link to the help tab
-                    esc_html__('Please verify your API signature is correct. %1$s', 'event_espresso'),
-                    $this->helpTabLink()
-                )
-            );
-        }
-    }
+	/**
+	 * Does the normal validation, but also verifies the PayPal API credentials work.
+	 * If they don't, sets a validation error on the entire form, and adds validation errors (which are really more
+	 * tips) on each of the inputs that could be the cause of the problem.
+	 * @throws EE_Error
+	 */
+	public function _validate()
+	{
+		parent::_validate();
+		$credentials_message = $this->checkForCredentialsErrors();
+		if ($credentials_message !== '') {
+			$this->add_validation_error($credentials_message);
+			$this->get_input('PMD_debug_mode')->add_validation_error(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'If you are using PayPal Sandbox (test) credentials, Debug mode should be set to "Yes". Otherwise, if you are using live PayPal credentials, set this to "No".',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+			$this->get_input('api_username')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__(
+						'Are you sure this is your API username, not your login username? %1$s',
+						'event_espresso'
+					),
+					$this->helpTabLink()
+				)
+			);
+			$this->get_input('api_password')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__(
+						'Are you sure this is your API password, not your login password? %1$s',
+						'event_espresso'
+					),
+					$this->helpTabLink()
+				)
+			);
+			$this->get_input('api_signature')->add_validation_error(
+				sprintf(
+					// translators: $1$s HTML for a link to the help tab
+					esc_html__('Please verify your API signature is correct. %1$s', 'event_espresso'),
+					$this->helpTabLink()
+				)
+			);
+		}
+	}
 }
 // End of file PayPalSettingsForm.php
 // Location: ${NAMESPACE}/PayPalSettingsForm.php

core/services/collections/CollectionDetails.php

Spacing +8 added lines, -8 removed lines

@@ -193,7 +193,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -221,7 +221,7 @@ 
      */
     protected function setCollectionName($collection_name)
     {
-        if (! is_string($collection_name)) {
+        if ( ! is_string($collection_name)) {
             throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
         }
         $this->collection_name = str_replace(
@@ -281,7 +281,7 @@ 
      */
     protected function setIdentifierCallback($identifier_callback = 'identifier')
     {
-        if (! is_string($identifier_callback)) {
+        if ( ! is_string($identifier_callback)) {
             throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
         }
         $this->identifier_callback = $identifier_callback;
@@ -311,7 +311,7 @@ 
         $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
         // we know our default is a string, so if it's not a string now,
         // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
+        if ( ! is_string($this->file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
         }
     }
@@ -336,7 +336,7 @@ 
     public function setCollectionFQCNs($collection_FQCNs)
     {
         foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
+            if ( ! empty($collection_FQCN)) {
                 if (class_exists($collection_FQCN)) {
                     $this->collection_FQCNs[] = $collection_FQCN;
                 } else {
@@ -358,7 +358,7 @@ 
      */
     protected function getFQCNsFromPartialNamespace($partial_FQCN)
     {
-        if (! $this->file_locator instanceof FqcnLocator) {
+        if ( ! $this->file_locator instanceof FqcnLocator) {
             $this->file_locator = new FqcnLocator();
         }
         $this->file_locator->locate($partial_FQCN);
@@ -384,8 +384,8 @@ 
     public function setCollectionPaths($collection_paths)
     {
         foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
+            if ( ! empty($collection_path)) {
+                if ( ! is_readable($collection_path)) {
                     throw new InvalidFilePathException($collection_path);
                 }
                 $this->collection_paths[] = $collection_path;

Indentation +350 added lines, -350 removed lines

@@ -42,354 +42,354 @@
  */
 class CollectionDetails implements CollectionDetailsInterface
 {
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's spl_object_hash() as it's identifier
-     */
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's class name as it's identifier
-     */
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use the return value from a specified callback method on each object
-     */
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
-
-    /**
-     * The interface used for controlling what gets added to the collection
-     *
-     * @var string $collection_interface
-     */
-    protected $collection_interface = '';
-
-    /**
-     * a unique name used to identify the collection in filter names
-     * supplied value is run through sanitize_title_with_dashes(),
-     * but then also converts dashes to underscores
-     *
-     * @var string $collection_name
-     */
-    protected $collection_name = '';
-
-    /**
-     * what the collection uses for the object identifier.
-     * corresponds to one of the class constants above.
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
-     *
-     * @var string $identifier_type
-     */
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
-
-    /**
-     * the pattern applied to paths when searching for class files to add to the collection
-     * ie: "My_Awesome_*.class.php"
-     * computed value (setter) defaults to "*.php"
-     *
-     * @var string $file_mask
-     * @see CollectionDetails::setFileMask() for details on how computed value is resolved
-     */
-    protected $file_mask = '';
-
-    /**
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
-     * then this specifies the method to use on each entity.
-     * If the callback method does not exist, then an exception will be thrown
-     *
-     * @var string $identifier_callback
-     */
-    protected $identifier_callback = '';
-
-    /**
-     * an array of Fully Qualified Class Names
-     *  for example:
-     *  $FQCNs = array(
-     *      '/Fully/Qualified/ClassNameA'
-     *      '/Fully/Qualified/Other/ClassNameB'
-     *  );
-     *
-     * @var array $collection_FQCNs
-     */
-    protected $collection_FQCNs = array();
-
-    /**
-     * an array of full server paths to folders containing files to be loaded into collection
-     *  for example:
-     *  $paths = array(
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
-     *  );
-     *
-     * @var array $collection_paths
-     */
-    protected $collection_paths = array();
-
-    /**
-     * @var LocatorInterface $file_locator
-     */
-    protected $file_locator;
-
-
-    /**
-     * CollectionDetails constructor.
-     *
-     * @access public
-     * @param string           $collection_name
-     * @param string           $collection_interface
-     * @param array            $collection_FQCNs
-     * @param array            $collection_paths
-     * @param string           $file_mask
-     * @param string           $identifier_type
-     * @param string           $identifier_callback
-     * @param LocatorInterface $file_locator
-     * @throws CollectionDetailsException
-     */
-    public function __construct(
-        $collection_name,
-        $collection_interface,
-        array $collection_FQCNs = array(),
-        array $collection_paths = array(),
-        $file_mask = '',
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
-        $identifier_callback = '',
-        LocatorInterface $file_locator = null
-    ) {
-        try {
-            $this->setCollectionName($collection_name);
-            $this->setCollectionInterface($collection_interface);
-            $this->setCollectionFQCNs($collection_FQCNs);
-            $this->setCollectionPaths($collection_paths);
-            $this->setFileMask($file_mask);
-            $this->setIdentifierType($identifier_type);
-            $this->setIdentifierCallback($identifier_callback);
-            $this->file_locator = $file_locator;
-        } catch (Exception $exception) {
-            throw new CollectionDetailsException($exception);
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return mixed
-     */
-    public function getCollectionInterface()
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * the collection name will be used for creating dynamic filters
-     *
-     * @access public
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * sanitizes collection name and converts spaces and dashes to underscores
-     *
-     * @access protected
-     * @param string $collection_name
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setCollectionName($collection_name)
-    {
-        if (! is_string($collection_name)) {
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
-        }
-        $this->collection_name = str_replace(
-            '-',
-            '_',
-            sanitize_title_with_dashes($collection_name, '', 'save')
-        );
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType()
-    {
-        return $this->identifier_type;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_type
-     * @throws InvalidIdentifierException
-     */
-    protected function setIdentifierType($identifier_type)
-    {
-        if (
-            ! ($identifier_type === CollectionDetails::ID_CLASS_NAME
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
-            )
-        ) {
-            throw new InvalidIdentifierException(
-                $identifier_type,
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
-            );
-        }
-        $this->identifier_type = $identifier_type;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback()
-    {
-        return $this->identifier_callback;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_callback
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
-    {
-        if (! is_string($identifier_callback)) {
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
-        }
-        $this->identifier_callback = $identifier_callback;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask()
-    {
-        return $this->file_mask;
-    }
-
-
-    /**
-     * sets the file mask which is then used to filter what files get loaded
-     * when searching for classes to add to the collection. Defaults to '*.php' when parameter is an empty string
-     *
-     * @access protected
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setFileMask($file_mask)
-    {
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
-        // we know our default is a string, so if it's not a string now,
-        // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionFQCNs()
-    {
-        return $this->collection_FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_FQCNs
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setCollectionFQCNs($collection_FQCNs)
-    {
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
-                if (class_exists($collection_FQCN)) {
-                    $this->collection_FQCNs[] = $collection_FQCN;
-                } else {
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
-                        $this->collection_FQCNs[] = $FQCN;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $partial_FQCN
-     * @return array
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
-    {
-        if (! $this->file_locator instanceof FqcnLocator) {
-            $this->file_locator = new FqcnLocator();
-        }
-        $this->file_locator->locate($partial_FQCN);
-        return $this->file_locator->getFQCNs();
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionPaths()
-    {
-        return $this->collection_paths;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_paths
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     */
-    public function setCollectionPaths($collection_paths)
-    {
-        foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
-                    throw new InvalidFilePathException($collection_path);
-                }
-                $this->collection_paths[] = $collection_path;
-            }
-        }
-    }
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's spl_object_hash() as it's identifier
+	 */
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's class name as it's identifier
+	 */
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use the return value from a specified callback method on each object
+	 */
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
+
+	/**
+	 * The interface used for controlling what gets added to the collection
+	 *
+	 * @var string $collection_interface
+	 */
+	protected $collection_interface = '';
+
+	/**
+	 * a unique name used to identify the collection in filter names
+	 * supplied value is run through sanitize_title_with_dashes(),
+	 * but then also converts dashes to underscores
+	 *
+	 * @var string $collection_name
+	 */
+	protected $collection_name = '';
+
+	/**
+	 * what the collection uses for the object identifier.
+	 * corresponds to one of the class constants above.
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
+	 *
+	 * @var string $identifier_type
+	 */
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
+
+	/**
+	 * the pattern applied to paths when searching for class files to add to the collection
+	 * ie: "My_Awesome_*.class.php"
+	 * computed value (setter) defaults to "*.php"
+	 *
+	 * @var string $file_mask
+	 * @see CollectionDetails::setFileMask() for details on how computed value is resolved
+	 */
+	protected $file_mask = '';
+
+	/**
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
+	 * then this specifies the method to use on each entity.
+	 * If the callback method does not exist, then an exception will be thrown
+	 *
+	 * @var string $identifier_callback
+	 */
+	protected $identifier_callback = '';
+
+	/**
+	 * an array of Fully Qualified Class Names
+	 *  for example:
+	 *  $FQCNs = array(
+	 *      '/Fully/Qualified/ClassNameA'
+	 *      '/Fully/Qualified/Other/ClassNameB'
+	 *  );
+	 *
+	 * @var array $collection_FQCNs
+	 */
+	protected $collection_FQCNs = array();
+
+	/**
+	 * an array of full server paths to folders containing files to be loaded into collection
+	 *  for example:
+	 *  $paths = array(
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
+	 *  );
+	 *
+	 * @var array $collection_paths
+	 */
+	protected $collection_paths = array();
+
+	/**
+	 * @var LocatorInterface $file_locator
+	 */
+	protected $file_locator;
+
+
+	/**
+	 * CollectionDetails constructor.
+	 *
+	 * @access public
+	 * @param string           $collection_name
+	 * @param string           $collection_interface
+	 * @param array            $collection_FQCNs
+	 * @param array            $collection_paths
+	 * @param string           $file_mask
+	 * @param string           $identifier_type
+	 * @param string           $identifier_callback
+	 * @param LocatorInterface $file_locator
+	 * @throws CollectionDetailsException
+	 */
+	public function __construct(
+		$collection_name,
+		$collection_interface,
+		array $collection_FQCNs = array(),
+		array $collection_paths = array(),
+		$file_mask = '',
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
+		$identifier_callback = '',
+		LocatorInterface $file_locator = null
+	) {
+		try {
+			$this->setCollectionName($collection_name);
+			$this->setCollectionInterface($collection_interface);
+			$this->setCollectionFQCNs($collection_FQCNs);
+			$this->setCollectionPaths($collection_paths);
+			$this->setFileMask($file_mask);
+			$this->setIdentifierType($identifier_type);
+			$this->setIdentifierCallback($identifier_callback);
+			$this->file_locator = $file_locator;
+		} catch (Exception $exception) {
+			throw new CollectionDetailsException($exception);
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return mixed
+	 */
+	public function getCollectionInterface()
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * the collection name will be used for creating dynamic filters
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * sanitizes collection name and converts spaces and dashes to underscores
+	 *
+	 * @access protected
+	 * @param string $collection_name
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		if (! is_string($collection_name)) {
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
+		}
+		$this->collection_name = str_replace(
+			'-',
+			'_',
+			sanitize_title_with_dashes($collection_name, '', 'save')
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType()
+	{
+		return $this->identifier_type;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_type
+	 * @throws InvalidIdentifierException
+	 */
+	protected function setIdentifierType($identifier_type)
+	{
+		if (
+			! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
+			)
+		) {
+			throw new InvalidIdentifierException(
+				$identifier_type,
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
+			);
+		}
+		$this->identifier_type = $identifier_type;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback()
+	{
+		return $this->identifier_callback;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_callback
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
+	{
+		if (! is_string($identifier_callback)) {
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
+		}
+		$this->identifier_callback = $identifier_callback;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask()
+	{
+		return $this->file_mask;
+	}
+
+
+	/**
+	 * sets the file mask which is then used to filter what files get loaded
+	 * when searching for classes to add to the collection. Defaults to '*.php' when parameter is an empty string
+	 *
+	 * @access protected
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setFileMask($file_mask)
+	{
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
+		// we know our default is a string, so if it's not a string now,
+		// then that means the incoming parameter was something else
+		if (! is_string($this->file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionFQCNs()
+	{
+		return $this->collection_FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_FQCNs
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setCollectionFQCNs($collection_FQCNs)
+	{
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
+			if (! empty($collection_FQCN)) {
+				if (class_exists($collection_FQCN)) {
+					$this->collection_FQCNs[] = $collection_FQCN;
+				} else {
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
+						$this->collection_FQCNs[] = $FQCN;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $partial_FQCN
+	 * @return array
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
+	{
+		if (! $this->file_locator instanceof FqcnLocator) {
+			$this->file_locator = new FqcnLocator();
+		}
+		$this->file_locator->locate($partial_FQCN);
+		return $this->file_locator->getFQCNs();
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionPaths()
+	{
+		return $this->collection_paths;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_paths
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 */
+	public function setCollectionPaths($collection_paths)
+	{
+		foreach ((array) $collection_paths as $collection_path) {
+			if (! empty($collection_path)) {
+				if (! is_readable($collection_path)) {
+					throw new InvalidFilePathException($collection_path);
+				}
+				$this->collection_paths[] = $collection_path;
+			}
+		}
+	}
 }