eventespresso / event-espresso-core

core/helpers/EEH_Array.helper.php

Indentation +199 added lines, -199 removed lines

@@ -13,203 +13,203 @@
 {
 
 
-    /**
-     * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
-     * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
-     *
-     * @uses array_udiff core php function for setting up our own array comparison
-     * @uses self::_compare_objects as the custom method for array_udiff
-     * @param  array $array1 an array of objects
-     * @param  array $array2 an array of objects
-     * @return array         an array of objects found in array 1 that aren't found in array 2.
-     */
-    public static function object_array_diff($array1, $array2)
-    {
-        return array_udiff($array1, $array2, array('self', '_compare_objects'));
-    }
-
-    /**
-     * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
-     *
-     * @param array $array
-     * @return boolean
-     */
-    public static function is_associative_array(array $array)
-    {
-        return array_keys($array) !== range(0, count($array) - 1);
-    }
-
-    /**
-     * Gets an item from the array and leave the array intact. Use in place of end()
-     * when you don't want to change the array
-     *
-     * @param array $arr
-     * @return mixed what ever is in the array
-     */
-    public static function get_one_item_from_array($arr)
-    {
-        $item = end($arr);
-        reset($arr);
-        return $item;
-    }
-
-    /**
-     * Detects if this is a multi-dimensional array (meaning that the top-level
-     * values are themselves array. Eg array(array(...),...)
-     *
-     * @param mixed $arr
-     * @return boolean
-     */
-    public static function is_multi_dimensional_array($arr)
-    {
-        if (is_array($arr)) {
-            $first_item = reset($arr);
-            if (is_array($first_item)) {
-                return true;// yep, there's at least 2 levels to this array
-            } else {
-                return false;// nope, only 1 level
-            }
-        } else {
-            return false;// its not an array at all!
-        }
-    }
-
-    /**
-     * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
-     *
-     * @param array $arr
-     * @param mixed $index
-     * @param mixed $default
-     * @return mixed
-     */
-    public static function is_set($arr, $index, $default)
-    {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
-    }
-
-    /**
-     * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
-     *
-     * @param mixed $value usually a string, but could be an array or object
-     * @return mixed the UN-serialized data
-     */
-    public static function maybe_unserialize($value)
-    {
-        $data = maybe_unserialize($value);
-        // it's possible that this still has serialized data if its the session.  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesnt' unserialize this automatically.
-        $token = 'C';
-        $data = is_string($data) ? trim($data) : $data;
-        if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
-            return unserialize($data);
-        } else {
-            return $data;
-        }
-    }
-
-
-    /**
-     * insert_into_array
-     *
-     * @param array        $target_array the array to insert new data into
-     * @param array        $array_to_insert the new data to be inserted
-     * @param int | string $offset a known key within $target_array where new data will be inserted
-     * @param bool         $add_before whether to add new data before or after the offset key
-     * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
-     * @return array
-     */
-    public static function insert_into_array(
-        $target_array = array(),
-        $array_to_insert = array(),
-        $offset = null,
-        $add_before = true,
-        $preserve_keys = true
-    ) {
-        // ensure incoming arrays are actually arrays
-        $target_array = (array) $target_array;
-        $array_to_insert = (array) $array_to_insert;
-        // if no offset key was supplied
-        if (empty($offset)) {
-            // use start or end of $target_array based on whether we are adding before or not
-            $offset = $add_before ? 0 : count($target_array);
-        }
-        // if offset key is a string, then find the corresponding numeric location for that element
-        $offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
-        // add one to the offset if adding after
-        $offset = $add_before ? $offset : $offset + 1;
-        // but ensure offset does not exceed the length of the array
-        $offset = $offset > count($target_array) ? count($target_array) : $offset;
-        // reindex array ???
-        if ($preserve_keys) {
-            // take a slice of the target array from the beginning till the offset,
-            // then add the new data
-            // then add another slice that starts at the offset and goes till the end
-            return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
-                $target_array,
-                $offset,
-                null,
-                true
-            );
-        } else {
-            // since we don't want to preserve keys, we can use array_splice
-            array_splice($target_array, $offset, 0, $array_to_insert);
-            return $target_array;
-        }
-    }
-
-
-    /**
-     * array_merge() is slow and should never be used while looping over data
-     * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
-     * so really this acts more like array_replace( $array1, $array2 )
-     * or a union with the arrays flipped ( $array2 + $array1 )
-     * this saves a few lines of code and improves readability
-     *
-     * @param array $array1
-     * @param array $array2
-     * @return array
-     */
-    public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
-    {
-        foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
-        }
-        return $array1;
-    }
-
-
-    /**
-     * given a flat array like $array = array('A', 'B', 'C')
-     * will convert into a multidimensional array like $array[A][B][C]
-     * if $final_value is provided and is anything other than null,
-     * then that will be set as the value for the innermost array key
-     * like so: $array[A][B][C] = $final_value
-     *
-     * @param array $flat_array
-     * @param mixed $final_value
-     * @return array
-     */
-    public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
-    {
-        $multidimensional = array();
-        $reference = &$multidimensional;
-        foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
-        }
-        if ($final_value !== null) {
-            $reference = $final_value;
-        }
-        return $multidimensional;
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    public static function is_array_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
-    }
+	/**
+	 * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
+	 * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
+	 *
+	 * @uses array_udiff core php function for setting up our own array comparison
+	 * @uses self::_compare_objects as the custom method for array_udiff
+	 * @param  array $array1 an array of objects
+	 * @param  array $array2 an array of objects
+	 * @return array         an array of objects found in array 1 that aren't found in array 2.
+	 */
+	public static function object_array_diff($array1, $array2)
+	{
+		return array_udiff($array1, $array2, array('self', '_compare_objects'));
+	}
+
+	/**
+	 * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	public static function is_associative_array(array $array)
+	{
+		return array_keys($array) !== range(0, count($array) - 1);
+	}
+
+	/**
+	 * Gets an item from the array and leave the array intact. Use in place of end()
+	 * when you don't want to change the array
+	 *
+	 * @param array $arr
+	 * @return mixed what ever is in the array
+	 */
+	public static function get_one_item_from_array($arr)
+	{
+		$item = end($arr);
+		reset($arr);
+		return $item;
+	}
+
+	/**
+	 * Detects if this is a multi-dimensional array (meaning that the top-level
+	 * values are themselves array. Eg array(array(...),...)
+	 *
+	 * @param mixed $arr
+	 * @return boolean
+	 */
+	public static function is_multi_dimensional_array($arr)
+	{
+		if (is_array($arr)) {
+			$first_item = reset($arr);
+			if (is_array($first_item)) {
+				return true;// yep, there's at least 2 levels to this array
+			} else {
+				return false;// nope, only 1 level
+			}
+		} else {
+			return false;// its not an array at all!
+		}
+	}
+
+	/**
+	 * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
+	 *
+	 * @param array $arr
+	 * @param mixed $index
+	 * @param mixed $default
+	 * @return mixed
+	 */
+	public static function is_set($arr, $index, $default)
+	{
+		return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+	}
+
+	/**
+	 * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
+	 *
+	 * @param mixed $value usually a string, but could be an array or object
+	 * @return mixed the UN-serialized data
+	 */
+	public static function maybe_unserialize($value)
+	{
+		$data = maybe_unserialize($value);
+		// it's possible that this still has serialized data if its the session.  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesnt' unserialize this automatically.
+		$token = 'C';
+		$data = is_string($data) ? trim($data) : $data;
+		if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
+			return unserialize($data);
+		} else {
+			return $data;
+		}
+	}
+
+
+	/**
+	 * insert_into_array
+	 *
+	 * @param array        $target_array the array to insert new data into
+	 * @param array        $array_to_insert the new data to be inserted
+	 * @param int | string $offset a known key within $target_array where new data will be inserted
+	 * @param bool         $add_before whether to add new data before or after the offset key
+	 * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
+	 * @return array
+	 */
+	public static function insert_into_array(
+		$target_array = array(),
+		$array_to_insert = array(),
+		$offset = null,
+		$add_before = true,
+		$preserve_keys = true
+	) {
+		// ensure incoming arrays are actually arrays
+		$target_array = (array) $target_array;
+		$array_to_insert = (array) $array_to_insert;
+		// if no offset key was supplied
+		if (empty($offset)) {
+			// use start or end of $target_array based on whether we are adding before or not
+			$offset = $add_before ? 0 : count($target_array);
+		}
+		// if offset key is a string, then find the corresponding numeric location for that element
+		$offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
+		// add one to the offset if adding after
+		$offset = $add_before ? $offset : $offset + 1;
+		// but ensure offset does not exceed the length of the array
+		$offset = $offset > count($target_array) ? count($target_array) : $offset;
+		// reindex array ???
+		if ($preserve_keys) {
+			// take a slice of the target array from the beginning till the offset,
+			// then add the new data
+			// then add another slice that starts at the offset and goes till the end
+			return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
+				$target_array,
+				$offset,
+				null,
+				true
+			);
+		} else {
+			// since we don't want to preserve keys, we can use array_splice
+			array_splice($target_array, $offset, 0, $array_to_insert);
+			return $target_array;
+		}
+	}
+
+
+	/**
+	 * array_merge() is slow and should never be used while looping over data
+	 * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
+	 * so really this acts more like array_replace( $array1, $array2 )
+	 * or a union with the arrays flipped ( $array2 + $array1 )
+	 * this saves a few lines of code and improves readability
+	 *
+	 * @param array $array1
+	 * @param array $array2
+	 * @return array
+	 */
+	public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
+	{
+		foreach ($array2 as $key => $value) {
+			$array1[ $key ] = $value;
+		}
+		return $array1;
+	}
+
+
+	/**
+	 * given a flat array like $array = array('A', 'B', 'C')
+	 * will convert into a multidimensional array like $array[A][B][C]
+	 * if $final_value is provided and is anything other than null,
+	 * then that will be set as the value for the innermost array key
+	 * like so: $array[A][B][C] = $final_value
+	 *
+	 * @param array $flat_array
+	 * @param mixed $final_value
+	 * @return array
+	 */
+	public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
+	{
+		$multidimensional = array();
+		$reference = &$multidimensional;
+		foreach ($flat_array as $key) {
+			$reference[ $key ] = array();
+			$reference = &$reference[ $key ];
+		}
+		if ($final_value !== null) {
+			$reference = $final_value;
+		}
+		return $multidimensional;
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	public static function is_array_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -65,12 +65,12 @@ 
         if (is_array($arr)) {
             $first_item = reset($arr);
             if (is_array($first_item)) {
-                return true;// yep, there's at least 2 levels to this array
+                return true; // yep, there's at least 2 levels to this array
             } else {
-                return false;// nope, only 1 level
+                return false; // nope, only 1 level
             }
         } else {
-            return false;// its not an array at all!
+            return false; // its not an array at all!
         }
     }
 
