eventespresso / event-espresso-core

core/libraries/form_sections/inputs/EE_Form_Input_With_Options_Base.input.php

Indentation +319 added lines, -319 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,324 +16,324 @@ 
 class EE_Form_Input_With_Options_Base extends EE_Form_Input_Base
 {
 
-    /**
-     * array of available options to choose as an answer
-     *
-     * @var array
-     */
-    protected $_options = array();
-
-    /**
-     * whether to display the html_label_text above the checkbox/radio button options
-     *
-     * @var boolean
-     */
-    protected $_display_html_label_text = true;
-
-    /**
-     * whether to display an question option description as part of the input label
-     *
-     * @var boolean
-     */
-    protected $_use_desc_in_label = true;
-
-    /**
-     * strlen() result for the longest input value (what gets displayed in the label)
-     * this is used to apply a css class to the input label
-     *
-     * @var int
-     */
-    protected $_label_size = 0;
-
-    /**
-     * whether to enforce the label size value passed in the constructor
-     *
-     * @var boolean
-     */
-    protected $_enforce_label_size = false;
-
-    /**
-     * whether to allow multiple selections (ie, the value of this input should be an array)
-     * or not (ie, the value should be a simple int, string, etc)
-     *
-     * @var boolean
-     */
-    protected $_multiple_selections = false;
-
-
-
-    /**
-     * @param array     $answer_options
-     * @param array     $input_settings {
-     * @type int|string $label_size
-     * @type boolean    $display_html_label_text
-     *                                  }
-     *                                  And all the options accepted by EE_Form_Input_Base
-     */
-    public function __construct($answer_options = array(), $input_settings = array())
-    {
-        if (isset($input_settings['label_size'])) {
-            $this->_set_label_size($input_settings['label_size']);
-            if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
-                $this->_enforce_label_size = true;
-            }
-        }
-        if (isset($input_settings['display_html_label_text'])) {
-            $this->set_display_html_label_text($input_settings['display_html_label_text']);
-        }
-        $this->set_select_options($answer_options);
-        parent::__construct($input_settings);
-    }
-
-
-
-    /**
-     * Sets the allowed options for this input. Also has the side-effect of
-     * updating the normalization strategy to match the keys provided in the array
-     *
-     * @param array $answer_options
-     * @return void  just has the side-effect of setting the options for this input
-     */
-    public function set_select_options($answer_options = array())
-    {
-        $answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
-        //get the first item in the select options and check it's type
-        $this->_options = reset($answer_options) instanceof EE_Question_Option
-            ? $this->_process_question_options($answer_options)
-            : $answer_options;
-        //d( $this->_options );
-        $select_option_keys = array_keys($this->_options);
-        // attempt to determine data type for values in order to set normalization type
-        //purposefully only
-        if (
-            count($this->_options) === 2
-            && (
-                (in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
-                || (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
-            )
-        ) {
-            // values appear to be boolean, like TRUE, FALSE, 1, 0
-            $normalization = new EE_Boolean_Normalization();
-        } else {
-            //are ALL the options ints (even if we're using a multi-dimensional array)? If so use int validation
-            $all_ints = true;
-            array_walk_recursive(
-                $this->_options,
-                function($value,$key) use (&$all_ints){
-                    //is this a top-level key? ignore it
-                    if(! is_array($value)
-                        && ! is_int($key)
-                       && $key !== ''
-                       && $key !== null){
-                        $all_ints = false;
-                    }
-                }
-            );
-            if ($all_ints) {
-                $normalization = new EE_Int_Normalization();
-            } else {
-                $normalization = new EE_Text_Normalization();
-            }
-        }
-        // does input type have multiple options ?
-        if ($this->_multiple_selections) {
-            $this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
-        } else {
-            $this->_set_normalization_strategy($normalization);
-        }
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function options()
-    {
-        return $this->_options;
-    }
-
-
-
-    /**
-     * Returns an array which is guaranteed to not be multidimensional
-     *
-     * @return array
-     */
-    public function flat_options()
-    {
-        return $this->_flatten_select_options($this->options());
-    }
-
-
-
-    /**
-     * Makes sure $arr is a flat array, not a multidimensional one
-     *
-     * @param array $arr
-     * @return array
-     */
-    protected function _flatten_select_options($arr)
-    {
-        $flat_array = array();
-        if (EEH_Array::is_multi_dimensional_array($arr)) {
-            foreach ($arr as $sub_array) {
-                foreach ((array)$sub_array as $key => $value) {
-                    $flat_array[$key] = $value;
-                    $this->_set_label_size($value);
-                }
-            }
-        } else {
-            foreach ($arr as $key => $value) {
-                $flat_array[$key] = $value;
-                $this->_set_label_size($value);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     * @param EE_Question_Option[] $question_options_array
-     * @return array
-     */
-    protected function _process_question_options($question_options_array = array())
-    {
-        $flat_array = array();
-        foreach ($question_options_array as $question_option) {
-            if ($question_option instanceof EE_Question_Option) {
-                $desc = '';
-                if ($this->_use_desc_in_label) {
-                    $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
-                }
-                $value = $question_option->value();
-                // add value even if it's empty
-                $flat_array[$value] = $value;
-                // if both value and desc are not empty, then separate with a dash
-                if ( ! empty($value) && ! empty($desc)) {
-                    $flat_array[$value] .= ' - ' . $desc;
-                } else {
-                    // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
-                    $flat_array[$value] .= $desc;
-                }
-            } elseif (is_array($question_option)) {
-                $flat_array += $this->_flatten_select_options($question_option);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     *    set_label_sizes
-     *
-     * @return void
-     */
-    public function set_label_sizes()
-    {
-        // did the input settings specifically say to NOT set the label size dynamically ?
-        if ( ! $this->_enforce_label_size) {
-            foreach ($this->_options as $option) {
-                // calculate the strlen of the label
-                $this->_set_label_size($option);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _set_label_size_class
-     *
-     * @param int|string $value
-     * @return void
-     */
-    private function _set_label_size($value = '')
-    {
-        // don't change label size if it has already been set and is being enforced
-        if($this->_enforce_label_size && $this->_label_size >  0) {
-            return;
-        }
-        // determine length of option value
-        $val_size = is_int($value) ? $value : strlen($value);
-        // use new value if bigger than existing
-        $this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
-    }
-
-
-
-    /**
-     *    get_label_size_class
-     *
-     * @return string
-     */
-    public function get_label_size_class()
-    {
-        $size = ' medium-lbl';
-        // use maximum option value length to determine label size
-        if ($this->_label_size < 3) {
-            $size = ' nano-lbl';
-        } else if ($this->_label_size < 6) {
-            $size = ' micro-lbl';
-        } else if ($this->_label_size < 12) {
-            $size = ' tiny-lbl';
-        } else if ($this->_label_size < 25) {
-            $size = ' small-lbl';
-        } else if ($this->_label_size < 50) {
-            $size = ' medium-lbl';
-        } else if ($this->_label_size >= 100) {
-            $size = ' big-lbl';
-        }
-        return $size;
-    }
-
-
-
-    /**
-     * Returns the pretty value for the normalized value
-     *
-     * @return string
-     */
-    public function pretty_value()
-    {
-        $options = $this->flat_options();
-        $unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
-        if ( ! $this->_multiple_selections) {
-            $unnormalized_value_choices = array($unnormalized_value_choices);
-        }
-        $pretty_strings = array();
-        foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
-            if (isset($options[$unnormalized_value_choice])) {
-                $pretty_strings[] = $options[$unnormalized_value_choice];
-            } else {
-                $pretty_strings[] = $this->normalized_value();
-            }
-        }
-        return implode(', ', $pretty_strings);
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function display_html_label_text()
-    {
-        return $this->_display_html_label_text;
-    }
-
-
-
-    /**
-     * @param boolean $display_html_label_text
-     */
-    public function set_display_html_label_text($display_html_label_text)
-    {
-        $this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * array of available options to choose as an answer
+	 *
+	 * @var array
+	 */
+	protected $_options = array();
+
+	/**
+	 * whether to display the html_label_text above the checkbox/radio button options
+	 *
+	 * @var boolean
+	 */
+	protected $_display_html_label_text = true;
+
+	/**
+	 * whether to display an question option description as part of the input label
+	 *
+	 * @var boolean
+	 */
+	protected $_use_desc_in_label = true;
+
+	/**
+	 * strlen() result for the longest input value (what gets displayed in the label)
+	 * this is used to apply a css class to the input label
+	 *
+	 * @var int
+	 */
+	protected $_label_size = 0;
+
+	/**
+	 * whether to enforce the label size value passed in the constructor
+	 *
+	 * @var boolean
+	 */
+	protected $_enforce_label_size = false;
+
+	/**
+	 * whether to allow multiple selections (ie, the value of this input should be an array)
+	 * or not (ie, the value should be a simple int, string, etc)
+	 *
+	 * @var boolean
+	 */
+	protected $_multiple_selections = false;
+
+
+
+	/**
+	 * @param array     $answer_options
+	 * @param array     $input_settings {
+	 * @type int|string $label_size
+	 * @type boolean    $display_html_label_text
+	 *                                  }
+	 *                                  And all the options accepted by EE_Form_Input_Base
+	 */
+	public function __construct($answer_options = array(), $input_settings = array())
+	{
+		if (isset($input_settings['label_size'])) {
+			$this->_set_label_size($input_settings['label_size']);
+			if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
+				$this->_enforce_label_size = true;
+			}
+		}
+		if (isset($input_settings['display_html_label_text'])) {
+			$this->set_display_html_label_text($input_settings['display_html_label_text']);
+		}
+		$this->set_select_options($answer_options);
+		parent::__construct($input_settings);
+	}
+
+
+
+	/**
+	 * Sets the allowed options for this input. Also has the side-effect of
+	 * updating the normalization strategy to match the keys provided in the array
+	 *
+	 * @param array $answer_options
+	 * @return void  just has the side-effect of setting the options for this input
+	 */
+	public function set_select_options($answer_options = array())
+	{
+		$answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
+		//get the first item in the select options and check it's type
+		$this->_options = reset($answer_options) instanceof EE_Question_Option
+			? $this->_process_question_options($answer_options)
+			: $answer_options;
+		//d( $this->_options );
+		$select_option_keys = array_keys($this->_options);
+		// attempt to determine data type for values in order to set normalization type
+		//purposefully only
+		if (
+			count($this->_options) === 2
+			&& (
+				(in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
+				|| (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
+			)
+		) {
+			// values appear to be boolean, like TRUE, FALSE, 1, 0
+			$normalization = new EE_Boolean_Normalization();
+		} else {
+			//are ALL the options ints (even if we're using a multi-dimensional array)? If so use int validation
+			$all_ints = true;
+			array_walk_recursive(
+				$this->_options,
+				function($value,$key) use (&$all_ints){
+					//is this a top-level key? ignore it
+					if(! is_array($value)
+						&& ! is_int($key)
+					   && $key !== ''
+					   && $key !== null){
+						$all_ints = false;
+					}
+				}
+			);
+			if ($all_ints) {
+				$normalization = new EE_Int_Normalization();
+			} else {
+				$normalization = new EE_Text_Normalization();
+			}
+		}
+		// does input type have multiple options ?
+		if ($this->_multiple_selections) {
+			$this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
+		} else {
+			$this->_set_normalization_strategy($normalization);
+		}
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function options()
+	{
+		return $this->_options;
+	}
+
+
+
+	/**
+	 * Returns an array which is guaranteed to not be multidimensional
+	 *
+	 * @return array
+	 */
+	public function flat_options()
+	{
+		return $this->_flatten_select_options($this->options());
+	}
+
+
+
+	/**
+	 * Makes sure $arr is a flat array, not a multidimensional one
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	protected function _flatten_select_options($arr)
+	{
+		$flat_array = array();
+		if (EEH_Array::is_multi_dimensional_array($arr)) {
+			foreach ($arr as $sub_array) {
+				foreach ((array)$sub_array as $key => $value) {
+					$flat_array[$key] = $value;
+					$this->_set_label_size($value);
+				}
+			}
+		} else {
+			foreach ($arr as $key => $value) {
+				$flat_array[$key] = $value;
+				$this->_set_label_size($value);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 * @param EE_Question_Option[] $question_options_array
+	 * @return array
+	 */
+	protected function _process_question_options($question_options_array = array())
+	{
+		$flat_array = array();
+		foreach ($question_options_array as $question_option) {
+			if ($question_option instanceof EE_Question_Option) {
+				$desc = '';
+				if ($this->_use_desc_in_label) {
+					$desc = $question_option->desc();
+					$desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+				}
+				$value = $question_option->value();
+				// add value even if it's empty
+				$flat_array[$value] = $value;
+				// if both value and desc are not empty, then separate with a dash
+				if ( ! empty($value) && ! empty($desc)) {
+					$flat_array[$value] .= ' - ' . $desc;
+				} else {
+					// otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
+					$flat_array[$value] .= $desc;
+				}
+			} elseif (is_array($question_option)) {
+				$flat_array += $this->_flatten_select_options($question_option);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 *    set_label_sizes
+	 *
+	 * @return void
+	 */
+	public function set_label_sizes()
+	{
+		// did the input settings specifically say to NOT set the label size dynamically ?
+		if ( ! $this->_enforce_label_size) {
+			foreach ($this->_options as $option) {
+				// calculate the strlen of the label
+				$this->_set_label_size($option);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _set_label_size_class
+	 *
+	 * @param int|string $value
+	 * @return void
+	 */
+	private function _set_label_size($value = '')
+	{
+		// don't change label size if it has already been set and is being enforced
+		if($this->_enforce_label_size && $this->_label_size >  0) {
+			return;
+		}
+		// determine length of option value
+		$val_size = is_int($value) ? $value : strlen($value);
+		// use new value if bigger than existing
+		$this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
+	}
+
+
+
+	/**
+	 *    get_label_size_class
+	 *
+	 * @return string
+	 */
+	public function get_label_size_class()
+	{
+		$size = ' medium-lbl';
+		// use maximum option value length to determine label size
+		if ($this->_label_size < 3) {
+			$size = ' nano-lbl';
+		} else if ($this->_label_size < 6) {
+			$size = ' micro-lbl';
+		} else if ($this->_label_size < 12) {
+			$size = ' tiny-lbl';
+		} else if ($this->_label_size < 25) {
+			$size = ' small-lbl';
+		} else if ($this->_label_size < 50) {
+			$size = ' medium-lbl';
+		} else if ($this->_label_size >= 100) {
+			$size = ' big-lbl';
+		}
+		return $size;
+	}
+
+
+
+	/**
+	 * Returns the pretty value for the normalized value
+	 *
+	 * @return string
+	 */
+	public function pretty_value()
+	{
+		$options = $this->flat_options();
+		$unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
+		if ( ! $this->_multiple_selections) {
+			$unnormalized_value_choices = array($unnormalized_value_choices);
+		}
+		$pretty_strings = array();
+		foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
+			if (isset($options[$unnormalized_value_choice])) {
+				$pretty_strings[] = $options[$unnormalized_value_choice];
+			} else {
+				$pretty_strings[] = $this->normalized_value();
+			}
+		}
+		return implode(', ', $pretty_strings);
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function display_html_label_text()
+	{
+		return $this->_display_html_label_text;
+	}
+
+
+
+	/**
+	 * @param boolean $display_html_label_text
+	 */
+	public function set_display_html_label_text($display_html_label_text)
+	{
+		$this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
 

Spacing +8 added lines, -8 removed lines

@@ -119,12 +119,12 @@ 
             $all_ints = true;
             array_walk_recursive(
                 $this->_options,
-                function($value,$key) use (&$all_ints){
+                function($value, $key) use (&$all_ints){
                     //is this a top-level key? ignore it
-                    if(! is_array($value)
+                    if ( ! is_array($value)
                         && ! is_int($key)
                        && $key !== ''
-                       && $key !== null){
+                       && $key !== null) {
                         $all_ints = false;
                     }
                 }
@@ -178,7 +178,7 @@ 
         $flat_array = array();
         if (EEH_Array::is_multi_dimensional_array($arr)) {
             foreach ($arr as $sub_array) {
-                foreach ((array)$sub_array as $key => $value) {
+                foreach ((array) $sub_array as $key => $value) {
                     $flat_array[$key] = $value;
                     $this->_set_label_size($value);
                 }
@@ -206,14 +206,14 @@ 
                 $desc = '';
                 if ($this->_use_desc_in_label) {
                     $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">'.$desc.'</span>' : '';
                 }
                 $value = $question_option->value();
                 // add value even if it's empty
                 $flat_array[$value] = $value;
                 // if both value and desc are not empty, then separate with a dash
                 if ( ! empty($value) && ! empty($desc)) {
-                    $flat_array[$value] .= ' - ' . $desc;
+                    $flat_array[$value] .= ' - '.$desc;
                 } else {
                     // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
                     $flat_array[$value] .= $desc;
@@ -254,7 +254,7 @@ 
     private function _set_label_size($value = '')
     {
         // don't change label size if it has already been set and is being enforced
-        if($this->_enforce_label_size && $this->_label_size >  0) {
+        if ($this->_enforce_label_size && $this->_label_size > 0) {
             return;
         }
         // determine length of option value
@@ -305,7 +305,7 @@ 
             $unnormalized_value_choices = array($unnormalized_value_choices);
         }
         $pretty_strings = array();
-        foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
+        foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
             if (isset($options[$unnormalized_value_choice])) {
                 $pretty_strings[] = $options[$unnormalized_value_choice];
             } else {

core/libraries/batch/JobHandlers/DatetimeOffsetFix.php

Spacing +11 added lines, -11 removed lines

@@ -158,19 +158,19 @@ 
         $date_ranges = array();
         //since some affected models might have two tables, we have to get our tables and set up a query for each table.
         foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
+            $query = 'UPDATE '.$table->get_table_name();
             $fields_affected = array();
             $inner_query = array();
             foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
                 if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column() . ' = '
-                                     . $sql_date_function . '('
+                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column().' = '
+                                     . $sql_date_function.'('
                                      . $model_field->get_table_column()
                                      . ", INTERVAL {$offset} MINUTE)";
                     $fields_affected[] = $model_field;
                 }
             }
-            if (! $fields_affected) {
+            if ( ! $fields_affected) {
                 continue;
             }
             //do we do one query per column/field or one query for all fields on the model? It all depends on whether
@@ -187,7 +187,7 @@ 
                     //record error.
                     $error_message = $wpdb->last_error;
                     //handle the edgecases where last_error might be empty.
-                    if (! $error_message) {
+                    if ( ! $error_message) {
                         $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                     }
                     $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
@@ -220,7 +220,7 @@ 
         foreach ($inner_query as $field_name => $field_query) {
             $query_to_run = $query;
             $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
+            $query_to_run .= ' SET '.$field_query;
             if ($start_date_range instanceof DbSafeDateTime) {
                 $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
                 $where_conditions[] = "{$field_name} > '{$start_date}'";
@@ -230,14 +230,14 @@ 
                 $where_conditions[] = "{$field_name} < '{$end_date}'";
             }
             if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+                $query_to_run .= ' WHERE '.implode(' AND ', $where_conditions);
             }
             $result = $wpdb->query($query_to_run);
             if ($result === false) {
                 //record error.
                 $error_message = $wpdb->last_error;
                 //handle the edgecases where last_error might be empty.
-                if (! $error_message) {
+                if ( ! $error_message) {
                     $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                 }
                 $errors[$field_name] = $error_message;
@@ -257,7 +257,7 @@ 
     private function doQueryForAllFields($query, array $inner_query)
     {
         global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
+        $query .= ' SET '.implode(',', $inner_query);
         return $wpdb->query($query);
     }
 
@@ -283,7 +283,7 @@ 
         $fields = array();
         /** @var EE_Datetime_Field $model_field */
         foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
+            if ( ! $model_field instanceof EE_Datetime_Field) {
                 continue;
             }
             $fields[] = $model_field->get_name();
@@ -335,7 +335,7 @@ 
     private function getModelsWithDatetimeFields()
     {
         $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
+        if ( ! empty($this->models_with_datetime_fields)) {
             return $this->models_with_datetime_fields;
         }
 

Indentation +458 added lines, -458 removed lines

@@ -26,462 +26,462 @@
 class DatetimeOffsetFix extends JobHandler
 {
 
-    /**
-     * Key for the option used to track which models have been processed when doing the batches.
-     */
-    const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
-
-
-    const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
-
-    /**
-     * Key for the option used to track what the current offset is that will be applied when this tool is executed.
-     */
-    const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
-
-
-    const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
-
-
-    const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
-
-
-    /**
-     * String labelling the datetime offset fix type for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
-
-
-    /**
-     * String labelling a datetime offset fix error for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
-
-    /**
-     * @var EEM_Base[]
-     */
-    protected $models_with_datetime_fields = array();
-
-
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $models_with_datetime_fields = $this->getModelsWithDatetimeFields();
-        //we'll be doing each model as a batch.
-        $job_parameters->set_job_size(count($models_with_datetime_fields));
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Starting Datetime Offset Fix', 'event_espresso')
-        );
-    }
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $models_to_process = $this->getModelsWithDatetimeFields();
-        //let's pop off the a model and do the query to apply the offset.
-        $model_to_process = array_pop($models_to_process);
-        //update our record
-        $this->setModelsToProcess($models_to_process);
-        $this->processModel($model_to_process);
-        $this->updateCountOfModelsProcessed();
-        $job_parameters->set_units_processed($this->getCountOfModelsProcessed());
-        if (count($models_to_process) > 0) {
-            $job_parameters->set_status(JobParameters::status_continue);
-        } else {
-            $job_parameters->set_status(JobParameters::status_complete);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
-                $model_to_process
-            )
-        );
-    }
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        //delete important saved options.
-        delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
-        delete_option(self::COUNT_OF_MODELS_PROCESSED);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
-        return new JobStepResponse($job_parameters, esc_html__(
-            'Offset has been applied to all affected fields.',
-            'event_espresso'
-        ));
-    }
-
-
-    /**
-     * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
-     * @param string $model_class_name
-     * @throws EE_Error
-     */
-    protected function processModel($model_class_name)
-    {
-        global $wpdb;
-        /** @var EEM_Base $model */
-        $model = $model_class_name::instance();
-        $original_offset = self::getOffset();
-        $start_date_range = self::getStartDateRange();
-        $end_date_range = self::getEndDateRange();
-        $sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
-        $offset = abs($original_offset) * 60;
-        $date_ranges = array();
-        //since some affected models might have two tables, we have to get our tables and set up a query for each table.
-        foreach ($model->get_tables() as $table) {
-            $query = 'UPDATE ' . $table->get_table_name();
-            $fields_affected = array();
-            $inner_query = array();
-            foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
-                if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column() . ' = '
-                                     . $sql_date_function . '('
-                                     . $model_field->get_table_column()
-                                     . ", INTERVAL {$offset} MINUTE)";
-                    $fields_affected[] = $model_field;
-                }
-            }
-            if (! $fields_affected) {
-                continue;
-            }
-            //do we do one query per column/field or one query for all fields on the model? It all depends on whether
-            //there is a date range applied or not.
-            if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
-                $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
-            } else {
-                $result = $this->doQueryForAllFields($query, $inner_query);
-            }
-
-            //record appropriate logs for the query
-            switch (true) {
-                case $result === false:
-                    //record error.
-                    $error_message = $wpdb->last_error;
-                    //handle the edgecases where last_error might be empty.
-                    if (! $error_message) {
-                        $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                    }
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
-                    break;
-                case is_array($result) && ! empty($result):
-                    foreach ($result as $field_name => $error_message) {
-                        $this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
-                    }
-                    break;
-                default:
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected);
-            }
-        }
-    }
-
-
-    /**
-     * Does the query on each $inner_query individually.
-     *
-     * @param string              $query
-     * @param array               $inner_query
-     * @param DbSafeDateTime|null $start_date_range
-     * @param DbSafeDateTime|null $end_date_range
-     * @return array  An array of any errors encountered and the fields they were for.
-     */
-    private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
-    {
-        global $wpdb;
-        $errors = array();
-        foreach ($inner_query as $field_name => $field_query) {
-            $query_to_run = $query;
-            $where_conditions = array();
-            $query_to_run .= ' SET ' . $field_query;
-            if ($start_date_range instanceof DbSafeDateTime) {
-                $start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} > '{$start_date}'";
-            }
-            if ($end_date_range instanceof DbSafeDateTime) {
-                $end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "{$field_name} < '{$end_date}'";
-            }
-            if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
-            }
-            $result = $wpdb->query($query_to_run);
-            if ($result === false) {
-                //record error.
-                $error_message = $wpdb->last_error;
-                //handle the edgecases where last_error might be empty.
-                if (! $error_message) {
-                    $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                }
-                $errors[$field_name] = $error_message;
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * Performs the query for all fields within the inner_query
-     *
-     * @param string $query
-     * @param array  $inner_query
-     * @return false|int
-     */
-    private function doQueryForAllFields($query, array $inner_query)
-    {
-        global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * Records a changelog entry using the given information.
-     *
-     * @param EEM_Base              $model
-     * @param float                 $offset
-     * @param EE_Table_Base         $table
-     * @param EE_Model_Field_Base[] $model_fields_affected
-     * @param string                $error_message   If present then there was an error so let's record that instead.
-     * @throws EE_Error
-     */
-    private function recordChangeLog(
-        EEM_Base $model,
-        $offset,
-        EE_Table_Base $table,
-        $model_fields_affected,
-        $error_message = ''
-    ) {
-        //setup $fields list.
-        $fields = array();
-        /** @var EE_Datetime_Field $model_field */
-        foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
-                continue;
-            }
-            $fields[] = $model_field->get_name();
-        }
-        //setup the message for the changelog entry.
-        $message = $error_message
-            ? sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields),
-                $error_message
-            )
-            : sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields)
-            );
-        //write to the log
-        $changelog = EE_Change_Log::new_instance(array(
-            'LOG_type' => $error_message
-                ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
-                : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
-            'LOG_message' => $message
-        ));
-        $changelog->save();
-    }
-
-
-    /**
-     * Returns an array of models that have datetime fields.
-     * This array is added to a short lived transient cache to keep having to build this list to a minimum.
-     *
-     * @return array an array of model class names.
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getModelsWithDatetimeFields()
-    {
-        $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
-            return $this->models_with_datetime_fields;
-        }
-
-        $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
-        foreach ($all_non_abstract_models as $non_abstract_model) {
-            //get model instance
-            /** @var EEM_Base $non_abstract_model */
-            $non_abstract_model = $non_abstract_model::instance();
-            if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
-                $this->models_with_datetime_fields[] = get_class($non_abstract_model);
-            }
-        }
-        $this->setModelsToProcess($this->models_with_datetime_fields);
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * This simply records the models that have been processed with our tracking option.
-     * @param array $models_to_set  array of model class names.
-     */
-    private function setModelsToProcess($models_to_set)
-    {
-        update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
-    }
-
-
-    /**
-     * Used to keep track of how many models have been processed for the batch
-     * @param $count
-     */
-    private function updateCountOfModelsProcessed($count = 1)
-    {
-        $count = $this->getCountOfModelsProcessed() + (int) $count;
-        update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
-    }
-
-
-    /**
-     * Retrieve the tracked number of models processed between requests.
-     * @return int
-     */
-    private function getCountOfModelsProcessed()
-    {
-        return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
-    }
-
-
-    /**
-     * Returns the models that are left to process.
-     * @return array  an array of model class names.
-     */
-    private function getModelsToProcess()
-    {
-        if (empty($this->models_with_datetime_fields)) {
-            $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
-        }
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
-     * @param float $offset
-     */
-    public static function updateOffset($offset)
-    {
-        update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
-    }
-
-
-    /**
-     * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @return float
-     */
-    public static function getOffset()
-    {
-        return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
-    }
-
-
-    /**
-     * Used to set the saved offset range start date.
-     * @param DbSafeDateTime|null $start_date
-     */
-    public static function updateStartDateRange(DbSafeDateTime $start_date = null)
-    {
-        $date_to_save = $start_date instanceof DbSafeDateTime
-            ? $start_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range start date.
-     * @return DbSafeDateTime|null
-     */
-    public static function getStartDateRange()
-    {
-        $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        try {
-            $datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
-            $start_date = $datetime instanceof DateTime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-
-        } catch (Exception $e) {
-            $start_date = null;
-        }
-        return $start_date;
-    }
-
-
-
-    /**
-     * Used to set the saved offset range end date.
-     * @param DbSafeDateTime|null $end_date
-     */
-    public static function updateEndDateRange(DbSafeDateTime $end_date = null)
-    {
-        $date_to_save = $end_date instanceof DbSafeDateTime
-            ? $end_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range end date.
-     * @return DbSafeDateTime|null
-     */
-    public static function getEndDateRange()
-    {
-        $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        try {
-            $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
-            $end_date = $datetime instanceof Datetime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $end_date = null;
-        }
-        return $end_date;
-    }
+	/**
+	 * Key for the option used to track which models have been processed when doing the batches.
+	 */
+	const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
+
+
+	const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
+
+	/**
+	 * Key for the option used to track what the current offset is that will be applied when this tool is executed.
+	 */
+	const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
+
+
+	const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
+
+
+	const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
+
+
+	/**
+	 * String labelling the datetime offset fix type for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
+
+
+	/**
+	 * String labelling a datetime offset fix error for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
+
+	/**
+	 * @var EEM_Base[]
+	 */
+	protected $models_with_datetime_fields = array();
+
+
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$models_with_datetime_fields = $this->getModelsWithDatetimeFields();
+		//we'll be doing each model as a batch.
+		$job_parameters->set_job_size(count($models_with_datetime_fields));
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Starting Datetime Offset Fix', 'event_espresso')
+		);
+	}
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$models_to_process = $this->getModelsWithDatetimeFields();
+		//let's pop off the a model and do the query to apply the offset.
+		$model_to_process = array_pop($models_to_process);
+		//update our record
+		$this->setModelsToProcess($models_to_process);
+		$this->processModel($model_to_process);
+		$this->updateCountOfModelsProcessed();
+		$job_parameters->set_units_processed($this->getCountOfModelsProcessed());
+		if (count($models_to_process) > 0) {
+			$job_parameters->set_status(JobParameters::status_continue);
+		} else {
+			$job_parameters->set_status(JobParameters::status_complete);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
+				$model_to_process
+			)
+		);
+	}
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		//delete important saved options.
+		delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
+		delete_option(self::COUNT_OF_MODELS_PROCESSED);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
+		return new JobStepResponse($job_parameters, esc_html__(
+			'Offset has been applied to all affected fields.',
+			'event_espresso'
+		));
+	}
+
+
+	/**
+	 * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
+	 * @param string $model_class_name
+	 * @throws EE_Error
+	 */
+	protected function processModel($model_class_name)
+	{
+		global $wpdb;
+		/** @var EEM_Base $model */
+		$model = $model_class_name::instance();
+		$original_offset = self::getOffset();
+		$start_date_range = self::getStartDateRange();
+		$end_date_range = self::getEndDateRange();
+		$sql_date_function = $original_offset > 0 ? 'DATE_ADD' : 'DATE_SUB';
+		$offset = abs($original_offset) * 60;
+		$date_ranges = array();
+		//since some affected models might have two tables, we have to get our tables and set up a query for each table.
+		foreach ($model->get_tables() as $table) {
+			$query = 'UPDATE ' . $table->get_table_name();
+			$fields_affected = array();
+			$inner_query = array();
+			foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
+				if ($model_field instanceof EE_Datetime_Field) {
+					$inner_query[$model_field->get_table_column()] = $model_field->get_table_column() . ' = '
+									 . $sql_date_function . '('
+									 . $model_field->get_table_column()
+									 . ", INTERVAL {$offset} MINUTE)";
+					$fields_affected[] = $model_field;
+				}
+			}
+			if (! $fields_affected) {
+				continue;
+			}
+			//do we do one query per column/field or one query for all fields on the model? It all depends on whether
+			//there is a date range applied or not.
+			if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
+				$result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
+			} else {
+				$result = $this->doQueryForAllFields($query, $inner_query);
+			}
+
+			//record appropriate logs for the query
+			switch (true) {
+				case $result === false:
+					//record error.
+					$error_message = $wpdb->last_error;
+					//handle the edgecases where last_error might be empty.
+					if (! $error_message) {
+						$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+					}
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
+					break;
+				case is_array($result) && ! empty($result):
+					foreach ($result as $field_name => $error_message) {
+						$this->recordChangeLog($model, $original_offset, $table, array($field_name), $error_message);
+					}
+					break;
+				default:
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected);
+			}
+		}
+	}
+
+
+	/**
+	 * Does the query on each $inner_query individually.
+	 *
+	 * @param string              $query
+	 * @param array               $inner_query
+	 * @param DbSafeDateTime|null $start_date_range
+	 * @param DbSafeDateTime|null $end_date_range
+	 * @return array  An array of any errors encountered and the fields they were for.
+	 */
+	private function doQueryForEachField($query, array $inner_query, $start_date_range, $end_date_range)
+	{
+		global $wpdb;
+		$errors = array();
+		foreach ($inner_query as $field_name => $field_query) {
+			$query_to_run = $query;
+			$where_conditions = array();
+			$query_to_run .= ' SET ' . $field_query;
+			if ($start_date_range instanceof DbSafeDateTime) {
+				$start_date = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} > '{$start_date}'";
+			}
+			if ($end_date_range instanceof DbSafeDateTime) {
+				$end_date = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "{$field_name} < '{$end_date}'";
+			}
+			if ($where_conditions) {
+				$query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+			}
+			$result = $wpdb->query($query_to_run);
+			if ($result === false) {
+				//record error.
+				$error_message = $wpdb->last_error;
+				//handle the edgecases where last_error might be empty.
+				if (! $error_message) {
+					$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+				}
+				$errors[$field_name] = $error_message;
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * Performs the query for all fields within the inner_query
+	 *
+	 * @param string $query
+	 * @param array  $inner_query
+	 * @return false|int
+	 */
+	private function doQueryForAllFields($query, array $inner_query)
+	{
+		global $wpdb;
+		$query .= ' SET ' . implode(',', $inner_query);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * Records a changelog entry using the given information.
+	 *
+	 * @param EEM_Base              $model
+	 * @param float                 $offset
+	 * @param EE_Table_Base         $table
+	 * @param EE_Model_Field_Base[] $model_fields_affected
+	 * @param string                $error_message   If present then there was an error so let's record that instead.
+	 * @throws EE_Error
+	 */
+	private function recordChangeLog(
+		EEM_Base $model,
+		$offset,
+		EE_Table_Base $table,
+		$model_fields_affected,
+		$error_message = ''
+	) {
+		//setup $fields list.
+		$fields = array();
+		/** @var EE_Datetime_Field $model_field */
+		foreach ($model_fields_affected as $model_field) {
+			if (! $model_field instanceof EE_Datetime_Field) {
+				continue;
+			}
+			$fields[] = $model_field->get_name();
+		}
+		//setup the message for the changelog entry.
+		$message = $error_message
+			? sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields),
+				$error_message
+			)
+			: sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields)
+			);
+		//write to the log
+		$changelog = EE_Change_Log::new_instance(array(
+			'LOG_type' => $error_message
+				? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
+				: self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
+			'LOG_message' => $message
+		));
+		$changelog->save();
+	}
+
+
+	/**
+	 * Returns an array of models that have datetime fields.
+	 * This array is added to a short lived transient cache to keep having to build this list to a minimum.
+	 *
+	 * @return array an array of model class names.
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getModelsWithDatetimeFields()
+	{
+		$this->getModelsToProcess();
+		if (! empty($this->models_with_datetime_fields)) {
+			return $this->models_with_datetime_fields;
+		}
+
+		$all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
+		foreach ($all_non_abstract_models as $non_abstract_model) {
+			//get model instance
+			/** @var EEM_Base $non_abstract_model */
+			$non_abstract_model = $non_abstract_model::instance();
+			if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
+				$this->models_with_datetime_fields[] = get_class($non_abstract_model);
+			}
+		}
+		$this->setModelsToProcess($this->models_with_datetime_fields);
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * This simply records the models that have been processed with our tracking option.
+	 * @param array $models_to_set  array of model class names.
+	 */
+	private function setModelsToProcess($models_to_set)
+	{
+		update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
+	}
+
+
+	/**
+	 * Used to keep track of how many models have been processed for the batch
+	 * @param $count
+	 */
+	private function updateCountOfModelsProcessed($count = 1)
+	{
+		$count = $this->getCountOfModelsProcessed() + (int) $count;
+		update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
+	}
+
+
+	/**
+	 * Retrieve the tracked number of models processed between requests.
+	 * @return int
+	 */
+	private function getCountOfModelsProcessed()
+	{
+		return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
+	}
+
+
+	/**
+	 * Returns the models that are left to process.
+	 * @return array  an array of model class names.
+	 */
+	private function getModelsToProcess()
+	{
+		if (empty($this->models_with_datetime_fields)) {
+			$this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
+		}
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 * @param float $offset
+	 */
+	public static function updateOffset($offset)
+	{
+		update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
+	}
+
+
+	/**
+	 * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @return float
+	 */
+	public static function getOffset()
+	{
+		return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
+	}
+
+
+	/**
+	 * Used to set the saved offset range start date.
+	 * @param DbSafeDateTime|null $start_date
+	 */
+	public static function updateStartDateRange(DbSafeDateTime $start_date = null)
+	{
+		$date_to_save = $start_date instanceof DbSafeDateTime
+			? $start_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range start date.
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getStartDateRange()
+	{
+		$start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
+		try {
+			$datetime = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
+			$start_date = $datetime instanceof DateTime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+
+		} catch (Exception $e) {
+			$start_date = null;
+		}
+		return $start_date;
+	}
+
+
+
+	/**
+	 * Used to set the saved offset range end date.
+	 * @param DbSafeDateTime|null $end_date
+	 */
+	public static function updateEndDateRange(DbSafeDateTime $end_date = null)
+	{
+		$date_to_save = $end_date instanceof DbSafeDateTime
+			? $end_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range end date.
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getEndDateRange()
+	{
+		$end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
+		try {
+			$datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
+			$end_date = $datetime instanceof Datetime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$end_date = null;
+		}
+		return $end_date;
+	}
 }

payment_methods/Paypal_Express/EE_PMT_Paypal_Express.pm.php

Indentation +140 added lines, -140 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -17,153 +17,153 @@ 
 class EE_PMT_Paypal_Express extends EE_PMT_Base
 {
 
-    /**
-     * EE_PMT_Paypal_Express constructor.
-     */
-    public function __construct($pm_instance = null)
-    {
-        require_once($this->file_folder() . 'EEG_Paypal_Express.gateway.php');
-        $this->_gateway = new EEG_Paypal_Express();
+	/**
+	 * EE_PMT_Paypal_Express constructor.
+	 */
+	public function __construct($pm_instance = null)
+	{
+		require_once($this->file_folder() . 'EEG_Paypal_Express.gateway.php');
+		$this->_gateway = new EEG_Paypal_Express();
 
-        $this->_pretty_name = esc_html__('PayPal Express', 'event_espresso');
-        $this->_template_path = $this->file_folder() . 'templates' . DS;
-        $this->_default_description = esc_html__(
-            // @codingStandardsIgnoreStart
-            'After clicking \'Finalize Registration\', you will be forwarded to PayPal website to Login and make your payment.',
-            // @codingStandardsIgnoreEnd
-            'event_espresso'
-        );
-        $this->_default_button_url = $this->file_url() . 'lib' . DS . 'paypal-express-checkout-logo.png';
+		$this->_pretty_name = esc_html__('PayPal Express', 'event_espresso');
+		$this->_template_path = $this->file_folder() . 'templates' . DS;
+		$this->_default_description = esc_html__(
+			// @codingStandardsIgnoreStart
+			'After clicking \'Finalize Registration\', you will be forwarded to PayPal website to Login and make your payment.',
+			// @codingStandardsIgnoreEnd
+			'event_espresso'
+		);
+		$this->_default_button_url = $this->file_url() . 'lib' . DS . 'paypal-express-checkout-logo.png';
 
-        parent::__construct($pm_instance);
-    }
+		parent::__construct($pm_instance);
+	}
 
 
-    /**
-     * Adds the help tab.
-     *
-     * @see EE_PMT_Base::help_tabs_config()
-     * @return array
-     */
-    public function help_tabs_config()
-    {
-        return array(
-            $this->get_help_tab_name() => array(
-                'title'    => esc_html__('PayPal Express Settings', 'event_espresso'),
-                'filename' => 'payment_methods_overview_paypal_express'
-            )
-        );
-    }
+	/**
+	 * Adds the help tab.
+	 *
+	 * @see EE_PMT_Base::help_tabs_config()
+	 * @return array
+	 */
+	public function help_tabs_config()
+	{
+		return array(
+			$this->get_help_tab_name() => array(
+				'title'    => esc_html__('PayPal Express Settings', 'event_espresso'),
+				'filename' => 'payment_methods_overview_paypal_express'
+			)
+		);
+	}
 
 
-    /**
-     * Gets the form for all the settings related to this payment method type.
-     *
-     * @return EE_Payment_Method_Form
-     */
-    public function generate_new_settings_form()
-    {
-        EE_Registry::instance()->load_helper('Template');
-        $form = new EE_Payment_Method_Form(
-            array(
-                'extra_meta_inputs' => array(
-                    'api_username' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                esc_html__('API Username %s', 'event_espresso'),
-                                $this->get_help_tab_link()
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_password' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                esc_html__('API Password %s', 'event_espresso'),
-                                $this->get_help_tab_link()
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'api_signature' => new EE_Text_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                esc_html__('API Signature %s', 'event_espresso'),
-                                $this->get_help_tab_link()
-                            ),
-                            'required'        => true,
-                        )
-                    ),
-                    'request_shipping_addr' => new EE_Yes_No_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                esc_html__('Request Shipping Address %s', 'event_espresso'),
-                                $this->get_help_tab_link()
-                            ),
-                            'html_help_text'  => esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'If set to "Yes", then a shipping address will be requested on the PayPal checkout page.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            'required'        => true,
-                            'default'         => false,
-                        )
-                    ),
-                    'image_url' => new EE_Admin_File_Uploader_Input(
-                        array(
-                            'html_label_text' => sprintf(
-                                esc_html__('Image URL %s', 'event_espresso'),
-                                $this->get_help_tab_link()
-                            ),
-                            'html_help_text'  => esc_html__(
-                                'Used for your business/personal logo on the PayPal page',
-                                'event_espresso'
-                            ),
-                            'required'        => false,
-                        )
-                    ),
-                )
-            )
-        );
-        return $form;
-    }
+	/**
+	 * Gets the form for all the settings related to this payment method type.
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	public function generate_new_settings_form()
+	{
+		EE_Registry::instance()->load_helper('Template');
+		$form = new EE_Payment_Method_Form(
+			array(
+				'extra_meta_inputs' => array(
+					'api_username' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								esc_html__('API Username %s', 'event_espresso'),
+								$this->get_help_tab_link()
+							),
+							'required'        => true,
+						)
+					),
+					'api_password' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								esc_html__('API Password %s', 'event_espresso'),
+								$this->get_help_tab_link()
+							),
+							'required'        => true,
+						)
+					),
+					'api_signature' => new EE_Text_Input(
+						array(
+							'html_label_text' => sprintf(
+								esc_html__('API Signature %s', 'event_espresso'),
+								$this->get_help_tab_link()
+							),
+							'required'        => true,
+						)
+					),
+					'request_shipping_addr' => new EE_Yes_No_Input(
+						array(
+							'html_label_text' => sprintf(
+								esc_html__('Request Shipping Address %s', 'event_espresso'),
+								$this->get_help_tab_link()
+							),
+							'html_help_text'  => esc_html__(
+								// @codingStandardsIgnoreStart
+								'If set to "Yes", then a shipping address will be requested on the PayPal checkout page.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							'required'        => true,
+							'default'         => false,
+						)
+					),
+					'image_url' => new EE_Admin_File_Uploader_Input(
+						array(
+							'html_label_text' => sprintf(
+								esc_html__('Image URL %s', 'event_espresso'),
+								$this->get_help_tab_link()
+							),
+							'html_help_text'  => esc_html__(
+								'Used for your business/personal logo on the PayPal page',
+								'event_espresso'
+							),
+							'required'        => false,
+						)
+					),
+				)
+			)
+		);
+		return $form;
+	}
 
 
-    /**
-     * Creates a billing form for this payment method type.
-     *
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null)
-    {
-        if ($this->_pm_instance->debug_mode()) {
-            $form = new EE_Billing_Info_Form(
-                $this->_pm_instance,
-                array(
-                    'name' => 'paypal_express_Info_Form',
-                    'subsections' => array(
-                        'paypal_express_debug_info' => new EE_Form_Section_Proper(
-                            array(
-                                'layout_strategy' => new EE_Template_Layout(
-                                    array(
-                                        'layout_template_file' => $this->_template_path
-                                                                    . 'paypal_express_debug_info.template.php',
-                                        'template_args'        => array(
-                                            'debug_mode' => $this->_pm_instance->debug_mode()
-                                        )
-                                    )
-                                )
-                            )
-                        )
-                    )
-                )
-            );
-            return $form;
-        }
+	/**
+	 * Creates a billing form for this payment method type.
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null)
+	{
+		if ($this->_pm_instance->debug_mode()) {
+			$form = new EE_Billing_Info_Form(
+				$this->_pm_instance,
+				array(
+					'name' => 'paypal_express_Info_Form',
+					'subsections' => array(
+						'paypal_express_debug_info' => new EE_Form_Section_Proper(
+							array(
+								'layout_strategy' => new EE_Template_Layout(
+									array(
+										'layout_template_file' => $this->_template_path
+																	. 'paypal_express_debug_info.template.php',
+										'template_args'        => array(
+											'debug_mode' => $this->_pm_instance->debug_mode()
+										)
+									)
+								)
+							)
+						)
+					)
+				)
+			);
+			return $form;
+		}
 
-        return false;
-    }
+		return false;
+	}
 }
 // End of file EE_PMT_Paypal_Express.pm.php
\ No newline at end of file

Spacing +4 added lines, -4 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -22,18 +22,18 @@ 
      */
     public function __construct($pm_instance = null)
     {
-        require_once($this->file_folder() . 'EEG_Paypal_Express.gateway.php');
+        require_once($this->file_folder().'EEG_Paypal_Express.gateway.php');
         $this->_gateway = new EEG_Paypal_Express();
 
         $this->_pretty_name = esc_html__('PayPal Express', 'event_espresso');
-        $this->_template_path = $this->file_folder() . 'templates' . DS;
+        $this->_template_path = $this->file_folder().'templates'.DS;
         $this->_default_description = esc_html__(
             // @codingStandardsIgnoreStart
             'After clicking \'Finalize Registration\', you will be forwarded to PayPal website to Login and make your payment.',
             // @codingStandardsIgnoreEnd
             'event_espresso'
         );
-        $this->_default_button_url = $this->file_url() . 'lib' . DS . 'paypal-express-checkout-logo.png';
+        $this->_default_button_url = $this->file_url().'lib'.DS.'paypal-express-checkout-logo.png';
 
         parent::__construct($pm_instance);
     }

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +669 added lines, -669 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -16,678 +16,678 @@ 
  */
 //Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
 if (! function_exists('mb_strcut')) {
-    /**
-     * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
-     * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
-     * @param $string
-     * @param $start
-     * @param $length
-     * @return bool|string
-     */
-    function mb_strcut($string, $start, $length = null)
-    {
-        return mb_substr($string, $start, $length);
-    }
+	/**
+	 * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
+	 * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
+	 * @param $string
+	 * @param $start
+	 * @param $length
+	 * @return bool|string
+	 */
+	function mb_strcut($string, $start, $length = null)
+	{
+		return mb_substr($string, $start, $length);
+	}
 }
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $order_description = mb_strcut($this->_format_order_description($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            //EE will blow up if you change this
-            'BUTTONSOURCE'                   => 'EventEspresso_SP',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        $itemized_list = $this->itemize_list($payment, $transaction);
-        $token_request_dtls = array_merge($token_request_dtls, $itemized_list);
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                    //EE will blow up if you change this
-                    'BUTTONSOURCE'                   => 'EventEspresso_SP',
-                );
-                 // Include itemized list.
-                $itemized_list = $this->itemize_list(
-                    $payment,
-                    $transaction,
-                    $cdata_response_args
-                );
-                $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            esc_html__(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        esc_html__(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(
-                esc_html__(
-                    'Error occurred while trying to process the payment.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make a list of items that are in the giver transaction.
-     *
-     * @param EEI_Payment     $payment
-     * @param EEI_Transaction $transaction
-     * @param array           $request_response_args Data from a previous communication with PP.
-     * @return array
-     */
-    public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
-    {
-        $itemized_list = array();
-        // If we have data from a previous communication with PP (on this transaction) we may use that for our list...
-        if (
-            ! empty($request_response_args)
-            && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
-            && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
-        ) {
-            foreach ($request_response_args as $arg_key => $arg_val) {
-                if (
-                    strpos($arg_key, 'PAYMENTREQUEST_') !== false
-                    && strpos($arg_key, 'NOTIFYURL') === false
-                ) {
-                    $itemized_list[$arg_key] = $arg_val;
-                }
-            }
-            // If we got only a few Items then something is not right.
-            if (count($itemized_list) > 2) {
-                return $itemized_list;
-            } else {
-                if (WP_DEBUG) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($itemized_list)
-                        )
-                    );
-                }
-                // Reset the list and log an error, maybe allow to try and generate a new list (below).
-                $itemized_list = array();
-                $this->log(
-                    array(
-                        esc_html__(
-                            'Could not generate a proper item list with:',
-                            'event_espresso'
-                        ) => $request_response_args
-                    ),
-                    $payment
-                );
-            }
-        }
-        // ...otherwise we generate a new list for this transaction.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
-                        $this->_format_line_item_name($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut(
-                        $this->_format_line_item_desc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
-                    // Item Number.
-                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
-                    // Item quantity.
-                    $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
-                    // Digital item is sold.
-                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
-                    esc_html__(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
-                // Cost of individual item.
-                $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
-                // Item quantity.
-                $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
-                // Digital item is sold.
-                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
-                $this->_format_partial_payment_line_item_name($payment),
-                0,
-                127
-            );
-            // Item description.
-            $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
-                $this->_format_partial_payment_line_item_desc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
-            // Item Number.
-            $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
-            $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        return $itemized_list;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION'   => '204.0',
-            'USER'      => urlencode($this->_api_username),
-            'PWD'       => urlencode($this->_api_password),
-            'SIGNATURE' => urlencode($this->_api_signature),
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array["L_ERRORCODE{$n}"])) {
-            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
-                ? $data_array["L_ERRORCODE{$n}"]
-                : '';
-            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
-                ? $data_array["L_SEVERITYCODE{$n}"]
-                : '';
-            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
-                ? $data_array["L_SHORTMESSAGE{$n}"]
-                : '';
-            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
-                ? $data_array["L_LONGMESSAGE{$n}"]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+		);
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$order_description = mb_strcut($this->_format_order_description($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			//EE will blow up if you change this
+			'BUTTONSOURCE'                   => 'EventEspresso_SP',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		$itemized_list = $this->itemize_list($payment, $transaction);
+		$token_request_dtls = array_merge($token_request_dtls, $itemized_list);
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			// If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+					//EE will blow up if you change this
+					'BUTTONSOURCE'                   => 'EventEspresso_SP',
+				);
+				 // Include itemized list.
+				$itemized_list = $this->itemize_list(
+					$payment,
+					$transaction,
+					$cdata_response_args
+				);
+				$docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							esc_html__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						esc_html__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(
+				esc_html__(
+					'Error occurred while trying to process the payment.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make a list of items that are in the giver transaction.
+	 *
+	 * @param EEI_Payment     $payment
+	 * @param EEI_Transaction $transaction
+	 * @param array           $request_response_args Data from a previous communication with PP.
+	 * @return array
+	 */
+	public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array())
+	{
+		$itemized_list = array();
+		// If we have data from a previous communication with PP (on this transaction) we may use that for our list...
+		if (
+			! empty($request_response_args)
+			&& array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args)
+			&& array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args)
+		) {
+			foreach ($request_response_args as $arg_key => $arg_val) {
+				if (
+					strpos($arg_key, 'PAYMENTREQUEST_') !== false
+					&& strpos($arg_key, 'NOTIFYURL') === false
+				) {
+					$itemized_list[$arg_key] = $arg_val;
+				}
+			}
+			// If we got only a few Items then something is not right.
+			if (count($itemized_list) > 2) {
+				return $itemized_list;
+			} else {
+				if (WP_DEBUG) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($itemized_list)
+						)
+					);
+				}
+				// Reset the list and log an error, maybe allow to try and generate a new list (below).
+				$itemized_list = array();
+				$this->log(
+					array(
+						esc_html__(
+							'Could not generate a proper item list with:',
+							'event_espresso'
+						) => $request_response_args
+					),
+					$payment
+				);
+			}
+		}
+		// ...otherwise we generate a new list for this transaction.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+						$this->_format_line_item_name($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut(
+						$this->_format_line_item_desc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
+					// Item Number.
+					$itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+					// Item quantity.
+					$itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
+					// Digital item is sold.
+					$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+					esc_html__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
+				// Cost of individual item.
+				$itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+				// Item quantity.
+				$itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
+				// Digital item is sold.
+				$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut(
+				$this->_format_partial_payment_line_item_name($payment),
+				0,
+				127
+			);
+			// Item description.
+			$itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut(
+				$this->_format_partial_payment_line_item_desc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
+			// Item Number.
+			$itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
+			$itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		return $itemized_list;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION'   => '204.0',
+			'USER'      => urlencode($this->_api_username),
+			'PWD'       => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature),
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array["L_ERRORCODE{$n}"])) {
+			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+				? $data_array["L_ERRORCODE{$n}"]
+				: '';
+			$l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+				? $data_array["L_SEVERITYCODE{$n}"]
+				: '';
+			$l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+				? $data_array["L_SHORTMESSAGE{$n}"]
+				: '';
+			$l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+				? $data_array["L_LONGMESSAGE{$n}"]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 
 }
 // End of file EEG_Paypal_Express.gateway.php

Spacing +29 added lines, -29 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -15,7 +15,7 @@ 
  * ----------------------------------------------
  */
 //Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP
-if (! function_exists('mb_strcut')) {
+if ( ! function_exists('mb_strcut')) {
     /**
      * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr
      * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks)
@@ -145,7 +145,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Error. No associated payment was found.',
@@ -156,7 +156,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 esc_html__(
                     'Could not process this payment because it has no associated transaction.',
@@ -204,13 +204,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -235,7 +235,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -266,7 +266,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     esc_html__(
                         'Could not process this payment because it has no associated transaction.',
@@ -279,7 +279,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+            if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
                 $payment->set_status($this->_pay_model->failed_status());
                 return $payment;
             }
@@ -333,7 +333,7 @@ 
                         : '';
                     $payment->set_extra_accntng($primary_registration_code);
                     $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
+                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
                         : 0);
                     $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
                         ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
@@ -468,25 +468,25 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                         $this->_format_line_item_name($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut(
+                    $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut(
                         $this->_format_line_item_desc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
+                    $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($unit_price);
                     // Item Number.
-                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+                    $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
+                    $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+                    $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->total();
                     ++$item_num;
                 }
@@ -504,7 +504,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut(
+                $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut(
                     esc_html__(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -513,17 +513,17 @@ 
                     127
                 );
                 // Item description.
-                $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
+                $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
+                $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency(
                     $itemized_sum_diff_from_txn_total
                 );
                 // Item Number.
-                $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+                $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
+                $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+                $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -576,7 +576,7 @@ 
             'SIGNATURE' => urlencode($this->_api_signature),
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -590,7 +590,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -610,7 +610,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if (
@@ -679,10 +679,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 );
             } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE'] .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }

core/domain/services/event/EventSpacesCalculator.php

Indentation +660 added lines, -660 removed lines

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

Spacing +50 added lines, -50 removed lines

@@ -131,14 +131,14 @@ 
      */
     private function setHooks()
     {
-        add_action( 'AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
-        add_action( 'AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
+        add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
+        add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
+        add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
+        add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
+        add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
+        add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
+        add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
+        add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
     }
 
 
@@ -194,7 +194,7 @@ 
             // sort incoming array by ticket quantity (asc)
             usort(
                 $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
+                function(EE_Ticket $a, EE_Ticket $b) {
                     if ($a->qty() === $b->qty()) {
                         return 0;
                     }
@@ -270,7 +270,7 @@ 
                 )
             );
         }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
+        $this->datetimes[$datetime->ID()] = $datetime;
     }
 
 
@@ -310,7 +310,7 @@ 
      */
     public function totalSpacesAvailable()
     {
-        if($this->total_spaces_available === null) {
+        if ($this->total_spaces_available === null) {
             $this->initialize();
             $this->total_spaces_available = $this->calculate(false);
         }
@@ -367,16 +367,16 @@ 
                     // we are going to move all of our data into the following arrays:
                     // datetime spaces initially represents the reg limit for each datetime,
                     // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+                    $this->datetime_spaces[$datetime_identifier] = $reg_limit;
                     // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+                    $this->datetime_tickets[$datetime_identifier][] = $ticket_identifier;
                     // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+                    $this->ticket_datetimes[$ticket_identifier][] = $datetime_identifier;
                 }
                 // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+                $this->tickets_sold[$ticket_identifier] = $ticket->sold() + $ticket->reserved();
                 // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+                $this->ticket_quantities[$ticket_identifier] = $max_tickets;
             }
         }
         // sort datetime spaces by reg limit, but maintain our string indexes
@@ -435,19 +435,19 @@ 
             \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
         }
         foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])){
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+            if (isset($this->ticket_quantities[$ticket_identifier])) {
+                $this->ticket_quantities[$ticket_identifier] -= $tickets_sold;
                 if ($this->debug) {
                     \EEH_Debug_Tools::printr("{$tickets_sold} sales for ticket {$ticket_identifier} ", 'subtracting', __FILE__, __LINE__);
                 }
             }
             if (
-                isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
-            ){
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+                isset($this->ticket_datetimes[$ticket_identifier])
+                && is_array($this->ticket_datetimes[$ticket_identifier])
+            ) {
+                foreach ($this->ticket_datetimes[$ticket_identifier] as $ticket_datetime) {
+                    if (isset($this->ticket_quantities[$ticket_identifier])) {
+                        $this->datetime_spaces[$ticket_datetime] -= $tickets_sold;
                         if ($this->debug) {
                             \EEH_Debug_Tools::printr("{$tickets_sold} sales for datetime {$ticket_datetime} ",
                                 'subtracting', __FILE__, __LINE__);
@@ -467,8 +467,8 @@ 
     private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
     {
         // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
+        $reg_limit = isset($this->datetime_spaces[$datetime_identifier])
+            ? $this->datetime_spaces[$datetime_identifier]
             : 0;
         // and bail if it is not
         if ( ! $reg_limit) {
@@ -483,7 +483,7 @@ 
         }
         // number of allocated spaces always starts at zero
         $spaces_allocated                           = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
+        $this->total_spaces[$datetime_identifier] = 0;
         foreach ($tickets as $ticket_identifier) {
             $spaces_allocated = $this->calculateAvailableSpacesForTicket(
                 $datetime_identifier,
@@ -496,9 +496,9 @@ 
         $spaces_allocated = max($spaces_allocated, 0);
         if ($spaces_allocated) {
             // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+            $this->total_spaces[$datetime_identifier] += $spaces_allocated;
             if ($this->debug) {
-                \EEH_Debug_Tools::printr((string)$spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
+                \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
             }
         } else {
             if ($this->debug) {
@@ -506,7 +506,7 @@ 
             }
         }
         if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->total_spaces[ $datetime_identifier ], '$total_spaces', __FILE__,
+            \EEH_Debug_Tools::printr($this->total_spaces[$datetime_identifier], '$total_spaces', __FILE__,
                 __LINE__);
             \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
             \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
@@ -529,8 +529,8 @@ 
         $spaces_allocated
     ) {
         // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
+        $ticket_quantity = isset($this->ticket_quantities[$ticket_identifier])
+            ? $this->ticket_quantities[$ticket_identifier]
             : 0;
         if ($this->debug) {
             \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
@@ -554,13 +554,13 @@ 
                 //  or the maximum ticket quantity
                 $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
                 // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+                $this->ticket_quantities[$ticket_identifier] -= $ticket_quantity;
                 // and increment spaces allocated for this datetime
                 $spaces_allocated += $ticket_quantity;
                 $at_capacity = $spaces_allocated >= $reg_limit;
                 if ($this->debug) {
                     \EEH_Debug_Tools::printr("{$ticket_quantity} {$ticket_identifier} tickets", ' > > allocate ',
-                        __FILE__, __LINE__,   3);
+                        __FILE__, __LINE__, 3);
                     if ($at_capacity) {
                         \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
                     }
@@ -607,15 +607,15 @@ 
                 $ticket_quantity
             );
             // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
+            if ( ! ($adjusted || $at_capacity)) {
                 continue;
             }
             // then all of it's tickets are now unavailable
             foreach ($datetime_tickets as $datetime_ticket) {
                 if (
                     ($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
+                    && isset($this->ticket_quantities[$datetime_ticket])
+                    && $this->ticket_quantities[$datetime_ticket] > 0
                 ) {
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr($datetime_ticket, ' . . . adjust ticket quantities for', __FILE__,
@@ -625,14 +625,14 @@ 
                     // otherwise just subtract the ticket quantity
                     $new_quantity = $at_capacity
                         ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+                        : $this->ticket_quantities[$datetime_ticket] - $ticket_quantity;
                     // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+                    $this->ticket_quantities[$datetime_ticket] = max($new_quantity, 0);
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
                             $at_capacity
                                 ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
+                                : "{$this->ticket_quantities[$datetime_ticket]}",
                             " . . . . {$datetime_ticket} quantity set to ",
                             __FILE__, __LINE__
                         );
@@ -640,14 +640,14 @@ 
                 }
                 // but we also need to adjust spaces for any other datetimes this ticket has access to
                 if ($datetime_ticket === $ticket_identifier) {
-                    if (isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
+                    if (isset($this->ticket_datetimes[$datetime_ticket])
+                        && is_array($this->ticket_datetimes[$datetime_ticket])
                     ) {
                         if ($this->debug) {
                             \EEH_Debug_Tools::printr($datetime_ticket, ' . . adjust other Datetimes for', __FILE__,
                                 __LINE__);
                         }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+                        foreach ($this->ticket_datetimes[$datetime_ticket] as $datetime) {
                             // don't adjust the current datetime twice
                             if ($datetime !== $datetime_identifier) {
                                 $this->adjustDatetimeSpaces(
@@ -668,19 +668,19 @@ 
         // does datetime have spaces available?
         // and does the supplied ticket have access to this datetime ?
         if (
-            $this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+            $this->datetime_spaces[$datetime_identifier] > 0
+            && isset($this->datetime_spaces[$datetime_identifier], $this->datetime_tickets[$datetime_identifier])
+            && in_array($ticket_identifier, $this->datetime_tickets[$datetime_identifier], true)
             ) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
-                \EEH_Debug_Tools::printr("{$this->datetime_spaces[ $datetime_identifier ]}", " . . current  {$datetime_identifier} spaces available", __FILE__, __LINE__);
+                \EEH_Debug_Tools::printr("{$this->datetime_spaces[$datetime_identifier]}", " . . current  {$datetime_identifier} spaces available", __FILE__, __LINE__);
             }
             // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+            $this->datetime_spaces[$datetime_identifier] -= $ticket_quantity;
             // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
+            $this->datetime_spaces[$datetime_identifier] = max(
+                $this->datetime_spaces[$datetime_identifier],
                 0
             );
             if ($this->debug) {

core/db_classes/EE_Ticket.class.php

Indentation +626 added lines, -626 removed lines

@@ -61,15 +61,15 @@ 
 
 
 
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Ticket
-     * @throws \EE_Error
-     */
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Ticket
+	 * @throws \EE_Error
+	 */
 	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
 		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
 		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
@@ -77,36 +77,36 @@ 
 
 
 
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Ticket
-     * @throws \EE_Error
-     */
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Ticket
+	 * @throws \EE_Error
+	 */
 	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
 		return new self( $props_n_values, TRUE, $timezone );
 	}
 
 
 
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function parent() {
 		return $this->get( 'TKT_parent' );
 	}
 
 
 
-    /**
-     * return if a ticket has quantities available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * return if a ticket has quantities available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function available( $DTT_ID = 0 ) {
 		// are we checking availability for a particular datetime ?
 		if ( $DTT_ID ) {
@@ -123,14 +123,14 @@ 
 
 
 
-    /**
-     * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
-     *
-     * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
-     * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
-     * @return mixed status int if the display string isn't requested
-     * @throws \EE_Error
-     */
+	/**
+	 * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
+	 *
+	 * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the relevant status const
+	 * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing
+	 * @return mixed status int if the display string isn't requested
+	 * @throws \EE_Error
+	 */
 	public function ticket_status( $display = FALSE, $remaining = null ) {
 		$remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining();
 		if ( ! $remaining ) {
@@ -153,14 +153,14 @@ 
 
 
 
-    /**
-     * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out.
-     *
-     * @access public
-     * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
-     * @return boolean         true = tickets remaining, false not.
-     * @throws \EE_Error
-     */
+	/**
+	 * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out.
+	 *
+	 * @access public
+	 * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
+	 * @return boolean         true = tickets remaining, false not.
+	 * @throws \EE_Error
+	 */
 	public function is_remaining( $DTT_ID = 0 ) {
 		$num_remaining = $this->remaining( $DTT_ID );
 		if ( $num_remaining === 0 ) {
@@ -174,76 +174,76 @@ 
 
 
 
-    /**
-     * return the total number of tickets available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime.
-     *                     set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * return the total number of tickets available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime.
+	 *                     set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function remaining( $DTT_ID = 0 ) {
 		return $this->real_quantity_on_ticket('saleable', $DTT_ID );
 	}
 
 
 
-    /**
-     * Gets min
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets min
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function min() {
 		return $this->get( 'TKT_min' );
 	}
 
 
 
-    /**
-     * return if a ticket is no longer available cause its available dates have expired.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * return if a ticket is no longer available cause its available dates have expired.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_expired() {
 		return ( $this->get_raw( 'TKT_end_date' ) < time() );
 	}
 
 
 
-    /**
-     * Return if a ticket is yet to go on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Return if a ticket is yet to go on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_pending() {
 		return ( $this->get_raw( 'TKT_start_date' ) > time() );
 	}
 
 
 
-    /**
-     * Return if a ticket is on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Return if a ticket is on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_on_sale() {
 		return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() );
 	}
 
 
 
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @param string $dt_frmt
-     * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @param string $dt_frmt
+	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
 		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : '';
 		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : '';
@@ -253,12 +253,12 @@ 
 
 
 
-    /**
-     * This returns the chronologically first datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically first datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
 	public function first_datetime() {
 		$datetimes = $this->datetimes( array( 'limit' => 1 ) );
 		return reset( $datetimes );
@@ -266,14 +266,14 @@ 
 
 
 
-    /**
-     * Gets all the datetimes this ticket can be used for attending.
-     * Unless otherwise specified, orders datetimes by start date.
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the datetimes this ticket can be used for attending.
+	 * Unless otherwise specified, orders datetimes by start date.
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function datetimes( $query_params = array() ) {
 		if ( ! isset( $query_params[ 'order_by' ] ) ) {
 			$query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC';
@@ -283,12 +283,12 @@ 
 
 
 
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
 	public function last_datetime() {
 		$datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) );
 		return end( $datetimes );
@@ -296,19 +296,19 @@ 
 
 
 
-    /**
-     * This returns the total tickets sold depending on the given parameters.
-     *
-     * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
-     *                        'ticket' = total ticket sales for all datetimes this ticket is related to
-     *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
-     *                        'datetime' = total ticket sales in the datetime_ticket table.
-     *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
-     *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
-     * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
-     * @return mixed (array|int)          how many tickets have sold
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the total tickets sold depending on the given parameters.
+	 *
+	 * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
+	 *                        'ticket' = total ticket sales for all datetimes this ticket is related to
+	 *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
+	 *                        'datetime' = total ticket sales in the datetime_ticket table.
+	 *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
+	 *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
+	 * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
+	 * @return mixed (array|int)          how many tickets have sold
+	 * @throws \EE_Error
+	 */
 	public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) {
 		$total = 0;
 		$tickets_sold = $this->_all_tickets_sold();
@@ -333,12 +333,12 @@ 
 
 
 
-    /**
-     * This returns an array indexed by datetime_id for tickets sold with this ticket.
-     *
-     * @return EE_Ticket[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns an array indexed by datetime_id for tickets sold with this ticket.
+	 *
+	 * @return EE_Ticket[]
+	 * @throws \EE_Error
+	 */
 	protected function _all_tickets_sold() {
 		$datetimes = $this->get_many_related( 'Datetime' );
 		$tickets_sold = array();
@@ -354,29 +354,29 @@ 
 
 
 
-    /**
-     * This returns the base price object for the ticket.
-     *
-     * @param  bool $return_array whether to return as an array indexed by price id or just the object.
-     * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns the base price object for the ticket.
+	 *
+	 * @param  bool $return_array whether to return as an array indexed by price id or just the object.
+	 * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function base_price( $return_array = FALSE ) {
 		$_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price );
 		return $return_array
-            ? $this->get_many_related( 'Price', array( $_where ) )
-            : $this->get_first_related( 'Price', array( $_where ) );
+			? $this->get_many_related( 'Price', array( $_where ) )
+			: $this->get_first_related( 'Price', array( $_where ) );
 	}
 
 
 
-    /**
-     * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
-     *
-     * @access public
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
+	/**
+	 * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
+	 *
+	 * @access public
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
 	public function price_modifiers() {
 		$query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) );
 		return $this->prices( $query_params );
@@ -384,132 +384,132 @@ 
 
 
 
-    /**
-     * Gets all the prices that combine to form the final price of this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the prices that combine to form the final price of this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function prices( $query_params = array() ) {
 		return $this->get_many_related( 'Price', $query_params );
 	}
 
 
 
-    /**
-     * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Datetime_Ticket|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Datetime_Ticket|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function datetime_tickets( $query_params = array() ) {
 		return $this->get_many_related( 'Datetime_Ticket', $query_params );
 	}
 
 
 
-    /**
-     * Gets all the datetimes from the db ordered by DTT_order
-     *
-     * @param boolean $show_expired
-     * @param boolean $show_deleted
-     * @return EE_Datetime[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the datetimes from the db ordered by DTT_order
+	 *
+	 * @param boolean $show_expired
+	 * @param boolean $show_deleted
+	 * @return EE_Datetime[]
+	 * @throws \EE_Error
+	 */
 	public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) {
 		return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted );
 	}
 
 
 
-    /**
-     * Gets ID
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ID
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function ID() {
 		return $this->get( 'TKT_ID' );
 	}
 
 
 
-    /**
-     * get the author of the ticket.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * get the author of the ticket.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function wp_user() {
 		return $this->get('TKT_wp_user');
 	}
 
 
 
-    /**
-     * Gets the template for the ticket
-     *
-     * @return EE_Ticket_Template|EE_Base_Class
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets the template for the ticket
+	 *
+	 * @return EE_Ticket_Template|EE_Base_Class
+	 * @throws \EE_Error
+	 */
 	public function template() {
 		return $this->get_first_related( 'Ticket_Template' );
 	}
 
 
 
-    /**
-     * Simply returns an array of EE_Price objects that are taxes.
-     *
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Simply returns an array of EE_Price objects that are taxes.
+	 *
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_taxes_for_admin() {
 		return EE_Taxes::get_taxes_for_admin();
 	}
 
 
 
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function ticket_price() {
 		return $this->get( 'TKT_price' );
 	}
 
 
 
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
 	public function pretty_price() {
 		return $this->get_pretty( 'TKT_price' );
 	}
 
 
 
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function is_free() {
 		return $this->get_ticket_total_with_taxes() === (float) 0;
 	}
 
 
 
-    /**
-     * get_ticket_total_with_taxes
-     *
-     * @param bool $no_cache
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * get_ticket_total_with_taxes
+	 *
+	 * @param bool $no_cache
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_total_with_taxes( $no_cache = FALSE ) {
 		if ($this->_ticket_total_with_taxes === null || $no_cache ) {
 			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
@@ -526,201 +526,201 @@ 
 
 
 
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_subtotal() {
 		return EE_Taxes::get_subtotal_for_admin( $this );
 	}
 
 
 
-    /**
-     * Returns the total taxes applied to this ticket
-     *
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * Returns the total taxes applied to this ticket
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function get_ticket_taxes_total_for_admin() {
 		return EE_Taxes::get_total_taxes_for_admin( $this );
 	}
 
 
 
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws \EE_Error
+	 */
 	public function set_name( $name ) {
 		$this->set( 'TKT_name', $name );
 	}
 
 
 
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function description() {
 		return $this->get( 'TKT_description' );
 	}
 
 
 
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws \EE_Error
+	 */
 	public function set_description( $description ) {
 		$this->set( 'TKT_description', $description );
 	}
 
 
 
-    /**
-     * Gets start_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets start_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function start_date( $dt_frmt = '', $tm_frmt = '' ) {
 		return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt );
 	}
 
 
 
-    /**
-     * Sets start_date
-     *
-     * @param string $start_date
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets start_date
+	 *
+	 * @param string $start_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_start_date( $start_date ) {
 		$this->_set_date_time( 'B', $start_date, 'TKT_start_date' );
 	}
 
 
 
-    /**
-     * Gets end_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets end_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function end_date( $dt_frmt = '', $tm_frmt = '' ) {
 		return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt );
 	}
 
 
 
-    /**
-     * Sets end_date
-     *
-     * @param string $end_date
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets end_date
+	 *
+	 * @param string $end_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_end_date( $end_date ) {
 		$this->_set_date_time( 'B', $end_date, 'TKT_end_date' );
 	}
 
 
 
-    /**
-     * Sets sell until time
-     *
-     * @since 4.5.0
-     * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets sell until time
+	 *
+	 * @since 4.5.0
+	 * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
+	 * @throws \EE_Error
+	 */
 	public function set_end_time( $time ) {
 		$this->_set_time_for( $time, 'TKT_end_date' );
 	}
 
 
 
-    /**
-     * Sets min
-     *
-     * @param int $min
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets min
+	 *
+	 * @param int $min
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_min( $min ) {
 		$this->set( 'TKT_min', $min );
 	}
 
 
 
-    /**
-     * Gets max
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets max
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function max() {
 		return $this->get( 'TKT_max' );
 	}
 
 
 
-    /**
-     * Sets max
-     *
-     * @param int $max
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets max
+	 *
+	 * @param int $max
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_max( $max ) {
 		$this->set( 'TKT_max', $max );
 	}
 
 
 
-    /**
-     * Sets price
-     *
-     * @param float $price
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets price
+	 *
+	 * @param float $price
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_price( $price ) {
 		$this->set( 'TKT_price', $price );
 	}
 
 
 
-    /**
-     * Gets sold
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets sold
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function sold() {
 		return $this->get_raw( 'TKT_sold' );
 	}
 
 
 
-    /**
-     * Sets sold
-     *
-     * @param int $sold
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets sold
+	 *
+	 * @param int $sold
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_sold( $sold ) {
 		// sold can not go below zero
 		$sold = max( 0, $sold );
@@ -729,13 +729,13 @@ 
 
 
 
-    /**
-     * increments sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function increase_sold( $qty = 1 ) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
@@ -744,22 +744,22 @@ 
 		$this->_increase_sold_for_datetimes( $qty );
 		$this->set_sold( $sold );
 		do_action(
-		    'AHEE__EE_Ticket__increase_sold',
-            $this,
-            $qty,
-            $sold
-        );
+			'AHEE__EE_Ticket__increase_sold',
+			$this,
+			$qty,
+			$sold
+		);
 	}
 
 
 
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _increase_sold_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -774,34 +774,34 @@ 
 
 
 
-    /**
-     * decrements (subtracts) sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function decrease_sold( $qty = 1 ) {
 		$sold = $this->sold() - $qty;
 		$this->_decrease_sold_for_datetimes( $qty );
 		$this->set_sold( $sold );
-        do_action(
-            'AHEE__EE_Ticket__decrease_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+		do_action(
+			'AHEE__EE_Ticket__decrease_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _decrease_sold_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -816,25 +816,25 @@ 
 
 
 
-    /**
-     * Gets qty of reserved tickets
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets qty of reserved tickets
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function reserved() {
 		return $this->get_raw( 'TKT_reserved' );
 	}
 
 
 
-    /**
-     * Sets reserved
-     *
-     * @param int $reserved
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets reserved
+	 *
+	 * @param int $reserved
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_reserved( $reserved ) {
 		// reserved can not go below zero
 		$reserved = max( 0, (int) $reserved );
@@ -843,35 +843,35 @@ 
 
 
 
-    /**
-     * increments reserved by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * increments reserved by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function increase_reserved( $qty = 1 ) {
 		$qty = absint( $qty );
 		$reserved = $this->reserved() + $qty;
 		$this->_increase_reserved_for_datetimes( $qty );
 		$this->set_reserved( $reserved );
-        do_action(
-            'AHEE__EE_Ticket__increase_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-    }
-
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+		do_action(
+			'AHEE__EE_Ticket__increase_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+	}
+
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _increase_reserved_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -886,37 +886,37 @@ 
 
 
 
-    /**
-     * decrements (subtracts) reserved by amount passed by $qty
-     *
-     * @param int  $qty
-     * @param bool $adjust_datetimes
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * decrements (subtracts) reserved by amount passed by $qty
+	 *
+	 * @param int  $qty
+	 * @param bool $adjust_datetimes
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) {
 		$reserved = $this->reserved() - absint( $qty );
 		if ( $adjust_datetimes ) {
 			$this->_decrease_reserved_for_datetimes( $qty );
 		}
 		$this->set_reserved( $reserved );
-        do_action(
-            'AHEE__EE_Ticket__decrease_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-    }
-
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
+		do_action(
+			'AHEE__EE_Ticket__decrease_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+	}
+
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	protected function _decrease_reserved_for_datetimes( $qty = 1 ) {
 		$datetimes = $this->datetimes();
 		if ( is_array( $datetimes ) ) {
@@ -931,18 +931,18 @@ 
 
 
 
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
-     *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
+	 *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function qty( $context = '' ) {
 		switch ( $context ) {
 			case 'reg_limit' :
@@ -956,19 +956,19 @@ 
 
 
 
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @param  int   $DTT_ID      the primary key for a particular datetime.
-     *                            set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @param  int   $DTT_ID      the primary key for a particular datetime.
+	 *                            set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) {
 		$raw = $this->get_raw( 'TKT_qty' );
 		// return immediately if it's zero
@@ -1051,212 +1051,212 @@ 
 
 
 
-    /**
-     * Gets uses
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets uses
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function uses() {
 		return $this->get( 'TKT_uses' );
 	}
 
 
 
-    /**
-     * Sets uses
-     *
-     * @param int $uses
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets uses
+	 *
+	 * @param int $uses
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_uses( $uses ) {
 		$this->set( 'TKT_uses', $uses );
 	}
 
 
 
-    /**
-     * returns whether ticket is required or not.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * returns whether ticket is required or not.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function required() {
 		return $this->get( 'TKT_required' );
 	}
 
 
 
-    /**
-     * sets the TKT_required property
-     *
-     * @param boolean $required
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * sets the TKT_required property
+	 *
+	 * @param boolean $required
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_required( $required ) {
 		$this->set( 'TKT_required', $required );
 	}
 
 
 
-    /**
-     * Gets taxable
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets taxable
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function taxable() {
 		return $this->get( 'TKT_taxable' );
 	}
 
 
 
-    /**
-     * Sets taxable
-     *
-     * @param boolean $taxable
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets taxable
+	 *
+	 * @param boolean $taxable
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_taxable( $taxable ) {
 		$this->set( 'TKT_taxable', $taxable );
 	}
 
 
 
-    /**
-     * Gets is_default
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets is_default
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function is_default() {
 		return $this->get( 'TKT_is_default' );
 	}
 
 
 
-    /**
-     * Sets is_default
-     *
-     * @param boolean $is_default
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets is_default
+	 *
+	 * @param boolean $is_default
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_is_default( $is_default ) {
 		$this->set( 'TKT_is_default', $is_default );
 	}
 
 
 
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function order() {
 		return $this->get( 'TKT_order' );
 	}
 
 
 
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_order( $order ) {
 		$this->set( 'TKT_order', $order );
 	}
 
 
 
-    /**
-     * Gets row
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets row
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function row() {
 		return $this->get( 'TKT_row' );
 	}
 
 
 
-    /**
-     * Sets row
-     *
-     * @param int $row
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets row
+	 *
+	 * @param int $row
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_row( $row ) {
 		$this->set( 'TKT_row', $row );
 	}
 
 
 
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
 	public function deleted() {
 		return $this->get( 'TKT_deleted' );
 	}
 
 
 
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_deleted( $deleted ) {
 		$this->set( 'TKT_deleted', $deleted );
 	}
 
 
 
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function parent_ID() {
 		return $this->get( 'TKT_parent' );
 	}
 
 
 
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @return void
-     * @throws \EE_Error
-     */
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	public function set_parent_ID( $parent ) {
 		$this->set( 'TKT_parent', $parent );
 	}
 
 
 
-    /**
-     * Gets a string which is handy for showing in gateways etc that describes the ticket.
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets a string which is handy for showing in gateways etc that describes the ticket.
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function name_and_info() {
 		$times = array();
 		foreach ( $this->datetimes() as $datetime ) {
@@ -1267,67 +1267,67 @@ 
 
 
 
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
 	public function name() {
 		return $this->get( 'TKT_name' );
 	}
 
 
 
-    /**
-     * Gets price
-     *
-     * @return float
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets price
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
 	public function price() {
 		return $this->get( 'TKT_price' );
 	}
 
 
 
-    /**
-     * Gets all the registrations for this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return EE_Registration[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
+	/**
+	 * Gets all the registrations for this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return EE_Registration[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
 	public function registrations( $query_params = array() ) {
 		return $this->get_many_related( 'Registration', $query_params );
 	}
 
 
 
-    /**
-     * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
-     * into account
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
+	 * into account
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function update_tickets_sold() {
-        $count_regs_for_this_ticket = $this->count_registrations(
-            array(
-                array(
-                    'STS_ID'      => EEM_Registration::status_id_approved,
-                    'REG_deleted' => 0,
-                ),
-            )
-        );
-        $sold = $this->sold();
-        if ($count_regs_for_this_ticket > $sold) {
-            $this->increase_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        } else if ($count_regs_for_this_ticket < $sold) {
-            $this->decrease_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        }
+		$count_regs_for_this_ticket = $this->count_registrations(
+			array(
+				array(
+					'STS_ID'      => EEM_Registration::status_id_approved,
+					'REG_deleted' => 0,
+				),
+			)
+		);
+		$sold = $this->sold();
+		if ($count_regs_for_this_ticket > $sold) {
+			$this->increase_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		} else if ($count_regs_for_this_ticket < $sold) {
+			$this->decrease_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		}
 		return $count_regs_for_this_ticket;
 	}
 
@@ -1355,21 +1355,21 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return EE_Event
-     * @throws \EE_Error
-     * @throws UnexpectedEntityException
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return EE_Event
+	 * @throws \EE_Error
+	 * @throws UnexpectedEntityException
+	 */
 	public function get_related_event() {
 		//get one datetime to use for getting the event
 		$datetime = $this->first_datetime();
 		if ( ! $datetime instanceof \EE_Datetime ) {
 			throw new UnexpectedEntityException(
 				$datetime,
-                'EE_Datetime',
+				'EE_Datetime',
 				sprintf(
 					__( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
 					$this->name()
@@ -1380,7 +1380,7 @@ 
 		if ( ! $event instanceof \EE_Event ) {
 			throw new UnexpectedEntityException(
 				$event,
-                'EE_Event',
+				'EE_Event',
 				sprintf(
 					__( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'),
 					$this->name()
@@ -1392,14 +1392,14 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
 	public function get_event_name() {
 		$event = $this->get_related_event();
 		return $event instanceof EE_Event ? $event->name() : '';
@@ -1407,28 +1407,28 @@ 
 
 
 
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
 	public function get_event_ID() {
 		$event = $this->get_related_event();
 		return $event instanceof EE_Event ? $event->ID() : 0;
 	}
 
 
-    /**
-     * This simply returns whether a ticket can be permanently deleted or not.
-     * The criteria for determining this is whether the ticket has any related registrations.
-     * If there are none then it can be permanently deleted.
-     *
-     * @return bool
-     */
+	/**
+	 * This simply returns whether a ticket can be permanently deleted or not.
+	 * The criteria for determining this is whether the ticket has any related registrations.
+	 * If there are none then it can be permanently deleted.
+	 *
+	 * @return bool
+	 */
 	public function is_permanently_deleteable() {
-	    return $this->count_registrations() === 0;
-    }
+		return $this->count_registrations() === 0;
+	}
 } //end EE_Ticket class

Spacing +203 added lines, -203 removed lines

@@ -1,7 +1,7 @@ 
 <?php use EventEspresso\core\exceptions\UnexpectedEntityException;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -70,9 +70,9 @@ 
      * @return EE_Ticket
      * @throws \EE_Error
      */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -84,8 +84,8 @@ 
      * @return EE_Ticket
      * @throws \EE_Error
      */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -95,7 +95,7 @@ 
      * @throws \EE_Error
      */
 	public function parent() {
-		return $this->get( 'TKT_parent' );
+		return $this->get('TKT_parent');
 	}
 
 
@@ -107,13 +107,13 @@ 
      * @return boolean
      * @throws \EE_Error
      */
-	public function available( $DTT_ID = 0 ) {
+	public function available($DTT_ID = 0) {
 		// are we checking availability for a particular datetime ?
-		if ( $DTT_ID ) {
+		if ($DTT_ID) {
 			// get that datetime object
-			$datetime = $this->get_first_related( 'Datetime', array( array( 'DTT_ID' => $DTT_ID ) ) );
+			$datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
 			// if  ticket sales for this datetime have exceeded the reg limit...
-			if ( $datetime instanceof EE_Datetime && $datetime->sold_out() ) {
+			if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
 				return FALSE;
 			}
 		}
@@ -131,22 +131,22 @@ 
      * @return mixed status int if the display string isn't requested
      * @throws \EE_Error
      */
-	public function ticket_status( $display = FALSE, $remaining = null ) {
-		$remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining();
-		if ( ! $remaining ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::sold_out, FALSE, 'sentence' ) : EE_Ticket::sold_out;
+	public function ticket_status($display = FALSE, $remaining = null) {
+		$remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
+		if ( ! $remaining) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, FALSE, 'sentence') : EE_Ticket::sold_out;
 		}
-		if ( $this->get( 'TKT_deleted' ) ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::archived, FALSE, 'sentence' ) : EE_Ticket::archived;
+		if ($this->get('TKT_deleted')) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::archived, FALSE, 'sentence') : EE_Ticket::archived;
 		}
-		if ( $this->is_expired() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::expired, FALSE, 'sentence' ) : EE_Ticket::expired;
+		if ($this->is_expired()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::expired, FALSE, 'sentence') : EE_Ticket::expired;
 		}
-		if ( $this->is_pending() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::pending, FALSE, 'sentence' ) : EE_Ticket::pending;
+		if ($this->is_pending()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::pending, FALSE, 'sentence') : EE_Ticket::pending;
 		}
-		if ( $this->is_on_sale() ) {
-			return $display ? EEH_Template::pretty_status( EE_Ticket::onsale, FALSE, 'sentence' ) : EE_Ticket::onsale;
+		if ($this->is_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, FALSE, 'sentence') : EE_Ticket::onsale;
 		}
 		return '';
 	}
@@ -161,12 +161,12 @@ 
      * @return boolean         true = tickets remaining, false not.
      * @throws \EE_Error
      */
-	public function is_remaining( $DTT_ID = 0 ) {
-		$num_remaining = $this->remaining( $DTT_ID );
-		if ( $num_remaining === 0 ) {
+	public function is_remaining($DTT_ID = 0) {
+		$num_remaining = $this->remaining($DTT_ID);
+		if ($num_remaining === 0) {
 			return FALSE;
 		}
-		if ( $num_remaining > 0 && $num_remaining < $this->min() ) {
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
 			return FALSE;
 		}
 		return TRUE;
@@ -182,8 +182,8 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function remaining( $DTT_ID = 0 ) {
-		return $this->real_quantity_on_ticket('saleable', $DTT_ID );
+	public function remaining($DTT_ID = 0) {
+		return $this->real_quantity_on_ticket('saleable', $DTT_ID);
 	}
 
 
@@ -195,7 +195,7 @@ 
      * @throws \EE_Error
      */
 	public function min() {
-		return $this->get( 'TKT_min' );
+		return $this->get('TKT_min');
 	}
 
 
@@ -207,7 +207,7 @@ 
      * @throws \EE_Error
      */
 	public function is_expired() {
-		return ( $this->get_raw( 'TKT_end_date' ) < time() );
+		return ($this->get_raw('TKT_end_date') < time());
 	}
 
 
@@ -219,7 +219,7 @@ 
      * @throws \EE_Error
      */
 	public function is_pending() {
-		return ( $this->get_raw( 'TKT_start_date' ) > time() );
+		return ($this->get_raw('TKT_start_date') > time());
 	}
 
 
@@ -231,7 +231,7 @@ 
      * @throws \EE_Error
      */
 	public function is_on_sale() {
-		return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() );
+		return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
 	}
 
 
@@ -244,11 +244,11 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : '';
-		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : '';
+	public function date_range($dt_frmt = '', $conjunction = ' - ') {
+		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date($dt_frmt) : '';
+		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date($dt_frmt) : '';
 
-		return $first_date && $last_date ? $first_date . $conjunction  . $last_date : '';
+		return $first_date && $last_date ? $first_date.$conjunction.$last_date : '';
 	}
 
 
@@ -260,8 +260,8 @@ 
      * @throws \EE_Error
      */
 	public function first_datetime() {
-		$datetimes = $this->datetimes( array( 'limit' => 1 ) );
-		return reset( $datetimes );
+		$datetimes = $this->datetimes(array('limit' => 1));
+		return reset($datetimes);
 	}
 
 
@@ -274,11 +274,11 @@ 
      * @return EE_Datetime[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function datetimes( $query_params = array() ) {
-		if ( ! isset( $query_params[ 'order_by' ] ) ) {
-			$query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC';
+	public function datetimes($query_params = array()) {
+		if ( ! isset($query_params['order_by'])) {
+			$query_params['order_by']['DTT_order'] = 'ASC';
 		}
-		return $this->get_many_related( 'Datetime', $query_params );
+		return $this->get_many_related('Datetime', $query_params);
 	}
 
 
@@ -290,8 +290,8 @@ 
      * @throws \EE_Error
      */
 	public function last_datetime() {
-		$datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) );
-		return end( $datetimes );
+		$datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
+		return end($datetimes);
 	}
 
 
@@ -309,22 +309,22 @@ 
      * @return mixed (array|int)          how many tickets have sold
      * @throws \EE_Error
      */
-	public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) {
+	public function tickets_sold($what = 'ticket', $dtt_id = NULL) {
 		$total = 0;
 		$tickets_sold = $this->_all_tickets_sold();
-		switch ( $what ) {
+		switch ($what) {
 			case 'ticket' :
-				return $tickets_sold[ 'ticket' ];
+				return $tickets_sold['ticket'];
 				break;
 			case 'datetime' :
-				if ( empty( $tickets_sold[ 'datetime' ] ) ) {
+				if (empty($tickets_sold['datetime'])) {
 					return $total;
 				}
-				if ( ! empty( $dtt_id ) && ! isset( $tickets_sold[ 'datetime' ][ $dtt_id ] ) ) {
-					EE_Error::add_error( __( 'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+				if ( ! empty($dtt_id) && ! isset($tickets_sold['datetime'][$dtt_id])) {
+					EE_Error::add_error(__('You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 					return $total;
 				}
-				return empty( $dtt_id ) ? $tickets_sold[ 'datetime' ] : $tickets_sold[ 'datetime' ][ $dtt_id ];
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][$dtt_id];
 				break;
 			default:
 				return $total;
@@ -340,15 +340,15 @@ 
      * @throws \EE_Error
      */
 	protected function _all_tickets_sold() {
-		$datetimes = $this->get_many_related( 'Datetime' );
+		$datetimes = $this->get_many_related('Datetime');
 		$tickets_sold = array();
-		if ( ! empty( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				$tickets_sold[ 'datetime' ][ $datetime->ID() ] = $datetime->get( 'DTT_sold' );
+		if ( ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
 			}
 		}
 		//Tickets sold
-		$tickets_sold[ 'ticket' ] = $this->sold();
+		$tickets_sold['ticket'] = $this->sold();
 		return $tickets_sold;
 	}
 
@@ -361,11 +361,11 @@ 
      * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function base_price( $return_array = FALSE ) {
-		$_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price );
+	public function base_price($return_array = FALSE) {
+		$_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
 		return $return_array
-            ? $this->get_many_related( 'Price', array( $_where ) )
-            : $this->get_first_related( 'Price', array( $_where ) );
+            ? $this->get_many_related('Price', array($_where))
+            : $this->get_first_related('Price', array($_where));
 	}
 
 
@@ -378,8 +378,8 @@ 
      * @throws \EE_Error
      */
 	public function price_modifiers() {
-		$query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) );
-		return $this->prices( $query_params );
+		$query_params = array(0 => array('Price_Type.PBT_ID' => array('NOT IN', array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax))));
+		return $this->prices($query_params);
 	}
 
 
@@ -391,8 +391,8 @@ 
      * @return EE_Price[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function prices( $query_params = array() ) {
-		return $this->get_many_related( 'Price', $query_params );
+	public function prices($query_params = array()) {
+		return $this->get_many_related('Price', $query_params);
 	}
 
 
@@ -404,8 +404,8 @@ 
      * @return EE_Datetime_Ticket|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function datetime_tickets( $query_params = array() ) {
-		return $this->get_many_related( 'Datetime_Ticket', $query_params );
+	public function datetime_tickets($query_params = array()) {
+		return $this->get_many_related('Datetime_Ticket', $query_params);
 	}
 
 
@@ -418,8 +418,8 @@ 
      * @return EE_Datetime[]
      * @throws \EE_Error
      */
-	public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) {
-		return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted );
+	public function datetimes_ordered($show_expired = TRUE, $show_deleted = FALSE) {
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order($this->ID(), $show_expired, $show_deleted);
 	}
 
 
@@ -431,7 +431,7 @@ 
      * @throws \EE_Error
      */
 	public function ID() {
-		return $this->get( 'TKT_ID' );
+		return $this->get('TKT_ID');
 	}
 
 
@@ -456,7 +456,7 @@ 
      * @throws \EE_Error
      */
 	public function template() {
-		return $this->get_first_related( 'Ticket_Template' );
+		return $this->get_first_related('Ticket_Template');
 	}
 
 
@@ -478,7 +478,7 @@ 
      * @throws \EE_Error
      */
 	public function ticket_price() {
-		return $this->get( 'TKT_price' );
+		return $this->get('TKT_price');
 	}
 
 
@@ -488,7 +488,7 @@ 
      * @throws \EE_Error
      */
 	public function pretty_price() {
-		return $this->get_pretty( 'TKT_price' );
+		return $this->get_pretty('TKT_price');
 	}
 
 
@@ -510,8 +510,8 @@ 
      * @return float
      * @throws \EE_Error
      */
-	public function get_ticket_total_with_taxes( $no_cache = FALSE ) {
-		if ($this->_ticket_total_with_taxes === null || $no_cache ) {
+	public function get_ticket_total_with_taxes($no_cache = FALSE) {
+		if ($this->_ticket_total_with_taxes === null || $no_cache) {
 			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
 		}
 		return (float) $this->_ticket_total_with_taxes;
@@ -520,7 +520,7 @@ 
 
 
 	public function ensure_TKT_Price_correct() {
-		$this->set( 'TKT_price', EE_Taxes::get_subtotal_for_admin( $this ) );
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
 		$this->save();
 	}
 
@@ -531,7 +531,7 @@ 
      * @throws \EE_Error
      */
 	public function get_ticket_subtotal() {
-		return EE_Taxes::get_subtotal_for_admin( $this );
+		return EE_Taxes::get_subtotal_for_admin($this);
 	}
 
 
@@ -543,7 +543,7 @@ 
      * @throws \EE_Error
      */
 	public function get_ticket_taxes_total_for_admin() {
-		return EE_Taxes::get_total_taxes_for_admin( $this );
+		return EE_Taxes::get_total_taxes_for_admin($this);
 	}
 
 
@@ -554,8 +554,8 @@ 
      * @param string $name
      * @throws \EE_Error
      */
-	public function set_name( $name ) {
-		$this->set( 'TKT_name', $name );
+	public function set_name($name) {
+		$this->set('TKT_name', $name);
 	}
 
 
@@ -567,7 +567,7 @@ 
      * @throws \EE_Error
      */
 	public function description() {
-		return $this->get( 'TKT_description' );
+		return $this->get('TKT_description');
 	}
 
 
@@ -578,8 +578,8 @@ 
      * @param string $description
      * @throws \EE_Error
      */
-	public function set_description( $description ) {
-		$this->set( 'TKT_description', $description );
+	public function set_description($description) {
+		$this->set('TKT_description', $description);
 	}
 
 
@@ -592,8 +592,8 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function start_date( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt );
+	public function start_date($dt_frmt = '', $tm_frmt = '') {
+		return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -605,8 +605,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_start_date( $start_date ) {
-		$this->_set_date_time( 'B', $start_date, 'TKT_start_date' );
+	public function set_start_date($start_date) {
+		$this->_set_date_time('B', $start_date, 'TKT_start_date');
 	}
 
 
@@ -619,8 +619,8 @@ 
      * @return string
      * @throws \EE_Error
      */
-	public function end_date( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt );
+	public function end_date($dt_frmt = '', $tm_frmt = '') {
+		return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -632,8 +632,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_end_date( $end_date ) {
-		$this->_set_date_time( 'B', $end_date, 'TKT_end_date' );
+	public function set_end_date($end_date) {
+		$this->_set_date_time('B', $end_date, 'TKT_end_date');
 	}
 
 
@@ -645,8 +645,8 @@ 
      * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
      * @throws \EE_Error
      */
-	public function set_end_time( $time ) {
-		$this->_set_time_for( $time, 'TKT_end_date' );
+	public function set_end_time($time) {
+		$this->_set_time_for($time, 'TKT_end_date');
 	}
 
 
@@ -658,8 +658,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_min( $min ) {
-		$this->set( 'TKT_min', $min );
+	public function set_min($min) {
+		$this->set('TKT_min', $min);
 	}
 
 
@@ -671,7 +671,7 @@ 
      * @throws \EE_Error
      */
 	public function max() {
-		return $this->get( 'TKT_max' );
+		return $this->get('TKT_max');
 	}
 
 
@@ -683,8 +683,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_max( $max ) {
-		$this->set( 'TKT_max', $max );
+	public function set_max($max) {
+		$this->set('TKT_max', $max);
 	}
 
 
@@ -696,8 +696,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_price( $price ) {
-		$this->set( 'TKT_price', $price );
+	public function set_price($price) {
+		$this->set('TKT_price', $price);
 	}
 
 
@@ -709,7 +709,7 @@ 
      * @throws \EE_Error
      */
 	public function sold() {
-		return $this->get_raw( 'TKT_sold' );
+		return $this->get_raw('TKT_sold');
 	}
 
 
@@ -721,10 +721,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_sold( $sold ) {
+	public function set_sold($sold) {
 		// sold can not go below zero
-		$sold = max( 0, $sold );
-		$this->set( 'TKT_sold', $sold );
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
 	}
 
 
@@ -736,13 +736,13 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function increase_sold( $qty = 1 ) {
+	public function increase_sold($qty = 1) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
 		// via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
-		$this->decrease_reserved( $qty, false );
-		$this->_increase_sold_for_datetimes( $qty );
-		$this->set_sold( $sold );
+		$this->decrease_reserved($qty, false);
+		$this->_increase_sold_for_datetimes($qty);
+		$this->set_sold($sold);
 		do_action(
 		    'AHEE__EE_Ticket__increase_sold',
             $this,
@@ -760,12 +760,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _increase_sold_for_datetimes( $qty = 1 ) {
+	protected function _increase_sold_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->increase_sold( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_sold($qty);
 					$datetime->save();
 				}
 			}
@@ -781,10 +781,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function decrease_sold( $qty = 1 ) {
+	public function decrease_sold($qty = 1) {
 		$sold = $this->sold() - $qty;
-		$this->_decrease_sold_for_datetimes( $qty );
-		$this->set_sold( $sold );
+		$this->_decrease_sold_for_datetimes($qty);
+		$this->set_sold($sold);
         do_action(
             'AHEE__EE_Ticket__decrease_sold',
             $this,
@@ -802,12 +802,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _decrease_sold_for_datetimes( $qty = 1 ) {
+	protected function _decrease_sold_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->decrease_sold( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_sold($qty);
 					$datetime->save();
 				}
 			}
@@ -823,7 +823,7 @@ 
      * @throws \EE_Error
      */
 	public function reserved() {
-		return $this->get_raw( 'TKT_reserved' );
+		return $this->get_raw('TKT_reserved');
 	}
 
 
@@ -835,10 +835,10 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_reserved( $reserved ) {
+	public function set_reserved($reserved) {
 		// reserved can not go below zero
-		$reserved = max( 0, (int) $reserved );
-		$this->set( 'TKT_reserved', $reserved );
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
 	}
 
 
@@ -850,11 +850,11 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function increase_reserved( $qty = 1 ) {
-		$qty = absint( $qty );
+	public function increase_reserved($qty = 1) {
+		$qty = absint($qty);
 		$reserved = $this->reserved() + $qty;
-		$this->_increase_reserved_for_datetimes( $qty );
-		$this->set_reserved( $reserved );
+		$this->_increase_reserved_for_datetimes($qty);
+		$this->set_reserved($reserved);
         do_action(
             'AHEE__EE_Ticket__increase_reserved',
             $this,
@@ -872,12 +872,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _increase_reserved_for_datetimes( $qty = 1 ) {
+	protected function _increase_reserved_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->increase_reserved( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_reserved($qty);
 					$datetime->save();
 				}
 			}
@@ -894,12 +894,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) {
-		$reserved = $this->reserved() - absint( $qty );
-		if ( $adjust_datetimes ) {
-			$this->_decrease_reserved_for_datetimes( $qty );
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true) {
+		$reserved = $this->reserved() - absint($qty);
+		if ($adjust_datetimes) {
+			$this->_decrease_reserved_for_datetimes($qty);
 		}
-		$this->set_reserved( $reserved );
+		$this->set_reserved($reserved);
         do_action(
             'AHEE__EE_Ticket__decrease_reserved',
             $this,
@@ -917,12 +917,12 @@ 
      * @return void
      * @throws \EE_Error
      */
-	protected function _decrease_reserved_for_datetimes( $qty = 1 ) {
+	protected function _decrease_reserved_for_datetimes($qty = 1) {
 		$datetimes = $this->datetimes();
-		if ( is_array( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
-					$datetime->decrease_reserved( $qty );
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_reserved($qty);
 					$datetime->save();
 				}
 			}
@@ -943,14 +943,14 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function qty( $context = '' ) {
-		switch ( $context ) {
+	public function qty($context = '') {
+		switch ($context) {
 			case 'reg_limit' :
 				return $this->real_quantity_on_ticket();
 			case 'saleable' :
-				return $this->real_quantity_on_ticket( 'saleable' );
+				return $this->real_quantity_on_ticket('saleable');
 			default:
-				return $this->get_raw( 'TKT_qty' );
+				return $this->get_raw('TKT_qty');
 		}
 	}
 
@@ -969,15 +969,15 @@ 
      * @return int
      * @throws \EE_Error
      */
-	public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) {
-		$raw = $this->get_raw( 'TKT_qty' );
+	public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0) {
+		$raw = $this->get_raw('TKT_qty');
 		// return immediately if it's zero
-		if ( $raw === 0 ) {
+		if ($raw === 0) {
 			return $raw;
 		}
 		//echo "\n\n<br />Ticket: " . $this->name() . '<br />';
 		// ensure qty doesn't exceed raw value for THIS ticket
-		$qty = min( EE_INF, $raw );
+		$qty = min(EE_INF, $raw);
 		//echo "\n . qty: " . $qty . '<br />';
 		// calculate this ticket's total sales and reservations
 		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
@@ -986,23 +986,23 @@ 
 		//echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
 		// first we need to calculate the maximum number of tickets available for the datetime
 		// do we want data for one datetime or all of them ?
-		$query_params = $DTT_ID ? array( array( 'DTT_ID' => $DTT_ID ) ) : array();
-		$datetimes = $this->datetimes( $query_params );
-		if ( is_array( $datetimes ) && ! empty( $datetimes ) ) {
-			foreach ( $datetimes as $datetime ) {
-				if ( $datetime instanceof EE_Datetime ) {
+		$query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
+		$datetimes = $this->datetimes($query_params);
+		if (is_array($datetimes) && ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
 					$datetime->refresh_from_db();
 					//echo "\n . . datetime name: " . $datetime->name() . '<br />';
 					//echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
 					// initialize with no restrictions for each datetime
 					// but adjust datetime qty based on datetime reg limit
-					$datetime_qty = min( EE_INF, $datetime->reg_limit() );
+					$datetime_qty = min(EE_INF, $datetime->reg_limit());
 					//echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
 					//echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
 					// if we want the actual saleable amount, then we need to consider OTHER ticket sales
 					// and reservations for this datetime, that do NOT include sales and reservations
 					// for this ticket (so we add $this->sold() and $this->reserved() back in)
-					if ( $context === 'saleable' ) {
+					if ($context === 'saleable') {
 						$datetime_qty = max(
 							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
 							0
@@ -1014,16 +1014,16 @@ 
 						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
 						//echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
 					}
-					$qty = min( $datetime_qty, $qty );
+					$qty = min($datetime_qty, $qty);
 					//echo "\n . . qty: " . $qty . '<br />';
 				}
 			}
 		}
 		// NOW that we know the  maximum number of tickets available for the datetime
 		// we can finally factor in the details for this specific ticket
-		if ( $qty > 0 && $context === 'saleable' ) {
+		if ($qty > 0 && $context === 'saleable') {
 			// and subtract the sales for THIS ticket
-			$qty = max( $qty - $sold_and_reserved_for_this_ticket, 0 );
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
 			//echo "\n . qty: " . $qty . '<br />';
 		}
 		//echo "\nFINAL QTY: " . $qty . "<br /><br />";
@@ -1039,14 +1039,14 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function set_qty( $qty ) {
+	public function set_qty($qty) {
 		$datetimes = $this->datetimes();
-		foreach ( $datetimes as $datetime ) {
-			if ( $datetime instanceof EE_Datetime ) {
-				$qty = min( $qty, $datetime->reg_limit() );
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
 			}
 		}
-		$this->set( 'TKT_qty', $qty );
+		$this->set('TKT_qty', $qty);
 	}
 
 
@@ -1058,7 +1058,7 @@ 
      * @throws \EE_Error
      */
 	public function uses() {
-		return $this->get( 'TKT_uses' );
+		return $this->get('TKT_uses');
 	}
 
 
@@ -1070,8 +1070,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_uses( $uses ) {
-		$this->set( 'TKT_uses', $uses );
+	public function set_uses($uses) {
+		$this->set('TKT_uses', $uses);
 	}
 
 
@@ -1083,7 +1083,7 @@ 
      * @throws \EE_Error
      */
 	public function required() {
-		return $this->get( 'TKT_required' );
+		return $this->get('TKT_required');
 	}
 
 
@@ -1095,8 +1095,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_required( $required ) {
-		$this->set( 'TKT_required', $required );
+	public function set_required($required) {
+		$this->set('TKT_required', $required);
 	}
 
 
@@ -1108,7 +1108,7 @@ 
      * @throws \EE_Error
      */
 	public function taxable() {
-		return $this->get( 'TKT_taxable' );
+		return $this->get('TKT_taxable');
 	}
 
 
@@ -1120,8 +1120,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_taxable( $taxable ) {
-		$this->set( 'TKT_taxable', $taxable );
+	public function set_taxable($taxable) {
+		$this->set('TKT_taxable', $taxable);
 	}
 
 
@@ -1133,7 +1133,7 @@ 
      * @throws \EE_Error
      */
 	public function is_default() {
-		return $this->get( 'TKT_is_default' );
+		return $this->get('TKT_is_default');
 	}
 
 
@@ -1145,8 +1145,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_is_default( $is_default ) {
-		$this->set( 'TKT_is_default', $is_default );
+	public function set_is_default($is_default) {
+		$this->set('TKT_is_default', $is_default);
 	}
 
 
@@ -1158,7 +1158,7 @@ 
      * @throws \EE_Error
      */
 	public function order() {
-		return $this->get( 'TKT_order' );
+		return $this->get('TKT_order');
 	}
 
 
@@ -1170,8 +1170,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_order( $order ) {
-		$this->set( 'TKT_order', $order );
+	public function set_order($order) {
+		$this->set('TKT_order', $order);
 	}
 
 
@@ -1183,7 +1183,7 @@ 
      * @throws \EE_Error
      */
 	public function row() {
-		return $this->get( 'TKT_row' );
+		return $this->get('TKT_row');
 	}
 
 
@@ -1195,8 +1195,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_row( $row ) {
-		$this->set( 'TKT_row', $row );
+	public function set_row($row) {
+		$this->set('TKT_row', $row);
 	}
 
 
@@ -1208,7 +1208,7 @@ 
      * @throws \EE_Error
      */
 	public function deleted() {
-		return $this->get( 'TKT_deleted' );
+		return $this->get('TKT_deleted');
 	}
 
 
@@ -1220,8 +1220,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_deleted( $deleted ) {
-		$this->set( 'TKT_deleted', $deleted );
+	public function set_deleted($deleted) {
+		$this->set('TKT_deleted', $deleted);
 	}
 
 
@@ -1233,7 +1233,7 @@ 
      * @throws \EE_Error
      */
 	public function parent_ID() {
-		return $this->get( 'TKT_parent' );
+		return $this->get('TKT_parent');
 	}
 
 
@@ -1245,8 +1245,8 @@ 
      * @return void
      * @throws \EE_Error
      */
-	public function set_parent_ID( $parent ) {
-		$this->set( 'TKT_parent', $parent );
+	public function set_parent_ID($parent) {
+		$this->set('TKT_parent', $parent);
 	}
 
 
@@ -1259,10 +1259,10 @@ 
      */
 	public function name_and_info() {
 		$times = array();
-		foreach ( $this->datetimes() as $datetime ) {
+		foreach ($this->datetimes() as $datetime) {
 			$times[] = $datetime->start_date_and_time();
 		}
-		return $this->name() . ' @ ' . implode( ', ', $times ) . ' for ' . $this->pretty_price();
+		return $this->name().' @ '.implode(', ', $times).' for '.$this->pretty_price();
 	}
 
 
@@ -1274,7 +1274,7 @@ 
      * @throws \EE_Error
      */
 	public function name() {
-		return $this->get( 'TKT_name' );
+		return $this->get('TKT_name');
 	}
 
 
@@ -1286,7 +1286,7 @@ 
      * @throws \EE_Error
      */
 	public function price() {
-		return $this->get( 'TKT_price' );
+		return $this->get('TKT_price');
 	}
 
 
@@ -1298,8 +1298,8 @@ 
      * @return EE_Registration[]|EE_Base_Class[]
      * @throws \EE_Error
      */
-	public function registrations( $query_params = array() ) {
-		return $this->get_many_related( 'Registration', $query_params );
+	public function registrations($query_params = array()) {
+		return $this->get_many_related('Registration', $query_params);
 	}
 
 
@@ -1338,7 +1338,7 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function count_registrations( $query_params = array() ) {
+	public function count_registrations($query_params = array()) {
 		return $this->count_related('Registration', $query_params);
 	}
 
@@ -1366,23 +1366,23 @@ 
 	public function get_related_event() {
 		//get one datetime to use for getting the event
 		$datetime = $this->first_datetime();
-		if ( ! $datetime instanceof \EE_Datetime ) {
+		if ( ! $datetime instanceof \EE_Datetime) {
 			throw new UnexpectedEntityException(
 				$datetime,
                 'EE_Datetime',
 				sprintf(
-					__( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
 					$this->name()
 				)
 			);
 		}
 		$event = $datetime->event();
-		if ( ! $event instanceof \EE_Event ) {
+		if ( ! $event instanceof \EE_Event) {
 			throw new UnexpectedEntityException(
 				$event,
                 'EE_Event',
 				sprintf(
-					__( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'),
+					__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
 					$this->name()
 				)
 			);

core/db_classes/EE_Datetime.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -435,7 +435,7 @@ 
 	 * @param string $dt_frmt     - string representation of date format defaults to WP settings
 	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
 	 *                            the end date ie: Jan 01 "to" Dec 31
-	 * @return mixed        string on success, FALSE on fail
+	 * @return string        string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
 	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
@@ -507,7 +507,7 @@ 
 	 * @param string $tm_format   string representation of time format defaults to 'g:i a'
 	 * @param string $conjunction conjunction junction what's your function ?
 	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-	 * @return mixed              string on success, FALSE on fail
+	 * @return string              string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
 	public function time_range( $tm_format = '', $conjunction = ' - ' ) {

Indentation +79 added lines, -79 removed lines

@@ -210,13 +210,13 @@ 
 		// remove ticket reservation
 		$this->decrease_reserved( $qty );
 		$this->set_sold( $sold );
-        do_action(
-            'AHEE__EE_Datetime__increase_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
+		do_action(
+			'AHEE__EE_Datetime__increase_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
 
 
 
@@ -227,13 +227,13 @@ 
 	public function decrease_sold( $qty = 1 ) {
 		$sold = $this->sold() - $qty;
 		$this->set_sold( $sold );
-        do_action(
-            'AHEE__EE_Datetime__decrease_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
+		do_action(
+			'AHEE__EE_Datetime__decrease_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
 
 
 
@@ -269,13 +269,13 @@ 
 	 */
 	public function increase_reserved( $qty = 1 ) {
 		$reserved = $this->reserved() + absint( $qty );
-        do_action(
-            'AHEE__EE_Datetime__increase_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-        $this->set_reserved( $reserved );
+		do_action(
+			'AHEE__EE_Datetime__increase_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+		$this->set_reserved( $reserved );
 	}
 
 
@@ -288,13 +288,13 @@ 
 	 */
 	public function decrease_reserved( $qty = 1 ) {
 		$reserved = $this->reserved() - absint( $qty );
-        do_action(
-            'AHEE__EE_Datetime__decrease_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-        $this->set_reserved( $reserved );
+		do_action(
+			'AHEE__EE_Datetime__decrease_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+		$this->set_reserved( $reserved );
 	}
 
 
@@ -382,13 +382,13 @@ 
 
 
 
-    /**
-     * get event start date.  Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
-     * @return        mixed        string on success, FALSE on fail
-     */
+	/**
+	 * get event start date.  Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
+	 * @return        mixed        string on success, FALSE on fail
+	 */
 	public function start_date( $dt_frmt = '' ) {
 		return $this->_show_datetime( 'D', 'start', $dt_frmt );
 	}
@@ -405,13 +405,13 @@ 
 
 
 
-    /**
-     * get end date. Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
-     * @return        mixed        string on success, FALSE on fail
-     */
+	/**
+	 * get end date. Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
+	 * @return        mixed        string on success, FALSE on fail
+	 */
 	public function end_date( $dt_frmt = '' ) {
 		return $this->_show_datetime( 'D', 'end', $dt_frmt );
 	}
@@ -533,23 +533,23 @@ 
 	/**
 	 * This returns a range representation of the date and times.
 	 * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
-     * Also, the return value is localized.
-     *
-     * @param string $dt_format
+	 * Also, the return value is localized.
+	 *
+	 * @param string $dt_format
 	 * @param string $tm_format
 	 * @param string $conjunction used between two different dates or times.
-     *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
-     * @param string $separator   used between the date and time formats.
-     *                            ex: Dec 1, 2016{$separator}2pm
+	 *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
+	 * @param string $separator   used between the date and time formats.
+	 *                            ex: Dec 1, 2016{$separator}2pm
 	 * @return string
 	 * @throws \EE_Error
 	 */
 	public function date_and_time_range(
-	    $dt_format = '',
-        $tm_format = '',
-        $conjunction = ' - ' ,
-        $separator = ' '
-    ) {
+		$dt_format = '',
+		$tm_format = '',
+		$conjunction = ' - ' ,
+		$separator = ' '
+	) {
 		$dt_format = ! empty( $dt_format ) ? $dt_format : $this->_dt_frmt;
 		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
 		$full_format = $dt_format . $separator . $tm_format;
@@ -563,14 +563,14 @@ 
 			//start and end date are the same but times are different
 			case ( $this->start_date() === $this->end_date() ) :
 				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
-				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
+						  . $conjunction
+						  . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
 				break;
 			//all other conditions
 			default :
 				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
-				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
+						  . $conjunction
+						  . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
 				break;
 		}
 		return $output;
@@ -654,13 +654,13 @@ 
 
 
 	/**
-     *        get end date and time
-     *
-     * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed                string on success, FALSE on fail
-     */
-    public function end_date_and_time($dt_frmt = '', $tm_format = '') {
+	 *        get end date and time
+	 *
+	 * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed                string on success, FALSE on fail
+	 */
+	public function end_date_and_time($dt_frmt = '', $tm_format = '') {
 		return $this->_show_datetime( '', 'end', $dt_frmt, $tm_format );
 	}
 
@@ -929,13 +929,13 @@ 
 
 
 
-    /**
-     * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime (via the tickets).
-     * into account
-     *
-     * @return int
-     * @throws \EE_Error
-     */
+	/**
+	 * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime (via the tickets).
+	 * into account
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
 	public function update_sold() {
 		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
 			array( array(
@@ -944,14 +944,14 @@ 
 				'Ticket.Datetime.DTT_ID' 	=> $this->ID(),
 			) )
 		);
-        $sold = $this->sold();
-        if ($count_regs_for_this_datetime > $sold) {
-            $this->increase_sold($count_regs_for_this_datetime - $sold);
-            $this->save();
-        } else if ($count_regs_for_this_datetime < $sold) {
-            $this->decrease_sold($count_regs_for_this_datetime - $sold);
-            $this->save();
-        }
+		$sold = $this->sold();
+		if ($count_regs_for_this_datetime > $sold) {
+			$this->increase_sold($count_regs_for_this_datetime - $sold);
+			$this->save();
+		} else if ($count_regs_for_this_datetime < $sold) {
+			$this->decrease_sold($count_regs_for_this_datetime - $sold);
+			$this->save();
+		}
 		return $count_regs_for_this_datetime;
 	}
 }

Spacing +149 added lines, -149 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -74,9 +74,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Datetime
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -87,8 +87,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Datetime
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -96,8 +96,8 @@ 
 	/**
 	 * @param $name
 	 */
-	public function set_name( $name ) {
-		$this->set( 'DTT_name', $name );
+	public function set_name($name) {
+		$this->set('DTT_name', $name);
 	}
 
 
@@ -105,8 +105,8 @@ 
 	/**
 	 * @param $description
 	 */
-	public function set_description( $description ) {
-		$this->set( 'DTT_description', $description );
+	public function set_description($description) {
+		$this->set('DTT_description', $description);
 	}
 
 
@@ -118,8 +118,8 @@ 
 	 *
 	 * @param        string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
 	 */
-	public function set_start_date( $date ) {
-		$this->_set_date_for( $date, 'DTT_EVT_start' );
+	public function set_start_date($date) {
+		$this->_set_date_for($date, 'DTT_EVT_start');
 	}
 
 
@@ -131,8 +131,8 @@ 
 	 *
 	 * @param        string $time a string representation of the event time ex:  9am  or  7:30 PM
 	 */
-	public function set_start_time( $time ) {
-		$this->_set_time_for( $time, 'DTT_EVT_start' );
+	public function set_start_time($time) {
+		$this->_set_time_for($time, 'DTT_EVT_start');
 	}
 
 
@@ -144,8 +144,8 @@ 
 	 *
 	 * @param        string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
 	 */
-	public function set_end_date( $date ) {
-		$this->_set_date_for( $date, 'DTT_EVT_end' );
+	public function set_end_date($date) {
+		$this->_set_date_for($date, 'DTT_EVT_end');
 	}
 
 
@@ -157,8 +157,8 @@ 
 	 *
 	 * @param        string $time a string representation of the event time ex:  9am  or  7:30 PM
 	 */
-	public function set_end_time( $time ) {
-		$this->_set_time_for( $time, 'DTT_EVT_end' );
+	public function set_end_time($time) {
+		$this->_set_time_for($time, 'DTT_EVT_end');
 	}
 
 
@@ -170,8 +170,8 @@ 
 	 *
 	 * @param        int $reg_limit
 	 */
-	public function set_reg_limit( $reg_limit ) {
-		$this->set( 'DTT_reg_limit', $reg_limit );
+	public function set_reg_limit($reg_limit) {
+		$this->set('DTT_reg_limit', $reg_limit);
 	}
 
 
@@ -183,7 +183,7 @@ 
 	 * @return        mixed        int on success, FALSE on fail
 	 */
 	public function sold() {
-		return $this->get_raw( 'DTT_sold' );
+		return $this->get_raw('DTT_sold');
 	}
 
 
@@ -193,10 +193,10 @@ 
 	 *
 	 * @param        int $sold
 	 */
-	public function set_sold( $sold ) {
+	public function set_sold($sold) {
 		// sold can not go below zero
-		$sold = max( 0, $sold );
-		$this->set( 'DTT_sold', $sold );
+		$sold = max(0, $sold);
+		$this->set('DTT_sold', $sold);
 	}
 
 
@@ -205,11 +205,11 @@ 
 	 * increments sold by amount passed by $qty
 	 * @param int $qty
 	 */
-	public function increase_sold( $qty = 1 ) {
+	public function increase_sold($qty = 1) {
 		$sold = $this->sold() + $qty;
 		// remove ticket reservation
-		$this->decrease_reserved( $qty );
-		$this->set_sold( $sold );
+		$this->decrease_reserved($qty);
+		$this->set_sold($sold);
         do_action(
             'AHEE__EE_Datetime__increase_sold',
             $this,
@@ -224,9 +224,9 @@ 
 	 * decrements (subtracts) sold amount passed by $qty
 	 * @param int $qty
 	 */
-	public function decrease_sold( $qty = 1 ) {
+	public function decrease_sold($qty = 1) {
 		$sold = $this->sold() - $qty;
-		$this->set_sold( $sold );
+		$this->set_sold($sold);
         do_action(
             'AHEE__EE_Datetime__decrease_sold',
             $this,
@@ -243,7 +243,7 @@ 
 	 * @return int
 	 */
 	public function reserved() {
-		return $this->get_raw( 'DTT_reserved' );
+		return $this->get_raw('DTT_reserved');
 	}
 
 
@@ -253,10 +253,10 @@ 
 	 *
 	 * @param int $reserved
 	 */
-	public function set_reserved( $reserved ) {
+	public function set_reserved($reserved) {
 		// reserved can not go below zero
-		$reserved = max( 0, (int) $reserved );
-		$this->set( 'DTT_reserved', $reserved );
+		$reserved = max(0, (int) $reserved);
+		$this->set('DTT_reserved', $reserved);
 	}
 
 
@@ -267,15 +267,15 @@ 
 	 * @param int $qty
 	 * @return void
 	 */
-	public function increase_reserved( $qty = 1 ) {
-		$reserved = $this->reserved() + absint( $qty );
+	public function increase_reserved($qty = 1) {
+		$reserved = $this->reserved() + absint($qty);
         do_action(
             'AHEE__EE_Datetime__increase_reserved',
             $this,
             $qty,
             $reserved
         );
-        $this->set_reserved( $reserved );
+        $this->set_reserved($reserved);
 	}
 
 
@@ -286,15 +286,15 @@ 
 	 * @param int $qty
 	 * @return void
 	 */
-	public function decrease_reserved( $qty = 1 ) {
-		$reserved = $this->reserved() - absint( $qty );
+	public function decrease_reserved($qty = 1) {
+		$reserved = $this->reserved() - absint($qty);
         do_action(
             'AHEE__EE_Datetime__decrease_reserved',
             $this,
             $qty,
             $reserved
         );
-        $this->set_reserved( $reserved );
+        $this->set_reserved($reserved);
 	}
 
 
@@ -315,7 +315,7 @@ 
 	 * @return string
 	 */
 	public function name() {
-		return $this->get( 'DTT_name' );
+		return $this->get('DTT_name');
 	}
 
 
@@ -325,7 +325,7 @@ 
 	 * @return string
 	 */
 	public function description() {
-		return $this->get( 'DTT_description' );
+		return $this->get('DTT_description');
 	}
 
 
@@ -335,7 +335,7 @@ 
 	 * @return boolean          TRUE if is primary, FALSE if not.
 	 */
 	public function is_primary() {
-		return $this->get( 'DTT_is_primary' );
+		return $this->get('DTT_is_primary');
 	}
 
 
@@ -345,7 +345,7 @@ 
 	 * @return int         The order of the datetime for this event.
 	 */
 	public function order() {
-		return $this->get( 'DTT_order' );
+		return $this->get('DTT_order');
 	}
 
 
@@ -355,7 +355,7 @@ 
 	 * @return int
 	 */
 	public function parent() {
-		return $this->get( 'DTT_parent' );
+		return $this->get('DTT_parent');
 	}
 
 
@@ -371,10 +371,10 @@ 
 	 * @param    bool   $echo         - whether we echo or return (note echoing uses "pretty" formats, otherwise we use the standard formats)
 	 * @return    string|bool  string on success, FALSE on fail
 	 */
-	private function _show_datetime( $date_or_time = NULL, $start_or_end = 'start', $dt_frmt = '', $tm_frmt = '', $echo = FALSE ) {
+	private function _show_datetime($date_or_time = NULL, $start_or_end = 'start', $dt_frmt = '', $tm_frmt = '', $echo = FALSE) {
 		$field_name = "DTT_EVT_{$start_or_end}";
-		$dtt = $this->_get_datetime( $field_name, $dt_frmt, $tm_frmt, $date_or_time, $echo );
-		if ( ! $echo ) {
+		$dtt = $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, $date_or_time, $echo);
+		if ( ! $echo) {
 			return $dtt;
 		}
 		return '';
@@ -389,8 +389,8 @@ 
      * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
      * @return        mixed        string on success, FALSE on fail
      */
-	public function start_date( $dt_frmt = '' ) {
-		return $this->_show_datetime( 'D', 'start', $dt_frmt );
+	public function start_date($dt_frmt = '') {
+		return $this->_show_datetime('D', 'start', $dt_frmt);
 	}
 
 
@@ -399,8 +399,8 @@ 
 	 * Echoes start_date()
 	 * @param string $dt_frmt
 	 */
-	public function e_start_date( $dt_frmt = '' ) {
-		$this->_show_datetime( 'D', 'start', $dt_frmt, NULL, TRUE );
+	public function e_start_date($dt_frmt = '') {
+		$this->_show_datetime('D', 'start', $dt_frmt, NULL, TRUE);
 	}
 
 
@@ -412,8 +412,8 @@ 
      * @param string $dt_frmt - string representation of date format defaults to 'F j, Y'
      * @return        mixed        string on success, FALSE on fail
      */
-	public function end_date( $dt_frmt = '' ) {
-		return $this->_show_datetime( 'D', 'end', $dt_frmt );
+	public function end_date($dt_frmt = '') {
+		return $this->_show_datetime('D', 'end', $dt_frmt);
 	}
 
 
@@ -422,8 +422,8 @@ 
 	 * Echoes the end date. See end_date()
 	 * @param string $dt_frmt
 	 */
-	public function e_end_date( $dt_frmt = '' ) {
-		$this->_show_datetime( 'D', 'end', $dt_frmt, NULL, TRUE );
+	public function e_end_date($dt_frmt = '') {
+		$this->_show_datetime('D', 'end', $dt_frmt, NULL, TRUE);
 	}
 
 
@@ -438,11 +438,11 @@ 
 	 * @return mixed        string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
-	public function date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		$dt_frmt = ! empty( $dt_frmt ) ? $dt_frmt : $this->_dt_frmt;
-		$start = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_start', $dt_frmt ) );
-		$end = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_end', $dt_frmt ) );
-		return $start !== $end ? $start . $conjunction . $end : $start;
+	public function date_range($dt_frmt = '', $conjunction = ' - ') {
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$start = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt));
+		$end = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt));
+		return $start !== $end ? $start.$conjunction.$end : $start;
 	}
 
 
@@ -452,8 +452,8 @@ 
 	 * @param string $conjunction
 	 * @throws \EE_Error
 	 */
-	public function e_date_range( $dt_frmt = '', $conjunction = ' - ' ) {
-		echo $this->date_range( $dt_frmt, $conjunction );
+	public function e_date_range($dt_frmt = '', $conjunction = ' - ') {
+		echo $this->date_range($dt_frmt, $conjunction);
 	}
 
 
@@ -464,8 +464,8 @@ 
 	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
 	 * @return mixed        string on success, FALSE on fail
 	 */
-	public function start_time( $tm_format = '' ) {
-		return $this->_show_datetime( 'T', 'start', NULL, $tm_format );
+	public function start_time($tm_format = '') {
+		return $this->_show_datetime('T', 'start', NULL, $tm_format);
 	}
 
 
@@ -473,8 +473,8 @@ 
 	/**
 	 * @param string $tm_format
 	 */
-	public function e_start_time( $tm_format = '' ) {
-		$this->_show_datetime( 'T', 'start', NULL, $tm_format, TRUE );
+	public function e_start_time($tm_format = '') {
+		$this->_show_datetime('T', 'start', NULL, $tm_format, TRUE);
 	}
 
 
@@ -485,8 +485,8 @@ 
 	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
 	 * @return mixed        string on success, FALSE on fail
 	 */
-	public function end_time( $tm_format = '' ) {
-		return $this->_show_datetime( 'T', 'end', NULL, $tm_format );
+	public function end_time($tm_format = '') {
+		return $this->_show_datetime('T', 'end', NULL, $tm_format);
 	}
 
 
@@ -494,8 +494,8 @@ 
 	/**
 	 * @param string $tm_format
 	 */
-	public function e_end_time( $tm_format = '' ) {
-		$this->_show_datetime( 'T', 'end', NULL, $tm_format, TRUE );
+	public function e_end_time($tm_format = '') {
+		$this->_show_datetime('T', 'end', NULL, $tm_format, TRUE);
 	}
 
 
@@ -510,11 +510,11 @@ 
 	 * @return mixed              string on success, FALSE on fail
 	 * @throws \EE_Error
 	 */
-	public function time_range( $tm_format = '', $conjunction = ' - ' ) {
-		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
-		$start = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_start', $tm_format ) );
-		$end = str_replace( ' ', '&nbsp;', $this->get_i18n_datetime( 'DTT_EVT_end',  $tm_format ) );
-		return $start !== $end ? $start . $conjunction . $end : $start;
+	public function time_range($tm_format = '', $conjunction = ' - ') {
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$start = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_start', $tm_format));
+		$end = str_replace(' ', '&nbsp;', $this->get_i18n_datetime('DTT_EVT_end', $tm_format));
+		return $start !== $end ? $start.$conjunction.$end : $start;
 	}
 
 
@@ -524,8 +524,8 @@ 
 	 * @param string $conjunction
 	 * @throws \EE_Error
 	 */
-	public function e_time_range( $tm_format = '', $conjunction = ' - ' ) {
-		echo $this->time_range( $tm_format, $conjunction );
+	public function e_time_range($tm_format = '', $conjunction = ' - ') {
+		echo $this->time_range($tm_format, $conjunction);
 	}
 
 
@@ -547,30 +547,30 @@ 
 	public function date_and_time_range(
 	    $dt_format = '',
         $tm_format = '',
-        $conjunction = ' - ' ,
+        $conjunction = ' - ',
         $separator = ' '
     ) {
-		$dt_format = ! empty( $dt_format ) ? $dt_format : $this->_dt_frmt;
-		$tm_format = ! empty( $tm_format ) ? $tm_format : $this->_tm_frmt;
-		$full_format = $dt_format . $separator . $tm_format;
+		$dt_format = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$full_format = $dt_format.$separator.$tm_format;
 
 		//the range output depends on various conditions
-		switch ( true ) {
+		switch (true) {
 			//start date timestamp and end date timestamp are the same.
-			case ( $this->get_raw( 'DTT_EVT_start' ) === $this->get_raw( 'DTT_EVT_end' ) ) :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format );
+			case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
 				break;
 			//start and end date are the same but times are different
-			case ( $this->start_date() === $this->end_date() ) :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
+			case ($this->start_date() === $this->end_date()) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
 				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $tm_format );
+				          . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
 				break;
 			//all other conditions
 			default :
-				$output = $this->get_i18n_datetime( 'DTT_EVT_start', $full_format )
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
 				          . $conjunction
-				          . $this->get_i18n_datetime( 'DTT_EVT_end', $full_format );
+				          . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
 				break;
 		}
 		return $output;
@@ -588,8 +588,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function e_date_and_time_range( $dt_format = '', $tm_format = '', $conjunction = ' - ' ) {
-		echo $this->date_and_time_range( $dt_format, $tm_format, $conjunction );
+	public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ') {
+		echo $this->date_and_time_range($dt_format, $tm_format, $conjunction);
 	}
 
 
@@ -601,8 +601,8 @@ 
 	 * @param 	string 	$tm_format - string representation of time format defaults to 'g:i a'
 	 * @return 	mixed 	string on success, FALSE on fail
 	 */
-	public function start_date_and_time( $dt_format = '', $tm_format = '' ) {
-		return $this->_show_datetime( '', 'start', $dt_format, $tm_format );
+	public function start_date_and_time($dt_format = '', $tm_format = '') {
+		return $this->_show_datetime('', 'start', $dt_format, $tm_format);
 	}
 
 
@@ -611,8 +611,8 @@ 
 	 * @param string $dt_frmt
 	 * @param string $tm_format
 	 */
-	public function e_start_date_and_time( $dt_frmt = '', $tm_format = '' ) {
-		$this->_show_datetime( '', 'start', $dt_frmt, $tm_format, TRUE );
+	public function e_start_date_and_time($dt_frmt = '', $tm_format = '') {
+		$this->_show_datetime('', 'start', $dt_frmt, $tm_format, TRUE);
 	}
 
 
@@ -626,11 +626,11 @@ 
 	 * @param bool   $round_up
 	 * @return float|int|mixed
 	 */
-	public function length( $units = 'seconds', $round_up = FALSE ) {
-		$start = $this->get_raw( 'DTT_EVT_start' );
-		$end = $this->get_raw( 'DTT_EVT_end' );
+	public function length($units = 'seconds', $round_up = FALSE) {
+		$start = $this->get_raw('DTT_EVT_start');
+		$end = $this->get_raw('DTT_EVT_end');
 		$length_in_units = $end - $start;
-		switch ( $units ) {
+		switch ($units) {
 			//NOTE: We purposefully don't use "break;" in order to chain the divisions
 			/** @noinspection PhpMissingBreakStatementInspection */
 			case 'days':
@@ -643,10 +643,10 @@ 
 				$length_in_units /= 60;
 			case 'seconds':
 			default:
-				$length_in_units = ceil( $length_in_units );
+				$length_in_units = ceil($length_in_units);
 		}
-		if ( $round_up ) {
-			$length_in_units = max( $length_in_units, 1 );
+		if ($round_up) {
+			$length_in_units = max($length_in_units, 1);
 		}
 		return $length_in_units;
 	}
@@ -661,7 +661,7 @@ 
      * @return    mixed                string on success, FALSE on fail
      */
     public function end_date_and_time($dt_frmt = '', $tm_format = '') {
-		return $this->_show_datetime( '', 'end', $dt_frmt, $tm_format );
+		return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
 	}
 
 
@@ -670,8 +670,8 @@ 
 	 * @param string $dt_frmt
 	 * @param string $tm_format
 	 */
-	public function e_end_date_and_time( $dt_frmt = '', $tm_format = '' ) {
-		$this->_show_datetime( '', 'end', $dt_frmt, $tm_format, TRUE );
+	public function e_end_date_and_time($dt_frmt = '', $tm_format = '') {
+		$this->_show_datetime('', 'end', $dt_frmt, $tm_format, TRUE);
 	}
 
 
@@ -682,7 +682,7 @@ 
 	 * @return        int
 	 */
 	public function start() {
-		return $this->get_raw( 'DTT_EVT_start' );
+		return $this->get_raw('DTT_EVT_start');
 	}
 
 
@@ -693,7 +693,7 @@ 
 	 * @return        int
 	 */
 	public function end() {
-		return $this->get_raw( 'DTT_EVT_end' );
+		return $this->get_raw('DTT_EVT_end');
 	}
 
 
@@ -704,7 +704,7 @@ 
 	 * @return        mixed        int on success, FALSE on fail
 	 */
 	public function reg_limit() {
-		return $this->get_raw( 'DTT_reg_limit' );
+		return $this->get_raw('DTT_reg_limit');
 	}
 
 
@@ -732,15 +732,15 @@ 
 	 * 																	the spaces remaining for this particular datetime, hence the flag.
 	 * @return 	int
 	 */
-	public function spaces_remaining( $consider_tickets = FALSE ) {
+	public function spaces_remaining($consider_tickets = FALSE) {
 		// tickets remaining available for purchase
 		//no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
 		$dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-		if ( ! $consider_tickets ) {
+		if ( ! $consider_tickets) {
 			return $dtt_remaining;
 		}
 		$tickets_remaining = $this->tickets_remaining();
-		return min( $dtt_remaining, $tickets_remaining );
+		return min($dtt_remaining, $tickets_remaining);
 	}
 
 
@@ -751,19 +751,19 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function tickets_remaining( $query_params = array() ) {
+	public function tickets_remaining($query_params = array()) {
 		$sum = 0;
-		$tickets = $this->tickets( $query_params );
-		if ( ! empty( $tickets ) ) {
-			foreach ( $tickets as $ticket ) {
-				if ( $ticket instanceof EE_Ticket ) {
+		$tickets = $this->tickets($query_params);
+		if ( ! empty($tickets)) {
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
 					// get the actual amount of tickets that can be sold
-					$qty = $ticket->qty( 'saleable' );
-					if ( $qty === EE_INF ) {
+					$qty = $ticket->qty('saleable');
+					if ($qty === EE_INF) {
 						return EE_INF;
 					}
 					// no negative ticket quantities plz
-					if ( $qty > 0 ) {
+					if ($qty > 0) {
 						$sum += $qty;
 					}
 				}
@@ -780,8 +780,8 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return int
 	 */
-	public function sum_tickets_initially_available( $query_params = array() ) {
-		return $this->sum_related( 'Ticket', $query_params, 'TKT_qty' );
+	public function sum_tickets_initially_available($query_params = array()) {
+		return $this->sum_related('Ticket', $query_params, 'TKT_qty');
 	}
 
 
@@ -793,7 +793,7 @@ 
 	 * @return int
 	 */
 	public function total_tickets_available_at_this_datetime() {
-		return $this->spaces_remaining( true );
+		return $this->spaces_remaining(true);
 	}
 
 
@@ -804,7 +804,7 @@ 
 	 * @return boolean
 	 */
 	public function is_upcoming() {
-		return ( $this->get_raw( 'DTT_EVT_start' ) > time() );
+		return ($this->get_raw('DTT_EVT_start') > time());
 	}
 
 
@@ -814,7 +814,7 @@ 
 	 * @return boolean
 	 */
 	public function is_active() {
-		return ( $this->get_raw( 'DTT_EVT_start' ) < time() && $this->get_raw( 'DTT_EVT_end' ) > time() );
+		return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
 	}
 
 
@@ -824,7 +824,7 @@ 
 	 * @return boolean
 	 */
 	public function is_expired() {
-		return ( $this->get_raw( 'DTT_EVT_end' ) < time() );
+		return ($this->get_raw('DTT_EVT_end') < time());
 	}
 
 
@@ -835,16 +835,16 @@ 
 	 */
 	public function get_active_status() {
 		$total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
-		if ( $total_tickets_for_this_dtt !== FALSE && $total_tickets_for_this_dtt < 1 ) {
+		if ($total_tickets_for_this_dtt !== FALSE && $total_tickets_for_this_dtt < 1) {
 			return EE_Datetime::sold_out;
 		}
-		if ( $this->is_expired() ) {
+		if ($this->is_expired()) {
 			return EE_Datetime::expired;
 		}
-		if ( $this->is_upcoming() ) {
+		if ($this->is_upcoming()) {
 			return EE_Datetime::upcoming;
 		}
-		if ( $this->is_active() ) {
+		if ($this->is_active()) {
 			return EE_Datetime::active;
 		}
 		return NULL;
@@ -858,24 +858,24 @@ 
 	 * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
 	 * @return string
 	 */
-	public function get_dtt_display_name( $use_dtt_name = FALSE ) {
-		if ( $use_dtt_name ) {
+	public function get_dtt_display_name($use_dtt_name = FALSE) {
+		if ($use_dtt_name) {
 			$dtt_name = $this->name();
-			if ( !empty( $dtt_name ) ) {
+			if ( ! empty($dtt_name)) {
 				return $dtt_name;
 			}
 		}
 		//first condition is to see if the months are different
-		if ( date( 'm', $this->get_raw( 'DTT_EVT_start' ) ) != date( 'm', $this->get_raw( 'DTT_EVT_end' ) ) ) {
-			$display_date = $this->start_date( 'M j\, Y g:i a' ) . ' - ' . $this->end_date( 'M j\, Y g:i a' );
+		if (date('m', $this->get_raw('DTT_EVT_start')) != date('m', $this->get_raw('DTT_EVT_end'))) {
+			$display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a');
 			//next condition is if its the same month but different day
 		}
 		else {
-			if ( date( 'm', $this->get_raw( 'DTT_EVT_start' ) ) == date( 'm', $this->get_raw( 'DTT_EVT_end' ) ) && date( 'd', $this->get_raw( 'DTT_EVT_start' ) ) != date( 'd', $this->get_raw( 'DTT_EVT_end' ) ) ) {
-				$display_date = $this->start_date( 'M j\, g:i a' ) . ' - ' . $this->end_date( 'M j\, g:i a Y' );
+			if (date('m', $this->get_raw('DTT_EVT_start')) == date('m', $this->get_raw('DTT_EVT_end')) && date('d', $this->get_raw('DTT_EVT_start')) != date('d', $this->get_raw('DTT_EVT_end'))) {
+				$display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y');
 			}
 			else {
-				$display_date = $this->start_date( 'F j\, Y' ) . ' @ ' . $this->start_date( 'g:i a' ) . ' - ' . $this->end_date( 'g:i a' );
+				$display_date = $this->start_date('F j\, Y').' @ '.$this->start_date('g:i a').' - '.$this->end_date('g:i a');
 			}
 		}
 		return $display_date;
@@ -889,8 +889,8 @@ 
 *@param array $query_params see EEM_Base::get_all()
 	 * @return EE_Ticket[]
 	 */
-	public function tickets( $query_params = array() ) {
-		return $this->get_many_related( 'Ticket', $query_params );
+	public function tickets($query_params = array()) {
+		return $this->get_many_related('Ticket', $query_params);
 	}
 
 
@@ -900,21 +900,21 @@ 
 	 * @param array $query_params like EEM_Base::get_all's
 	 * @return EE_Ticket[]
 	 */
-	public function ticket_types_available_for_purchase( $query_params = array() ) {
+	public function ticket_types_available_for_purchase($query_params = array()) {
 		// first check if datetime is valid
-		if ( ! ( $this->is_upcoming() || $this->is_active() ) || $this->sold_out() ) {
+		if ( ! ($this->is_upcoming() || $this->is_active()) || $this->sold_out()) {
 			return array();
 		}
-		if ( empty( $query_params ) ) {
+		if (empty($query_params)) {
 			$query_params = array(
 				array(
-					'TKT_start_date' => array( '<=', EEM_Ticket::instance()->current_time_for_query( 'TKT_start_date' ) ),
-					'TKT_end_date'   => array( '>=', EEM_Ticket::instance()->current_time_for_query( 'TKT_end_date' ) ),
+					'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
+					'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
 					'TKT_deleted'    => false
 				)
 			);
 		}
-		return $this->tickets( $query_params );
+		return $this->tickets($query_params);
 	}
 
 
@@ -924,7 +924,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -938,11 +938,11 @@ 
      */
 	public function update_sold() {
 		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
-			array( array(
+			array(array(
 				'STS_ID' 					=> EEM_Registration::status_id_approved,
 				'REG_deleted' 				=> 0,
 				'Ticket.Datetime.DTT_ID' 	=> $this->ID(),
-			) )
+			))
 		);
         $sold = $this->sold();
         if ($count_regs_for_this_datetime > $sold) {

modules/single_page_checkout/reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php

Indentation +2870 added lines, -2870 removed lines

@@ -15,2874 +15,2874 @@
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @access protected
-     * @var EE_Line_Item_Display $Line_Item_Display
-     */
-    protected $line_item_display;
-
-    /**
-     * @access protected
-     * @var boolean $handle_IPN_in_this_request
-     */
-    protected $handle_IPN_in_this_request = false;
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_filter(
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
-        );
-        add_action(
-            'wp_ajax_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action(
-            'wp_ajax_nopriv_switch_spco_billing_form',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
-        );
-        add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
-        add_action(
-            'wp_ajax_nopriv_save_payer_details',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
-        );
-        add_action(
-            'wp_ajax_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_action(
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
-        );
-        add_filter(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
-            10,
-            1
-        );
-    }
-
-
-    /**
-     *    ajax switch_spco_billing_form
-     *
-     * @throws \EE_Error
-     */
-    public static function switch_spco_billing_form()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
-    }
-
-
-    /**
-     *    ajax save_payer_details
-     *
-     * @throws \EE_Error
-     */
-    public static function save_payer_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
-    }
-
-
-    /**
-     *    ajax get_transaction_details
-     *
-     * @throws \EE_Error
-     */
-    public static function get_transaction_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
-    }
-
-
-    /**
-     * bypass_recaptcha_for_load_payment_method
-     *
-     * @access public
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function bypass_recaptcha_for_load_payment_method()
-    {
-        return array(
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'spco_billing_form',
-        );
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug     = 'payment_options';
-        $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__(
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return null
-     */
-    public function line_item_display()
-    {
-        return $this->line_item_display;
-    }
-
-
-    /**
-     * @param null $line_item_display
-     */
-    public function set_line_item_display($line_item_display)
-    {
-        $this->line_item_display = $line_item_display;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request()
-    {
-        return $this->handle_IPN_in_this_request;
-    }
-
-
-    /**
-     * @param boolean $handle_IPN_in_this_request
-     */
-    public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
-    {
-        $this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * translate_js_strings
-     *
-     * @return void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
-            'Please select a method of payment in order to continue.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
-            'Forwarding to Secure Payment Provider.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * enqueue_styles_and_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        $transaction = $this->checkout->transaction;
-        //if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
-            return;
-        }
-        foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
-            $type_obj = $payment_method->type_obj();
-            if ($type_obj instanceof EE_PMT_Base) {
-                $billing_form = $type_obj->generate_new_billing_form($transaction);
-                if ($billing_form instanceof EE_Form_Section_Proper) {
-                    $billing_form->enqueue_js();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * initialize_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function initialize_reg_step()
-    {
-        // TODO: if /when we implement donations, then this will need overriding
-        if (// don't need payment options for:
-            // 	registrations made via the admin
-            // 	completed transactions
-            // 	overpaid transactions
-            // 	$ 0.00 transactions (no payment required)
-            ! $this->checkout->payment_required()
-            // but do NOT remove if current action being called belongs to this reg step
-            && ! is_callable(array($this, $this->checkout->action))
-            && ! $this->completed()
-        ) {
-            // and if so, then we no longer need the Payment Options step
-            if ($this->is_current_step()) {
-                $this->checkout->generate_reg_form = false;
-            }
-            $this->checkout->remove_reg_step($this->_slug);
-            // DEBUG LOG
-            //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            return false;
-        }
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        // get all active payment methods
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function generate_reg_form()
-    {
-        // reset in case someone changes their mind
-        $this->_reset_selected_method_of_payment();
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'payments_closed';
-        $registrations_requiring_payment            = array();
-        $registrations_for_free_events              = array();
-        $registrations_requiring_pre_approval       = array();
-        $sold_out_events                            = array();
-        $insufficient_spaces_available              = array();
-        $no_payment_required                        = true;
-        // loop thru registrations to gather info
-        $registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            $this->checkout->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                } else {
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
-                }
-                continue;
-            }
-            // event requires admin approval
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
-                // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            if ($this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-                && (
-                    $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out(true)
-                )
-            ) {
-                // add event to list of events that are sold out
-                $sold_out_events[$registration->event()->ID()] = $registration->event();
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            // are they allowed to pay now and is there monies owing?
-            if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
-                    $registration->event(),
-                    $this
-                );
-            } elseif (! $this->checkout->revisit
-                && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                && $registration->ticket()->is_free()
-            ) {
-                $registrations_for_free_events[$registration->event()->ID()] = $registration;
-            }
-        }
-        $subsections = array();
-        // now decide which template to load
-        if (! empty($sold_out_events)) {
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
-        }
-        if (! empty($insufficient_spaces_available)) {
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
-                $insufficient_spaces_available
-            );
-        }
-        if (! empty($registrations_requiring_pre_approval)) {
-            $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
-                $registrations_requiring_pre_approval
-            );
-        }
-        if (! empty($registrations_for_free_events)) {
-            $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
-        }
-        if (! empty($registrations_requiring_payment)) {
-            if ($this->checkout->amount_owing > 0) {
-                // autoload Line_Item_Display classes
-                EEH_Autoloader::register_line_item_filter_autoloaders();
-                $line_item_filter_processor = new EE_Line_Item_Filter_Processor(
-                    apply_filters(
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-                        new EE_Line_Item_Filter_Collection()
-                    ),
-                    $this->checkout->cart->get_grand_total()
-                );
-                /** @var EE_Line_Item $filtered_line_item_tree */
-                $filtered_line_item_tree = $line_item_filter_processor->process();
-                EEH_Autoloader::register_line_item_display_autoloaders();
-                $this->set_line_item_display(new EE_Line_Item_Display('spco'));
-                $subsections['payment_options'] = $this->_display_payment_options(
-                    $this->line_item_display->display_line_item(
-                        $filtered_line_item_tree,
-                        array('registrations' => $registrations)
-                    )
-                );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
-                $this->_apply_registration_payments_to_amount_owing($registrations);
-            }
-            $no_payment_required = false;
-        } else {
-            $this->_hide_reg_step_submit_button_if_revisit();
-        }
-        $this->_save_selected_method_of_payment();
-
-        $subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
-        $subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => new EE_No_Layout(),
-            )
-        );
-    }
-
-
-    /**
-     * add line item filters required for this reg step
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
-     *        payment options reg step, can apply these filters via the following: apply_filters(
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
-     *        filter collection by passing that instead of instantiating a new collection
-     *
-     * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
-     * @return EE_Line_Item_Filter_Collection
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
-    {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
-            return $line_item_filter_collection;
-        }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
-            return $line_item_filter_collection;
-        }
-        $line_item_filter_collection->add(
-            new EE_Billable_Line_Item_Filter(
-                EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
-                    EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                    )
-                )
-            )
-        );
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
-        return $line_item_filter_collection;
-    }
-
-
-    /**
-     * remove_ejected_registrations
-     * if a registrant has lost their potential space at an event due to lack of payment,
-     * then this method removes them from the list of registrations being paid for during this request
-     *
-     * @param \EE_Registration[] $registrations
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function remove_ejected_registrations(array $registrations)
-    {
-        $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-            $registrations,
-            EE_Registry::instance()->SSN->checkout()->revisit
-        );
-        foreach ($registrations as $REG_ID => $registration) {
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[$REG_ID])) {
-                unset($registrations[$REG_ID]);
-                continue;
-            }
-        }
-        return $registrations;
-    }
-
-
-    /**
-     * find_registrations_that_lost_their_space
-     * If a registrant chooses an offline payment method like Invoice,
-     * then no space is reserved for them at the event until they fully pay fo that site
-     * (unless the event's default reg status is set to APPROVED)
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
-     * then this method will determine which registrations have lost the ability to complete the reg process.
-     *
-     * @param \EE_Registration[] $registrations
-     * @param bool               $revisit
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
-    {
-        // registrations per event
-        $event_reg_count = array();
-        // spaces left per event
-        $event_spaces_remaining = array();
-        // tickets left sorted by ID
-        $tickets_remaining = array();
-        // registrations that have lost their space
-        $ejected_registrations = array();
-        foreach ($registrations as $REG_ID => $registration) {
-            if ($registration->status_ID() === EEM_Registration::status_id_approved
-                || apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
-                    false,
-                    $registration,
-                    $revisit
-                )
-            ) {
-                continue;
-            }
-            $EVT_ID = $registration->event_ID();
-            $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[$ticket->ID()])) {
-                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
-            }
-            if ($tickets_remaining[$ticket->ID()] > 0) {
-                if (! isset($event_reg_count[$EVT_ID])) {
-                    $event_reg_count[$EVT_ID] = 0;
-                }
-                $event_reg_count[$EVT_ID]++;
-                if (! isset($event_spaces_remaining[$EVT_ID])) {
-                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
-                }
-            }
-            if ($revisit
-                && ($tickets_remaining[$ticket->ID()] === 0
-                    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
-                )
-            ) {
-                $ejected_registrations[$REG_ID] = $registration->event();
-                if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->manually_update_registration_status(
-                        $registration,
-                        EEM_Registration::status_id_wait_list
-                    );
-                }
-            }
-        }
-        return $ejected_registrations;
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _adjust_registration_status_if_event_old_sold()
-    {
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _hide_reg_step_submit_button_if_revisit()
-    {
-        if ($this->checkout->revisit) {
-            add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
-        }
-    }
-
-
-    /**
-     * sold_out_events
-     * displays notices regarding events that have sold out since hte registrant first signed up
-     *
-     * @param \EE_Event[] $sold_out_events_array
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _sold_out_events($sold_out_events_array = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'events_sold_out';
-        $sold_out_events                            = '';
-        foreach ($sold_out_events_array as $sold_out_event) {
-            $sold_out_events .= EEH_HTML::li(
-                EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
-                    '',
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
-                )
-            );
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                'sold_out_events'     => $sold_out_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
-                                    sprintf(
-                                        esc_html__(
-                                            'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
-                                            'event_espresso'
-                                        ),
-                                        '<strong>',
-                                        '</strong>',
-                                        '<br />'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _insufficient_spaces_available
-     * displays notices regarding events that do not have enough remaining spaces
-     * to satisfy the current number of registrations looking to pay
-     *
-     * @param \EE_Event[] $insufficient_spaces_events_array
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'invoice';
-        $insufficient_space_events                  = '';
-        foreach ($insufficient_spaces_events_array as $event) {
-            if ($event instanceof EE_Event) {
-                $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => array(
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
-                ),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
-                            array(
-                                'sold_out_events'     => $insufficient_space_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
-                                    esc_html__(
-                                        'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * registrations_requiring_pre_approval
-     *
-     * @param array $registrations_requiring_pre_approval
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
-    {
-        $events_requiring_pre_approval = '';
-        foreach ($registrations_requiring_pre_approval as $registration) {
-            if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
-                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
-                    EEH_HTML::span(
-                        '',
-                        '',
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
-                    )
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'events_requiring_pre_approval.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            array(
-                                'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
-                                'events_requiring_pre_approval_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
-                                    esc_html__(
-                                        'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _no_payment_required
-     *
-     * @param \EE_Event[] $registrations_for_free_events
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _no_payment_required($registrations_for_free_events = array())
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
-        // generate no_payment_required form
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . DS
-                                                  . 'no_payment_required.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
-                            array(
-                                'revisit'                       => $this->checkout->revisit,
-                                'registrations'                 => array(),
-                                'ticket_count'                  => array(),
-                                'registrations_for_free_events' => $registrations_for_free_events,
-                                'no_payment_required_msg'       => EEH_HTML::p(
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
-                                ),
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _display_payment_options
-     *
-     * @param string $transaction_details
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _display_payment_options($transaction_details = '')
-    {
-        // has method_of_payment been set by no-js user?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
-        // build payment options form
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
-            new EE_Form_Section_Proper(
-                array(
-                    'subsections'     => array(
-                        'before_payment_options' => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                        'payment_options'        => $this->_setup_payment_options(),
-                        'after_payment_options'  => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
-                            new EE_Form_Section_Proper(
-                                array('layout_strategy' => new EE_Div_Per_Section_Layout())
-                            )
-                        ),
-                    ),
-                    'layout_strategy' => new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template,
-                            'template_args'        => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
-                                array(
-                                    'reg_count'                 => $this->line_item_display->total_items(),
-                                    'transaction_details'       => $transaction_details,
-                                    'available_payment_methods' => array(),
-                                )
-                            ),
-                        )
-                    ),
-                )
-            )
-        );
-    }
-
-
-    /**
-     * _extra_hidden_inputs
-     *
-     * @param bool $no_payment_required
-     * @return \EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _extra_hidden_inputs($no_payment_required = true)
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'spco_no_payment_required' => new EE_Hidden_Input(
-                        array(
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
-                            'html_name'              => 'spco_no_payment_required',
-                            'html_id'                => 'spco-no-payment-required-payment_options',
-                            'default'                => $no_payment_required,
-                        )
-                    ),
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
-                        array(
-                            'normalization_strategy' => new EE_Int_Normalization(),
-                            'html_name'              => 'spco_transaction_id',
-                            'html_id'                => 'spco-transaction-id',
-                            'default'                => $this->checkout->transaction->ID(),
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     *    _apply_registration_payments_to_amount_owing
-     *
-     * @access protected
-     * @param array $registrations
-     * @throws EE_Error
-     */
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
-    {
-        $payments = array();
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
-                $payments += $registration->registration_payments();
-            }
-        }
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Registration_Payment) {
-                    $this->checkout->amount_owing -= $payment->amount();
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    _reset_selected_method_of_payment
-     *
-     * @access    private
-     * @param    bool $force_reset
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _reset_selected_method_of_payment($force_reset = false)
-    {
-        $reset_payment_method = $force_reset
-            ? true
-            : sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
-        if ($reset_payment_method) {
-            $this->checkout->selected_method_of_payment = null;
-            $this->checkout->payment_method             = null;
-            $this->checkout->billing_form               = null;
-            $this->_save_selected_method_of_payment();
-        }
-    }
-
-
-    /**
-     * _save_selected_method_of_payment
-     * stores the selected_method_of_payment in the session
-     * so that it's available for all subsequent requests including AJAX
-     *
-     * @access        private
-     * @param string $selected_method_of_payment
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_selected_method_of_payment($selected_method_of_payment = '')
-    {
-        $selected_method_of_payment = ! empty($selected_method_of_payment)
-            ? $selected_method_of_payment
-            : $this->checkout->selected_method_of_payment;
-        EE_Registry::instance()->SSN->set_session_data(
-            array('selected_method_of_payment' => $selected_method_of_payment)
-        );
-    }
-
-
-    /**
-     * _setup_payment_options
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function _setup_payment_options()
-    {
-        // load payment method classes
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
-        if (empty($this->checkout->available_payment_methods)) {
-            EE_Error::add_error(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
-                    sprintf(
-                        esc_html__(
-                            'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
-                            'event_espresso'
-                        ),
-                        '<br>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    )
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
-            ? apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
-            )
-            : apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Method of Payment', 'event_espresso')
-            );
-        $available_payment_methods = array(
-            // display the "Payment Method" header
-            'payment_method_header' => new EE_Form_Section_HTML(
-                EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
-            ),
-        );
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
-        $available_payment_method_options = array();
-        $default_payment_method_option    = array();
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
-        $payment_methods_billing_info = array(
-            new EE_Form_Section_HTML(
-                EEH_HTML::div('<br />', '', '', 'clear:both;')
-            ),
-        );
-        // loop through payment methods
-        foreach ($this->checkout->available_payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $payment_method_button = EEH_HTML::img(
-                    $payment_method->button_url(),
-                    $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
-                    'spco-payment-method-btn-img'
-                );
-                // check if any payment methods are set as default
-                // if payment method is already selected OR nothing is selected and this payment method should be
-                // open_by_default
-                if (($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
-                ) {
-                    $this->checkout->selected_method_of_payment = $payment_method->slug();
-                    $this->_save_selected_method_of_payment();
-                    $default_payment_method_option[$payment_method->slug()] = $payment_method_button;
-                } else {
-                    $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
-                }
-                $payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
-                    $payment_method
-                );
-            }
-        }
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
-        // of PMs
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
-        // now generate the actual form  inputs
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
-            $available_payment_method_options
-        );
-        $available_payment_methods                              += $payment_methods_billing_info;
-        // build the available payment methods form
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'spco-available-methods-of-payment-dv',
-                'subsections'     => $available_payment_methods,
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-            )
-        );
-    }
-
-
-    /**
-     * _get_available_payment_methods
-     *
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _get_available_payment_methods()
-    {
-        if (! empty($this->checkout->available_payment_methods)) {
-            return $this->checkout->available_payment_methods;
-        }
-        $available_payment_methods = array();
-        // load EEM_Payment_Method
-        EE_Registry::instance()->load_model('Payment_Method');
-        /** @type EEM_Payment_Method $EEM_Payment_Method */
-        $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-        // get all active payment methods
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        foreach ($payment_methods as $payment_method) {
-            if ($payment_method instanceof EE_Payment_Method) {
-                $available_payment_methods[$payment_method->slug()] = $payment_method;
-            }
-        }
-        return $available_payment_methods;
-    }
-
-
-    /**
-     *    _available_payment_method_inputs
-     *
-     * @access    private
-     * @param    array $available_payment_method_options
-     * @return    \EE_Form_Section_Proper
-     */
-    private function _available_payment_method_inputs($available_payment_method_options = array())
-    {
-        // generate inputs
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'ee-available-payment-method-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    '' => new EE_Radio_Button_Input(
-                        $available_payment_method_options,
-                        array(
-                            'html_name'          => 'selected_method_of_payment',
-                            'html_class'         => 'spco-payment-method',
-                            'default'            => $this->checkout->selected_method_of_payment,
-                            'label_size'         => 11,
-                            'enforce_label_size' => true,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     *    _payment_method_billing_info
-     *
-     * @access    private
-     * @param    EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
-    {
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
-            ? true
-            : false;
-        // generate the billing form for payment method
-        $billing_form                 = $currently_selected
-            ? $this->_get_billing_form_for_payment_method($payment_method)
-            : new EE_Form_Section_HTML();
-        $this->checkout->billing_form = $currently_selected
-            ? $billing_form
-            : $this->checkout->billing_form;
-        // it's all in the details
-        $info_html = EEH_HTML::h3(
-            esc_html__('Important information regarding your payment', 'event_espresso'),
-            '',
-            'spco-payment-method-hdr'
-        );
-        // add some info regarding the step, either from what's saved in the admin,
-        // or a default string depending on whether the PM has a billing form or not
-        if ($payment_method->description()) {
-            $payment_method_info = $payment_method->description();
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
-            $payment_method_info = sprintf(
-                esc_html__(
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
-                    'event_espresso'
-                ),
-                $this->submit_button_text()
-            );
-        } else {
-            $payment_method_info = sprintf(
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
-                $this->submit_button_text()
-            );
-        }
-        $info_html .= EEH_HTML::p(
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
-                $payment_method_info
-            ),
-            '',
-            'spco-payment-method-desc ee-attention'
-        );
-        return new EE_Form_Section_Proper(
-            array(
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
-                'html_class'      => 'spco-payment-method-info-dv',
-                // only display the selected or default PM
-                'html_style'      => $currently_selected ? '' : 'display:none;',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => array(
-                    'info'         => new EE_Form_Section_HTML($info_html),
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * get_billing_form_html_for_payment_method
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_billing_form_html_for_payment_method()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            return false;
-        }
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-            false
-        )) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // now generate billing form for selected method of payment
-        $payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
-        // fill form with attendee info if applicable
-        if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-            && $this->checkout->transaction_has_primary_registrant()
-        ) {
-            $payment_method_billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if ($payment_method_billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $payment_method_billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $payment_method_billing_form
-                );
-        }
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
-            ? $payment_method_billing_form->get_html()
-            : '';
-        $this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
-        // localize validation rules for main form
-        $this->checkout->current_step->reg_form->localize_validation_rules();
-        $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        return true;
-    }
-
-
-    /**
-     * _get_billing_form_for_payment_method
-     *
-     * @access private
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
-    {
-        $billing_form = $payment_method->type_obj()->billing_form(
-            $this->checkout->transaction,
-            array('amount_owing' => $this->checkout->amount_owing)
-        );
-        if ($billing_form instanceof EE_Billing_Info_Form) {
-            if (apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-                false
-            )
-                && EE_Registry::instance()->REQ->is_set('payment_method')
-            ) {
-                EE_Error::add_success(
-                    apply_filters(
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                        sprintf(
-                            esc_html__(
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                                'event_espresso'
-                            ),
-                            $payment_method->name()
-                        )
-                    )
-                );
-            }
-            return apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-                $billing_form,
-                $payment_method
-            );
-        }
-        // no actual billing form, so return empty HTML form section
-        return new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _get_selected_method_of_payment
-     *
-     * @access private
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
-     *                          is not found in the incoming request
-     * @param string  $request_param
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_selected_method_of_payment(
-        $required = false,
-        $request_param = 'selected_method_of_payment'
-    ) {
-        // is selected_method_of_payment set in the request ?
-        $selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
-        if ($selected_method_of_payment) {
-            // sanitize it
-            $selected_method_of_payment = is_array($selected_method_of_payment)
-                ? array_shift($selected_method_of_payment)
-                : $selected_method_of_payment;
-            $selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
-            // store it in the session so that it's available for all subsequent requests including AJAX
-            $this->_save_selected_method_of_payment($selected_method_of_payment);
-        } else {
-            // or is is set in the session ?
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
-                'selected_method_of_payment'
-            );
-        }
-        // do ya really really gotta have it?
-        if (empty($selected_method_of_payment) && $required) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $selected_method_of_payment;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
-    /********************************************************************************************************/
-    /**
-     * switch_payment_method
-     *
-     * @access public
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function switch_payment_method()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return false;
-        }
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
-            false
-        )) {
-            EE_Error::add_success(
-                apply_filters(
-                    'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // fill form with attendee info if applicable
-        if (apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            (
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $this->checkout->transaction_has_primary_registrant()
-            ),
-            $this->checkout->billing_form,
-            $this->checkout->transaction
-        )
-        ) {
-            $this->checkout->billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
-            && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
-        ) {
-            $this->checkout->billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $this->checkout->billing_form
-                );
-        }
-        // get html and validation rules for form
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->json_response->set_return_data(
-                array('payment_method_info' => $this->checkout->billing_form->get_html())
-            );
-            // localize validation rules for main form
-            $this->checkout->billing_form->localize_validation_rules(true);
-            $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-        } else {
-            $this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
-        }
-        //prevents advancement to next step
-        $this->checkout->continue_reg = false;
-        return true;
-    }
-
-
-    /**
-     * _verify_payment_method_is_set
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _verify_payment_method_is_set()
-    {
-        // generate billing form for selected method of payment if it hasn't been done already
-        if (empty($this->checkout->selected_method_of_payment)) {
-            // how have they chosen to pay?
-            $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        } else {
-            // choose your own adventure based on method_of_payment
-            switch ($this->checkout->selected_method_of_payment) {
-                case 'events_sold_out' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                case 'payments_closed' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                case 'no_payment_required' :
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-                            esc_html__(
-                                'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
-                                'event_espresso'
-                            )
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                    return false;
-                    break;
-                default:
-            }
-        }
-        // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            // get payment method for selected method of payment
-            $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
-        }
-        return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
-    }
-
-
-
-    /********************************************************************************************************/
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * save_payer_details_via_ajax
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function save_payer_details_via_ajax()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return;
-        }
-        // generate billing form for selected method of payment if it hasn't been done already
-        if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
-            $attendee = $this->_create_attendee_from_request_data();
-            if ($attendee instanceof EE_Attendee) {
-                foreach ($this->checkout->transaction->registrations() as $registration) {
-                    if ($registration->is_primary_registrant()) {
-                        $this->checkout->primary_attendee_obj = $attendee;
-                        $registration->_add_relation_to($attendee, 'Attendee');
-                        $registration->set_attendee_id($attendee->ID());
-                        $registration->update_cache_after_object_save('Attendee', $attendee);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * create_attendee_from_request_data
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _create_attendee_from_request_data()
-    {
-        // get State ID
-        $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
-        if (! empty($STA_ID)) {
-            // can we get state object from name ?
-            EE_Registry::instance()->load_model('State');
-            $state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
-        }
-        // get Country ISO
-        $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
-        if (! empty($CNT_ISO)) {
-            // can we get country object from name ?
-            EE_Registry::instance()->load_model('Country');
-            $country = EEM_Country::instance()->get_col(
-                array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
-                'CNT_ISO'
-            );
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
-        }
-        // grab attendee data
-        $attendee_data = array(
-            'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
-            'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
-            'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
-            'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
-            'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
-            'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
-            'STA_ID'       => $STA_ID,
-            'CNT_ISO'      => $CNT_ISO,
-            'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
-            'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
-        );
-        // validate the email address since it is the most important piece of info
-        if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
-            EE_Error::add_error(
-                esc_html__('An invalid email address was submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
-        // AND email address
-        if (! empty($attendee_data['ATT_fname'])
-            && ! empty($attendee_data['ATT_lname'])
-            && ! empty($attendee_data['ATT_email'])
-        ) {
-            $existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
-                array(
-                    'ATT_fname' => $attendee_data['ATT_fname'],
-                    'ATT_lname' => $attendee_data['ATT_lname'],
-                    'ATT_email' => $attendee_data['ATT_email'],
-                )
-            );
-            if ($existing_attendee instanceof EE_Attendee) {
-                return $existing_attendee;
-            }
-        }
-        // no existing attendee? kk let's create a new one
-        // kinda lame, but we need a first and last name to create an attendee, so use the email address if those
-        // don't exist
-        $attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
-            ? $attendee_data['ATT_fname']
-            : $attendee_data['ATT_email'];
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : $attendee_data['ATT_email'];
-        return EE_Attendee::new_instance($attendee_data);
-    }
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  *****************************************/
-    /********************************************************************************************************/
-    /**
-     * process_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function process_reg_step()
-    {
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
-            ? 'no_payment_required'
-            : $this->_get_selected_method_of_payment(true);
-        // choose your own adventure based on method_of_payment
-        switch ($this->checkout->selected_method_of_payment) {
-
-            case 'events_sold_out' :
-                $this->checkout->redirect     = true;
-                $this->checkout->redirect_url = $this->checkout->cancel_page_url;
-                $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-                // mark this reg step as completed
-                $this->set_completed();
-                return false;
-                break;
-
-            case 'payments_closed' :
-                if (apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
-                    false
-                )) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required at this time.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-                break;
-
-            case 'no_payment_required' :
-                if (apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
-                    false
-                )) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-                break;
-
-            default:
-                $registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                );
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-                    $registrations,
-                    EE_Registry::instance()->SSN->checkout()->revisit
-                );
-                // calculate difference between the two arrays
-                $registrations = array_diff($registrations, $ejected_registrations);
-                if (empty($registrations)) {
-                    $this->_redirect_because_event_sold_out();
-                    return false;
-                }
-                $payment_successful = $this->_process_payment();
-                if ($payment_successful) {
-                    $this->checkout->continue_reg = true;
-                    $this->_maybe_set_completed($this->checkout->payment_method);
-                } else {
-                    $this->checkout->continue_reg = false;
-                }
-                return $payment_successful;
-        }
-    }
-
-
-    /**
-     * _redirect_because_event_sold_out
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _redirect_because_event_sold_out()
-    {
-        $this->checkout->continue_reg = false;
-        // set redirect URL
-        $this->checkout->redirect_url = add_query_arg(
-            array('e_reg_url_link' => $this->checkout->reg_url_link),
-            $this->checkout->current_step->reg_step_url()
-        );
-        $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-    }
-
-
-    /**
-     * _maybe_set_completed
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _maybe_set_completed(EE_Payment_Method $payment_method)
-    {
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite :
-                break;
-            case EE_PMT_Base::onsite :
-            case EE_PMT_Base::offline :
-                // mark this reg step as completed
-                $this->set_completed();
-                break;
-        }
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to retry a payment
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidStatusException
-     */
-    public function update_reg_step()
-    {
-        $success = true;
-        // if payment required
-        if ($this->checkout->transaction->total() > 0) {
-            do_action(
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
-                $this->checkout->transaction
-            );
-            // attempt payment via payment method
-            $success = $this->process_reg_step();
-        }
-        if ($success && ! $this->checkout->redirect) {
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
-                $this->checkout->transaction->ID()
-            );
-            // set return URL
-            $this->checkout->redirect_url = add_query_arg(
-                array('e_reg_url_link' => $this->checkout->reg_url_link),
-                $this->checkout->thank_you_page_url
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     *    _process_payment
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_payment()
-    {
-        // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
-            return false;
-        }
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $this->checkout->json_response->set_plz_select_method_of_payment(
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
-            );
-            return false;
-        }
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            return false;
-        }
-        // setup billing form
-        if ($this->checkout->payment_method->is_on_site()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-            // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
-                return false;
-            }
-        }
-        // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
-            return false;
-        }
-        // if session is close to expiring (under 10 minutes by default)
-        if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
-            // add some time to session expiration so that payment can be completed
-            EE_Registry::instance()->SSN->extend_expiration();
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        //$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
-        // in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
-        // for events with a default reg status of Approved
-        // $transaction_processor->toggle_registration_statuses_for_default_approved_events(
-        //      $this->checkout->transaction, $this->checkout->reg_cache_where_params
-        // );
-        // attempt payment
-        $payment = $this->_attempt_payment($this->checkout->payment_method);
-        // process results
-        $payment = $this->_validate_payment($payment);
-        $payment = $this->_post_payment_processing($payment);
-        // verify payment
-        if ($payment instanceof EE_Payment) {
-            // store that for later
-            $this->checkout->payment = $payment;
-            // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
-            $this->checkout->transaction->toggle_failed_transaction_status();
-            $payment_status = $payment->status();
-            if (
-                $payment_status === EEM_Payment::status_id_approved
-                || $payment_status === EEM_Payment::status_id_pending
-            ) {
-                return true;
-            } else {
-                return false;
-            }
-        } else if ($payment === true) {
-            // please note that offline payment methods will NOT make a payment,
-            // but instead just mark themselves as the PMD_ID on the transaction, and return true
-            $this->checkout->payment = $payment;
-            return true;
-        }
-        // where's my money?
-        return false;
-    }
-
-
-    /**
-     * _last_second_ticket_verifications
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _last_second_ticket_verifications()
-    {
-        // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
-            return true;
-        }
-        $registrations = $this->checkout->transaction->registrations();
-        if (empty($registrations)) {
-            return false;
-        }
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $event = $registration->event_obj();
-                if ($event instanceof EE_Event && $event->is_sold_out(true)) {
-                    EE_Error::add_error(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
-                            sprintf(
-                                esc_html__(
-                                    'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                    'event_espresso'
-                                ),
-                                $event->name()
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * redirect_form
-     *
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function redirect_form()
-    {
-        $payment_method_billing_info = $this->_payment_method_billing_info(
-            $this->_get_payment_method_for_selected_method_of_payment()
-        );
-        $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
-        EE_Registry::instance()->REQ->add_output($html);
-        return true;
-    }
-
-
-    /**
-     * _billing_form_is_valid
-     *
-     * @access private
-     * @return bool
-     * @throws \EE_Error
-     */
-    private function _billing_form_is_valid()
-    {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
-            return true;
-        }
-        if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
-            if ($this->checkout->billing_form->was_submitted()) {
-                $this->checkout->billing_form->receive_form_submission();
-                if ($this->checkout->billing_form->is_valid()) {
-                    return true;
-                }
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
-                $error_strings     = array();
-                foreach ($validation_errors as $validation_error) {
-                    if ($validation_error instanceof EE_Validation_Error) {
-                        $form_section = $validation_error->get_form_section();
-                        if ($form_section instanceof EE_Form_Input_Base) {
-                            $label = $form_section->html_label_text();
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
-                            $label = $form_section->name();
-                        } else {
-                            $label = esc_html__('Validation Error', 'event_espresso');
-                        }
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
-                    }
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        implode('<br/>', $error_strings)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The billing form was not submitted or something prevented it\'s submission.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * _setup_primary_registrant_prior_to_payment
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
-     * yet)
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _setup_primary_registrant_prior_to_payment()
-    {
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        // if not, then we need to at least gather some primary registrant data before attempting payment
-        if (
-            $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-            && ! $this->checkout->transaction_has_primary_registrant()
-            && ! $this->_capture_primary_registration_data_from_billing_form()
-        ) {
-            return false;
-        }
-        // because saving an object clears it's cache, we need to do the chevy shuffle
-        // grab the primary_registration object
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        // at this point we'll consider a TXN to not have been failed
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // save the TXN ( which clears cached copy of primary_registration)
-        $this->checkout->transaction->save();
-        // grab TXN ID and save it to the primary_registration
-        $primary_registration->set_transaction_id($this->checkout->transaction->ID());
-        // save what we have so far
-        $primary_registration->save();
-        return true;
-    }
-
-
-    /**
-     * _capture_primary_registration_data_from_billing_form
-     *
-     * @access private
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _capture_primary_registration_data_from_billing_form()
-    {
-        // convert billing form data into an attendee
-        $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The billing form details could not be used for attendee details 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 false;
-        }
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant for this transaction 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 false;
-        }
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
-              instanceof
-              EE_Attendee
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant could not be associated with this transaction 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 false;
-        }
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-        $registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
-        return true;
-    }
-
-
-    /**
-     * _get_payment_method_for_selected_method_of_payment
-     * retrieves a valid payment method
-     *
-     * @access public
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _get_payment_method_for_selected_method_of_payment()
-    {
-        if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
-            $this->_redirect_because_event_sold_out();
-            return null;
-        }
-        // get EE_Payment_Method object
-        if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
-            $payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
-        } else {
-            // load EEM_Payment_Method
-            EE_Registry::instance()->load_model('Payment_Method');
-            /** @type EEM_Payment_Method $EEM_Payment_Method */
-            $EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-            $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
-        }
-        // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment 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;
-        }
-        // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        '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;
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     *    _attempt_payment
-     *
-     * @access    private
-     * @type    EE_Payment_Method $payment_method
-     * @return mixed EE_Payment | boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _attempt_payment(EE_Payment_Method $payment_method)
-    {
-        $payment = null;
-        $this->checkout->transaction->save();
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
-            return false;
-        }
-        try {
-            $payment_processor->set_revisit($this->checkout->revisit);
-            // generate payment object
-            $payment = $payment_processor->process_payment(
-                $payment_method,
-                $this->checkout->transaction,
-                $this->checkout->amount_owing,
-                $this->checkout->billing_form,
-                $this->_get_return_url($payment_method),
-                'CART',
-                $this->checkout->admin_request,
-                true,
-                $this->reg_step_url()
-            );
-        } catch (Exception $e) {
-            $this->_handle_payment_processor_exception($e);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _handle_payment_processor_exception
-     *
-     * @access protected
-     * @param \Exception $e
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _handle_payment_processor_exception(Exception $e)
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $e->getMessage(),
-                $e->getFile(),
-                $e->getLine()
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _get_return_url
-     *
-     * @access protected
-     * @param \EE_Payment_Method $payment_method
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_return_url(EE_Payment_Method $payment_method)
-    {
-        $return_url = '';
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite :
-                $return_url = add_query_arg(
-                    array(
-                        'action'                     => 'process_gateway_response',
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
-                    ),
-                    $this->reg_step_url()
-                );
-                break;
-            case EE_PMT_Base::onsite :
-            case EE_PMT_Base::offline :
-                $return_url = $this->checkout->next_step->reg_step_url();
-                break;
-        }
-        return $return_url;
-    }
-
-
-    /**
-     * _validate_payment
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _validate_payment($payment = null)
-    {
-        if ($this->checkout->payment_method->is_off_line()) {
-            return true;
-        }
-        // verify payment object
-        if (! $payment instanceof EE_Payment) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _post_payment_processing
-     *
-     * @access private
-     * @param EE_Payment|bool $payment
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _post_payment_processing($payment = null)
-    {
-        // Off-Line payment?
-        if ($payment === true) {
-            //$this->_setup_redirect_for_next_step();
-            return true;
-            // On-Site payment?
-        } else if ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
-                //$this->_setup_redirect_for_next_step();
-                $this->checkout->continue_reg = false;
-            }
-            // Off-Site payment?
-        } else if ($this->checkout->payment_method->is_off_site()) {
-            // if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
-            if ($payment instanceof EE_Payment && $payment->redirect_url()) {
-                do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
-                $this->checkout->redirect      = true;
-                $this->checkout->redirect_form = $payment->redirect_form();
-                $this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
-                // set JSON response
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
-                // and lastly, let's bump the payment status to pending
-                $payment->set_status(EEM_Payment::status_id_pending);
-                $payment->save();
-            } else {
-                // not a payment
-                $this->checkout->continue_reg = false;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            // ummm ya... not Off-Line, not On-Site, not off-Site ????
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    _process_payment_status
-     *
-     * @access private
-     * @type    EE_Payment $payment
-     * @param string       $payment_occurs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
-    {
-        // off-line payment? carry on
-        if ($payment_occurs === EE_PMT_Base::offline) {
-            return true;
-        }
-        // verify payment validity
-        if ($payment instanceof EE_Payment) {
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
-            $msg = $payment->gateway_response();
-            // check results
-            switch ($payment->status()) {
-                // good payment
-                case EEM_Payment::status_id_approved :
-                    EE_Error::add_success(
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return true;
-                    break;
-                // slow payment
-                case EEM_Payment::status_id_pending :
-                    if (empty($msg)) {
-                        $msg = esc_html__(
-                            'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return true;
-                    break;
-                // don't wanna payment
-                case EEM_Payment::status_id_cancelled :
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'Payment cancelled. Please try again.',
-                            'Payment cancelled. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                    break;
-                // not enough payment
-                case EEM_Payment::status_id_declined :
-                    if (empty($msg)) {
-                        $msg = _n(
-                            'We\'re sorry but your payment was declined. Please try again.',
-                            'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
-                            count($this->checkout->available_payment_methods),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                    break;
-                // bad payment
-                case EEM_Payment::status_id_failed :
-                    if (! empty($msg)) {
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        return false;
-                    }
-                    // default to error below
-                    break;
-            }
-        }
-        // off-site payment gateway responses are too unreliable, so let's just assume that
-        // the payment processing is just running slower than the registrant's request
-        if ($payment_occurs === EE_PMT_Base::offsite) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully 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 false;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
-    /********************************************************************************************************/
-    /**
-     * process_gateway_response
-     * this is the return point for Off-Site Payment Methods
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
-     * otherwise, it will load up the last payment made for the TXN.
-     * If the payment retrieved looks good, it will then either:
-     *    complete the current step and allow advancement to the next reg step
-     *        or present the payment options again
-     *
-     * @access private
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public function process_gateway_response()
-    {
-        $payment = null;
-        // how have they chosen to pay?
-        $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        if (! $this->checkout->payment_method->is_off_site()) {
-            return false;
-        }
-        $this->_validate_offsite_return();
-        // DEBUG LOG
-        //$this->checkout->log(
-        //	__CLASS__, __FUNCTION__, __LINE__,
-        //	array(
-        //		'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-        //		'payment_method' => $this->checkout->payment_method,
-        //	),
-        //	true
-        //);
-        // verify TXN
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
-                $this->checkout->continue_reg = false;
-                return false;
-            }
-            $payment = $this->_process_off_site_payment($gateway);
-            $payment = $this->_process_cancelled_payments($payment);
-            $payment = $this->_validate_payment($payment);
-            // if payment was not declined by the payment gateway or cancelled by the registrant
-            if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
-                //$this->_setup_redirect_for_next_step();
-                // store that for later
-                $this->checkout->payment = $payment;
-                // mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
-                // because we will complete this step during the IPN processing then
-                if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
-                    $this->set_completed();
-                }
-                return true;
-            }
-        }
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
-        //	array( 'payment' => $payment )
-        //);
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     * _validate_return
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    private function _validate_offsite_return()
-    {
-        $TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
-        if ($TXN_ID !== $this->checkout->transaction->ID()) {
-            // Houston... we might have a problem
-            $invalid_TXN = false;
-            // first gather some info
-            $valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $primary_registrant = $valid_TXN instanceof EE_Transaction
-                ? $valid_TXN->primary_registration()
-                : null;
-            // let's start by retrieving the cart for this TXN
-            $cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
-            if ($cart instanceof EE_Cart) {
-                // verify that the current cart has tickets
-                $tickets = $cart->get_tickets();
-                if (empty($tickets)) {
-                    $invalid_TXN = true;
-                }
-            } else {
-                $invalid_TXN = true;
-            }
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
-                ? $primary_registrant->session_ID()
-                : null;
-            // validate current Session ID and compare against valid TXN session ID
-            if (
-                $invalid_TXN // if this is already true, then skip other checks
-                || EE_Session::instance()->id() === null
-                || (
-                    // WARNING !!!
-                    // this could be PayPal sending back duplicate requests (ya they do that)
-                    // or it **could** mean someone is simply registering AGAIN after having just done so
-                    // so now we need to determine if this current TXN looks valid or not
-                    // and whether this reg step has even been started ?
-                    EE_Session::instance()->id() === $valid_TXN_SID
-                    // really? you're half way through this reg step, but you never started it ?
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
-                )
-            ) {
-                $invalid_TXN = true;
-            }
-            if ($invalid_TXN) {
-                // is the valid TXN completed ?
-                if ($valid_TXN instanceof EE_Transaction) {
-                    // has this step even been started ?
-                    $reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
-                    if ($reg_step_completed !== false && $reg_step_completed !== true) {
-                        // so it **looks** like this is a double request from PayPal
-                        // so let's try to pick up where we left off
-                        $this->checkout->transaction = $valid_TXN;
-                        $this->checkout->refresh_all_entities(true);
-                        return;
-                    }
-                }
-                // you appear to be lost?
-                $this->_redirect_wayward_request($primary_registrant);
-            }
-        }
-    }
-
-
-    /**
-     * _redirect_wayward_request
-     *
-     * @access private
-     * @param \EE_Registration|null $primary_registrant
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _redirect_wayward_request(EE_Registration $primary_registrant)
-    {
-        if (! $primary_registrant instanceof EE_Registration) {
-            // try redirecting based on the current TXN
-            $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
-                ? $this->checkout->transaction->primary_registration()
-                : null;
-        }
-        if (! $primary_registrant instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // make sure transaction is not locked
-        $this->checkout->transaction->unlock();
-        wp_safe_redirect(
-            add_query_arg(
-                array(
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
-                ),
-                $this->checkout->thank_you_page_url
-            )
-        );
-        exit();
-    }
-
-
-    /**
-     * _process_off_site_payment
-     *
-     * @access private
-     * @param \EE_Offsite_Gateway $gateway
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
-    {
-        try {
-            $request_data = \EE_Registry::instance()->REQ->params();
-            // if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
-            $this->set_handle_IPN_in_this_request(
-                $gateway->handle_IPN_in_this_request($request_data, false)
-            );
-            if ($this->handle_IPN_in_this_request()) {
-                // get payment details and process results
-                /** @type EE_Payment_Processor $payment_processor */
-                $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                $payment           = $payment_processor->process_ipn(
-                    $request_data,
-                    $this->checkout->transaction,
-                    $this->checkout->payment_method,
-                    true,
-                    false
-                );
-                //$payment_source = 'process_ipn';
-            } else {
-                $payment = $this->checkout->transaction->last_payment();
-                //$payment_source = 'last_payment';
-            }
-        } catch (Exception $e) {
-            // let's just eat the exception and try to move on using any previously set payment info
-            $payment = $this->checkout->transaction->last_payment();
-            //$payment_source = 'last_payment after Exception';
-            // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-                $this->_handle_payment_processor_exception($e);
-            }
-        }
-        // DEBUG LOG
-        //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
-        //	array(
-        //		'process_ipn_payment' => $payment,
-        //		'payment_source'      => $payment_source,
-        //	)
-        //);
-        return $payment;
-    }
-
-
-    /**
-     * _process_cancelled_payments
-     * just makes sure that the payment status gets updated correctly
-     * so tha tan error isn't generated during payment validation
-     *
-     * @access private
-     * @param EE_Payment $payment
-     * @return EE_Payment | FALSE
-     * @throws \EE_Error
-     */
-    private function _process_cancelled_payments($payment = null)
-    {
-        if (
-            $payment instanceof EE_Payment
-            && isset($_REQUEST['ee_cancel_payment'])
-            && $payment->status() === EEM_Payment::status_id_failed
-        ) {
-            $payment->set_status(EEM_Payment::status_id_cancelled);
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    get_transaction_details_for_gateways
-     *
-     * @access    public
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function get_transaction_details_for_gateways()
-    {
-        $txn_details = array();
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $txn_details = array(
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
-            );
-        }
-        // get EE_Payment_Method object
-        if (
-            empty($txn_details)
-            &&
-            ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
-        ) {
-            $txn_details = array(
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                'error'                      => esc_html__(
-                    'A valid Payment Method could not be determined.',
-                    'event_espresso'
-                ),
-            );
-        }
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
-            $return_url  = $this->_get_return_url($this->checkout->payment_method);
-            $txn_details = array(
-                'TXN_ID'         => $this->checkout->transaction->ID(),
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
-                'TXN_total'      => $this->checkout->transaction->total(),
-                'TXN_paid'       => $this->checkout->transaction->paid(),
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
-                'payment_amount' => $this->checkout->amount_owing,
-                'return_url'     => $return_url,
-                'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
-                    array(
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
-                    )
-                ),
-            );
-        }
-        echo wp_json_encode($txn_details);
-        exit();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
-    }
+	/**
+	 * @access protected
+	 * @var EE_Line_Item_Display $Line_Item_Display
+	 */
+	protected $line_item_display;
+
+	/**
+	 * @access protected
+	 * @var boolean $handle_IPN_in_this_request
+	 */
+	protected $handle_IPN_in_this_request = false;
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_filter(
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
+		);
+		add_action(
+			'wp_ajax_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action(
+			'wp_ajax_nopriv_switch_spco_billing_form',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
+		);
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
+		add_action(
+			'wp_ajax_nopriv_save_payer_details',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
+		);
+		add_action(
+			'wp_ajax_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_action(
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
+		);
+		add_filter(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 *    ajax switch_spco_billing_form
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function switch_spco_billing_form()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
+	}
+
+
+	/**
+	 *    ajax save_payer_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function save_payer_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
+	}
+
+
+	/**
+	 *    ajax get_transaction_details
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function get_transaction_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
+	}
+
+
+	/**
+	 * bypass_recaptcha_for_load_payment_method
+	 *
+	 * @access public
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function bypass_recaptcha_for_load_payment_method()
+	{
+		return array(
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'spco_billing_form',
+		);
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug     = 'payment_options';
+		$this->_name     = esc_html__('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__(
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return null
+	 */
+	public function line_item_display()
+	{
+		return $this->line_item_display;
+	}
+
+
+	/**
+	 * @param null $line_item_display
+	 */
+	public function set_line_item_display($line_item_display)
+	{
+		$this->line_item_display = $line_item_display;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request()
+	{
+		return $this->handle_IPN_in_this_request;
+	}
+
+
+	/**
+	 * @param boolean $handle_IPN_in_this_request
+	 */
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request)
+	{
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * translate_js_strings
+	 *
+	 * @return void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+			'Please select a method of payment in order to continue.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+			'Forwarding to Secure Payment Provider.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * enqueue_styles_and_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		$transaction = $this->checkout->transaction;
+		//if the transaction isn't set or nothing is owed on it, don't enqueue any JS
+		if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+			return;
+		}
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
+			$type_obj = $payment_method->type_obj();
+			if ($type_obj instanceof EE_PMT_Base) {
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
+				if ($billing_form instanceof EE_Form_Section_Proper) {
+					$billing_form->enqueue_js();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * initialize_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function initialize_reg_step()
+	{
+		// TODO: if /when we implement donations, then this will need overriding
+		if (// don't need payment options for:
+			// 	registrations made via the admin
+			// 	completed transactions
+			// 	overpaid transactions
+			// 	$ 0.00 transactions (no payment required)
+			! $this->checkout->payment_required()
+			// but do NOT remove if current action being called belongs to this reg step
+			&& ! is_callable(array($this, $this->checkout->action))
+			&& ! $this->completed()
+		) {
+			// and if so, then we no longer need the Payment Options step
+			if ($this->is_current_step()) {
+				$this->checkout->generate_reg_form = false;
+			}
+			$this->checkout->remove_reg_step($this->_slug);
+			// DEBUG LOG
+			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			return false;
+		}
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		// get all active payment methods
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function generate_reg_form()
+	{
+		// reset in case someone changes their mind
+		$this->_reset_selected_method_of_payment();
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'payments_closed';
+		$registrations_requiring_payment            = array();
+		$registrations_for_free_events              = array();
+		$registrations_requiring_pre_approval       = array();
+		$sold_out_events                            = array();
+		$insufficient_spaces_available              = array();
+		$no_payment_required                        = true;
+		// loop thru registrations to gather info
+		$registrations         = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			$this->checkout->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[ $REG_ID ])) {
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				} else {
+					$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+				}
+				continue;
+			}
+			// event requires admin approval
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
+				// add event to list of events with pre-approval reg status
+				$registrations_requiring_pre_approval[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			if ($this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+				&& (
+					$registration->event()->is_sold_out()
+					|| $registration->event()->is_sold_out(true)
+				)
+			) {
+				// add event to list of events that are sold out
+				$sold_out_events[$registration->event()->ID()] = $registration->event();
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			// are they allowed to pay now and is there monies owing?
+			if ($registration->owes_monies_and_can_pay()) {
+				$registrations_requiring_payment[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
+					$registration->event(),
+					$this
+				);
+			} elseif (! $this->checkout->revisit
+				&& $registration->status_ID() !== EEM_Registration::status_id_not_approved
+				&& $registration->ticket()->is_free()
+			) {
+				$registrations_for_free_events[$registration->event()->ID()] = $registration;
+			}
+		}
+		$subsections = array();
+		// now decide which template to load
+		if (! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
+		}
+		if (! empty($insufficient_spaces_available)) {
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
+				$insufficient_spaces_available
+			);
+		}
+		if (! empty($registrations_requiring_pre_approval)) {
+			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
+				$registrations_requiring_pre_approval
+			);
+		}
+		if (! empty($registrations_for_free_events)) {
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
+		}
+		if (! empty($registrations_requiring_payment)) {
+			if ($this->checkout->amount_owing > 0) {
+				// autoload Line_Item_Display classes
+				EEH_Autoloader::register_line_item_filter_autoloaders();
+				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
+					apply_filters(
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+						new EE_Line_Item_Filter_Collection()
+					),
+					$this->checkout->cart->get_grand_total()
+				);
+				/** @var EE_Line_Item $filtered_line_item_tree */
+				$filtered_line_item_tree = $line_item_filter_processor->process();
+				EEH_Autoloader::register_line_item_display_autoloaders();
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
+				$subsections['payment_options'] = $this->_display_payment_options(
+					$this->line_item_display->display_line_item(
+						$filtered_line_item_tree,
+						array('registrations' => $registrations)
+					)
+				);
+				$this->checkout->amount_owing   = $filtered_line_item_tree->total();
+				$this->_apply_registration_payments_to_amount_owing($registrations);
+			}
+			$no_payment_required = false;
+		} else {
+			$this->_hide_reg_step_submit_button_if_revisit();
+		}
+		$this->_save_selected_method_of_payment();
+
+		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
+		$subsections['extra_hidden_inputs']   = $this->_extra_hidden_inputs($no_payment_required);
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => new EE_No_Layout(),
+			)
+		);
+	}
+
+
+	/**
+	 * add line item filters required for this reg step
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
+	 *        filter collection by passing that instead of instantiating a new collection
+	 *
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filter_collection
+	 * @return EE_Line_Item_Filter_Collection
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
+	{
+		if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+			return $line_item_filter_collection;
+		}
+		if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+			return $line_item_filter_collection;
+		}
+		$line_item_filter_collection->add(
+			new EE_Billable_Line_Item_Filter(
+				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
+					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+					)
+				)
+			)
+		);
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
+		return $line_item_filter_collection;
+	}
+
+
+	/**
+	 * remove_ejected_registrations
+	 * if a registrant has lost their potential space at an event due to lack of payment,
+	 * then this method removes them from the list of registrations being paid for during this request
+	 *
+	 * @param \EE_Registration[] $registrations
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function remove_ejected_registrations(array $registrations)
+	{
+		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+			$registrations,
+			EE_Registry::instance()->SSN->checkout()->revisit
+		);
+		foreach ($registrations as $REG_ID => $registration) {
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[$REG_ID])) {
+				unset($registrations[$REG_ID]);
+				continue;
+			}
+		}
+		return $registrations;
+	}
+
+
+	/**
+	 * find_registrations_that_lost_their_space
+	 * If a registrant chooses an offline payment method like Invoice,
+	 * then no space is reserved for them at the event until they fully pay fo that site
+	 * (unless the event's default reg status is set to APPROVED)
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
+	 *
+	 * @param \EE_Registration[] $registrations
+	 * @param bool               $revisit
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
+	{
+		// registrations per event
+		$event_reg_count = array();
+		// spaces left per event
+		$event_spaces_remaining = array();
+		// tickets left sorted by ID
+		$tickets_remaining = array();
+		// registrations that have lost their space
+		$ejected_registrations = array();
+		foreach ($registrations as $REG_ID => $registration) {
+			if ($registration->status_ID() === EEM_Registration::status_id_approved
+				|| apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
+					false,
+					$registration,
+					$revisit
+				)
+			) {
+				continue;
+			}
+			$EVT_ID = $registration->event_ID();
+			$ticket = $registration->ticket();
+			if (! isset($tickets_remaining[$ticket->ID()])) {
+				$tickets_remaining[$ticket->ID()] = $ticket->remaining();
+			}
+			if ($tickets_remaining[$ticket->ID()] > 0) {
+				if (! isset($event_reg_count[$EVT_ID])) {
+					$event_reg_count[$EVT_ID] = 0;
+				}
+				$event_reg_count[$EVT_ID]++;
+				if (! isset($event_spaces_remaining[$EVT_ID])) {
+					$event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
+				}
+			}
+			if ($revisit
+				&& ($tickets_remaining[$ticket->ID()] === 0
+					|| $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
+				)
+			) {
+				$ejected_registrations[$REG_ID] = $registration->event();
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->manually_update_registration_status(
+						$registration,
+						EEM_Registration::status_id_wait_list
+					);
+				}
+			}
+		}
+		return $ejected_registrations;
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _adjust_registration_status_if_event_old_sold()
+	{
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _hide_reg_step_submit_button_if_revisit()
+	{
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
+		}
+	}
+
+
+	/**
+	 * sold_out_events
+	 * displays notices regarding events that have sold out since hte registrant first signed up
+	 *
+	 * @param \EE_Event[] $sold_out_events_array
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _sold_out_events($sold_out_events_array = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'events_sold_out';
+		$sold_out_events                            = '';
+		foreach ($sold_out_events_array as $sold_out_event) {
+			$sold_out_events .= EEH_HTML::li(
+				EEH_HTML::span(
+					'  ' . $sold_out_event->name(),
+					'',
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
+				)
+			);
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'sold_out_events'     => $sold_out_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
+									sprintf(
+										esc_html__(
+											'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%2$s',
+											'event_espresso'
+										),
+										'<strong>',
+										'</strong>',
+										'<br />'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _insufficient_spaces_available
+	 * displays notices regarding events that do not have enough remaining spaces
+	 * to satisfy the current number of registrations looking to pay
+	 *
+	 * @param \EE_Event[] $insufficient_spaces_events_array
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'invoice';
+		$insufficient_space_events                  = '';
+		foreach ($insufficient_spaces_events_array as $event) {
+			if ($event instanceof EE_Event) {
+				$insufficient_space_events .= EEH_HTML::li(
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => array(
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
+				),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
+							array(
+								'sold_out_events'     => $insufficient_space_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
+									esc_html__(
+										'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+										'event_espresso'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * registrations_requiring_pre_approval
+	 *
+	 * @param array $registrations_requiring_pre_approval
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array())
+	{
+		$events_requiring_pre_approval = '';
+		foreach ($registrations_requiring_pre_approval as $registration) {
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
+				$events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
+					EEH_HTML::span(
+						'',
+						'',
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
+					)
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'events_requiring_pre_approval.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							array(
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
+								'events_requiring_pre_approval_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
+									esc_html__(
+										'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
+										'event_espresso'
+									)
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _no_payment_required
+	 *
+	 * @param \EE_Event[] $registrations_for_free_events
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _no_payment_required($registrations_for_free_events = array())
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
+		// generate no_payment_required form
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . DS
+												  . 'no_payment_required.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
+							array(
+								'revisit'                       => $this->checkout->revisit,
+								'registrations'                 => array(),
+								'ticket_count'                  => array(),
+								'registrations_for_free_events' => $registrations_for_free_events,
+								'no_payment_required_msg'       => EEH_HTML::p(
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
+								),
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _display_payment_options
+	 *
+	 * @param string $transaction_details
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _display_payment_options($transaction_details = '')
+	{
+		// has method_of_payment been set by no-js user?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
+		// build payment options form
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
+			new EE_Form_Section_Proper(
+				array(
+					'subsections'     => array(
+						'before_payment_options' => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
+							new EE_Form_Section_Proper(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+						'payment_options'        => $this->_setup_payment_options(),
+						'after_payment_options'  => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
+							new EE_Form_Section_Proper(
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
+							)
+						),
+					),
+					'layout_strategy' => new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template,
+							'template_args'        => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
+								array(
+									'reg_count'                 => $this->line_item_display->total_items(),
+									'transaction_details'       => $transaction_details,
+									'available_payment_methods' => array(),
+								)
+							),
+						)
+					),
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * _extra_hidden_inputs
+	 *
+	 * @param bool $no_payment_required
+	 * @return \EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _extra_hidden_inputs($no_payment_required = true)
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'spco_no_payment_required' => new EE_Hidden_Input(
+						array(
+							'normalization_strategy' => new EE_Boolean_Normalization(),
+							'html_name'              => 'spco_no_payment_required',
+							'html_id'                => 'spco-no-payment-required-payment_options',
+							'default'                => $no_payment_required,
+						)
+					),
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
+						array(
+							'normalization_strategy' => new EE_Int_Normalization(),
+							'html_name'              => 'spco_transaction_id',
+							'html_id'                => 'spco-transaction-id',
+							'default'                => $this->checkout->transaction->ID(),
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 *    _apply_registration_payments_to_amount_owing
+	 *
+	 * @access protected
+	 * @param array $registrations
+	 * @throws EE_Error
+	 */
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
+	{
+		$payments = array();
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
+				$payments += $registration->registration_payments();
+			}
+		}
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
+					$this->checkout->amount_owing -= $payment->amount();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    _reset_selected_method_of_payment
+	 *
+	 * @access    private
+	 * @param    bool $force_reset
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _reset_selected_method_of_payment($force_reset = false)
+	{
+		$reset_payment_method = $force_reset
+			? true
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
+		if ($reset_payment_method) {
+			$this->checkout->selected_method_of_payment = null;
+			$this->checkout->payment_method             = null;
+			$this->checkout->billing_form               = null;
+			$this->_save_selected_method_of_payment();
+		}
+	}
+
+
+	/**
+	 * _save_selected_method_of_payment
+	 * stores the selected_method_of_payment in the session
+	 * so that it's available for all subsequent requests including AJAX
+	 *
+	 * @access        private
+	 * @param string $selected_method_of_payment
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_selected_method_of_payment($selected_method_of_payment = '')
+	{
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
+			? $selected_method_of_payment
+			: $this->checkout->selected_method_of_payment;
+		EE_Registry::instance()->SSN->set_session_data(
+			array('selected_method_of_payment' => $selected_method_of_payment)
+		);
+	}
+
+
+	/**
+	 * _setup_payment_options
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function _setup_payment_options()
+	{
+		// load payment method classes
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
+		if (empty($this->checkout->available_payment_methods)) {
+			EE_Error::add_error(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
+					sprintf(
+						esc_html__(
+							'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
+							'event_espresso'
+						),
+						'<br>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// switch up header depending on number of available payment methods
+		$payment_method_header     = count($this->checkout->available_payment_methods) > 1
+			? apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
+			)
+			: apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Method of Payment', 'event_espresso')
+			);
+		$available_payment_methods = array(
+			// display the "Payment Method" header
+			'payment_method_header' => new EE_Form_Section_HTML(
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
+			),
+		);
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
+		$available_payment_method_options = array();
+		$default_payment_method_option    = array();
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
+		$payment_methods_billing_info = array(
+			new EE_Form_Section_HTML(
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
+			),
+		);
+		// loop through payment methods
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$payment_method_button = EEH_HTML::img(
+					$payment_method->button_url(),
+					$payment_method->name(),
+					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+					'spco-payment-method-btn-img'
+				);
+				// check if any payment methods are set as default
+				// if payment method is already selected OR nothing is selected and this payment method should be
+				// open_by_default
+				if (($this->checkout->selected_method_of_payment === $payment_method->slug())
+					|| (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+				) {
+					$this->checkout->selected_method_of_payment = $payment_method->slug();
+					$this->_save_selected_method_of_payment();
+					$default_payment_method_option[$payment_method->slug()] = $payment_method_button;
+				} else {
+					$available_payment_method_options[$payment_method->slug()] = $payment_method_button;
+				}
+				$payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
+					$payment_method
+				);
+			}
+		}
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
+		// of PMs
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
+		// now generate the actual form  inputs
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
+			$available_payment_method_options
+		);
+		$available_payment_methods                              += $payment_methods_billing_info;
+		// build the available payment methods form
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'spco-available-methods-of-payment-dv',
+				'subsections'     => $available_payment_methods,
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+			)
+		);
+	}
+
+
+	/**
+	 * _get_available_payment_methods
+	 *
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _get_available_payment_methods()
+	{
+		if (! empty($this->checkout->available_payment_methods)) {
+			return $this->checkout->available_payment_methods;
+		}
+		$available_payment_methods = array();
+		// load EEM_Payment_Method
+		EE_Registry::instance()->load_model('Payment_Method');
+		/** @type EEM_Payment_Method $EEM_Payment_Method */
+		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+		// get all active payment methods
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$available_payment_methods[$payment_method->slug()] = $payment_method;
+			}
+		}
+		return $available_payment_methods;
+	}
+
+
+	/**
+	 *    _available_payment_method_inputs
+	 *
+	 * @access    private
+	 * @param    array $available_payment_method_options
+	 * @return    \EE_Form_Section_Proper
+	 */
+	private function _available_payment_method_inputs($available_payment_method_options = array())
+	{
+		// generate inputs
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'ee-available-payment-method-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'' => new EE_Radio_Button_Input(
+						$available_payment_method_options,
+						array(
+							'html_name'          => 'selected_method_of_payment',
+							'html_class'         => 'spco-payment-method',
+							'default'            => $this->checkout->selected_method_of_payment,
+							'label_size'         => 11,
+							'enforce_label_size' => true,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 *    _payment_method_billing_info
+	 *
+	 * @access    private
+	 * @param    EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
+	{
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
+			? true
+			: false;
+		// generate the billing form for payment method
+		$billing_form                 = $currently_selected
+			? $this->_get_billing_form_for_payment_method($payment_method)
+			: new EE_Form_Section_HTML();
+		$this->checkout->billing_form = $currently_selected
+			? $billing_form
+			: $this->checkout->billing_form;
+		// it's all in the details
+		$info_html = EEH_HTML::h3(
+			esc_html__('Important information regarding your payment', 'event_espresso'),
+			'',
+			'spco-payment-method-hdr'
+		);
+		// add some info regarding the step, either from what's saved in the admin,
+		// or a default string depending on whether the PM has a billing form or not
+		if ($payment_method->description()) {
+			$payment_method_info = $payment_method->description();
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
+			$payment_method_info = sprintf(
+				esc_html__(
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
+					'event_espresso'
+				),
+				$this->submit_button_text()
+			);
+		} else {
+			$payment_method_info = sprintf(
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
+				$this->submit_button_text()
+			);
+		}
+		$info_html .= EEH_HTML::p(
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
+				$payment_method_info
+			),
+			'',
+			'spco-payment-method-desc ee-attention'
+		);
+		return new EE_Form_Section_Proper(
+			array(
+				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+				'html_class'      => 'spco-payment-method-info-dv',
+				// only display the selected or default PM
+				'html_style'      => $currently_selected ? '' : 'display:none;',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => array(
+					'info'         => new EE_Form_Section_HTML($info_html),
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * get_billing_form_html_for_payment_method
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_billing_form_html_for_payment_method()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		$this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			return false;
+		}
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+			false
+		)) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// now generate billing form for selected method of payment
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
+		// fill form with attendee info if applicable
+		if ($payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& $this->checkout->transaction_has_primary_registrant()
+		) {
+			$payment_method_billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if ($payment_method_billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$payment_method_billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$payment_method_billing_form
+				);
+		}
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
+			? $payment_method_billing_form->get_html()
+			: '';
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
+		// localize validation rules for main form
+		$this->checkout->current_step->reg_form->localize_validation_rules();
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		return true;
+	}
+
+
+	/**
+	 * _get_billing_form_for_payment_method
+	 *
+	 * @access private
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
+	{
+		$billing_form = $payment_method->type_obj()->billing_form(
+			$this->checkout->transaction,
+			array('amount_owing' => $this->checkout->amount_owing)
+		);
+		if ($billing_form instanceof EE_Billing_Info_Form) {
+			if (apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+				false
+			)
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
+			) {
+				EE_Error::add_success(
+					apply_filters(
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+						sprintf(
+							esc_html__(
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
+								'event_espresso'
+							),
+							$payment_method->name()
+						)
+					)
+				);
+			}
+			return apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+				$billing_form,
+				$payment_method
+			);
+		}
+		// no actual billing form, so return empty HTML form section
+		return new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _get_selected_method_of_payment
+	 *
+	 * @access private
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
+	 *                          is not found in the incoming request
+	 * @param string  $request_param
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_selected_method_of_payment(
+		$required = false,
+		$request_param = 'selected_method_of_payment'
+	) {
+		// is selected_method_of_payment set in the request ?
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
+		if ($selected_method_of_payment) {
+			// sanitize it
+			$selected_method_of_payment = is_array($selected_method_of_payment)
+				? array_shift($selected_method_of_payment)
+				: $selected_method_of_payment;
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
+			// store it in the session so that it's available for all subsequent requests including AJAX
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
+		} else {
+			// or is is set in the session ?
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
+				'selected_method_of_payment'
+			);
+		}
+		// do ya really really gotta have it?
+		if (empty($selected_method_of_payment) && $required) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $selected_method_of_payment;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
+	/********************************************************************************************************/
+	/**
+	 * switch_payment_method
+	 *
+	 * @access public
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function switch_payment_method()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return false;
+		}
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
+			false
+		)) {
+			EE_Error::add_success(
+				apply_filters(
+					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// fill form with attendee info if applicable
+		if (apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			(
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $this->checkout->transaction_has_primary_registrant()
+			),
+			$this->checkout->billing_form,
+			$this->checkout->transaction
+		)
+		) {
+			$this->checkout->billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+		) {
+			$this->checkout->billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$this->checkout->billing_form
+				);
+		}
+		// get html and validation rules for form
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->json_response->set_return_data(
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
+			);
+			// localize validation rules for main form
+			$this->checkout->billing_form->localize_validation_rules(true);
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+		} else {
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
+		}
+		//prevents advancement to next step
+		$this->checkout->continue_reg = false;
+		return true;
+	}
+
+
+	/**
+	 * _verify_payment_method_is_set
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _verify_payment_method_is_set()
+	{
+		// generate billing form for selected method of payment if it hasn't been done already
+		if (empty($this->checkout->selected_method_of_payment)) {
+			// how have they chosen to pay?
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		} else {
+			// choose your own adventure based on method_of_payment
+			switch ($this->checkout->selected_method_of_payment) {
+				case 'events_sold_out' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				case 'payments_closed' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				case 'no_payment_required' :
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
+							esc_html__(
+								'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.',
+								'event_espresso'
+							)
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+					return false;
+					break;
+				default:
+			}
+		}
+		// verify payment method
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			// get payment method for selected method of payment
+			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
+		}
+		return $this->checkout->payment_method instanceof EE_Payment_Method ? true : false;
+	}
+
+
+
+	/********************************************************************************************************/
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * save_payer_details_via_ajax
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function save_payer_details_via_ajax()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return;
+		}
+		// generate billing form for selected method of payment if it hasn't been done already
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// generate primary attendee from payer info if applicable
+		if (! $this->checkout->transaction_has_primary_registrant()) {
+			$attendee = $this->_create_attendee_from_request_data();
+			if ($attendee instanceof EE_Attendee) {
+				foreach ($this->checkout->transaction->registrations() as $registration) {
+					if ($registration->is_primary_registrant()) {
+						$this->checkout->primary_attendee_obj = $attendee;
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * create_attendee_from_request_data
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _create_attendee_from_request_data()
+	{
+		// get State ID
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
+		if (! empty($STA_ID)) {
+			// can we get state object from name ?
+			EE_Registry::instance()->load_model('State');
+			$state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
+		}
+		// get Country ISO
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
+		if (! empty($CNT_ISO)) {
+			// can we get country object from name ?
+			EE_Registry::instance()->load_model('Country');
+			$country = EEM_Country::instance()->get_col(
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
+				'CNT_ISO'
+			);
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
+		}
+		// grab attendee data
+		$attendee_data = array(
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
+			'STA_ID'       => $STA_ID,
+			'CNT_ISO'      => $CNT_ISO,
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
+		);
+		// validate the email address since it is the most important piece of info
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
+			EE_Error::add_error(
+				esc_html__('An invalid email address was submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// does this attendee already exist in the db ? we're searching using a combination of first name, last name,
+		// AND email address
+		if (! empty($attendee_data['ATT_fname'])
+			&& ! empty($attendee_data['ATT_lname'])
+			&& ! empty($attendee_data['ATT_email'])
+		) {
+			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
+				array(
+					'ATT_fname' => $attendee_data['ATT_fname'],
+					'ATT_lname' => $attendee_data['ATT_lname'],
+					'ATT_email' => $attendee_data['ATT_email'],
+				)
+			);
+			if ($existing_attendee instanceof EE_Attendee) {
+				return $existing_attendee;
+			}
+		}
+		// no existing attendee? kk let's create a new one
+		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those
+		// don't exist
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
+			? $attendee_data['ATT_fname']
+			: $attendee_data['ATT_email'];
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: $attendee_data['ATT_email'];
+		return EE_Attendee::new_instance($attendee_data);
+	}
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  *****************************************/
+	/********************************************************************************************************/
+	/**
+	 * process_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function process_reg_step()
+	{
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
+			? 'no_payment_required'
+			: $this->_get_selected_method_of_payment(true);
+		// choose your own adventure based on method_of_payment
+		switch ($this->checkout->selected_method_of_payment) {
+
+			case 'events_sold_out' :
+				$this->checkout->redirect     = true;
+				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+				// mark this reg step as completed
+				$this->set_completed();
+				return false;
+				break;
+
+			case 'payments_closed' :
+				if (apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
+					false
+				)) {
+					EE_Error::add_success(
+						esc_html__('no payment required at this time.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+				break;
+
+			case 'no_payment_required' :
+				if (apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
+					false
+				)) {
+					EE_Error::add_success(
+						esc_html__('no payment required.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+				break;
+
+			default:
+				$registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+				);
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+					$registrations,
+					EE_Registry::instance()->SSN->checkout()->revisit
+				);
+				// calculate difference between the two arrays
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
+					$this->_redirect_because_event_sold_out();
+					return false;
+				}
+				$payment_successful = $this->_process_payment();
+				if ($payment_successful) {
+					$this->checkout->continue_reg = true;
+					$this->_maybe_set_completed($this->checkout->payment_method);
+				} else {
+					$this->checkout->continue_reg = false;
+				}
+				return $payment_successful;
+		}
+	}
+
+
+	/**
+	 * _redirect_because_event_sold_out
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _redirect_because_event_sold_out()
+	{
+		$this->checkout->continue_reg = false;
+		// set redirect URL
+		$this->checkout->redirect_url = add_query_arg(
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
+			$this->checkout->current_step->reg_step_url()
+		);
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+	}
+
+
+	/**
+	 * _maybe_set_completed
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method)
+	{
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite :
+				break;
+			case EE_PMT_Base::onsite :
+			case EE_PMT_Base::offline :
+				// mark this reg step as completed
+				$this->set_completed();
+				break;
+		}
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to retry a payment
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidStatusException
+	 */
+	public function update_reg_step()
+	{
+		$success = true;
+		// if payment required
+		if ($this->checkout->transaction->total() > 0) {
+			do_action(
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
+				$this->checkout->transaction
+			);
+			// attempt payment via payment method
+			$success = $this->process_reg_step();
+		}
+		if ($success && ! $this->checkout->redirect) {
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
+				$this->checkout->transaction->ID()
+			);
+			// set return URL
+			$this->checkout->redirect_url = add_query_arg(
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
+				$this->checkout->thank_you_page_url
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 *    _process_payment
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_payment()
+	{
+		// basically confirm that the event hasn't sold out since they hit the page
+		if (! $this->_last_second_ticket_verifications()) {
+			return false;
+		}
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$this->checkout->json_response->set_plz_select_method_of_payment(
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
+			);
+			return false;
+		}
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			return false;
+		}
+		// setup billing form
+		if ($this->checkout->payment_method->is_on_site()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+			// bad billing form ?
+			if (! $this->_billing_form_is_valid()) {
+				return false;
+			}
+		}
+		// ensure primary registrant has been fully processed
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
+			return false;
+		}
+		// if session is close to expiring (under 10 minutes by default)
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
+			// add some time to session expiration so that payment can be completed
+			EE_Registry::instance()->SSN->extend_expiration();
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		//$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations
+		// for events with a default reg status of Approved
+		// $transaction_processor->toggle_registration_statuses_for_default_approved_events(
+		//      $this->checkout->transaction, $this->checkout->reg_cache_where_params
+		// );
+		// attempt payment
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
+		// process results
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
+		// verify payment
+		if ($payment instanceof EE_Payment) {
+			// store that for later
+			$this->checkout->payment = $payment;
+			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
+			$this->checkout->transaction->toggle_failed_transaction_status();
+			$payment_status = $payment->status();
+			if (
+				$payment_status === EEM_Payment::status_id_approved
+				|| $payment_status === EEM_Payment::status_id_pending
+			) {
+				return true;
+			} else {
+				return false;
+			}
+		} else if ($payment === true) {
+			// please note that offline payment methods will NOT make a payment,
+			// but instead just mark themselves as the PMD_ID on the transaction, and return true
+			$this->checkout->payment = $payment;
+			return true;
+		}
+		// where's my money?
+		return false;
+	}
+
+
+	/**
+	 * _last_second_ticket_verifications
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _last_second_ticket_verifications()
+	{
+		// don't bother re-validating if not a return visit
+		if (! $this->checkout->revisit) {
+			return true;
+		}
+		$registrations = $this->checkout->transaction->registrations();
+		if (empty($registrations)) {
+			return false;
+		}
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$event = $registration->event_obj();
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
+					EE_Error::add_error(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
+							sprintf(
+								esc_html__(
+									'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+									'event_espresso'
+								),
+								$event->name()
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * redirect_form
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function redirect_form()
+	{
+		$payment_method_billing_info = $this->_payment_method_billing_info(
+			$this->_get_payment_method_for_selected_method_of_payment()
+		);
+		$html                        = $payment_method_billing_info->get_html();
+		$html                        .= $this->checkout->redirect_form;
+		EE_Registry::instance()->REQ->add_output($html);
+		return true;
+	}
+
+
+	/**
+	 * _billing_form_is_valid
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	private function _billing_form_is_valid()
+	{
+		if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+			return true;
+		}
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
+			if ($this->checkout->billing_form->was_submitted()) {
+				$this->checkout->billing_form->receive_form_submission();
+				if ($this->checkout->billing_form->is_valid()) {
+					return true;
+				}
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
+				$error_strings     = array();
+				foreach ($validation_errors as $validation_error) {
+					if ($validation_error instanceof EE_Validation_Error) {
+						$form_section = $validation_error->get_form_section();
+						if ($form_section instanceof EE_Form_Input_Base) {
+							$label = $form_section->html_label_text();
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
+							$label = $form_section->name();
+						} else {
+							$label = esc_html__('Validation Error', 'event_espresso');
+						}
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
+					}
+				}
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
+							'event_espresso'
+						),
+						'<br/>',
+						implode('<br/>', $error_strings)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'The billing form was not submitted or something prevented it\'s submission.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * _setup_primary_registrant_prior_to_payment
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
+	 * yet)
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _setup_primary_registrant_prior_to_payment()
+	{
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		// if not, then we need to at least gather some primary registrant data before attempting payment
+		if (
+			$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& ! $this->checkout->transaction_has_primary_registrant()
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
+		) {
+			return false;
+		}
+		// because saving an object clears it's cache, we need to do the chevy shuffle
+		// grab the primary_registration object
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		// at this point we'll consider a TXN to not have been failed
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// save the TXN ( which clears cached copy of primary_registration)
+		$this->checkout->transaction->save();
+		// grab TXN ID and save it to the primary_registration
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
+		// save what we have so far
+		$primary_registration->save();
+		return true;
+	}
+
+
+	/**
+	 * _capture_primary_registration_data_from_billing_form
+	 *
+	 * @access private
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _capture_primary_registration_data_from_billing_form()
+	{
+		// convert billing form data into an attendee
+		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
+		if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The billing form details could not be used for attendee details 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 false;
+		}
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		if (! $primary_registration instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant for this transaction 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 false;
+		}
+		if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+			  instanceof
+			  EE_Attendee
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant could not be associated with this transaction 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 false;
+		}
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
+		return true;
+	}
+
+
+	/**
+	 * _get_payment_method_for_selected_method_of_payment
+	 * retrieves a valid payment method
+	 *
+	 * @access public
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _get_payment_method_for_selected_method_of_payment()
+	{
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
+			$this->_redirect_because_event_sold_out();
+			return null;
+		}
+		// get EE_Payment_Method object
+		if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
+			$payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
+		} else {
+			// load EEM_Payment_Method
+			EE_Registry::instance()->load_model('Payment_Method');
+			/** @type EEM_Payment_Method $EEM_Payment_Method */
+			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
+			$payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
+		}
+		// verify $payment_method
+		if (! $payment_method instanceof EE_Payment_Method) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment 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;
+		}
+		// and verify it has a valid Payment_Method Type object
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'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;
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 *    _attempt_payment
+	 *
+	 * @access    private
+	 * @type    EE_Payment_Method $payment_method
+	 * @return mixed EE_Payment | boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _attempt_payment(EE_Payment_Method $payment_method)
+	{
+		$payment = null;
+		$this->checkout->transaction->save();
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		if (! $payment_processor instanceof EE_Payment_Processor) {
+			return false;
+		}
+		try {
+			$payment_processor->set_revisit($this->checkout->revisit);
+			// generate payment object
+			$payment = $payment_processor->process_payment(
+				$payment_method,
+				$this->checkout->transaction,
+				$this->checkout->amount_owing,
+				$this->checkout->billing_form,
+				$this->_get_return_url($payment_method),
+				'CART',
+				$this->checkout->admin_request,
+				true,
+				$this->reg_step_url()
+			);
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _handle_payment_processor_exception
+	 *
+	 * @access protected
+	 * @param \Exception $e
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _handle_payment_processor_exception(Exception $e)
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$e->getMessage(),
+				$e->getFile(),
+				$e->getLine()
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _get_return_url
+	 *
+	 * @access protected
+	 * @param \EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_return_url(EE_Payment_Method $payment_method)
+	{
+		$return_url = '';
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite :
+				$return_url = add_query_arg(
+					array(
+						'action'                     => 'process_gateway_response',
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+						'spco_txn'                   => $this->checkout->transaction->ID(),
+					),
+					$this->reg_step_url()
+				);
+				break;
+			case EE_PMT_Base::onsite :
+			case EE_PMT_Base::offline :
+				$return_url = $this->checkout->next_step->reg_step_url();
+				break;
+		}
+		return $return_url;
+	}
+
+
+	/**
+	 * _validate_payment
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _validate_payment($payment = null)
+	{
+		if ($this->checkout->payment_method->is_off_line()) {
+			return true;
+		}
+		// verify payment object
+		if (! $payment instanceof EE_Payment) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _post_payment_processing
+	 *
+	 * @access private
+	 * @param EE_Payment|bool $payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _post_payment_processing($payment = null)
+	{
+		// Off-Line payment?
+		if ($payment === true) {
+			//$this->_setup_redirect_for_next_step();
+			return true;
+			// On-Site payment?
+		} else if ($this->checkout->payment_method->is_on_site()) {
+			if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+				//$this->_setup_redirect_for_next_step();
+				$this->checkout->continue_reg = false;
+			}
+			// Off-Site payment?
+		} else if ($this->checkout->payment_method->is_off_site()) {
+			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
+				$this->checkout->redirect      = true;
+				$this->checkout->redirect_form = $payment->redirect_form();
+				$this->checkout->redirect_url  = $this->reg_step_url('redirect_form');
+				// set JSON response
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
+				// and lastly, let's bump the payment status to pending
+				$payment->set_status(EEM_Payment::status_id_pending);
+				$payment->save();
+			} else {
+				// not a payment
+				$this->checkout->continue_reg = false;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'It appears the Off Site Payment Method was not configured properly.%sPlease try again or contact %s for assistance.',
+							'event_espresso'
+						),
+						'<br/>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			// ummm ya... not Off-Line, not On-Site, not off-Site ????
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    _process_payment_status
+	 *
+	 * @access private
+	 * @type    EE_Payment $payment
+	 * @param string       $payment_occurs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
+	{
+		// off-line payment? carry on
+		if ($payment_occurs === EE_PMT_Base::offline) {
+			return true;
+		}
+		// verify payment validity
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
+			$msg = $payment->gateway_response();
+			// check results
+			switch ($payment->status()) {
+				// good payment
+				case EEM_Payment::status_id_approved :
+					EE_Error::add_success(
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return true;
+					break;
+				// slow payment
+				case EEM_Payment::status_id_pending :
+					if (empty($msg)) {
+						$msg = esc_html__(
+							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
+							'event_espresso'
+						);
+					}
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
+					return true;
+					break;
+				// don't wanna payment
+				case EEM_Payment::status_id_cancelled :
+					if (empty($msg)) {
+						$msg = _n(
+							'Payment cancelled. Please try again.',
+							'Payment cancelled. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+					break;
+				// not enough payment
+				case EEM_Payment::status_id_declined :
+					if (empty($msg)) {
+						$msg = _n(
+							'We\'re sorry but your payment was declined. Please try again.',
+							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
+							count($this->checkout->available_payment_methods),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+					break;
+				// bad payment
+				case EEM_Payment::status_id_failed :
+					if (! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						return false;
+					}
+					// default to error below
+					break;
+			}
+		}
+		// off-site payment gateway responses are too unreliable, so let's just assume that
+		// the payment processing is just running slower than the registrant's request
+		if ($payment_occurs === EE_PMT_Base::offsite) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully 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 false;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
+	/********************************************************************************************************/
+	/**
+	 * process_gateway_response
+	 * this is the return point for Off-Site Payment Methods
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
+	 * otherwise, it will load up the last payment made for the TXN.
+	 * If the payment retrieved looks good, it will then either:
+	 *    complete the current step and allow advancement to the next reg step
+	 *        or present the payment options again
+	 *
+	 * @access private
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public function process_gateway_response()
+	{
+		$payment = null;
+		// how have they chosen to pay?
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		if (! $this->checkout->payment_method->is_off_site()) {
+			return false;
+		}
+		$this->_validate_offsite_return();
+		// DEBUG LOG
+		//$this->checkout->log(
+		//	__CLASS__, __FUNCTION__, __LINE__,
+		//	array(
+		//		'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+		//		'payment_method' => $this->checkout->payment_method,
+		//	),
+		//	true
+		//);
+		// verify TXN
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
+			if (! $gateway instanceof EE_Offsite_Gateway) {
+				$this->checkout->continue_reg = false;
+				return false;
+			}
+			$payment = $this->_process_off_site_payment($gateway);
+			$payment = $this->_process_cancelled_payments($payment);
+			$payment = $this->_validate_payment($payment);
+			// if payment was not declined by the payment gateway or cancelled by the registrant
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
+				//$this->_setup_redirect_for_next_step();
+				// store that for later
+				$this->checkout->payment = $payment;
+				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
+				// because we will complete this step during the IPN processing then
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
+					$this->set_completed();
+				}
+				return true;
+			}
+		}
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
+		//	array( 'payment' => $payment )
+		//);
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 * _validate_return
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	private function _validate_offsite_return()
+	{
+		$TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
+			// Houston... we might have a problem
+			$invalid_TXN = false;
+			// first gather some info
+			$valid_TXN          = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$primary_registrant = $valid_TXN instanceof EE_Transaction
+				? $valid_TXN->primary_registration()
+				: null;
+			// let's start by retrieving the cart for this TXN
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
+			if ($cart instanceof EE_Cart) {
+				// verify that the current cart has tickets
+				$tickets = $cart->get_tickets();
+				if (empty($tickets)) {
+					$invalid_TXN = true;
+				}
+			} else {
+				$invalid_TXN = true;
+			}
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
+				? $primary_registrant->session_ID()
+				: null;
+			// validate current Session ID and compare against valid TXN session ID
+			if (
+				$invalid_TXN // if this is already true, then skip other checks
+				|| EE_Session::instance()->id() === null
+				|| (
+					// WARNING !!!
+					// this could be PayPal sending back duplicate requests (ya they do that)
+					// or it **could** mean someone is simply registering AGAIN after having just done so
+					// so now we need to determine if this current TXN looks valid or not
+					// and whether this reg step has even been started ?
+					EE_Session::instance()->id() === $valid_TXN_SID
+					// really? you're half way through this reg step, but you never started it ?
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
+				)
+			) {
+				$invalid_TXN = true;
+			}
+			if ($invalid_TXN) {
+				// is the valid TXN completed ?
+				if ($valid_TXN instanceof EE_Transaction) {
+					// has this step even been started ?
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
+						// so it **looks** like this is a double request from PayPal
+						// so let's try to pick up where we left off
+						$this->checkout->transaction = $valid_TXN;
+						$this->checkout->refresh_all_entities(true);
+						return;
+					}
+				}
+				// you appear to be lost?
+				$this->_redirect_wayward_request($primary_registrant);
+			}
+		}
+	}
+
+
+	/**
+	 * _redirect_wayward_request
+	 *
+	 * @access private
+	 * @param \EE_Registration|null $primary_registrant
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _redirect_wayward_request(EE_Registration $primary_registrant)
+	{
+		if (! $primary_registrant instanceof EE_Registration) {
+			// try redirecting based on the current TXN
+			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
+				? $this->checkout->transaction->primary_registration()
+				: null;
+		}
+		if (! $primary_registrant instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// make sure transaction is not locked
+		$this->checkout->transaction->unlock();
+		wp_safe_redirect(
+			add_query_arg(
+				array(
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
+				),
+				$this->checkout->thank_you_page_url
+			)
+		);
+		exit();
+	}
+
+
+	/**
+	 * _process_off_site_payment
+	 *
+	 * @access private
+	 * @param \EE_Offsite_Gateway $gateway
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
+	{
+		try {
+			$request_data = \EE_Registry::instance()->REQ->params();
+			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
+			$this->set_handle_IPN_in_this_request(
+				$gateway->handle_IPN_in_this_request($request_data, false)
+			);
+			if ($this->handle_IPN_in_this_request()) {
+				// get payment details and process results
+				/** @type EE_Payment_Processor $payment_processor */
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+				$payment           = $payment_processor->process_ipn(
+					$request_data,
+					$this->checkout->transaction,
+					$this->checkout->payment_method,
+					true,
+					false
+				);
+				//$payment_source = 'process_ipn';
+			} else {
+				$payment = $this->checkout->transaction->last_payment();
+				//$payment_source = 'last_payment';
+			}
+		} catch (Exception $e) {
+			// let's just eat the exception and try to move on using any previously set payment info
+			$payment = $this->checkout->transaction->last_payment();
+			//$payment_source = 'last_payment after Exception';
+			// but if we STILL don't have a payment object
+			if (! $payment instanceof EE_Payment) {
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
+				$this->_handle_payment_processor_exception($e);
+			}
+		}
+		// DEBUG LOG
+		//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__,
+		//	array(
+		//		'process_ipn_payment' => $payment,
+		//		'payment_source'      => $payment_source,
+		//	)
+		//);
+		return $payment;
+	}
+
+
+	/**
+	 * _process_cancelled_payments
+	 * just makes sure that the payment status gets updated correctly
+	 * so tha tan error isn't generated during payment validation
+	 *
+	 * @access private
+	 * @param EE_Payment $payment
+	 * @return EE_Payment | FALSE
+	 * @throws \EE_Error
+	 */
+	private function _process_cancelled_payments($payment = null)
+	{
+		if (
+			$payment instanceof EE_Payment
+			&& isset($_REQUEST['ee_cancel_payment'])
+			&& $payment->status() === EEM_Payment::status_id_failed
+		) {
+			$payment->set_status(EEM_Payment::status_id_cancelled);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    get_transaction_details_for_gateways
+	 *
+	 * @access    public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function get_transaction_details_for_gateways()
+	{
+		$txn_details = array();
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$txn_details = array(
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
+			);
+		}
+		// get EE_Payment_Method object
+		if (
+			empty($txn_details)
+			&&
+			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
+		) {
+			$txn_details = array(
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+				'error'                      => esc_html__(
+					'A valid Payment Method could not be determined.',
+					'event_espresso'
+				),
+			);
+		}
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url  = $this->_get_return_url($this->checkout->payment_method);
+			$txn_details = array(
+				'TXN_ID'         => $this->checkout->transaction->ID(),
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
+				'TXN_total'      => $this->checkout->transaction->total(),
+				'TXN_paid'       => $this->checkout->transaction->paid(),
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
+				'payment_amount' => $this->checkout->amount_owing,
+				'return_url'     => $return_url,
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
+					array(
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
+					)
+				),
+			);
+		}
+		echo wp_json_encode($txn_details);
+		exit();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
+	}
 }

Spacing +62 added lines, -62 removed lines

@@ -132,7 +132,7 @@ 
     {
         $this->_slug     = 'payment_options';
         $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'payment_options_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -187,7 +187,7 @@ 
      */
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
             'Please select a method of payment in order to continue.',
             'event_espresso'
         );
@@ -195,7 +195,7 @@ 
             'A valid method of payment could not be determined. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
             'Forwarding to Secure Payment Provider.',
             'event_espresso'
         );
@@ -215,7 +215,7 @@ 
     {
         $transaction = $this->checkout->transaction;
         //if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-        if (! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
+        if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
             return;
         }
         foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
@@ -304,11 +304,11 @@ 
         foreach ($registrations as $REG_ID => $registration) {
             /** @var $registration EE_Registration */
             // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
+            if (isset($ejected_registrations[$REG_ID])) {
                 if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                    $sold_out_events[$registration->event()->ID()] = $registration->event();
                 } else {
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+                    $insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
                 }
                 continue;
             }
@@ -347,7 +347,7 @@ 
                     $registration->event(),
                     $this
                 );
-            } elseif (! $this->checkout->revisit
+            } elseif ( ! $this->checkout->revisit
                 && $registration->status_ID() !== EEM_Registration::status_id_not_approved
                 && $registration->ticket()->is_free()
             ) {
@@ -356,23 +356,23 @@ 
         }
         $subsections = array();
         // now decide which template to load
-        if (! empty($sold_out_events)) {
+        if ( ! empty($sold_out_events)) {
             $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
         }
-        if (! empty($insufficient_spaces_available)) {
+        if ( ! empty($insufficient_spaces_available)) {
             $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
                 $insufficient_spaces_available
             );
         }
-        if (! empty($registrations_requiring_pre_approval)) {
+        if ( ! empty($registrations_requiring_pre_approval)) {
             $subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
                 $registrations_requiring_pre_approval
             );
         }
-        if (! empty($registrations_for_free_events)) {
+        if ( ! empty($registrations_for_free_events)) {
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
         }
-        if (! empty($registrations_requiring_payment)) {
+        if ( ! empty($registrations_requiring_payment)) {
             if ($this->checkout->amount_owing > 0) {
                 // autoload Line_Item_Display classes
                 EEH_Autoloader::register_line_item_filter_autoloaders();
@@ -393,7 +393,7 @@ 
                         array('registrations' => $registrations)
                     )
                 );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
+                $this->checkout->amount_owing = $filtered_line_item_tree->total();
                 $this->_apply_registration_payments_to_amount_owing($registrations);
             }
             $no_payment_required = false;
@@ -437,13 +437,13 @@ 
      */
     public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection)
     {
-        if (! EE_Registry::instance()->SSN instanceof EE_Session) {
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
             return $line_item_filter_collection;
         }
-        if (! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
+        if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
             return $line_item_filter_collection;
         }
-        if (! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
+        if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
             return $line_item_filter_collection;
         }
         $line_item_filter_collection->add(
@@ -534,15 +534,15 @@ 
             }
             $EVT_ID = $registration->event_ID();
             $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[$ticket->ID()])) {
+            if ( ! isset($tickets_remaining[$ticket->ID()])) {
                 $tickets_remaining[$ticket->ID()] = $ticket->remaining();
             }
             if ($tickets_remaining[$ticket->ID()] > 0) {
-                if (! isset($event_reg_count[$EVT_ID])) {
+                if ( ! isset($event_reg_count[$EVT_ID])) {
                     $event_reg_count[$EVT_ID] = 0;
                 }
                 $event_reg_count[$EVT_ID]++;
-                if (! isset($event_spaces_remaining[$EVT_ID])) {
+                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
                     $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
                 }
             }
@@ -611,7 +611,7 @@ 
         foreach ($sold_out_events_array as $sold_out_event) {
             $sold_out_events .= EEH_HTML::li(
                 EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
+                    '  '.$sold_out_event->name(),
                     '',
                     'dashicons dashicons-marker ee-icon-size-16 pink-text'
                 )
@@ -667,7 +667,7 @@ 
         foreach ($insufficient_spaces_events_array as $event) {
             if ($event instanceof EE_Event) {
                 $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+                    EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
                 );
             }
         }
@@ -857,7 +857,7 @@ 
     {
         return new EE_Form_Section_Proper(
             array(
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
                 'subsections'     => array(
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -897,7 +897,7 @@ 
                 $payments += $registration->registration_payments();
             }
         }
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Registration_Payment) {
                     $this->checkout->amount_owing -= $payment->amount();
@@ -987,7 +987,7 @@ 
             );
         }
         // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
+        $payment_method_header = count($this->checkout->available_payment_methods) > 1
             ? apply_filters(
                 'FHEE__registration_page_payment_options__method_of_payment_hdr',
                 esc_html__('Please Select Your Method of Payment', 'event_espresso')
@@ -1017,14 +1017,14 @@ 
                 $payment_method_button = EEH_HTML::img(
                     $payment_method->button_url(),
                     $payment_method->name(),
-                    'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+                    'spco-payment-method-'.$payment_method->slug().'-btn-img',
                     'spco-payment-method-btn-img'
                 );
                 // check if any payment methods are set as default
                 // if payment method is already selected OR nothing is selected and this payment method should be
                 // open_by_default
                 if (($this->checkout->selected_method_of_payment === $payment_method->slug())
-                    || (! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
+                    || ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
                 ) {
                     $this->checkout->selected_method_of_payment = $payment_method->slug();
                     $this->_save_selected_method_of_payment();
@@ -1032,7 +1032,7 @@ 
                 } else {
                     $available_payment_method_options[$payment_method->slug()] = $payment_method_button;
                 }
-                $payment_methods_billing_info[$payment_method->slug() . '-info'] = $this->_payment_method_billing_info(
+                $payment_methods_billing_info[$payment_method->slug().'-info'] = $this->_payment_method_billing_info(
                     $payment_method
                 );
             }
@@ -1044,7 +1044,7 @@ 
         $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
             $available_payment_method_options
         );
-        $available_payment_methods                              += $payment_methods_billing_info;
+        $available_payment_methods += $payment_methods_billing_info;
         // build the available payment methods form
         return new EE_Form_Section_Proper(
             array(
@@ -1068,7 +1068,7 @@ 
      */
     protected function _get_available_payment_methods()
     {
-        if (! empty($this->checkout->available_payment_methods)) {
+        if ( ! empty($this->checkout->available_payment_methods)) {
             return $this->checkout->available_payment_methods;
         }
         $available_payment_methods = array();
@@ -1178,7 +1178,7 @@ 
         );
         return new EE_Form_Section_Proper(
             array(
-                'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+                'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
                 'html_class'      => 'spco-payment-method-info-dv',
                 // only display the selected or default PM
                 'html_style'      => $currently_selected ? '' : 'display:none;',
@@ -1208,7 +1208,7 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         $this->checkout->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
             return false;
         }
         if (apply_filters(
@@ -1380,7 +1380,7 @@ 
      */
     public function switch_payment_method()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return false;
         }
         if (apply_filters(
@@ -1509,7 +1509,7 @@ 
             }
         }
         // verify payment method
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+        if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
             // get payment method for selected method of payment
             $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
         }
@@ -1534,7 +1534,7 @@ 
      */
     public function save_payer_details_via_ajax()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return;
         }
         // generate billing form for selected method of payment if it hasn't been done already
@@ -1544,7 +1544,7 @@ 
             );
         }
         // generate primary attendee from payer info if applicable
-        if (! $this->checkout->transaction_has_primary_registrant()) {
+        if ( ! $this->checkout->transaction_has_primary_registrant()) {
             $attendee = $this->_create_attendee_from_request_data();
             if ($attendee instanceof EE_Attendee) {
                 foreach ($this->checkout->transaction->registrations() as $registration) {
@@ -1575,7 +1575,7 @@ 
     {
         // get State ID
         $STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
-        if (! empty($STA_ID)) {
+        if ( ! empty($STA_ID)) {
             // can we get state object from name ?
             EE_Registry::instance()->load_model('State');
             $state  = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
@@ -1583,7 +1583,7 @@ 
         }
         // get Country ISO
         $CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
-        if (! empty($CNT_ISO)) {
+        if ( ! empty($CNT_ISO)) {
             // can we get country object from name ?
             EE_Registry::instance()->load_model('Country');
             $country = EEM_Country::instance()->get_col(
@@ -1616,7 +1616,7 @@ 
         }
         // does this attendee already exist in the db ? we're searching using a combination of first name, last name,
         // AND email address
-        if (! empty($attendee_data['ATT_fname'])
+        if ( ! empty($attendee_data['ATT_fname'])
             && ! empty($attendee_data['ATT_lname'])
             && ! empty($attendee_data['ATT_email'])
         ) {
@@ -1832,7 +1832,7 @@ 
     private function _process_payment()
     {
         // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
+        if ( ! $this->_last_second_ticket_verifications()) {
             return false;
         }
         // ya gotta make a choice man
@@ -1843,7 +1843,7 @@ 
             return false;
         }
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             return false;
         }
         // setup billing form
@@ -1852,12 +1852,12 @@ 
                 $this->checkout->payment_method
             );
             // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
+            if ( ! $this->_billing_form_is_valid()) {
                 return false;
             }
         }
         // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
             return false;
         }
         // if session is close to expiring (under 10 minutes by default)
@@ -1913,7 +1913,7 @@ 
     protected function _last_second_ticket_verifications()
     {
         // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
+        if ( ! $this->checkout->revisit) {
             return true;
         }
         $registrations = $this->checkout->transaction->registrations();
@@ -1964,7 +1964,7 @@ 
             $this->_get_payment_method_for_selected_method_of_payment()
         );
         $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
+        $html .= $this->checkout->redirect_form;
         EE_Registry::instance()->REQ->add_output($html);
         return true;
     }
@@ -1979,7 +1979,7 @@ 
      */
     private function _billing_form_is_valid()
     {
-        if (! $this->checkout->payment_method->type_obj()->has_billing_form()) {
+        if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
             return true;
         }
         if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
@@ -2096,7 +2096,7 @@ 
     {
         // convert billing form data into an attendee
         $this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-        if (! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
+        if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2113,7 +2113,7 @@ 
             return false;
         }
         $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
+        if ( ! $primary_registration instanceof EE_Registration) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2129,7 +2129,7 @@ 
             );
             return false;
         }
-        if (! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+        if ( ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
               instanceof
               EE_Attendee
         ) {
@@ -2185,7 +2185,7 @@ 
             $payment_method     = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
         }
         // verify $payment_method
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2203,7 +2203,7 @@ 
             return null;
         }
         // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+        if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2241,7 +2241,7 @@ 
         $payment = null;
         $this->checkout->transaction->save();
         $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
+        if ( ! $payment_processor instanceof EE_Payment_Processor) {
             return false;
         }
         try {
@@ -2345,7 +2345,7 @@ 
             return true;
         }
         // verify payment object
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2385,7 +2385,7 @@ 
             return true;
             // On-Site payment?
         } else if ($this->checkout->payment_method->is_on_site()) {
-            if (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+            if ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
                 //$this->_setup_redirect_for_next_step();
                 $this->checkout->continue_reg = false;
             }
@@ -2501,7 +2501,7 @@ 
                     break;
                 // bad payment
                 case EEM_Payment::status_id_failed :
-                    if (! empty($msg)) {
+                    if ( ! empty($msg)) {
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
                         return false;
                     }
@@ -2562,11 +2562,11 @@ 
         // how have they chosen to pay?
         $this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
         // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+        if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
             $this->checkout->continue_reg = false;
             return false;
         }
-        if (! $this->checkout->payment_method->is_off_site()) {
+        if ( ! $this->checkout->payment_method->is_off_site()) {
             return false;
         }
         $this->_validate_offsite_return();
@@ -2582,7 +2582,7 @@ 
         // verify TXN
         if ($this->checkout->transaction instanceof EE_Transaction) {
             $gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-            if (! $gateway instanceof EE_Offsite_Gateway) {
+            if ( ! $gateway instanceof EE_Offsite_Gateway) {
                 $this->checkout->continue_reg = false;
                 return false;
             }
@@ -2624,7 +2624,7 @@ 
      */
     private function _validate_offsite_return()
     {
-        $TXN_ID = (int)EE_Registry::instance()->REQ->get('spco_txn', 0);
+        $TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
         if ($TXN_ID !== $this->checkout->transaction->ID()) {
             // Houston... we might have a problem
             $invalid_TXN = false;
@@ -2697,13 +2697,13 @@ 
      */
     private function _redirect_wayward_request(EE_Registration $primary_registrant)
     {
-        if (! $primary_registrant instanceof EE_Registration) {
+        if ( ! $primary_registrant instanceof EE_Registration) {
             // try redirecting based on the current TXN
             $primary_registrant = $this->checkout->transaction instanceof EE_Transaction
                 ? $this->checkout->transaction->primary_registration()
                 : null;
         }
-        if (! $primary_registrant instanceof EE_Registration) {
+        if ( ! $primary_registrant instanceof EE_Registration) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2773,7 +2773,7 @@ 
             $payment = $this->checkout->transaction->last_payment();
             //$payment_source = 'last_payment after Exception';
             // but if we STILL don't have a payment object
-            if (! $payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
                 $this->_handle_payment_processor_exception($e);
             }

core/helpers/EEH_Event_Query.helper.php

Indentation +670 added lines, -670 removed lines

@@ -18,676 +18,676 @@
 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

@@ -230,7 +230,7 @@ 
     {
         if (EEH_Event_Query::apply_query_filters($wp_query)) {
             global $wpdb;
-            $clauses['groupby'] = $wpdb->posts . '.ID ';
+            $clauses['groupby'] = $wpdb->posts.'.ID ';
         }
         return $clauses;
     }
@@ -267,24 +267,24 @@ 
      */
     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;
             }
         }
@@ -326,12 +326,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;
@@ -347,7 +347,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)";
@@ -377,13 +377,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' :
@@ -396,7 +396,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;
             }
         }
@@ -416,10 +416,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 '';
@@ -440,8 +440,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
@@ -532,7 +532,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).'\' '
             : '';
     }
 
@@ -563,14 +563,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;
     }
@@ -633,15 +633,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;
             }
@@ -651,39 +651,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;