@@ -84,7 +84,7 @@ 
      */
     public static function is_set($arr, $index, $default)
     {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+        return isset($arr[$index]) ? $arr[$index] : $default;
     }
 
     /**
@@ -171,7 +171,7 @@ 
     public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
     {
         foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
+            $array1[$key] = $value;
         }
         return $array1;
     }
@@ -193,8 +193,8 @@ 
         $multidimensional = array();
         $reference = &$multidimensional;
         foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
+            $reference[$key] = array();
+            $reference = &$reference[$key];
         }
         if ($final_value !== null) {
             $reference = $final_value;

core/helpers/EEH_Event_Query.helper.php

Indentation +669 added lines, -669 removed lines

@@ -15,673 +15,673 @@
 class EEH_Event_Query
 {
 
-    /**
-     * Start Date
-     *
-     * @var $_event_query_month
-     */
-    protected static $_event_query_month;
-
-    /**
-     * Category
-     *
-     * @var $_event_query_category
-     */
-    protected static $_event_query_category;
-
-    /**
-     * whether to display expired events in the event list
-     *
-     * @var bool $_show_expired
-     */
-    protected static $_event_query_show_expired = false;
-
-    /**
-     * list of params for controlling how the query results are ordered
-     *
-     * @var array $_event_query_orderby
-     */
-    protected static $_event_query_orderby = array();
-
-    /**
-     * direction list is sorted
-     *
-     * @var string $_event_query_sort
-     */
-    protected static $_event_query_sort;
-
-    /**
-     * list of params used to build the query's various clauses
-     *
-     * @var $_query_params
-     */
-    protected static $_query_params = array();
-
-
-
-    /**
-     * @return void
-     */
-    public static function add_query_filters()
-    {
-        // add query filters
-        add_action('pre_get_posts', array('EEH_Event_Query', 'filter_query_parts'), 10, 1);
-    }
-
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return bool
-     */
-    public static function apply_query_filters(WP_Query $WP_Query)
-    {
-        return (
-                   isset($WP_Query->query['post_type'])
-                   && $WP_Query->query['post_type'] === 'espresso_events'
-               )
-               || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
-    }
-
-
-    /**
-     * @param WP_Query $WP_Query
-     */
-    public static function filter_query_parts(WP_Query $WP_Query)
-    {
-        // ONLY add our filters if this isn't the main wp_query,
-        // because if this is the main wp_query we already have
-        // our cpt strategies take care of adding things in.
-        if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
-            // build event list query
-            add_filter('posts_fields', array('EEH_Event_Query', 'posts_fields'), 10, 2);
-            add_filter('posts_join', array('EEH_Event_Query', 'posts_join'), 10, 2);
-            add_filter('posts_where', array('EEH_Event_Query', 'posts_where'), 10, 2);
-            add_filter('posts_orderby', array('EEH_Event_Query', 'posts_orderby'), 10, 2);
-            add_filter('posts_clauses_request', array('EEH_Event_Query', 'posts_clauses'), 10, 2);
-        }
-    }
-
-
-
-    /**
-     * @param string $month
-     * @param string $category
-     * @param bool   $show_expired
-     * @param string $orderby
-     * @param string $sort
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_query_params(
-        $month = '',
-        $category = '',
-        $show_expired = false,
-        $orderby = 'start_date',
-        $sort = 'ASC'
-    ) {
-        self::$_query_params                        = array();
-        EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
-        EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
-        EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
-        EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
-        EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
-    }
-
-
-
-    /**
-     * what month should the event list display events for?
-     *
-     * @param string $month
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _display_month($month = '')
-    {
-        return sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_month', $month));
-    }
-
-
-
-    /**
-     * @param string $category
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _event_category_slug($category = '')
-    {
-        return sanitize_title_with_dashes(EE_Registry::instance()->REQ->get('event_query_category', $category));
-    }
-
-
-
-    /**
-     * @param bool $show_expired
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _show_expired($show_expired = false)
-    {
-        // override default expired option if set via filter
-        return filter_var(
-            EE_Registry::instance()->REQ->get('event_query_show_expired', $show_expired),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-
-    /**
-     * @param    string $orderby
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _orderby($orderby = 'start_date')
-    {
-        $event_query_orderby = EE_Registry::instance()->REQ->get('event_query_orderby', $orderby);
-        $event_query_orderby = is_array($event_query_orderby)
-            ? $event_query_orderby
-            : explode(',', $event_query_orderby);
-        $event_query_orderby = array_map('trim', $event_query_orderby);
-        $event_query_orderby = array_map('sanitize_text_field', $event_query_orderby);
-        return $event_query_orderby;
-    }
-
-
-
-    /**
-     * @param string $sort
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _sort($sort = 'ASC')
-    {
-        $sort = EE_Registry::instance()->REQ->get('event_query_sort', $sort);
-        return in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
-            ? strtoupper($sort)
-            : 'ASC';
-    }
-
-
-
-    /**
-     * Filters the clauses for the WP_Query object
-     *
-     * @param array    $clauses array of clauses
-     * @param WP_Query $wp_query
-     * @return array   array of clauses
-     */
-    public static function posts_clauses($clauses, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
-        }
-        return $clauses;
-    }
-
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields($SQL, WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-            $SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param array $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_fields_sql_for_orderby(array $orderby_params = array())
-    {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
-                    break;
-                case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
-                    break;
-                case 'venue_title':
-                    $SQL .= ', Venue.post_title AS venue_title';
-                    break;
-                case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
-                    break;
-                case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join($SQL = '', WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Category
-            $SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
-            $SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
-            $SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string  $SQL
-     * @param boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
-    {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            // don't add if this is already in the SQL
-            if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
-            }
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
-     *                              used for anything yet
-     * @return string
-     */
-    public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
-    {
-        if (! empty($join_terms)) {
-            global $wpdb;
-            $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
-            $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
-            $SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
-     *
-     * @param    string $SQL
-     * @param    array  $orderby_params
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_join_for_orderby($SQL = '', array $orderby_params = array())
-    {
-        foreach ($orderby_params as $orderby) {
-            switch ($orderby) {
-                case 'ticket_start':
-                case 'ticket_end':
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime(
-                        $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
-                    );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
-                    $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
-                    $SQL .= ' )';
-                    break;
-                case 'venue_title':
-                case 'city':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    break;
-                case 'state':
-                    $SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
-                    $SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
-                    break;
-            }
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @param string $join
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_datetime($SQL = '', $join = '')
-    {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-            if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
-            }
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_event_venue($SQL = '')
-    {
-        // Event Venue table name
-        $event_venue_table = EEM_Event_Venue::instance()->table();
-        // generate conditions for:  Event <=> Event Venue  JOIN clause
-        $event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
-        $event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
-        // don't add joins if they have already been added
-        if (strpos($SQL, $event_to_event_venue_join) === false) {
-            // Venue table name
-            $venue_table = EEM_Venue::instance()->table();
-            // Venue table pk
-            $venue_table_pk = EEM_Venue::instance()->primary_key_name();
-            // Venue Meta table name
-            $venue_meta_table = EEM_Venue::instance()->second_table();
-            // generate JOIN clause for: Event <=> Event Venue
-            $venue_SQL = " LEFT JOIN $event_venue_table ON ( $event_to_event_venue_join )";
-            // generate JOIN clause for: Event Venue <=> Venue
-            $venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
-            // generate JOIN clause for: Venue <=> Venue Meta
-            $venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
-            unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
-            return $venue_SQL;
-        }
-        unset($event_venue_table, $event_to_event_venue_join);
-        return '';
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _posts_join_for_venue_state($SQL = '')
-    {
-        // Venue Meta table name
-        $venue_meta_table = EEM_Venue::instance()->second_table();
-        // State table name
-        $state_table = EEM_State::instance()->table();
-        // State table pk
-        $state_table_pk = EEM_State::instance()->primary_key_name();
-        // verify vars
-        if ($venue_meta_table && $state_table && $state_table_pk) {
-            // like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
-            $join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
-            // don't add join if it has already been added
-            if (strpos($SQL, $join) === false) {
-                unset($state_table_pk, $venue_meta_table, $venue_table_pk);
-                return " LEFT JOIN $state_table ON ( $join )";
-            }
-        }
-        unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
-        return '';
-    }
-
-
-
-    /**
-     * @param string   $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where($SQL = '', WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            // Show Expired ?
-            $SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
-            // Category
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
-            // Start Date
-            $SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param    boolean $show_expired if TRUE, then displayed past events
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
-            : '';
-    }
-
-
-
-    /**
-     * @param boolean $event_category_slug
-     * @return string
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        global $wpdb;
-        return ! empty($event_category_slug)
-            ? $wpdb->prepare(" AND {$wpdb->terms}.slug = %s ", $event_category_slug)
-            : '';
-    }
-
-
-
-    /**
-     * @param boolean $month
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        $SQL = '';
-        if (! empty($month)) {
-            $datetime_table = EEM_Datetime::instance()->table();
-            // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-            $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
-            // event end date is GREATER than the start of the month ( so nothing that ended before this month )
-            $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     * @param string $SQL
-     * @param WP_Query $wp_query
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby($SQL = '', WP_Query $wp_query)
-    {
-        if (EEH_Event_Query::apply_query_filters($wp_query)) {
-            $SQL = EEH_Event_Query::posts_orderby_sql(
-                EEH_Event_Query::$_event_query_orderby,
-                EEH_Event_Query::$_event_query_sort
-            );
-        }
-        return $SQL;
-    }
-
-
-
-    /**
-     *    posts_orderby_sql
-     *    possible parameters:
-     *    ID
-     *    start_date
-     *    end_date
-     *    event_name
-     *    category_slug
-     *    ticket_start
-     *    ticket_end
-     *    venue_title
-     *    city
-     *    state
-     *    **IMPORTANT**
-     *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
-     *    or else some of the table references below will result in MySQL errors
-     *
-     * @param array  $orderby_params
-     * @param string $sort
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function posts_orderby_sql(array $orderby_params = array(), $sort = 'ASC')
-    {
-        global $wpdb;
-        $SQL     = '';
-        $counter = 0;
-        $sort    = in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
-            ? strtoupper($sort)
-            : 'ASC';
-        // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
-            self::$_query_params['orderby'] = array();
-        }
-        // loop thru $orderby_params (type cast as array)
-        foreach ($orderby_params as $orderby) {
-            // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
-                // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
-                // then bump ahead to the next param
-                continue;
-            }
-            // this will ad a comma depending on whether this is the first or last param
-            $glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
-            // ok what's we dealing with?
-            switch ($orderby) {
-                case 'id':
-                case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
-                    break;
-                case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
-                    break;
-                case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
-                    break;
-                case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
-                    break;
-                case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
-                    break;
-                case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
-                    break;
-                case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
-                    break;
-                case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
-                    break;
-                case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
-                    break;
-                case 'start_date':
-                default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
-                    break;
-            }
-            // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
-            $counter++;
-        }
-        return $SQL;
-    }
+	/**
+	 * Start Date
+	 *
+	 * @var $_event_query_month
+	 */
+	protected static $_event_query_month;
+
+	/**
+	 * Category
+	 *
+	 * @var $_event_query_category
+	 */
+	protected static $_event_query_category;
+
+	/**
+	 * whether to display expired events in the event list
+	 *
+	 * @var bool $_show_expired
+	 */
+	protected static $_event_query_show_expired = false;
+
+	/**
+	 * list of params for controlling how the query results are ordered
+	 *
+	 * @var array $_event_query_orderby
+	 */
+	protected static $_event_query_orderby = array();
+
+	/**
+	 * direction list is sorted
+	 *
+	 * @var string $_event_query_sort
+	 */
+	protected static $_event_query_sort;
+
+	/**
+	 * list of params used to build the query's various clauses
+	 *
+	 * @var $_query_params
+	 */
+	protected static $_query_params = array();
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function add_query_filters()
+	{
+		// add query filters
+		add_action('pre_get_posts', array('EEH_Event_Query', 'filter_query_parts'), 10, 1);
+	}
+
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return bool
+	 */
+	public static function apply_query_filters(WP_Query $WP_Query)
+	{
+		return (
+				   isset($WP_Query->query['post_type'])
+				   && $WP_Query->query['post_type'] === 'espresso_events'
+			   )
+			   || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false);
+	}
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 */
+	public static function filter_query_parts(WP_Query $WP_Query)
+	{
+		// ONLY add our filters if this isn't the main wp_query,
+		// because if this is the main wp_query we already have
+		// our cpt strategies take care of adding things in.
+		if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
+			// build event list query
+			add_filter('posts_fields', array('EEH_Event_Query', 'posts_fields'), 10, 2);
+			add_filter('posts_join', array('EEH_Event_Query', 'posts_join'), 10, 2);
+			add_filter('posts_where', array('EEH_Event_Query', 'posts_where'), 10, 2);
+			add_filter('posts_orderby', array('EEH_Event_Query', 'posts_orderby'), 10, 2);
+			add_filter('posts_clauses_request', array('EEH_Event_Query', 'posts_clauses'), 10, 2);
+		}
+	}
+
+
+
+	/**
+	 * @param string $month
+	 * @param string $category
+	 * @param bool   $show_expired
+	 * @param string $orderby
+	 * @param string $sort
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_query_params(
+		$month = '',
+		$category = '',
+		$show_expired = false,
+		$orderby = 'start_date',
+		$sort = 'ASC'
+	) {
+		self::$_query_params                        = array();
+		EEH_Event_Query::$_event_query_month        = EEH_Event_Query::_display_month($month);
+		EEH_Event_Query::$_event_query_category     = EEH_Event_Query::_event_category_slug($category);
+		EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
+		EEH_Event_Query::$_event_query_orderby      = EEH_Event_Query::_orderby($orderby);
+		EEH_Event_Query::$_event_query_sort         = EEH_Event_Query::_sort($sort);
+	}
+
+
+
+	/**
+	 * what month should the event list display events for?
+	 *
+	 * @param string $month
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _display_month($month = '')
+	{
+		return sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_month', $month));
+	}
+
+
+
+	/**
+	 * @param string $category
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _event_category_slug($category = '')
+	{
+		return sanitize_title_with_dashes(EE_Registry::instance()->REQ->get('event_query_category', $category));
+	}
+
+
+
+	/**
+	 * @param bool $show_expired
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _show_expired($show_expired = false)
+	{
+		// override default expired option if set via filter
+		return filter_var(
+			EE_Registry::instance()->REQ->get('event_query_show_expired', $show_expired),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+
+	/**
+	 * @param    string $orderby
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _orderby($orderby = 'start_date')
+	{
+		$event_query_orderby = EE_Registry::instance()->REQ->get('event_query_orderby', $orderby);
+		$event_query_orderby = is_array($event_query_orderby)
+			? $event_query_orderby
+			: explode(',', $event_query_orderby);
+		$event_query_orderby = array_map('trim', $event_query_orderby);
+		$event_query_orderby = array_map('sanitize_text_field', $event_query_orderby);
+		return $event_query_orderby;
+	}
+
+
+
+	/**
+	 * @param string $sort
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _sort($sort = 'ASC')
+	{
+		$sort = EE_Registry::instance()->REQ->get('event_query_sort', $sort);
+		return in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
+			? strtoupper($sort)
+			: 'ASC';
+	}
+
+
+
+	/**
+	 * Filters the clauses for the WP_Query object
+	 *
+	 * @param array    $clauses array of clauses
+	 * @param WP_Query $wp_query
+	 * @return array   array of clauses
+	 */
+	public static function posts_clauses($clauses, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			global $wpdb;
+			$clauses['groupby'] = $wpdb->posts . '.ID ';
+		}
+		return $clauses;
+	}
+
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields($SQL, WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
+			$SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param array $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_fields_sql_for_orderby(array $orderby_params = array())
+	{
+		$SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+					break;
+				case 'ticket_end':
+					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+					break;
+				case 'venue_title':
+					$SQL .= ', Venue.post_title AS venue_title';
+					break;
+				case 'city':
+					$SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+					break;
+				case 'state':
+					$SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join($SQL = '', WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Category
+			$SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
+			$SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
+			$SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string  $SQL
+	 * @param boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
+	{
+		if (! $show_expired) {
+			$join = EEM_Event::instance()->table() . '.ID = ';
+			$join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			// don't add if this is already in the SQL
+			if (strpos($SQL, $join) === false) {
+				$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+			}
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join_terms    pass TRUE or term string, doesn't really matter since this value doesn't really get
+	 *                              used for anything yet
+	 * @return string
+	 */
+	public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
+	{
+		if (! empty($join_terms)) {
+			global $wpdb;
+			$SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
+			$SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
+			$SQL .= " LEFT JOIN $wpdb->terms ON ($wpdb->terms.term_id = $wpdb->term_taxonomy.term_id) ";
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * usage:  $SQL .= EEH_Event_Query::posts_join_for_orderby( $orderby_params );
+	 *
+	 * @param    string $SQL
+	 * @param    array  $orderby_params
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_join_for_orderby($SQL = '', array $orderby_params = array())
+	{
+		foreach ($orderby_params as $orderby) {
+			switch ($orderby) {
+				case 'ticket_start':
+				case 'ticket_end':
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime(
+						$SQL,
+						EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+					);
+					$SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+					$SQL .= ' ON (';
+					$SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' = ';
+					$SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+					$SQL .= ' )';
+					break;
+				case 'venue_title':
+				case 'city':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					break;
+				case 'state':
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					$SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
+					break;
+				case 'start_date':
+				default:
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+					break;
+			}
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @param string $join
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_datetime($SQL = '', $join = '')
+	{
+		if (! empty($join)) {
+			$join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+			if (strpos($SQL, $join) === false) {
+				return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+			}
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_event_venue($SQL = '')
+	{
+		// Event Venue table name
+		$event_venue_table = EEM_Event_Venue::instance()->table();
+		// generate conditions for:  Event <=> Event Venue  JOIN clause
+		$event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
+		$event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+		// don't add joins if they have already been added
+		if (strpos($SQL, $event_to_event_venue_join) === false) {
+			// Venue table name
+			$venue_table = EEM_Venue::instance()->table();
+			// Venue table pk
+			$venue_table_pk = EEM_Venue::instance()->primary_key_name();
+			// Venue Meta table name
+			$venue_meta_table = EEM_Venue::instance()->second_table();
+			// generate JOIN clause for: Event <=> Event Venue
+			$venue_SQL = " LEFT JOIN $event_venue_table ON ( $event_to_event_venue_join )";
+			// generate JOIN clause for: Event Venue <=> Venue
+			$venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
+			// generate JOIN clause for: Venue <=> Venue Meta
+			$venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
+			unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
+			return $venue_SQL;
+		}
+		unset($event_venue_table, $event_to_event_venue_join);
+		return '';
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _posts_join_for_venue_state($SQL = '')
+	{
+		// Venue Meta table name
+		$venue_meta_table = EEM_Venue::instance()->second_table();
+		// State table name
+		$state_table = EEM_State::instance()->table();
+		// State table pk
+		$state_table_pk = EEM_State::instance()->primary_key_name();
+		// verify vars
+		if ($venue_meta_table && $state_table && $state_table_pk) {
+			// like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
+			$join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
+			// don't add join if it has already been added
+			if (strpos($SQL, $join) === false) {
+				unset($state_table_pk, $venue_meta_table, $venue_table_pk);
+				return " LEFT JOIN $state_table ON ( $join )";
+			}
+		}
+		unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
+		return '';
+	}
+
+
+
+	/**
+	 * @param string   $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where($SQL = '', WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			// Show Expired ?
+			$SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
+			// Category
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
+			// Start Date
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param    boolean $show_expired if TRUE, then displayed past events
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		return ! $show_expired
+			? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+			: '';
+	}
+
+
+
+	/**
+	 * @param boolean $event_category_slug
+	 * @return string
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		global $wpdb;
+		return ! empty($event_category_slug)
+			? $wpdb->prepare(" AND {$wpdb->terms}.slug = %s ", $event_category_slug)
+			: '';
+	}
+
+
+
+	/**
+	 * @param boolean $month
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		$SQL = '';
+		if (! empty($month)) {
+			$datetime_table = EEM_Datetime::instance()->table();
+			// event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
+			$SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
+			$SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+			// event end date is GREATER than the start of the month ( so nothing that ended before this month )
+			$SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
+			$SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 * @param string $SQL
+	 * @param WP_Query $wp_query
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby($SQL = '', WP_Query $wp_query)
+	{
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			$SQL = EEH_Event_Query::posts_orderby_sql(
+				EEH_Event_Query::$_event_query_orderby,
+				EEH_Event_Query::$_event_query_sort
+			);
+		}
+		return $SQL;
+	}
+
+
+
+	/**
+	 *    posts_orderby_sql
+	 *    possible parameters:
+	 *    ID
+	 *    start_date
+	 *    end_date
+	 *    event_name
+	 *    category_slug
+	 *    ticket_start
+	 *    ticket_end
+	 *    venue_title
+	 *    city
+	 *    state
+	 *    **IMPORTANT**
+	 *    make sure to also send the $orderby_params array to the posts_join_for_orderby() method
+	 *    or else some of the table references below will result in MySQL errors
+	 *
+	 * @param array  $orderby_params
+	 * @param string $sort
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function posts_orderby_sql(array $orderby_params = array(), $sort = 'ASC')
+	{
+		global $wpdb;
+		$SQL     = '';
+		$counter = 0;
+		$sort    = in_array($sort, array('ASC', 'asc', 'DESC', 'desc'), true)
+			? strtoupper($sort)
+			: 'ASC';
+		// make sure 'orderby' is set in query params
+		if (! isset(self::$_query_params['orderby'])) {
+			self::$_query_params['orderby'] = array();
+		}
+		// loop thru $orderby_params (type cast as array)
+		foreach ($orderby_params as $orderby) {
+			// check if we have already added this param
+			if (isset(self::$_query_params['orderby'][ $orderby ])) {
+				// if so then remove from the $orderby_params so that the count() method below is accurate
+				unset($orderby_params[ $orderby ]);
+				// then bump ahead to the next param
+				continue;
+			}
+			// this will ad a comma depending on whether this is the first or last param
+			$glue = $counter === 0 || $counter === count($orderby_params) ? ' ' : ', ';
+			// ok what's we dealing with?
+			switch ($orderby) {
+				case 'id':
+				case 'ID':
+					$SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+					break;
+				case 'end_date':
+					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+					break;
+				case 'event_name':
+					$SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+					break;
+				case 'category_slug':
+					$SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+					break;
+				case 'ticket_start':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+					break;
+				case 'ticket_end':
+					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+					break;
+				case 'venue_title':
+					$SQL .= $glue . 'venue_title ' . $sort;
+					break;
+				case 'city':
+					$SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+					break;
+				case 'state':
+					$SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+					break;
+				case 'start_date':
+				default:
+					$SQL .= $glue . ' event_start_date ' . $sort;
+					break;
+			}
+			// add to array of orderby params that have been added
+			self::$_query_params['orderby'][ $orderby ] = true;
+			$counter++;
+		}
+		return $SQL;
+	}
 }

Spacing +39 added lines, -39 removed lines

@@ -227,7 +227,7 @@ 
     {
         if (EEH_Event_Query::apply_query_filters($wp_query)) {
             global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
+            $clauses['groupby'] = $wpdb->posts.'.ID ';
         }
         return $clauses;
     }
@@ -264,23 +264,23 @@ 
      */
     public static function posts_fields_sql_for_orderby(array $orderby_params = array())
     {
-        $SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ';
+        $SQL = ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
         foreach ($orderby_params as $orderby) {
             switch ($orderby) {
                 case 'ticket_start':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_start_date';
                     break;
                 case 'ticket_end':
-                    $SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date';
+                    $SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_end_date';
                     break;
                 case 'venue_title':
                     $SQL .= ', Venue.post_title AS venue_title';
                     break;
                 case 'city':
-                    $SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city';
+                    $SQL .= ', '.EEM_Venue::instance()->second_table().'.VNU_city';
                     break;
                 case 'state':
-                    $SQL .= ', ' . EEM_State::instance()->table() . '.STA_name';
+                    $SQL .= ', '.EEM_State::instance()->table().'.STA_name';
                     break;
             }
         }
@@ -322,12 +322,12 @@ 
      */
     public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = false)
     {
-        if (! $show_expired) {
-            $join = EEM_Event::instance()->table() . '.ID = ';
-            $join .= EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! $show_expired) {
+            $join = EEM_Event::instance()->table().'.ID = ';
+            $join .= EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             // don't add if this is already in the SQL
             if (strpos($SQL, $join) === false) {
-                $SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+                $SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' ) ';
             }
         }
         return $SQL;
@@ -343,7 +343,7 @@ 
      */
     public static function posts_join_sql_for_terms($SQL = '', $join_terms = '')
     {
-        if (! empty($join_terms)) {
+        if ( ! empty($join_terms)) {
             global $wpdb;
             $SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
             $SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
@@ -373,13 +373,13 @@ 
                 case 'ticket_end':
                     $SQL .= EEH_Event_Query::_posts_join_for_datetime(
                         $SQL,
-                        EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name()
+                        EEM_Datetime_Ticket::instance()->table().'.'.EEM_Datetime::instance()->primary_key_name()
                     );
-                    $SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table();
+                    $SQL .= ' LEFT JOIN '.EEM_Ticket::instance()->table();
                     $SQL .= ' ON (';
-                    $SQL .= EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Datetime_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' = ';
-                    $SQL .= EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name();
+                    $SQL .= EEM_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name();
                     $SQL .= ' )';
                     break;
                 case 'venue_title':
@@ -392,7 +392,7 @@ 
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table() . '.ID');
+                    $SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table().'.ID');
                     break;
             }
         }
@@ -412,10 +412,10 @@ 
      */
     protected static function _posts_join_for_datetime($SQL = '', $join = '')
     {
-        if (! empty($join)) {
-            $join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
+        if ( ! empty($join)) {
+            $join .= ' = '.EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
             if (strpos($SQL, $join) === false) {
-                return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+                return ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' )';
             }
         }
         return '';
@@ -436,8 +436,8 @@ 
         // Event Venue table name
         $event_venue_table = EEM_Event_Venue::instance()->table();
         // generate conditions for:  Event <=> Event Venue  JOIN clause
-        $event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ';
-        $event_to_event_venue_join .= $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+        $event_to_event_venue_join = EEM_Event::instance()->table().'.ID = ';
+        $event_to_event_venue_join .= $event_venue_table.'.'.EEM_Event::instance()->primary_key_name();
         // don't add joins if they have already been added
         if (strpos($SQL, $event_to_event_venue_join) === false) {
             // Venue table name
@@ -528,7 +528,7 @@ 
     public static function posts_where_sql_for_show_expired($show_expired = false)
     {
         return ! $show_expired
-            ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > \'' . current_time('mysql', true) . '\' '
+            ? ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end > \''.current_time('mysql', true).'\' '
             : '';
     }
 
@@ -559,14 +559,14 @@ 
     public static function posts_where_sql_for_event_list_month($month = null)
     {
         $SQL = '';
-        if (! empty($month)) {
+        if ( ! empty($month)) {
             $datetime_table = EEM_Datetime::instance()->table();
             // event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
             $SQL = " AND {$datetime_table}.DTT_EVT_start <= '";
-            $SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "'";
+            $SQL .= date('Y-m-t 23:59:59', \EEH_DTT_Helper::first_of_month_timestamp($month))."'";
             // event end date is GREATER than the start of the month ( so nothing that ended before this month )
             $SQL .= " AND {$datetime_table}.DTT_EVT_end >= '";
-            $SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month)) . "' ";
+            $SQL .= date('Y-m-01 0:0:00', \EEH_DTT_Helper::first_of_month_timestamp($month))."' ";
         }
         return $SQL;
     }
@@ -629,15 +629,15 @@ 
             ? strtoupper($sort)
             : 'ASC';
         // make sure 'orderby' is set in query params
-        if (! isset(self::$_query_params['orderby'])) {
+        if ( ! isset(self::$_query_params['orderby'])) {
             self::$_query_params['orderby'] = array();
         }
         // loop thru $orderby_params (type cast as array)
         foreach ($orderby_params as $orderby) {
             // check if we have already added this param
-            if (isset(self::$_query_params['orderby'][ $orderby ])) {
+            if (isset(self::$_query_params['orderby'][$orderby])) {
                 // if so then remove from the $orderby_params so that the count() method below is accurate
-                unset($orderby_params[ $orderby ]);
+                unset($orderby_params[$orderby]);
                 // then bump ahead to the next param
                 continue;
             }
@@ -647,39 +647,39 @@ 
             switch ($orderby) {
                 case 'id':
                 case 'ID':
-                    $SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.ID '.$sort;
                     break;
                 case 'end_date':
-                    $SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+                    $SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_end '.$sort;
                     break;
                 case 'event_name':
-                    $SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+                    $SQL .= $glue.$wpdb->posts.'.post_title '.$sort;
                     break;
                 case 'category_slug':
-                    $SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+                    $SQL .= $glue.$wpdb->terms.'.slug '.$sort;
                     break;
                 case 'ticket_start':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_start_date '.$sort;
                     break;
                 case 'ticket_end':
-                    $SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+                    $SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_end_date '.$sort;
                     break;
                 case 'venue_title':
-                    $SQL .= $glue . 'venue_title ' . $sort;
+                    $SQL .= $glue.'venue_title '.$sort;
                     break;
                 case 'city':
-                    $SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+                    $SQL .= $glue.EEM_Venue::instance()->second_table().'.VNU_city '.$sort;
                     break;
                 case 'state':
-                    $SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+                    $SQL .= $glue.EEM_State::instance()->table().'.STA_name '.$sort;
                     break;
                 case 'start_date':
                 default:
-                    $SQL .= $glue . ' event_start_date ' . $sort;
+                    $SQL .= $glue.' event_start_date '.$sort;
                     break;
             }
             // add to array of orderby params that have been added
-            self::$_query_params['orderby'][ $orderby ] = true;
+            self::$_query_params['orderby'][$orderby] = true;
             $counter++;
         }
         return $SQL;

core/helpers/EEH_Class_Tools.helper.php

Indentation +114 added lines, -114 removed lines

@@ -11,131 +11,131 @@
 class EEH_Class_Tools
 {
 
-    public static $i = 0;
-    public static $file_line = null;
+	public static $i = 0;
+	public static $file_line = null;
 
-    /**
-     *  get_called_class - for PHP versions < 5.3
-     *
-     *  @access     public
-     *  @author origins:  http://stackoverflow.com/a/1542045
-     *  return string
-     */
-    public static function get_called_class()
-    {
-        $backtrace = debug_backtrace();
-        if (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['class']) && ! isset($backtrace[2]['file'])) {
-            return $backtrace[2]['class'];
-        } elseif (isset($backtrace[3]) && is_array($backtrace[3]) && isset($backtrace[3]['class']) && ! isset($backtrace[3]['file'])) {
-            return $backtrace[3]['class'];
-        } elseif (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['file']) && isset($backtrace[2]['line'])) {
-            if (self::$file_line == $backtrace[2]['file'] . $backtrace[2]['line']) {
-                self::$i++;
-            } else {
-                self::$i = 0;
-                self::$file_line = $backtrace[2]['file'] . $backtrace[2]['line'];
-            }
-            // was  class method called via call_user_func ?
-            if ($backtrace[2]['function'] == 'call_user_func' && isset($backtrace[2]['args']) && is_array($backtrace[2]['args'])) {
-                if (isset($backtrace[2]['args'][0]) && isset($backtrace[2]['args'][0][0])) {
-                    $called_class = $backtrace[2]['args'][0][0];
-                    // is it an EE function ?
-                    if (strpos($called_class, 'EE') === 0) {
-                        $prefix_chars = strpos($called_class, '_') + 1;
-                        $prefix = substr($called_class, 0, $prefix_chars);
-                        $classname = substr($called_class, $prefix_chars, strlen($called_class));
-                        $classname = $prefix . str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
-                        return $classname;
-                    }
-                }
-            } else {
-                $lines = file($backtrace[2]['file']);
-                preg_match_all('/([a-zA-Z0-9\_]+)::' . $backtrace[2]['function'] . '/', $lines[ $backtrace[2]['line']-1 ], $matches);
-                if (isset($matches[1]) && isset($matches[1][ self::$i ])) {
-                    return $matches[1][ self::$i ];
-                }
-            }
-        }
-        return false;
-    }
+	/**
+	 *  get_called_class - for PHP versions < 5.3
+	 *
+	 *  @access     public
+	 *  @author origins:  http://stackoverflow.com/a/1542045
+	 *  return string
+	 */
+	public static function get_called_class()
+	{
+		$backtrace = debug_backtrace();
+		if (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['class']) && ! isset($backtrace[2]['file'])) {
+			return $backtrace[2]['class'];
+		} elseif (isset($backtrace[3]) && is_array($backtrace[3]) && isset($backtrace[3]['class']) && ! isset($backtrace[3]['file'])) {
+			return $backtrace[3]['class'];
+		} elseif (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['file']) && isset($backtrace[2]['line'])) {
+			if (self::$file_line == $backtrace[2]['file'] . $backtrace[2]['line']) {
+				self::$i++;
+			} else {
+				self::$i = 0;
+				self::$file_line = $backtrace[2]['file'] . $backtrace[2]['line'];
+			}
+			// was  class method called via call_user_func ?
+			if ($backtrace[2]['function'] == 'call_user_func' && isset($backtrace[2]['args']) && is_array($backtrace[2]['args'])) {
+				if (isset($backtrace[2]['args'][0]) && isset($backtrace[2]['args'][0][0])) {
+					$called_class = $backtrace[2]['args'][0][0];
+					// is it an EE function ?
+					if (strpos($called_class, 'EE') === 0) {
+						$prefix_chars = strpos($called_class, '_') + 1;
+						$prefix = substr($called_class, 0, $prefix_chars);
+						$classname = substr($called_class, $prefix_chars, strlen($called_class));
+						$classname = $prefix . str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
+						return $classname;
+					}
+				}
+			} else {
+				$lines = file($backtrace[2]['file']);
+				preg_match_all('/([a-zA-Z0-9\_]+)::' . $backtrace[2]['function'] . '/', $lines[ $backtrace[2]['line']-1 ], $matches);
+				if (isset($matches[1]) && isset($matches[1][ self::$i ])) {
+					return $matches[1][ self::$i ];
+				}
+			}
+		}
+		return false;
+	}
 
 
 
 
-    /**
-     *  get_class_names_for_all_callbacks_on_hook
-     * returns an array of names for all classes that have methods registered as callbacks for the given action or filter hook
-     *  @access     public
-     *  @param  string  $hook
-     *  @return     array
-     */
-    public static function get_class_names_for_all_callbacks_on_hook($hook = null)
-    {
-        global $wp_filter;
-        $class_names = array();
-        // are any callbacks registered for this hook ?
-        if (isset($wp_filter[ $hook ])) {
-            // loop thru all of the callbacks attached to the deprecated hookpoint
-            foreach ($wp_filter[ $hook ] as $priority) {
-                foreach ($priority as $callback) {
-                    // is the callback a non-static class method ?
-                    if (isset($callback['function']) && is_array($callback['function'])) {
-                        if (isset($callback['function'][0]) && is_object($callback['function'][0])) {
-                            $class_names[] = get_class($callback['function'][0]);
-                        }
-                    // test for static method
-                    } elseif (strpos($callback['function'], '::') !== false) {
-                        $class = explode('::', $callback['function']);
-                        $class_names[] = $class[0];
-                    } else {
-                        // just a function
-                    }
-                }
-            }
-        }
-        return $class_names;
-    }
+	/**
+	 *  get_class_names_for_all_callbacks_on_hook
+	 * returns an array of names for all classes that have methods registered as callbacks for the given action or filter hook
+	 *  @access     public
+	 *  @param  string  $hook
+	 *  @return     array
+	 */
+	public static function get_class_names_for_all_callbacks_on_hook($hook = null)
+	{
+		global $wp_filter;
+		$class_names = array();
+		// are any callbacks registered for this hook ?
+		if (isset($wp_filter[ $hook ])) {
+			// loop thru all of the callbacks attached to the deprecated hookpoint
+			foreach ($wp_filter[ $hook ] as $priority) {
+				foreach ($priority as $callback) {
+					// is the callback a non-static class method ?
+					if (isset($callback['function']) && is_array($callback['function'])) {
+						if (isset($callback['function'][0]) && is_object($callback['function'][0])) {
+							$class_names[] = get_class($callback['function'][0]);
+						}
+					// test for static method
+					} elseif (strpos($callback['function'], '::') !== false) {
+						$class = explode('::', $callback['function']);
+						$class_names[] = $class[0];
+					} else {
+						// just a function
+					}
+				}
+			}
+		}
+		return $class_names;
+	}
 
 
 
 
-    /**
-     *  property_exists() with fallback for PHP versions < 5.3
-     *  @access     public
-     *  @param      mixed object | string   $class
-     *  @param      string  $property
-     *  @return         boolean
-     */
-    public static function has_property($class = null, $property = null)
-    {
-        // if $class or $property don't exist, then get out, cuz that would be like... fatal dude
-        if (empty($class) || empty($property)) {
-            return false;
-        }
-        // if your hosting company doesn't cut the mustard
-        if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-            // just in case $class is an actual instantiated object
-            if (is_object($class)) {
-                return isset($class->{$property}) ? true : false;
-            } else {
-                // use reflection for < PHP 5.3 to get details using just the class name
-                $reflector = new ReflectionClass($class);
-                return $reflector->hasProperty($property);
-            }
-        } else {
-            // or try regular property exists method which works as expected in PHP 5.3+
-            return property_exists($class, $property);
-        }
-    }
+	/**
+	 *  property_exists() with fallback for PHP versions < 5.3
+	 *  @access     public
+	 *  @param      mixed object | string   $class
+	 *  @param      string  $property
+	 *  @return         boolean
+	 */
+	public static function has_property($class = null, $property = null)
+	{
+		// if $class or $property don't exist, then get out, cuz that would be like... fatal dude
+		if (empty($class) || empty($property)) {
+			return false;
+		}
+		// if your hosting company doesn't cut the mustard
+		if (version_compare(PHP_VERSION, '5.3.0') < 0) {
+			// just in case $class is an actual instantiated object
+			if (is_object($class)) {
+				return isset($class->{$property}) ? true : false;
+			} else {
+				// use reflection for < PHP 5.3 to get details using just the class name
+				$reflector = new ReflectionClass($class);
+				return $reflector->hasProperty($property);
+			}
+		} else {
+			// or try regular property exists method which works as expected in PHP 5.3+
+			return property_exists($class, $property);
+		}
+	}
 }
 
 // if PHP version < 5.3
 if (! function_exists('get_called_class')) {
-    /**
-     * @return string
-     */
-    function get_called_class()
-    {
-        return EEH_Class_Tools::get_called_class();
-    }
+	/**
+	 * @return string
+	 */
+	function get_called_class()
+	{
+		return EEH_Class_Tools::get_called_class();
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -29,11 +29,11 @@ 
         } elseif (isset($backtrace[3]) && is_array($backtrace[3]) && isset($backtrace[3]['class']) && ! isset($backtrace[3]['file'])) {
             return $backtrace[3]['class'];
         } elseif (isset($backtrace[2]) && is_array($backtrace[2]) && isset($backtrace[2]['file']) && isset($backtrace[2]['line'])) {
-            if (self::$file_line == $backtrace[2]['file'] . $backtrace[2]['line']) {
+            if (self::$file_line == $backtrace[2]['file'].$backtrace[2]['line']) {
                 self::$i++;
             } else {
                 self::$i = 0;
-                self::$file_line = $backtrace[2]['file'] . $backtrace[2]['line'];
+                self::$file_line = $backtrace[2]['file'].$backtrace[2]['line'];
             }
             // was  class method called via call_user_func ?
             if ($backtrace[2]['function'] == 'call_user_func' && isset($backtrace[2]['args']) && is_array($backtrace[2]['args'])) {
@@ -44,15 +44,15 @@ 
                         $prefix_chars = strpos($called_class, '_') + 1;
                         $prefix = substr($called_class, 0, $prefix_chars);
                         $classname = substr($called_class, $prefix_chars, strlen($called_class));
-                        $classname = $prefix . str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
+                        $classname = $prefix.str_replace(' ', '_', ucwords(strtolower(str_replace('_', ' ', $classname))));
                         return $classname;
                     }
                 }
             } else {
                 $lines = file($backtrace[2]['file']);
-                preg_match_all('/([a-zA-Z0-9\_]+)::' . $backtrace[2]['function'] . '/', $lines[ $backtrace[2]['line']-1 ], $matches);
-                if (isset($matches[1]) && isset($matches[1][ self::$i ])) {
-                    return $matches[1][ self::$i ];
+                preg_match_all('/([a-zA-Z0-9\_]+)::'.$backtrace[2]['function'].'/', $lines[$backtrace[2]['line'] - 1], $matches);
+                if (isset($matches[1]) && isset($matches[1][self::$i])) {
+                    return $matches[1][self::$i];
                 }
             }
         }
@@ -74,9 +74,9 @@ 
         global $wp_filter;
         $class_names = array();
         // are any callbacks registered for this hook ?
-        if (isset($wp_filter[ $hook ])) {
+        if (isset($wp_filter[$hook])) {
             // loop thru all of the callbacks attached to the deprecated hookpoint
-            foreach ($wp_filter[ $hook ] as $priority) {
+            foreach ($wp_filter[$hook] as $priority) {
                 foreach ($priority as $callback) {
                     // is the callback a non-static class method ?
                     if (isset($callback['function']) && is_array($callback['function'])) {
@@ -130,7 +130,7 @@ 
 }
 
 // if PHP version < 5.3
-if (! function_exists('get_called_class')) {
+if ( ! function_exists('get_called_class')) {
     /**
      * @return string
      */

core/CPTs/EE_CPT_Default_Strategy.core.php

Indentation +58 added lines, -58 removed lines

@@ -13,70 +13,70 @@
 {
 
 
-    /**
-     * $CPT - the current page, if it utilizes CPTs
-     *
-     * @var    object
-     * @access    protected
-     */
-    protected $CPT = null;
+	/**
+	 * $CPT - the current page, if it utilizes CPTs
+	 *
+	 * @var    object
+	 * @access    protected
+	 */
+	protected $CPT = null;
 
 
-    /**
-     *    class constructor
-     *
-     * @access    private
-     * @param    array $arguments
-     * @return    \EE_CPT_Default_Strategy
-     */
-    public function __construct($arguments = array())
-    {
-        $this->CPT = isset($arguments['CPT']) ? $arguments['CPT'] : null;
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 * @param    array $arguments
+	 * @return    \EE_CPT_Default_Strategy
+	 */
+	public function __construct($arguments = array())
+	{
+		$this->CPT = isset($arguments['CPT']) ? $arguments['CPT'] : null;
+	}
 
 
-    /**
-     *    pre_get_posts
-     *
-     * @access    public
-     * @param    \WP_Query $WP_Query
-     * @return    \WP_Query
-     */
-    public function pre_get_posts(WP_Query $WP_Query)
-    {
-        if (! $WP_Query->is_main_query() && ! $WP_Query->is_archive()) {
-            return $WP_Query;
-        }
-        return $WP_Query;
-    }
+	/**
+	 *    pre_get_posts
+	 *
+	 * @access    public
+	 * @param    \WP_Query $WP_Query
+	 * @return    \WP_Query
+	 */
+	public function pre_get_posts(WP_Query $WP_Query)
+	{
+		if (! $WP_Query->is_main_query() && ! $WP_Query->is_archive()) {
+			return $WP_Query;
+		}
+		return $WP_Query;
+	}
 
 
-    /**
-     *    wp
-     *
-     * @access    public
-     * @param    \WP_Post[] $posts
-     * @param    \WP_Query  $WP_Query
-     * @return    \WP_Post[]
-     */
-    public function the_posts($posts, WP_Query $WP_Query)
-    {
-        return $posts;
-    }
+	/**
+	 *    wp
+	 *
+	 * @access    public
+	 * @param    \WP_Post[] $posts
+	 * @param    \WP_Query  $WP_Query
+	 * @return    \WP_Post[]
+	 */
+	public function the_posts($posts, WP_Query $WP_Query)
+	{
+		return $posts;
+	}
 
 
-    /**
-     *    get_EE_post_type_metadata
-     *
-     * @access    public
-     * @param mixed     $meta_value
-     * @param    int    $post_id
-     * @param    string $meta_key
-     * @param    string $single
-     * @return    mixed
-     */
-    public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
-    {
-        return $meta_value;
-    }
+	/**
+	 *    get_EE_post_type_metadata
+	 *
+	 * @access    public
+	 * @param mixed     $meta_value
+	 * @param    int    $post_id
+	 * @param    string $meta_key
+	 * @param    string $single
+	 * @return    mixed
+	 */
+	public function get_EE_post_type_metadata($meta_value = null, $post_id, $meta_key, $single)
+	{
+		return $meta_value;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
      */
     public function pre_get_posts(WP_Query $WP_Query)
     {
-        if (! $WP_Query->is_main_query() && ! $WP_Query->is_archive()) {
+        if ( ! $WP_Query->is_main_query() && ! $WP_Query->is_archive()) {
             return $WP_Query;
         }
         return $WP_Query;

core/CPTs/EE_CPT_Attendee_Strategy.core.php

Indentation +31 added lines, -31 removed lines

@@ -24,39 +24,39 @@
 class EE_CPT_Attendee_Strategy
 {
 
-    /**
-     * $CPT - the current page, if it utilizes CPTs
-     *
-     * @var    array
-     * @access    protected
-     */
-    protected $CPT = null;
+	/**
+	 * $CPT - the current page, if it utilizes CPTs
+	 *
+	 * @var    array
+	 * @access    protected
+	 */
+	protected $CPT = null;
 
 
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    array $arguments
-     * @return \EE_CPT_Attendee_Strategy
-     */
-    public function __construct($arguments = array())
-    {
-        $this->CPT = isset($arguments['CPT']) ? $arguments['CPT'] : null;
-        $WP_Query = isset($arguments['WP_Query']) ? $arguments['WP_Query'] : null;
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    array $arguments
+	 * @return \EE_CPT_Attendee_Strategy
+	 */
+	public function __construct($arguments = array())
+	{
+		$this->CPT = isset($arguments['CPT']) ? $arguments['CPT'] : null;
+		$WP_Query = isset($arguments['WP_Query']) ? $arguments['WP_Query'] : null;
+	}
 
 
-    /**
-     *    the_posts
-     *
-     * @access    public
-     * @param          $posts
-     * @param WP_Query $wp_query
-     * @return    void
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        return $posts;
-    }
+	/**
+	 *    the_posts
+	 *
+	 * @access    public
+	 * @param          $posts
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		return $posts;
+	}
 }

core/CPTs/EE_CPT_Venue_Strategy.core.php

Indentation +46 added lines, -46 removed lines

@@ -12,54 +12,54 @@
 class EE_CPT_Venue_Strategy
 {
 
-    /**
-     * $CPT - the current page, if it utilizes CPTs
-     *
-     * @var    array
-     * @access    protected
-     */
-    protected $CPT = null;
+	/**
+	 * $CPT - the current page, if it utilizes CPTs
+	 *
+	 * @var    array
+	 * @access    protected
+	 */
+	protected $CPT = null;
 
 
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    array $arguments
-     * @return \EE_CPT_Venue_Strategy
-     */
-    public function __construct($arguments = array())
-    {
-        $this->CPT = isset($arguments['CPT']) ? $arguments['CPT'] : null;
-        $WP_Query = isset($arguments['WP_Query']) ? $arguments['WP_Query'] : null;
-        if ($WP_Query instanceof WP_Query && ! $WP_Query->is_tag) {
-            $WP_Query->is_espresso_venue_single = is_singular()
-                                                  && isset($WP_Query->query->post_type)
-                                                  && $WP_Query->query->post_type == 'espresso_venues';
-            $WP_Query->is_espresso_venue_archive = is_post_type_archive('espresso_venues') ? true : false;
-            $WP_Query->is_espresso_venue_taxonomy = is_tax('espresso_venue_categories') ? true : false;
-        }
-        add_filter('the_posts', array($this, 'the_posts'), 1, 2);
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    array $arguments
+	 * @return \EE_CPT_Venue_Strategy
+	 */
+	public function __construct($arguments = array())
+	{
+		$this->CPT = isset($arguments['CPT']) ? $arguments['CPT'] : null;
+		$WP_Query = isset($arguments['WP_Query']) ? $arguments['WP_Query'] : null;
+		if ($WP_Query instanceof WP_Query && ! $WP_Query->is_tag) {
+			$WP_Query->is_espresso_venue_single = is_singular()
+												  && isset($WP_Query->query->post_type)
+												  && $WP_Query->query->post_type == 'espresso_venues';
+			$WP_Query->is_espresso_venue_archive = is_post_type_archive('espresso_venues') ? true : false;
+			$WP_Query->is_espresso_venue_taxonomy = is_tax('espresso_venue_categories') ? true : false;
+		}
+		add_filter('the_posts', array($this, 'the_posts'), 1, 2);
+	}
 
 
-    /**
-     *    the_posts
-     *
-     * @access    public
-     * @param          $posts
-     * @param WP_Query $wp_query
-     * @return    void
-     */
-    public function the_posts($posts, WP_Query $wp_query)
-    {
-        // automagically load the EEH_Venue_View helper so that it's functions are available
-        if (isset(EE_Registry::instance()->CFG->map_settings->use_google_maps)
-            && EE_Registry::instance()->CFG->map_settings->use_google_maps
-        ) {
-            EEH_Maps::espresso_google_map_js();
-        }
-        remove_filter('the_posts', array($this, 'the_posts'), 1, 2);
-        return $posts;
-    }
+	/**
+	 *    the_posts
+	 *
+	 * @access    public
+	 * @param          $posts
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 */
+	public function the_posts($posts, WP_Query $wp_query)
+	{
+		// automagically load the EEH_Venue_View helper so that it's functions are available
+		if (isset(EE_Registry::instance()->CFG->map_settings->use_google_maps)
+			&& EE_Registry::instance()->CFG->map_settings->use_google_maps
+		) {
+			EEH_Maps::espresso_google_map_js();
+		}
+		remove_filter('the_posts', array($this, 'the_posts'), 1, 2);
+		return $posts;
+	}
 }

core/EE_Payment_Processor.core.php

Spacing +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
+        if ( ! self::$_instance instanceof EE_Payment_Processor) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -170,7 +170,7 @@ 
         /** @type \EE_Transaction $transaction */
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
+        if ( ! $primary_reg instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -265,7 +265,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -309,7 +309,7 @@ 
                         EEM_Change_Log::instance()->log(
                             EEM_Change_Log::type_gateway,
                             array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
+                                'message'     => 'IPN Exception: '.$e->getMessage(),
                                 'current_url' => EEH_URL::current_url(),
                                 'payment'     => $e->getPaymentProperties(),
                                 'IPN_data'    => $e->getIpnData(),
@@ -380,7 +380,7 @@ 
     {
         $return_data = array();
         foreach ($request_data as $key => $value) {
-            $return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
+            $return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters(
                 $value
             );
         }

Indentation +838 added lines, -838 removed lines

@@ -18,842 +18,842 @@
 class EE_Payment_Processor extends EE_Processor_Base implements ResettableInterface
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Payment_Processor
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float) $amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()), // make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        }
-        EE_Error::add_error(
-            sprintf(
-                __(
-                    'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            eg $_REQUEST
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request (true, like PayPal)
-     *                                                 or is processed manually (false, like Authorize.net)
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     * @throws \RuntimeException
-     * @throws \ReflectionException
-     * @throws \InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } elseif ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
-                                'event_espresso'
-                            ),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // that's actually pretty ok. The IPN just wasn't able
-                // to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array('IPN data' => $_req_data),
-                            $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        // that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment(
-                    $transaction,
-                    $payment,
-                    $update_txn,
-                    $separate_IPN_request
-                );
-            } else {
-                // we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $payment_method
-                    );
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $transaction
-                    );
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log',
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    __(
-                        'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
-                        'event_espresso'
-                    ),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
-                $value
-            );
-        }
-        return $return_data;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        }
-        return null;
-    }
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if ($payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            // global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        // EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                } else {
-                    $available_payment_amount = $this->process_registration_payment(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                }
-            }
-        }
-        if ($available_payment_amount > 0
-            && apply_filters(
-                'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
-                false
-            )) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'
-                    ),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_payment_amount = 0.00
-    ) {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _apply_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $payment_amount = 0.00
-    ) {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to(
-                $payment,
-                'Payment',
-                array('RPY_amount' => $payment_amount)
-            );
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_refund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_refund_amount = 0.00
-    ) {
-        // EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float) abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float) $registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float) abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if ($IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            // ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                $transaction,
-                $payment
-            );
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => (string) __('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect PayPal standard, pro, express, and Payflow.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            // Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            // instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 6);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Payment_Processor
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float) $amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()), // make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		}
+		EE_Error::add_error(
+			sprintf(
+				__(
+					'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            eg $_REQUEST
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request (true, like PayPal)
+	 *                                                 or is processed manually (false, like Authorize.net)
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 * @throws \RuntimeException
+	 * @throws \ReflectionException
+	 * @throws \InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} elseif ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
+								'event_espresso'
+							),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// that's actually pretty ok. The IPN just wasn't able
+				// to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array('IPN data' => $_req_data),
+							$payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						// that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment(
+					$transaction,
+					$payment,
+					$update_txn,
+					$separate_IPN_request
+				);
+			} else {
+				// we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$payment_method
+					);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$transaction
+					);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log',
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					__(
+						'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
+						'event_espresso'
+					),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
+				$value
+			);
+		}
+		return $return_data;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if ($payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			// global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		// EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				} else {
+					$available_payment_amount = $this->process_registration_payment(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				}
+			}
+		}
+		if ($available_payment_amount > 0
+			&& apply_filters(
+				'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
+				false
+			)) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'
+					),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_payment_amount = 0.00
+	) {
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _apply_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$payment_amount = 0.00
+	) {
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to(
+				$payment,
+				'Payment',
+				array('RPY_amount' => $payment_amount)
+			);
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_refund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_refund_amount = 0.00
+	) {
+		// EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float) abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float) $registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float) abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if ($IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			// ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+				$transaction,
+				$payment
+			);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => (string) __('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect PayPal standard, pro, express, and Payflow.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			// Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			// instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 6);
+		}
+	}
 }

modules/invalid_checkout_access/EED_Invalid_Checkout_Access.module.php

Indentation +67 added lines, -67 removed lines

@@ -13,82 +13,82 @@
 class EED_Invalid_Checkout_Access extends EED_Module
 {
 
-    /**
-     * @var InvalidCheckoutAccess $invalid_checkout_access_form
-     */
-    private static $invalid_checkout_access_form;
+	/**
+	 * @var InvalidCheckoutAccess $invalid_checkout_access_form
+	 */
+	private static $invalid_checkout_access_form;
 
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     */
-    public static function set_hooks()
-    {
-    }
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 */
+	public static function set_hooks()
+	{
+	}
 
 
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     */
-    public static function set_hooks_admin()
-    {
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array('EED_Invalid_Checkout_Access', 'display_invalid_checkout_access_form'),
-            15
-        );
-        add_filter(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            array('EED_Invalid_Checkout_Access', 'process_invalid_checkout_access_form')
-        );
-    }
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array('EED_Invalid_Checkout_Access', 'display_invalid_checkout_access_form'),
+			15
+		);
+		add_filter(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			array('EED_Invalid_Checkout_Access', 'process_invalid_checkout_access_form')
+		);
+	}
 
 
-    /**
-     * run - initial module setup
-     * this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @var WP $WP
-     */
-    public function run($WP)
-    {
-        // TODO: Implement run() method.
-    }
+	/**
+	 * run - initial module setup
+	 * this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @var WP $WP
+	 */
+	public function run($WP)
+	{
+		// TODO: Implement run() method.
+	}
 
 
-    /**
-     * @return InvalidCheckoutAccess
-     */
-    public static function getInvalidCheckoutAccess()
-    {
-        if (! self::$invalid_checkout_access_form instanceof InvalidCheckoutAccess) {
-            self::$invalid_checkout_access_form = new InvalidCheckoutAccess();
-        }
-        return self::$invalid_checkout_access_form;
-    }
+	/**
+	 * @return InvalidCheckoutAccess
+	 */
+	public static function getInvalidCheckoutAccess()
+	{
+		if (! self::$invalid_checkout_access_form instanceof InvalidCheckoutAccess) {
+			self::$invalid_checkout_access_form = new InvalidCheckoutAccess();
+		}
+		return self::$invalid_checkout_access_form;
+	}
 
 
-    /**
-     * email_validation_settings_form
-     *
-     * @return    void
-     * @throws \EE_Error
-     */
-    public static function display_invalid_checkout_access_form()
-    {
-        $invalid_checkout_access_form = \EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
-        echo $invalid_checkout_access_form->getForm()->get_html();
-    }
+	/**
+	 * email_validation_settings_form
+	 *
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public static function display_invalid_checkout_access_form()
+	{
+		$invalid_checkout_access_form = \EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
+		echo $invalid_checkout_access_form->getForm()->get_html();
+	}
 
 
-    /**
-     * email_validation_settings_form
-     *
-     * @param \EE_Registration_Config $EE_Registration_Config
-     * @return \EE_Registration_Config
-     */
-    public static function process_invalid_checkout_access_form(\EE_Registration_Config $EE_Registration_Config)
-    {
-        $invalid_checkout_access_form = \EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
-        return $invalid_checkout_access_form->processForm($EE_Registration_Config);
-    }
+	/**
+	 * email_validation_settings_form
+	 *
+	 * @param \EE_Registration_Config $EE_Registration_Config
+	 * @return \EE_Registration_Config
+	 */
+	public static function process_invalid_checkout_access_form(\EE_Registration_Config $EE_Registration_Config)
+	{
+		$invalid_checkout_access_form = \EED_Invalid_Checkout_Access::getInvalidCheckoutAccess();
+		return $invalid_checkout_access_form->processForm($EE_Registration_Config);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      */
     public static function getInvalidCheckoutAccess()
     {
-        if (! self::$invalid_checkout_access_form instanceof InvalidCheckoutAccess) {
+        if ( ! self::$invalid_checkout_access_form instanceof InvalidCheckoutAccess) {
             self::$invalid_checkout_access_form = new InvalidCheckoutAccess();
         }
         return self::$invalid_checkout_access_form;

modules/csv/EED_Csv.module.php

Indentation +56 added lines, -56 removed lines

@@ -12,69 +12,69 @@
 {
 
 
-    /**
-     * @return EED_Csv
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Csv
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
 
 
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
 
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
 
 
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
-    /**
-     *    export
-     *
-     * @access    public
-     * @return    void
-     */
-    public function export()
-    {
-        $Export = EE_Registry::instance()->load_class('Export');
-        $Export->export();
-    }
+	/**
+	 *    export
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function export()
+	{
+		$Export = EE_Registry::instance()->load_class('Export');
+		$Export->export();
+	}
 
 
-    /**
-     *    import
-     *
-     * @access    public
-     * @return    void
-     */
-    public function import()
-    {
-        $Import = EE_Registry::instance()->load_class('Import');
-        $Import->import();
-    }
+	/**
+	 *    import
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function import()
+	{
+		$Import = EE_Registry::instance()->load_class('Import');
+		$Import->import();
+	}
 }