eventespresso / event-espresso-core

core/db_classes/EE_Question_Group.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -215,7 +215,7 @@ 
      * Adds the question to this question group
      *
      * @param EE_Question || int $question object or ID
-     * @return boolean if successful
+     * @return EE_Base_Class if successful
      */
     public function add_question($questionObjectOrID)
     {
@@ -227,7 +227,7 @@ 
      * Removes the question from this question group
      *
      * @param EE_Question || int $question object or ID
-     * @return boolean of success
+     * @return EE_Base_Class of success
      */
     public function remove_question($questionObjectOrID)
     {

Indentation +276 added lines, -276 removed lines

@@ -12,280 +12,280 @@
 class EE_Question_Group extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * gets the question group's name
-     *
-     * @access public
-     * @param bool $pretty
-     * @return string
-     */
-    public function name($pretty = false)
-    {
-        return $pretty ? $this->get_pretty('QSG_name') : $this->get('QSG_name');
-    }
-
-
-    /**
-     * Gets the question group's internal name
-     *
-     * @access public
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->get('QSG_identifier');
-    }
-
-
-    /**
-     * Gets the question group's description
-     *
-     * @access public
-     * @param bool $pretty
-     * @return string
-     */
-    public function desc($pretty = false)
-    {
-        return $pretty ? $this->get_pretty('QSG_desc') : $this->get('QSG_desc');
-    }
-
-
-    /**
-     * Gets the question group's order number in a sequence
-     * of other question groups
-     *
-     * @access public
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('QSG_order');
-    }
-
-
-    /**
-     * Returns whether to show the group's name on the frontend
-     *
-     * @access public
-     * @return boolean
-     */
-    public function show_group_name()
-    {
-        return $this->get('QSG_show_group_name');
-    }
-
-
-    /**
-     * Returns whether to show the group's description
-     * on the frontend
-     *
-     * @access public
-     * @return boolean
-     */
-    public function show_group_desc()
-    {
-        return $this->get('QSG_show_group_desc');
-    }
-
-
-    /**
-     * Returns whether this is a 'system group' (meaning
-     * a question group integral to the system, whose questions
-     * relate to the attendee table)
-     *
-     * @access public
-     * @return int
-     */
-    public function system_group()
-    {
-        return $this->get('QSG_system');
-    }
-
-
-    /**
-     * get the author of the question group.
-     *
-     * @since 4.5.0
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('QSG_wp_user');
-    }
-
-
-    /**
-     * Returns whether this question group has
-     * been deleted
-     *
-     * @access public
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QST_deleted');
-    }
-
-
-    /**
-     * Gets an array of questions with questions IN the group at the start of the array and questions NOT in the group
-     * at the end of the array.  Questions in the group are ordered by Question_Group_Question.QGQ_order and questions
-     * NOT in the group are ordered by Question.QGQ_order
-     *
-     * @return EE_Question[]
-     */
-    public function questions_in_and_not_in_group()
-    {
-        $questions_in_group = $this->questions();
-        $exclude_question_ids = ! empty($questions_in_group) ? array_keys($questions_in_group) : array();
-        $questions_not_in_group = $this->questions_not_in_group($exclude_question_ids);
-        return $questions_in_group + $questions_not_in_group;
-    }
-
-
-    /**
-     * Gets all the questions which are part of this question group (ordered Question_Group_Question.QGQ_order)
-     *
-     * @param array $query_params
-     * @return EE_Question[]
-     */
-    public function questions($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params
-            : array('order_by' => array('Question_Group_Question.QGQ_order' => 'ASC'));
-        return $this->ID() ? $this->get_many_related('Question', $query_params) : array();
-    }
-
-
-    /**
-     * Gets all the questions which are NOT part of this question group.
-     *
-     * @param  mixed $question_IDS_in_group if empty array then all questions returned.  if FALSE then we first get
-     *                                      questions in this group and exclude them from questions get all. IF empty
-     *                                      array then we just return all questions.
-     * @return EE_Question[]
-     */
-    public function questions_not_in_group($question_IDS_in_group = false)
-    {
-        if ($question_IDS_in_group === false) {
-            $questions = $this->questions();
-            $question_IDS_in_group = ! empty($questions) ? array_keys($questions) : array();
-        }
-        $_where = ! empty($question_IDS_in_group) ? array('QST_ID' => array('not_in', $question_IDS_in_group))
-            : array();
-
-        return EEM_Question::instance()->get_all(array($_where, 'order_by' => array('QST_ID' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all events which are related to this question group
-     *
-     * @return EE_Event[]
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Adds the question to this question group
-     *
-     * @param EE_Question || int $question object or ID
-     * @return boolean if successful
-     */
-    public function add_question($questionObjectOrID)
-    {
-        return $this->_add_relation_to($questionObjectOrID, 'Question');
-    }
-
-
-    /**
-     * Removes the question from this question group
-     *
-     * @param EE_Question || int $question object or ID
-     * @return boolean of success
-     */
-    public function remove_question($questionObjectOrID)
-    {
-        return $this->_remove_relation_to($questionObjectOrID, 'Question');
-    }
-
-
-    /**
-     * @param $questionObjectOrID
-     * @param $qst_order
-     * @return int
-     */
-    public function update_question_order($questionObjectOrID, $qst_order)
-    {
-        $qst_ID = $questionObjectOrID instanceof EE_Question ? $questionObjectOrID->ID() : (int) $questionObjectOrID;
-        return EEM_Question_Group_Question::instance()->update(
-            array('QGQ_order' => $qst_order),
-            array(
-                array(
-                    'QST_ID' => $qst_ID,
-                    'QSG_ID' => $this->ID(),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * Basically this is method just returns whether the question group has any questions with answers.  This is used
-     * by the admin currently to determine whether we should display the ui for deleting permanently or not b/c
-     * question groups with questions that have answers should not be possible to delete permanently
-     *
-     * @return boolean true if has questions with answers, false if not.
-     */
-    public function has_questions_with_answers()
-    {
-        $has_answers = false;
-        $questions = $this->get_many_related('Question');
-        foreach ($questions as $question) {
-            if ($question->count_related('Answer') > 0) {
-                $has_answers = true;
-            }
-        }
-        return $has_answers;
-    }
-
-
-    /**
-     * The purpose of this method is set the question group order for this question group to be the max out of all
-     * question groups
-     *
-     * @access public
-     * @return void
-     */
-    public function set_order_to_latest()
-    {
-        $latest_order = $this->get_model()->get_latest_question_group_order();
-        $latest_order++;
-        $this->set('QSG_order', $latest_order);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * gets the question group's name
+	 *
+	 * @access public
+	 * @param bool $pretty
+	 * @return string
+	 */
+	public function name($pretty = false)
+	{
+		return $pretty ? $this->get_pretty('QSG_name') : $this->get('QSG_name');
+	}
+
+
+	/**
+	 * Gets the question group's internal name
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->get('QSG_identifier');
+	}
+
+
+	/**
+	 * Gets the question group's description
+	 *
+	 * @access public
+	 * @param bool $pretty
+	 * @return string
+	 */
+	public function desc($pretty = false)
+	{
+		return $pretty ? $this->get_pretty('QSG_desc') : $this->get('QSG_desc');
+	}
+
+
+	/**
+	 * Gets the question group's order number in a sequence
+	 * of other question groups
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('QSG_order');
+	}
+
+
+	/**
+	 * Returns whether to show the group's name on the frontend
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function show_group_name()
+	{
+		return $this->get('QSG_show_group_name');
+	}
+
+
+	/**
+	 * Returns whether to show the group's description
+	 * on the frontend
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function show_group_desc()
+	{
+		return $this->get('QSG_show_group_desc');
+	}
+
+
+	/**
+	 * Returns whether this is a 'system group' (meaning
+	 * a question group integral to the system, whose questions
+	 * relate to the attendee table)
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function system_group()
+	{
+		return $this->get('QSG_system');
+	}
+
+
+	/**
+	 * get the author of the question group.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('QSG_wp_user');
+	}
+
+
+	/**
+	 * Returns whether this question group has
+	 * been deleted
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QST_deleted');
+	}
+
+
+	/**
+	 * Gets an array of questions with questions IN the group at the start of the array and questions NOT in the group
+	 * at the end of the array.  Questions in the group are ordered by Question_Group_Question.QGQ_order and questions
+	 * NOT in the group are ordered by Question.QGQ_order
+	 *
+	 * @return EE_Question[]
+	 */
+	public function questions_in_and_not_in_group()
+	{
+		$questions_in_group = $this->questions();
+		$exclude_question_ids = ! empty($questions_in_group) ? array_keys($questions_in_group) : array();
+		$questions_not_in_group = $this->questions_not_in_group($exclude_question_ids);
+		return $questions_in_group + $questions_not_in_group;
+	}
+
+
+	/**
+	 * Gets all the questions which are part of this question group (ordered Question_Group_Question.QGQ_order)
+	 *
+	 * @param array $query_params
+	 * @return EE_Question[]
+	 */
+	public function questions($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params
+			: array('order_by' => array('Question_Group_Question.QGQ_order' => 'ASC'));
+		return $this->ID() ? $this->get_many_related('Question', $query_params) : array();
+	}
+
+
+	/**
+	 * Gets all the questions which are NOT part of this question group.
+	 *
+	 * @param  mixed $question_IDS_in_group if empty array then all questions returned.  if FALSE then we first get
+	 *                                      questions in this group and exclude them from questions get all. IF empty
+	 *                                      array then we just return all questions.
+	 * @return EE_Question[]
+	 */
+	public function questions_not_in_group($question_IDS_in_group = false)
+	{
+		if ($question_IDS_in_group === false) {
+			$questions = $this->questions();
+			$question_IDS_in_group = ! empty($questions) ? array_keys($questions) : array();
+		}
+		$_where = ! empty($question_IDS_in_group) ? array('QST_ID' => array('not_in', $question_IDS_in_group))
+			: array();
+
+		return EEM_Question::instance()->get_all(array($_where, 'order_by' => array('QST_ID' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all events which are related to this question group
+	 *
+	 * @return EE_Event[]
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Adds the question to this question group
+	 *
+	 * @param EE_Question || int $question object or ID
+	 * @return boolean if successful
+	 */
+	public function add_question($questionObjectOrID)
+	{
+		return $this->_add_relation_to($questionObjectOrID, 'Question');
+	}
+
+
+	/**
+	 * Removes the question from this question group
+	 *
+	 * @param EE_Question || int $question object or ID
+	 * @return boolean of success
+	 */
+	public function remove_question($questionObjectOrID)
+	{
+		return $this->_remove_relation_to($questionObjectOrID, 'Question');
+	}
+
+
+	/**
+	 * @param $questionObjectOrID
+	 * @param $qst_order
+	 * @return int
+	 */
+	public function update_question_order($questionObjectOrID, $qst_order)
+	{
+		$qst_ID = $questionObjectOrID instanceof EE_Question ? $questionObjectOrID->ID() : (int) $questionObjectOrID;
+		return EEM_Question_Group_Question::instance()->update(
+			array('QGQ_order' => $qst_order),
+			array(
+				array(
+					'QST_ID' => $qst_ID,
+					'QSG_ID' => $this->ID(),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * Basically this is method just returns whether the question group has any questions with answers.  This is used
+	 * by the admin currently to determine whether we should display the ui for deleting permanently or not b/c
+	 * question groups with questions that have answers should not be possible to delete permanently
+	 *
+	 * @return boolean true if has questions with answers, false if not.
+	 */
+	public function has_questions_with_answers()
+	{
+		$has_answers = false;
+		$questions = $this->get_many_related('Question');
+		foreach ($questions as $question) {
+			if ($question->count_related('Answer') > 0) {
+				$has_answers = true;
+			}
+		}
+		return $has_answers;
+	}
+
+
+	/**
+	 * The purpose of this method is set the question group order for this question group to be the max out of all
+	 * question groups
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_order_to_latest()
+	{
+		$latest_order = $this->get_model()->get_latest_question_group_order();
+		$latest_order++;
+		$this->set('QSG_order', $latest_order);
+	}
 }

core/db_classes/EE_Question_Option.class.php

Doc Comments +7 added lines, -7 removed lines

@@ -39,7 +39,7 @@ 
      * @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_Attendee
+     * @return EE_Question_Option
      */
     public static function new_instance_from_db($props_n_values = array(), $timezone = null)
     {
@@ -51,7 +51,7 @@ 
      * Sets the option's key value
      *
      * @param string $value
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_value($value)
     {
@@ -63,7 +63,7 @@ 
      * Sets the option's Display Text
      *
      * @param string $text
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_desc($text)
     {
@@ -76,7 +76,7 @@ 
      *
      * @access public
      * @param integer $order
-     * @return bool      $success
+     * @return boolean|null      $success
      */
     public function set_order($order)
     {
@@ -88,7 +88,7 @@ 
      * Sets the ID of the related question
      *
      * @param int $question_ID
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_question_ID($question_ID)
     {
@@ -100,7 +100,7 @@ 
      * Sets the option's opt_group
      *
      * @param string $text
-     * @return bool success
+     * @return string success
      */
     public function set_opt_group($text)
     {
@@ -220,7 +220,7 @@ 
      * Sets QSO_system
      *
      * @param string $QSO_system
-     * @return bool
+     * @return boolean|null
      */
     public function set_system($QSO_system)
     {

Indentation +216 added lines, -216 removed lines

@@ -10,220 +10,220 @@
 class EE_Question_Option extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
 
-    /**
-     * Question Option Opt Group Name
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_QSO_opt_group = null;
-
-
-    /**
-     *
-     * @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_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Sets the option's key value
-     *
-     * @param string $value
-     * @return bool success
-     */
-    public function set_value($value)
-    {
-        $this->set('QSO_value', $value);
-    }
-
-
-    /**
-     * Sets the option's Display Text
-     *
-     * @param string $text
-     * @return bool success
-     */
-    public function set_desc($text)
-    {
-        $this->set('QSO_desc', $text);
-    }
-
-
-    /**
-     * Sets the order for this option
-     *
-     * @access public
-     * @param integer $order
-     * @return bool      $success
-     */
-    public function set_order($order)
-    {
-        $this->set('QSO_order', $order);
-    }
-
-
-    /**
-     * Sets the ID of the related question
-     *
-     * @param int $question_ID
-     * @return bool success
-     */
-    public function set_question_ID($question_ID)
-    {
-        $this->set('QST_ID', $question_ID);
-    }
-
-
-    /**
-     * Sets the option's opt_group
-     *
-     * @param string $text
-     * @return bool success
-     */
-    public function set_opt_group($text)
-    {
-        return $this->_QSO_opt_group = $text;
-    }
-
-
-    /**
-     * Gets the option's key value
-     *
-     * @return string
-     */
-    public function value()
-    {
-        return $this->get('QSO_value');
-    }
-
-
-    /**
-     * Gets the option's display text
-     *
-     * @return string
-     */
-    public function desc()
-    {
-        return $this->get('QSO_desc');
-    }
-
-
-    /**
-     * Returns whether this option has been deleted or not
-     *
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QSO_deleted');
-    }
-
-
-    /**
-     * Returns the order or the Question Option
-     *
-     * @access public
-     * @return integer
-     */
-    public function order()
-    {
-        return $this->get('QSO_option');
-    }
-
-
-    /**
-     * Gets the related question's ID
-     *
-     * @return int
-     */
-    public function question_ID()
-    {
-        return $this->get('QST_ID');
-    }
-
-
-    /**
-     * Returns the question related to this question option
-     *
-     * @return EE_Question
-     */
-    public function question()
-    {
-        return $this->get_first_related('Question');
-    }
-
-
-    /**
-     * Gets the option's opt_group
-     *
-     * @return string
-     */
-    public function opt_group()
-    {
-        return $this->_QSO_opt_group;
-    }
-
-    /**
-     * Duplicates this question option. By default the new question option will be for the same question,
-     * but that can be overriden by setting the 'QST_ID' option
-     *
-     * @param array $options {
-     * @type int    $QST_ID  the QST_ID attribute of this question option, otherwise it will be for the same question
-     *                       as the original
-     */
-    public function duplicate($options = array())
-    {
-        $new_question_option = clone $this;
-        $new_question_option->set('QSO_ID', null);
-        if (array_key_exists(
-            'QST_ID',
-            $options
-        )) {// use array_key_exists instead of isset because NULL might be a valid value
-            $new_question_option->set_question_ID($options['QST_ID']);
-        }
-        $new_question_option->save();
-    }
-
-    /**
-     * Gets the QSO_system value
-     *
-     * @return string|null
-     */
-    public function system()
-    {
-        return $this->get('QSO_system');
-    }
-
-    /**
-     * Sets QSO_system
-     *
-     * @param string $QSO_system
-     * @return bool
-     */
-    public function set_system($QSO_system)
-    {
-        return $this->set('QSO_system', $QSO_system);
-    }
+	/**
+	 * Question Option Opt Group Name
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_QSO_opt_group = null;
+
+
+	/**
+	 *
+	 * @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_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Sets the option's key value
+	 *
+	 * @param string $value
+	 * @return bool success
+	 */
+	public function set_value($value)
+	{
+		$this->set('QSO_value', $value);
+	}
+
+
+	/**
+	 * Sets the option's Display Text
+	 *
+	 * @param string $text
+	 * @return bool success
+	 */
+	public function set_desc($text)
+	{
+		$this->set('QSO_desc', $text);
+	}
+
+
+	/**
+	 * Sets the order for this option
+	 *
+	 * @access public
+	 * @param integer $order
+	 * @return bool      $success
+	 */
+	public function set_order($order)
+	{
+		$this->set('QSO_order', $order);
+	}
+
+
+	/**
+	 * Sets the ID of the related question
+	 *
+	 * @param int $question_ID
+	 * @return bool success
+	 */
+	public function set_question_ID($question_ID)
+	{
+		$this->set('QST_ID', $question_ID);
+	}
+
+
+	/**
+	 * Sets the option's opt_group
+	 *
+	 * @param string $text
+	 * @return bool success
+	 */
+	public function set_opt_group($text)
+	{
+		return $this->_QSO_opt_group = $text;
+	}
+
+
+	/**
+	 * Gets the option's key value
+	 *
+	 * @return string
+	 */
+	public function value()
+	{
+		return $this->get('QSO_value');
+	}
+
+
+	/**
+	 * Gets the option's display text
+	 *
+	 * @return string
+	 */
+	public function desc()
+	{
+		return $this->get('QSO_desc');
+	}
+
+
+	/**
+	 * Returns whether this option has been deleted or not
+	 *
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QSO_deleted');
+	}
+
+
+	/**
+	 * Returns the order or the Question Option
+	 *
+	 * @access public
+	 * @return integer
+	 */
+	public function order()
+	{
+		return $this->get('QSO_option');
+	}
+
+
+	/**
+	 * Gets the related question's ID
+	 *
+	 * @return int
+	 */
+	public function question_ID()
+	{
+		return $this->get('QST_ID');
+	}
+
+
+	/**
+	 * Returns the question related to this question option
+	 *
+	 * @return EE_Question
+	 */
+	public function question()
+	{
+		return $this->get_first_related('Question');
+	}
+
+
+	/**
+	 * Gets the option's opt_group
+	 *
+	 * @return string
+	 */
+	public function opt_group()
+	{
+		return $this->_QSO_opt_group;
+	}
+
+	/**
+	 * Duplicates this question option. By default the new question option will be for the same question,
+	 * but that can be overriden by setting the 'QST_ID' option
+	 *
+	 * @param array $options {
+	 * @type int    $QST_ID  the QST_ID attribute of this question option, otherwise it will be for the same question
+	 *                       as the original
+	 */
+	public function duplicate($options = array())
+	{
+		$new_question_option = clone $this;
+		$new_question_option->set('QSO_ID', null);
+		if (array_key_exists(
+			'QST_ID',
+			$options
+		)) {// use array_key_exists instead of isset because NULL might be a valid value
+			$new_question_option->set_question_ID($options['QST_ID']);
+		}
+		$new_question_option->save();
+	}
+
+	/**
+	 * Gets the QSO_system value
+	 *
+	 * @return string|null
+	 */
+	public function system()
+	{
+		return $this->get('QSO_system');
+	}
+
+	/**
+	 * Sets QSO_system
+	 *
+	 * @param string $QSO_system
+	 * @return bool
+	 */
+	public function set_system($QSO_system)
+	{
+		return $this->set('QSO_system', $QSO_system);
+	}
 }

core/db_classes/EE_Status.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -52,7 +52,7 @@ 
      * Sets code
      *
      * @param string $code
-     * @return boolean
+     * @return boolean|null
      */
     public function set_code($code)
     {
@@ -75,7 +75,7 @@ 
      * Sets desc
      *
      * @param string $desc
-     * @return boolean
+     * @return boolean|null
      */
     public function set_desc($desc)
     {
@@ -98,7 +98,7 @@ 
      * Sets type
      *
      * @param string $type
-     * @return boolean
+     * @return boolean|null
      */
     public function set_type($type)
     {
@@ -121,7 +121,7 @@ 
      * Sets can_edit
      *
      * @param boolean $can_edit
-     * @return boolean
+     * @return boolean|null
      */
     public function set_can_edit($can_edit)
     {
@@ -144,7 +144,7 @@ 
      * Sets open
      *
      * @param boolean $open
-     * @return boolean
+     * @return boolean|null
      */
     public function set_open($open)
     {

Indentation +138 added lines, -138 removed lines

@@ -12,142 +12,142 @@
 class EE_Status extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Status
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Status
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets code
-     *
-     * @param bool   $plural
-     * @param string $schema
-     * @return string
-     */
-    public function code($plural = false, $schema = 'upper')
-    {
-        $id = $this->get('STS_ID');
-        $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
-    }
-
-
-    /**
-     * Sets code
-     *
-     * @param string $code
-     * @return boolean
-     */
-    public function set_code($code)
-    {
-        $this->set('STS_code', $code);
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function desc()
-    {
-        return $this->get('STS_desc');
-    }
-
-
-    /**
-     * Sets desc
-     *
-     * @param string $desc
-     * @return boolean
-     */
-    public function set_desc($desc)
-    {
-        $this->set('STS_desc', $desc);
-    }
-
-
-    /**
-     * Gets type
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('STS_type');
-    }
-
-
-    /**
-     * Sets type
-     *
-     * @param string $type
-     * @return boolean
-     */
-    public function set_type($type)
-    {
-        $this->set('STS_type', $type);
-    }
-
-
-    /**
-     * Gets can_edit
-     *
-     * @return boolean
-     */
-    public function can_edit()
-    {
-        return $this->get('STS_can_edit');
-    }
-
-
-    /**
-     * Sets can_edit
-     *
-     * @param boolean $can_edit
-     * @return boolean
-     */
-    public function set_can_edit($can_edit)
-    {
-        $this->set('STS_can_edit', $can_edit);
-    }
-
-
-    /**
-     * Gets open
-     *
-     * @return boolean
-     */
-    public function open()
-    {
-        return $this->get('STS_open');
-    }
-
-
-    /**
-     * Sets open
-     *
-     * @param boolean $open
-     * @return boolean
-     */
-    public function set_open($open)
-    {
-        $this->set('STS_open', $open);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Status
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Status
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets code
+	 *
+	 * @param bool   $plural
+	 * @param string $schema
+	 * @return string
+	 */
+	public function code($plural = false, $schema = 'upper')
+	{
+		$id = $this->get('STS_ID');
+		$code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
+		return $code[ $id ];
+	}
+
+
+	/**
+	 * Sets code
+	 *
+	 * @param string $code
+	 * @return boolean
+	 */
+	public function set_code($code)
+	{
+		$this->set('STS_code', $code);
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function desc()
+	{
+		return $this->get('STS_desc');
+	}
+
+
+	/**
+	 * Sets desc
+	 *
+	 * @param string $desc
+	 * @return boolean
+	 */
+	public function set_desc($desc)
+	{
+		$this->set('STS_desc', $desc);
+	}
+
+
+	/**
+	 * Gets type
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('STS_type');
+	}
+
+
+	/**
+	 * Sets type
+	 *
+	 * @param string $type
+	 * @return boolean
+	 */
+	public function set_type($type)
+	{
+		$this->set('STS_type', $type);
+	}
+
+
+	/**
+	 * Gets can_edit
+	 *
+	 * @return boolean
+	 */
+	public function can_edit()
+	{
+		return $this->get('STS_can_edit');
+	}
+
+
+	/**
+	 * Sets can_edit
+	 *
+	 * @param boolean $can_edit
+	 * @return boolean
+	 */
+	public function set_can_edit($can_edit)
+	{
+		$this->set('STS_can_edit', $can_edit);
+	}
+
+
+	/**
+	 * Gets open
+	 *
+	 * @return boolean
+	 */
+	public function open()
+	{
+		return $this->get('STS_open');
+	}
+
+
+	/**
+	 * Sets open
+	 *
+	 * @param boolean $open
+	 * @return boolean
+	 */
+	public function set_open($open)
+	{
+		$this->set('STS_open', $open);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     {
         $id = $this->get('STS_ID');
         $code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
-        return $code[ $id ];
+        return $code[$id];
     }
 
 

core/db_classes/EE_Term.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@ 
      * Sets name
      *
      * @param string $name
-     * @return boolean
+     * @return boolean|null
      */
     public function set_name($name)
     {
@@ -89,7 +89,7 @@ 
      * Sets slug
      *
      * @param string $slug
-     * @return boolean
+     * @return boolean|null
      */
     public function set_slug($slug)
     {

Indentation +70 added lines, -70 removed lines

@@ -12,87 +12,87 @@
 class EE_Term extends EE_Base_Class
 {
 
-    public $post_type;
+	public $post_type;
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
-    {
-        if (! isset($fieldValues['slug'])) {
-            $fieldValues['slug'] = $fieldValues['name'];
-        }
-        parent::__construct($fieldValues, $bydb, $timezone);
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
+	{
+		if (! isset($fieldValues['slug'])) {
+			$fieldValues['slug'] = $fieldValues['name'];
+		}
+		parent::__construct($fieldValues, $bydb, $timezone);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
 
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('name');
-    }
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('name');
+	}
 
 
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function set_name($name)
-    {
-        $this->set('name', $name);
-    }
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function set_name($name)
+	{
+		$this->set('name', $name);
+	}
 
 
-    /**
-     * Gets slug
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->get('slug');
-    }
+	/**
+	 * Gets slug
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->get('slug');
+	}
 
 
-    /**
-     * Sets slug
-     *
-     * @param string $slug
-     * @return boolean
-     */
-    public function set_slug($slug)
-    {
-        $this->set('slug', $slug);
-    }
+	/**
+	 * Sets slug
+	 *
+	 * @param string $slug
+	 * @return boolean
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('slug', $slug);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      */
     protected function __construct($fieldValues = array(), $bydb = false, $timezone = '')
     {
-        if (! isset($fieldValues['slug'])) {
+        if ( ! isset($fieldValues['slug'])) {
             $fieldValues['slug'] = $fieldValues['name'];
         }
         parent::__construct($fieldValues, $bydb, $timezone);

core/db_classes/EE_Term_Taxonomy.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
      * Sets taxonomy
      *
      * @param string $taxonomy
-     * @return boolean
+     * @return boolean|null
      */
     public function set_taxonomy($taxonomy)
     {
@@ -70,7 +70,7 @@ 
      * Sets term_count
      *
      * @param int $term_count
-     * @return boolean
+     * @return boolean|null
      */
     public function set_count($term_count)
     {

Indentation +64 added lines, -64 removed lines

@@ -11,80 +11,80 @@
 class EE_Term_Taxonomy extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Taxonomy
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Taxonomy
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Taxonomy
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Taxonomy
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 
 
-    /**
-     * Gets taxonomy
-     *
-     * @return string
-     */
-    public function taxonomy()
-    {
-        return $this->get('taxonomy');
-    }
+	/**
+	 * Gets taxonomy
+	 *
+	 * @return string
+	 */
+	public function taxonomy()
+	{
+		return $this->get('taxonomy');
+	}
 
 
-    /**
-     * Sets taxonomy
-     *
-     * @param string $taxonomy
-     * @return boolean
-     */
-    public function set_taxonomy($taxonomy)
-    {
-        $this->set('taxonomy', $taxonomy);
-    }
+	/**
+	 * Sets taxonomy
+	 *
+	 * @param string $taxonomy
+	 * @return boolean
+	 */
+	public function set_taxonomy($taxonomy)
+	{
+		$this->set('taxonomy', $taxonomy);
+	}
 
 
-    /**
-     * Gets term_count
-     *
-     * @return int
-     */
-    public function count()
-    {
-        return $this->get('term_count');
-    }
+	/**
+	 * Gets term_count
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		return $this->get('term_count');
+	}
 
 
-    /**
-     * Sets term_count
-     *
-     * @param int $term_count
-     * @return boolean
-     */
-    public function set_count($term_count)
-    {
-        $this->set('term_count', $term_count);
-    }
+	/**
+	 * Sets term_count
+	 *
+	 * @param int $term_count
+	 * @return boolean
+	 */
+	public function set_count($term_count)
+	{
+		$this->set('term_count', $term_count);
+	}
 
 
-    /**
-     * Gets the term for this term taxonomy
-     *
-     * @return EE_Term
-     */
-    public function term()
-    {
-        return $this->get_first_related('Term');
-    }
+	/**
+	 * Gets the term for this term taxonomy
+	 *
+	 * @return EE_Term
+	 */
+	public function term()
+	{
+		return $this->get_first_related('Term');
+	}
 }

core/db_classes/EE_Ticket.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -121,7 +121,8 @@
      *                               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
+     * @param boolean $remaining
+     * @return string status int if the display string isn't requested
      * @throws \EE_Error
      */
     public function ticket_status($display = false, $remaining = null)

Indentation +1460 added lines, -1460 removed lines

@@ -12,1464 +12,1464 @@
 class EE_Ticket extends EE_Soft_Delete_Base_Class implements EEI_Line_Item_Object, EEI_Event_Relation, EEI_Has_Icon
 {
 
-    /**
-     * The following constants are used by the ticket_status() method to indicate whether a ticket is on sale or not.
-     */
-    const sold_out = 'TKS';
-
-    /**
-     *
-     */
-    const expired = 'TKE';
-
-    /**
-     *
-     */
-    const archived = 'TKA';
-
-    /**
-     *
-     */
-    const pending = 'TKP';
-
-    /**
-     *
-     */
-    const onsale = 'TKO';
-
-    /**
-     * extra meta key for tracking ticket reservations
-     *
-     * @type string
-     */
-    const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
-
-    /**
-     * cached result from method of the same name
-     *
-     * @var float $_ticket_total_with_taxes
-     */
-    private $_ticket_total_with_taxes;
-
-
-    /**
-     * @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);
-    }
-
-
-    /**
-     * @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
-     */
-    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
-     */
-    public function available($DTT_ID = 0)
-    {
-        // are we checking availability for a particular datetime ?
-        if ($DTT_ID) {
-            // get that datetime object
-            $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()) {
-                return false;
-            }
-        }
-        // datetime is still open for registration, but is this ticket sold out ?
-        return $this->qty() < 1 || $this->qty() > $this->sold() ? true : false;
-    }
-
-
-    /**
-     * 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) {
-            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->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_on_sale()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
-        }
-        return '';
-    }
-
-
-    /**
-     * 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) {
-            return false;
-        }
-        if ($num_remaining > 0 && $num_remaining < $this->min()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * 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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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 : '';
-    }
-
-
-    /**
-     * 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);
-    }
-
-
-    /**
-     * 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';
-        }
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * 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);
-    }
-
-
-    /**
-     * 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();
-        switch ($what) {
-            case 'ticket':
-                return $tickets_sold['ticket'];
-                break;
-            case '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__
-                    );
-                    return $total;
-                }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
-                break;
-            default:
-                return $total;
-        }
-    }
-
-
-    /**
-     * 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();
-        if (! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
-            }
-        }
-        // Tickets sold
-        $tickets_sold['ticket'] = $this->sold();
-        return $tickets_sold;
-    }
-
-
-    /**
-     * 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 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);
-    }
-
-
-    /**
-     * 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
-     */
-    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
-     */
-    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
-     */
-    public function ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     * 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
-     */
-    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
-     */
-    public function get_ticket_taxes_for_admin()
-    {
-        return EE_Taxes::get_taxes_for_admin();
-    }
-
-
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
-    public function ticket_price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function pretty_price()
-    {
-        return $this->get_pretty('TKT_price');
-    }
-
-
-    /**
-     * @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
-     */
-    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;
-    }
-
-
-    public function ensure_TKT_Price_correct()
-    {
-        $this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
-        $this->save();
-    }
-
-
-    /**
-     * @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
-     */
-    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
-     */
-    public function set_name($name)
-    {
-        $this->set('TKT_name', $name);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function description()
-    {
-        return $this->get('TKT_description');
-    }
-
-
-    /**
-     * 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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'TKT_end_date');
-    }
-
-
-    /**
-     * 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
-     */
-    public function max()
-    {
-        return $this->get('TKT_max');
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_price($price)
-    {
-        $this->set('TKT_price', $price);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('TKT_sold', $sold);
-    }
-
-
-    /**
-     * 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
-        // via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
-        $this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:" . __LINE__ . ')');
-        $this->_increase_sold_for_datetimes($qty);
-        $this->set_sold($sold);
-        do_action(
-            'AHEE__EE_Ticket__increase_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-    /**
-     * 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)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->increase_sold($qty);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * 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
-     */
-    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);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_reserved($reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, (int) $reserved);
-        $this->set('TKT_reserved', $reserved);
-    }
-
-
-    /**
-     * increments reserved by amount passed by $qty
-     *
-     * @param int    $qty
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function increase_reserved($qty = 1, $source = 'unknown')
-    {
-        $qty = absint($qty);
-        $reserved = $this->reserved() + $qty;
-        if ($reserved
-            && $this->add_extra_meta(
-                EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                "{$qty} from {$source}"
-            )
-        ) {
-            $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
-     */
-    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);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * decrements (subtracts) reserved by amount passed by $qty
-     *
-     * @param int    $qty
-     * @param bool   $adjust_datetimes
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
-    {
-        $reserved = $this->reserved() - absint($qty);
-        if ($this->add_extra_meta(
-            EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            "-{$qty} from {$source}"
-        )) {
-            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
-     */
-    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);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * 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':
-                return $this->real_quantity_on_ticket();
-            case 'saleable':
-                return $this->real_quantity_on_ticket('saleable');
-            default:
-                return $this->get_raw('TKT_qty');
-        }
-    }
-
-
-    /**
-     * 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
-        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);
-        // echo "\n . qty: " . $qty . '<br />';
-        // calculate this ticket's total sales and reservations
-        $sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
-        // echo "\n . sold: " . $this->sold() . '<br />';
-        // echo "\n . reserved: " . $this->reserved() . '<br />';
-        // 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) {
-                    $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());
-                    // 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') {
-                        $datetime_qty = max(
-                            $datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
-                            0
-                        );
-                        // echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
-                        // echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
-                        // echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                        $datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    }
-                    $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') {
-            // and subtract the sales for THIS ticket
-            $qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
-            // echo "\n . qty: " . $qty . '<br />';
-        }
-        // echo "\nFINAL QTY: " . $qty . "<br /><br />";
-        return $qty;
-    }
-
-
-    /**
-     * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_qty($qty)
-    {
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $qty = min($qty, $datetime->reg_limit());
-            }
-        }
-        $this->set('TKT_qty', $qty);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_uses($uses)
-    {
-        $this->set('TKT_uses', $uses);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_required($required)
-    {
-        $this->set('TKT_required', $required);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_taxable($taxable)
-    {
-        $this->set('TKT_taxable', $taxable);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_is_default($is_default)
-    {
-        $this->set('TKT_is_default', $is_default);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_order($order)
-    {
-        $this->set('TKT_order', $order);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_row($row)
-    {
-        $this->set('TKT_row', $row);
-    }
-
-
-    /**
-     * 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
-     */
-    public function set_deleted($deleted)
-    {
-        $this->set('TKT_deleted', $deleted);
-    }
-
-
-    /**
-     * 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
-     */
-    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
-     */
-    public function name_and_info()
-    {
-        $times = array();
-        foreach ($this->datetimes() as $datetime) {
-            $times[] = $datetime->start_date_and_time();
-        }
-        return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        return $this->get('TKT_name');
-    }
-
-
-    /**
-     * 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
-     */
-    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
-     */
-    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();
-        } elseif ($count_regs_for_this_ticket < $sold) {
-            $this->decrease_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        }
-        return $count_regs_for_this_ticket;
-    }
-
-
-    /**
-     * Counts the registrations for this ticket
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return int
-     */
-    public function count_registrations($query_params = array())
-    {
-        return $this->count_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-tickets-alt"></span>';
-    }
-
-
-    /**
-     * 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',
-                sprintf(
-                    __('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        $event = $datetime->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'),
-                    $this->name()
-                )
-            );
-        }
-        return $event;
-    }
-
-
-    /**
-     * 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() : '';
-    }
-
-
-    /**
-     * 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
-     */
-    public function is_permanently_deleteable()
-    {
-        return $this->count_registrations() === 0;
-    }
+	/**
+	 * The following constants are used by the ticket_status() method to indicate whether a ticket is on sale or not.
+	 */
+	const sold_out = 'TKS';
+
+	/**
+	 *
+	 */
+	const expired = 'TKE';
+
+	/**
+	 *
+	 */
+	const archived = 'TKA';
+
+	/**
+	 *
+	 */
+	const pending = 'TKP';
+
+	/**
+	 *
+	 */
+	const onsale = 'TKO';
+
+	/**
+	 * extra meta key for tracking ticket reservations
+	 *
+	 * @type string
+	 */
+	const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
+
+	/**
+	 * cached result from method of the same name
+	 *
+	 * @var float $_ticket_total_with_taxes
+	 */
+	private $_ticket_total_with_taxes;
+
+
+	/**
+	 * @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);
+	}
+
+
+	/**
+	 * @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
+	 */
+	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
+	 */
+	public function available($DTT_ID = 0)
+	{
+		// are we checking availability for a particular datetime ?
+		if ($DTT_ID) {
+			// get that datetime object
+			$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()) {
+				return false;
+			}
+		}
+		// datetime is still open for registration, but is this ticket sold out ?
+		return $this->qty() < 1 || $this->qty() > $this->sold() ? true : false;
+	}
+
+
+	/**
+	 * 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) {
+			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->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_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
+		}
+		return '';
+	}
+
+
+	/**
+	 * 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) {
+			return false;
+		}
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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 : '';
+	}
+
+
+	/**
+	 * 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);
+	}
+
+
+	/**
+	 * 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';
+		}
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * 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);
+	}
+
+
+	/**
+	 * 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();
+		switch ($what) {
+			case 'ticket':
+				return $tickets_sold['ticket'];
+				break;
+			case '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__
+					);
+					return $total;
+				}
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+				break;
+			default:
+				return $total;
+		}
+	}
+
+
+	/**
+	 * 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();
+		if (! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+			}
+		}
+		// Tickets sold
+		$tickets_sold['ticket'] = $this->sold();
+		return $tickets_sold;
+	}
+
+
+	/**
+	 * 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 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);
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+	 */
+	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
+	 */
+	public function ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+	 */
+	public function get_ticket_taxes_for_admin()
+	{
+		return EE_Taxes::get_taxes_for_admin();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function ticket_price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function pretty_price()
+	{
+		return $this->get_pretty('TKT_price');
+	}
+
+
+	/**
+	 * @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
+	 */
+	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;
+	}
+
+
+	public function ensure_TKT_Price_correct()
+	{
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
+		$this->save();
+	}
+
+
+	/**
+	 * @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
+	 */
+	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
+	 */
+	public function set_name($name)
+	{
+		$this->set('TKT_name', $name);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('TKT_description');
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'TKT_end_date');
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function max()
+	{
+		return $this->get('TKT_max');
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_price($price)
+	{
+		$this->set('TKT_price', $price);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
+	}
+
+
+	/**
+	 * 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
+		// via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
+		$this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:" . __LINE__ . ')');
+		$this->_increase_sold_for_datetimes($qty);
+		$this->set_sold($sold);
+		do_action(
+			'AHEE__EE_Ticket__increase_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+	/**
+	 * 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)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_sold($qty);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * 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
+	 */
+	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);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_reserved($reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
+	}
+
+
+	/**
+	 * increments reserved by amount passed by $qty
+	 *
+	 * @param int    $qty
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function increase_reserved($qty = 1, $source = 'unknown')
+	{
+		$qty = absint($qty);
+		$reserved = $this->reserved() + $qty;
+		if ($reserved
+			&& $this->add_extra_meta(
+				EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+				"{$qty} from {$source}"
+			)
+		) {
+			$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
+	 */
+	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);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * decrements (subtracts) reserved by amount passed by $qty
+	 *
+	 * @param int    $qty
+	 * @param bool   $adjust_datetimes
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
+	{
+		$reserved = $this->reserved() - absint($qty);
+		if ($this->add_extra_meta(
+			EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+			"-{$qty} from {$source}"
+		)) {
+			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
+	 */
+	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);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * 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':
+				return $this->real_quantity_on_ticket();
+			case 'saleable':
+				return $this->real_quantity_on_ticket('saleable');
+			default:
+				return $this->get_raw('TKT_qty');
+		}
+	}
+
+
+	/**
+	 * 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
+		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);
+		// echo "\n . qty: " . $qty . '<br />';
+		// calculate this ticket's total sales and reservations
+		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
+		// echo "\n . sold: " . $this->sold() . '<br />';
+		// echo "\n . reserved: " . $this->reserved() . '<br />';
+		// 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) {
+					$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());
+					// 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') {
+						$datetime_qty = max(
+							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
+							0
+						);
+						// echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
+						// echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
+						// echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					}
+					$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') {
+			// and subtract the sales for THIS ticket
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
+			// echo "\n . qty: " . $qty . '<br />';
+		}
+		// echo "\nFINAL QTY: " . $qty . "<br /><br />";
+		return $qty;
+	}
+
+
+	/**
+	 * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_qty($qty)
+	{
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
+			}
+		}
+		$this->set('TKT_qty', $qty);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_uses($uses)
+	{
+		$this->set('TKT_uses', $uses);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_required($required)
+	{
+		$this->set('TKT_required', $required);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_taxable($taxable)
+	{
+		$this->set('TKT_taxable', $taxable);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_is_default($is_default)
+	{
+		$this->set('TKT_is_default', $is_default);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_order($order)
+	{
+		$this->set('TKT_order', $order);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_row($row)
+	{
+		$this->set('TKT_row', $row);
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function set_deleted($deleted)
+	{
+		$this->set('TKT_deleted', $deleted);
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+	 */
+	public function name_and_info()
+	{
+		$times = array();
+		foreach ($this->datetimes() as $datetime) {
+			$times[] = $datetime->start_date_and_time();
+		}
+		return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('TKT_name');
+	}
+
+
+	/**
+	 * 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
+	 */
+	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
+	 */
+	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();
+		} elseif ($count_regs_for_this_ticket < $sold) {
+			$this->decrease_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		}
+		return $count_regs_for_this_ticket;
+	}
+
+
+	/**
+	 * Counts the registrations for this ticket
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return int
+	 */
+	public function count_registrations($query_params = array())
+	{
+		return $this->count_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-tickets-alt"></span>';
+	}
+
+
+	/**
+	 * 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',
+				sprintf(
+					__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		$event = $datetime->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'),
+					$this->name()
+				)
+			);
+		}
+		return $event;
+	}
+
+
+	/**
+	 * 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() : '';
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function is_permanently_deleteable()
+	{
+		return $this->count_registrations() === 0;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -127,7 +127,7 @@ 
     public function ticket_status($display = false, $remaining = null)
     {
         $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
+        if ( ! $remaining) {
             return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
         }
         if ($this->get('TKT_deleted')) {
@@ -245,7 +245,7 @@ 
             : '';
         $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 : '';
     }
 
 
@@ -272,7 +272,7 @@ 
      */
     public function datetimes($query_params = array())
     {
-        if (! isset($query_params['order_by'])) {
+        if ( ! isset($query_params['order_by'])) {
             $query_params['order_by']['DTT_order'] = 'ASC';
         }
         return $this->get_many_related('Datetime', $query_params);
@@ -317,7 +317,7 @@ 
                 if (empty($tickets_sold['datetime'])) {
                     return $total;
                 }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+                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?',
@@ -329,7 +329,7 @@ 
                     );
                     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;
@@ -347,9 +347,9 @@ 
     {
         $datetimes = $this->get_many_related('Datetime');
         $tickets_sold = array();
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+                $tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
             }
         }
         // Tickets sold
@@ -756,7 +756,7 @@ 
         $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, "TKT: {$this->ID()} (ln:" . __LINE__ . ')');
+        $this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:".__LINE__.')');
         $this->_increase_sold_for_datetimes($qty);
         $this->set_sold($sold);
         do_action(
@@ -1300,7 +1300,7 @@ 
         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();
     }
 
 
@@ -1406,7 +1406,7 @@ 
     {
         // 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',
@@ -1417,7 +1417,7 @@ 
             );
         }
         $event = $datetime->event();
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new UnexpectedEntityException(
                 $event,
                 'EE_Event',

core/db_classes/EE_Venue.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
      * @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_Attendee
+     * @return EE_Venue
      */
     public static function new_instance_from_db($props_n_values = array(), $timezone = null)
     {

Indentation +560 added lines, -560 removed lines

@@ -10,564 +10,564 @@
 class EE_Venue extends EE_CPT_Base implements EEI_Address
 {
 
-    /**
-     *
-     * @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_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('VNU_name');
-    }
-
-
-    /**
-     * Gets phone
-     *
-     * @return string
-     */
-    public function phone()
-    {
-        return $this->get('VNU_phone');
-    }
-
-
-    /**
-     * venue_url
-     *
-     * @return string
-     */
-    public function venue_url()
-    {
-        return $this->get('VNU_url');
-    }
-
-
-    /**
-     * Gets desc
-     *
-     * @return string
-     */
-    public function description()
-    {
-        return $this->get('VNU_desc');
-    }
-
-
-    /**
-     * Gets short description (AKA: the excerpt)
-     *
-     * @return string
-     */
-    public function excerpt()
-    {
-        return $this->get('VNU_short_desc');
-    }
-
-
-    /**
-     * Gets identifier
-     *
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->get('VNU_identifier');
-    }
-
-
-    /**
-     * Gets address
-     *
-     * @return string
-     */
-    public function address()
-    {
-        return $this->get('VNU_address');
-    }
-
-
-    /**
-     * Gets address2
-     *
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->get('VNU_address2');
-    }
-
-
-    /**
-     * Gets city
-     *
-     * @return string
-     */
-    public function city()
-    {
-        return $this->get('VNU_city');
-    }
-
-    /**
-     * Gets state
-     *
-     * @return int
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
-    }
-
-
-    /**
-     * Gets the state for this venue
-     *
-     * @return EE_State
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * country_ID
-     *
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
-    }
-
-
-    /**
-     * Gets the country of this venue
-     *
-     * @return EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * Gets zip
-     *
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->get('VNU_zip');
-    }
-
-
-    /**
-     * Gets capacity
-     *
-     * @return int
-     */
-    public function capacity()
-    {
-        return $this->get_pretty('VNU_capacity', 'symbol');
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('VNU_created');
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('VNU_modified');
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('VNU_order');
-    }
-
-
-    /**
-     * Gets wp_user
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('VNU_wp_user');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function virtual_phone()
-    {
-        return $this->get('VNU_virtual_phone');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function virtual_url()
-    {
-        return $this->get('VNU_virtual_url');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function enable_for_gmap()
-    {
-        return $this->get('VNU_enable_for_gmap');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function google_map_link()
-    {
-        return $this->get('VNU_google_map_link');
-    }
-
-
-    /**
-     * Gets all events happening at this venue. Query parameters can be added to
-     * fetch a subset of those events.
-     *
-     * @param array $query_params like EEM_Base::get_all's $query_params
-     * @param bool  $upcoming
-     * @return EE_Event[]
-     */
-    public function events($query_params = array(), $upcoming = false)
-    {
-        if ($upcoming) {
-            $query_params = array(
-                array(
-                    'status'                 => 'publish',
-                    'Datetime.DTT_EVT_start' => array(
-                        '>',
-                        EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-                    ),
-                ),
-            );
-        }
-        return $this->get_many_related('Event', $query_params);
-    }
-
-
-    /**
-     * Sets address
-     */
-    public function set_address($address = '')
-    {
-        $this->set('VNU_address', $address);
-    }
-
-
-    /**
-     * @param string $address2
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('VNU_address2', $address2);
-    }
-
-
-    /**
-     * @param string $city
-     */
-    public function set_city($city = '')
-    {
-        $this->set('VNU_city', $city);
-    }
-
-
-    /**
-     * @param int $state
-     */
-    public function set_state_ID($state = 0)
-    {
-        $this->set('STA_ID', $state);
-    }
-
-
-    /**
-     * Sets the state, given either a state id or state object
-     *
-     * @param EE_State /int $state_id_or_obj
-     * @return EE_State
-     */
-    public function set_state_obj($state_id_or_obj)
-    {
-        return $this->_add_relation_to($state_id_or_obj, 'State');
-    }
-
-
-    /**
-     * @param int $country_ID
-     */
-    public function set_country_ID($country_ID = 0)
-    {
-        $this->set('CNT_ISO', $country_ID);
-    }
-
-
-    /**
-     * Sets the country on the venue
-     *
-     * @param EE_Country /string $country_id_or_obj
-     * @return EE_Country
-     */
-    public function set_country_obj($country_id_or_obj)
-    {
-        return $this->_add_relation_to($country_id_or_obj, 'Country');
-    }
-
-
-    /**
-     * @param string $zip
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('VNU_zip', $zip);
-    }
-
-
-    /**
-     * @param int $capacity
-     */
-    public function set_capacity($capacity = 0)
-    {
-        $this->set('VNU_capacity', $capacity);
-    }
-
-
-    /**
-     * @param string $created
-     */
-    public function set_created($created = '')
-    {
-        $this->set('VNU_created', $created);
-    }
-
-
-    /**
-     * @param string $desc
-     */
-    public function set_description($desc = '')
-    {
-        $this->set('VNU_desc', $desc);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    public function set_identifier($identifier = '')
-    {
-        $this->set('VNU_identifier', $identifier);
-    }
-
-
-    /**
-     * @param string $modified
-     */
-    public function set_modified($modified = '')
-    {
-        $this->set('VNU_modified', $modified);
-    }
-
-
-    /**
-     * @param string $name
-     */
-    public function set_name($name = '')
-    {
-        $this->set('VNU_name', $name);
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order = 0)
-    {
-        $this->set('VNU_order', $order);
-    }
-
-
-    /**
-     * @param string $phone
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('VNU_phone', $phone);
-    }
-
-
-    /**
-     * @param int $wp_user
-     */
-    public function set_wp_user($wp_user = 1)
-    {
-        $this->set('VNU_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param string $url
-     */
-    public function set_venue_url($url = '')
-    {
-        $this->set('VNU_url', $url);
-    }
-
-
-    /**
-     * @param string $phone
-     */
-    public function set_virtual_phone($phone = '')
-    {
-        $this->set('VNU_virtual_phone', $phone);
-    }
-
-
-    /**
-     * @param string $url
-     */
-    public function set_virtual_url($url = '')
-    {
-        $this->set('VNU_virtual_url', $url);
-    }
-
-
-    /**
-     * @param string $enable
-     */
-    public function set_enable_for_gmap($enable = '')
-    {
-        $this->set('VNU_enable_for_gmap', $enable);
-    }
-
-
-    /**
-     * @param string $google_map_link
-     */
-    public function set_google_map_link($google_map_link = '')
-    {
-        $this->set('VNU_google_map_link', $google_map_link);
-    }
+	/**
+	 *
+	 * @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_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('VNU_name');
+	}
+
+
+	/**
+	 * Gets phone
+	 *
+	 * @return string
+	 */
+	public function phone()
+	{
+		return $this->get('VNU_phone');
+	}
+
+
+	/**
+	 * venue_url
+	 *
+	 * @return string
+	 */
+	public function venue_url()
+	{
+		return $this->get('VNU_url');
+	}
+
+
+	/**
+	 * Gets desc
+	 *
+	 * @return string
+	 */
+	public function description()
+	{
+		return $this->get('VNU_desc');
+	}
+
+
+	/**
+	 * Gets short description (AKA: the excerpt)
+	 *
+	 * @return string
+	 */
+	public function excerpt()
+	{
+		return $this->get('VNU_short_desc');
+	}
+
+
+	/**
+	 * Gets identifier
+	 *
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->get('VNU_identifier');
+	}
+
+
+	/**
+	 * Gets address
+	 *
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->get('VNU_address');
+	}
+
+
+	/**
+	 * Gets address2
+	 *
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->get('VNU_address2');
+	}
+
+
+	/**
+	 * Gets city
+	 *
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->get('VNU_city');
+	}
+
+	/**
+	 * Gets state
+	 *
+	 * @return int
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->name() : '';
+	}
+
+
+	/**
+	 * Gets the state for this venue
+	 *
+	 * @return EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * country_ID
+	 *
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof EE_Country ? $this->country_obj()->name() : '';
+	}
+
+
+	/**
+	 * Gets the country of this venue
+	 *
+	 * @return EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * Gets zip
+	 *
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->get('VNU_zip');
+	}
+
+
+	/**
+	 * Gets capacity
+	 *
+	 * @return int
+	 */
+	public function capacity()
+	{
+		return $this->get_pretty('VNU_capacity', 'symbol');
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('VNU_created');
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('VNU_modified');
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('VNU_order');
+	}
+
+
+	/**
+	 * Gets wp_user
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('VNU_wp_user');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function virtual_phone()
+	{
+		return $this->get('VNU_virtual_phone');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function virtual_url()
+	{
+		return $this->get('VNU_virtual_url');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function enable_for_gmap()
+	{
+		return $this->get('VNU_enable_for_gmap');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function google_map_link()
+	{
+		return $this->get('VNU_google_map_link');
+	}
+
+
+	/**
+	 * Gets all events happening at this venue. Query parameters can be added to
+	 * fetch a subset of those events.
+	 *
+	 * @param array $query_params like EEM_Base::get_all's $query_params
+	 * @param bool  $upcoming
+	 * @return EE_Event[]
+	 */
+	public function events($query_params = array(), $upcoming = false)
+	{
+		if ($upcoming) {
+			$query_params = array(
+				array(
+					'status'                 => 'publish',
+					'Datetime.DTT_EVT_start' => array(
+						'>',
+						EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+					),
+				),
+			);
+		}
+		return $this->get_many_related('Event', $query_params);
+	}
+
+
+	/**
+	 * Sets address
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('VNU_address', $address);
+	}
+
+
+	/**
+	 * @param string $address2
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('VNU_address2', $address2);
+	}
+
+
+	/**
+	 * @param string $city
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('VNU_city', $city);
+	}
+
+
+	/**
+	 * @param int $state
+	 */
+	public function set_state_ID($state = 0)
+	{
+		$this->set('STA_ID', $state);
+	}
+
+
+	/**
+	 * Sets the state, given either a state id or state object
+	 *
+	 * @param EE_State /int $state_id_or_obj
+	 * @return EE_State
+	 */
+	public function set_state_obj($state_id_or_obj)
+	{
+		return $this->_add_relation_to($state_id_or_obj, 'State');
+	}
+
+
+	/**
+	 * @param int $country_ID
+	 */
+	public function set_country_ID($country_ID = 0)
+	{
+		$this->set('CNT_ISO', $country_ID);
+	}
+
+
+	/**
+	 * Sets the country on the venue
+	 *
+	 * @param EE_Country /string $country_id_or_obj
+	 * @return EE_Country
+	 */
+	public function set_country_obj($country_id_or_obj)
+	{
+		return $this->_add_relation_to($country_id_or_obj, 'Country');
+	}
+
+
+	/**
+	 * @param string $zip
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('VNU_zip', $zip);
+	}
+
+
+	/**
+	 * @param int $capacity
+	 */
+	public function set_capacity($capacity = 0)
+	{
+		$this->set('VNU_capacity', $capacity);
+	}
+
+
+	/**
+	 * @param string $created
+	 */
+	public function set_created($created = '')
+	{
+		$this->set('VNU_created', $created);
+	}
+
+
+	/**
+	 * @param string $desc
+	 */
+	public function set_description($desc = '')
+	{
+		$this->set('VNU_desc', $desc);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	public function set_identifier($identifier = '')
+	{
+		$this->set('VNU_identifier', $identifier);
+	}
+
+
+	/**
+	 * @param string $modified
+	 */
+	public function set_modified($modified = '')
+	{
+		$this->set('VNU_modified', $modified);
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	public function set_name($name = '')
+	{
+		$this->set('VNU_name', $name);
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order = 0)
+	{
+		$this->set('VNU_order', $order);
+	}
+
+
+	/**
+	 * @param string $phone
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('VNU_phone', $phone);
+	}
+
+
+	/**
+	 * @param int $wp_user
+	 */
+	public function set_wp_user($wp_user = 1)
+	{
+		$this->set('VNU_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param string $url
+	 */
+	public function set_venue_url($url = '')
+	{
+		$this->set('VNU_url', $url);
+	}
+
+
+	/**
+	 * @param string $phone
+	 */
+	public function set_virtual_phone($phone = '')
+	{
+		$this->set('VNU_virtual_phone', $phone);
+	}
+
+
+	/**
+	 * @param string $url
+	 */
+	public function set_virtual_url($url = '')
+	{
+		$this->set('VNU_virtual_url', $url);
+	}
+
+
+	/**
+	 * @param string $enable
+	 */
+	public function set_enable_for_gmap($enable = '')
+	{
+		$this->set('VNU_enable_for_gmap', $enable);
+	}
+
+
+	/**
+	 * @param string $google_map_link
+	 */
+	public function set_google_map_link($google_map_link = '')
+	{
+		$this->set('VNU_google_map_link', $google_map_link);
+	}
 }

modules/single_page_checkout/inc/EE_Checkout.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -319,7 +319,7 @@ 
 
     /**
      * @param $REG_ID
-     * @param $reg_status
+     * @param boolean $reg_status
      */
     public function set_reg_status_updated($REG_ID, $reg_status)
     {
@@ -1237,6 +1237,7 @@ 
      *
      * @param    string | int    $reg_cache_ID
      * @param    EE_Registration $registration
+     * @param integer $reg_cache_ID
      * @return void
      * @throws \EE_Error
      */

Indentation +1425 added lines, -1425 removed lines

@@ -15,1429 +15,1429 @@
 class EE_Checkout
 {
 
-    /**
-     *    whether current request originated from the EE admin
-     *
-     * @type bool
-     */
-    public $admin_request = false;
-
-    /**
-     * whether returning to edit attendee information or to retry a payment
-     *
-     * @type bool
-     */
-    public $revisit = false;
-
-    /**
-     * whether the primary registrant is returning to edit attendee information or to retry a payment
-     *
-     * @type bool
-     */
-    public $primary_revisit = false;
-
-    /**
-     * is registration allowed to progress or halted for some reason such as failing to pass recaptcha?
-     *
-     * @type bool
-     */
-    public $continue_reg = true;
-
-    /**
-     * redirect to thank you page ?
-     *
-     * @type bool
-     */
-    public $redirect = false;
-
-    /**
-     * generate the reg form or not ?
-     *
-     * @type bool
-     */
-    public $generate_reg_form = true;
-
-    /**
-     * process a reg form submission or not ?
-     *
-     * @type bool
-     */
-    public $process_form_submission = false;
-
-    /**
-     * tracks whether the TXN status modified during this checkout
-     *
-     * @type bool
-     */
-    public $txn_status_updated = false;
-
-    /**
-     * only triggered to true after absolutely everything has finished.
-     *
-     * @type bool
-     */
-    protected $exit_spco = false;
-
-    /**
-     * tracks whether any of the TXN's Registrations statuses modified during this checkout
-     * indexed by registration ID
-     *
-     * @type array
-     */
-    protected $reg_status_updated = array();
-
-    /**
-     * timestamp when redirected from Ticket Selector to the checkout
-     *
-     * @type int
-     */
-    public $uts = 0;
-
-    /**
-     * total number of tickets that were in the cart
-     *
-     * @type int
-     */
-    public $total_ticket_count = 0;
-
-    /**
-     * corresponds loosely to EE_Transaction::remaining()
-     * but can be modified by SPCO
-     *
-     * @type float
-     */
-    public $amount_owing = 0;
-
-    /**
-     * the reg step slug from the incoming request
-     *
-     * @type string
-     */
-    public $step = '';
-
-    /**
-     * the reg step slug for a step being edited
-     *
-     * @type string
-     */
-    public $edit_step = '';
-
-    /**
-     * the action being performed on the current step
-     *
-     * @type string
-     */
-    public $action = '';
-
-    /**
-     * reg_url_link for a previously saved registration
-     *
-     * @type string
-     */
-    public $reg_url_link = '';
-
-    /**
-     * string slug for the payment method that was selected during the payment options step
-     *
-     * @type string
-     */
-    public $selected_method_of_payment = '';
-
-    /**
-     * base url for the site's registration checkout page - additional url params will be added to this
-     *
-     * @type string
-     */
-    public $reg_page_base_url = '';
-
-    /**
-     * base url for the site's registration cancelled page - additional url params will be added to this
-     *
-     * @type string
-     */
-    public $cancel_page_url = '';
-
-    /**
-     * base url for the site's thank you page - additional url params will be added to this
-     *
-     * @type string
-     */
-    public $thank_you_page_url = '';
-
-    /**
-     * base url for any redirects - additional url params will be added to this
-     *
-     * @type string
-     */
-    public $redirect_url = '';
-
-    /**
-     * form of POST data for use with off-site gateways
-     *
-     * @type string
-     */
-    public $redirect_form = '';
-
-    /**
-     * array of query where params to use when retrieving cached registrations from $this->checkout->transaction
-     *
-     * @type array
-     */
-    public $reg_cache_where_params = array();
-
-    /**
-     * a class for managing and creating the JSON encoded array of data that gets passed back to the client during AJAX
-     * requests
-     *
-     * @type EE_SPCO_JSON_Response
-     */
-    public $json_response;
-
-    /**
-     * where we are going next in the reg process
-     *
-     * @type EE_SPCO_Reg_Step
-     */
-    public $next_step;
-
-    /**
-     * where we are in the reg process
-     *
-     * @type EE_SPCO_Reg_Step
-     */
-    public $current_step;
-
-    /**
-     *    $_cart - the current cart object
-     *
-     * @var EE_CART
-     */
-    public $cart;
-
-    /**
-     *    $_transaction - the current transaction object
-     *
-     * @var EE_Transaction
-     */
-    public $transaction;
-
-    /**
-     *    the related attendee object for the primary registrant
-     *
-     * @type EE_Attendee
-     */
-    public $primary_attendee_obj;
-
-    /**
-     *    $payment_method - the payment method object for the selected method of payment
-     *
-     * @type EE_Payment_Method
-     */
-    public $payment_method;
-
-    /**
-     *    $payment - if a payment was successfully made during the reg process,
-     *    then here it is !!!
-     *
-     * @type EE_Payment
-     */
-    public $payment;
-
-    /**
-     *    if a payment method was selected that uses an on-site gateway, then this is the billing form
-     *
-     * @type EE_Billing_Info_Form | EE_Billing_Attendee_Info_Form
-     */
-    public $billing_form;
-
-    /**
-     *    the entire registration form composed of ALL of the subsections generated by the various reg steps
-     *
-     * @type EE_Form_Section_Proper
-     */
-    public $registration_form;
-
-    /**
-     * array of EE_SPCO_Reg_Step objects
-     *
-     * @type EE_SPCO_Reg_Step[]
-     */
-    public $reg_steps = array();
-
-    /**
-     * array of EE_Payment_Method objects
-     *
-     * @type EE_Payment_Method[]
-     */
-    public $available_payment_methods = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        $this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
-        $this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
-        $this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
-        $this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
-        $this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->ajax;
-        $this->reg_cache_where_params = array(
-            0          => array('REG_deleted' => false),
-            'order_by' => array('REG_count' => 'ASC'),
-        );
-    }
-
-
-    /**
-     * returns true if ANY reg status was updated during checkout
-     *
-     * @return boolean
-     */
-    public function any_reg_status_updated()
-    {
-        foreach ($this->reg_status_updated as $reg_status) {
-            if ($reg_status) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @param $REG_ID
-     * @return boolean
-     */
-    public function reg_status_updated($REG_ID)
-    {
-        return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
-    }
-
-
-    /**
-     * @param $REG_ID
-     * @param $reg_status
-     */
-    public function set_reg_status_updated($REG_ID, $reg_status)
-    {
-        $this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * exit_spco
-     *
-     * @return bool
-     */
-    public function exit_spco()
-    {
-        return $this->exit_spco;
-    }
-
-
-    /**
-     * set_exit_spco
-     * can ONLY be set by the  Finalize_Registration reg step
-     */
-    public function set_exit_spco()
-    {
-        if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-            $this->exit_spco = true;
-        }
-    }
-
-
-    /**
-     *    reset_for_current_request
-     *
-     * @access    public
-     * @return    void
-     */
-    public function reset_for_current_request()
-    {
-        $this->process_form_submission = false;
-        $this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
-        $this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->front_ajax;
-        $this->continue_reg = true;
-        $this->redirect = false;
-        // don't reset the cached redirect form if we're about to be asked to display it !!!
-        if (EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step') !== 'redirect_form') {
-            $this->redirect_form = '';
-        }
-        $this->redirect_url = '';
-        $this->json_response = new EE_SPCO_JSON_Response();
-        EE_Form_Section_Proper::reset_js_localization();
-    }
-
-
-    /**
-     *    add_reg_step
-     *
-     * @access    public
-     * @param EE_SPCO_Reg_Step $reg_step_obj
-     * @return    void
-     */
-    public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
-    {
-        $this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
-    }
-
-
-    /**
-     * skip_reg_step
-     * if the current reg step does not need to run for some reason,
-     * then this will advance SPCO to the next reg step,
-     * and mark the skipped step as completed
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function skip_reg_step($reg_step_slug = '')
-    {
-        $step_to_skip = $this->find_reg_step($reg_step_slug);
-        if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
-            $step_to_skip->set_is_current_step(false);
-            $step_to_skip->set_completed();
-            // advance to the next step
-            $this->set_current_step($this->next_step->slug());
-            // also reset the step param in the request in case any other code references that directly
-            EE_Registry::instance()->REQ->set('step', $this->current_step->slug());
-            // since we are skipping a step and setting the current step to be what was previously the next step,
-            // we need to check that the next step is now correct, and not still set to the current step.
-            if ($this->current_step->slug() === $this->next_step->slug()) {
-                // correctly setup the next step
-                $this->set_next_step();
-            }
-            $this->set_reg_step_initiated($this->current_step);
-        }
-    }
-
-
-    /**
-     *    remove_reg_step
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @param bool   $reset whether to reset reg steps after removal
-     * @throws EE_Error
-     */
-    public function remove_reg_step($reg_step_slug = '', $reset = true)
-    {
-        unset($this->reg_steps[ $reg_step_slug ]);
-        if ($this->transaction instanceof EE_Transaction) {
-            // now remove reg step from TXN and save
-            $this->transaction->remove_reg_step($reg_step_slug);
-            $this->transaction->save();
-        }
-        if ($reset) {
-            $this->reset_reg_steps();
-        }
-    }
-
-
-    /**
-     *    set_reg_step_order
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @param int    $order
-     * @return    void
-     */
-    public function set_reg_step_order($reg_step_slug = '', $order = 100)
-    {
-        if (isset($this->reg_steps[ $reg_step_slug ])) {
-            $this->reg_steps[ $reg_step_slug ]->set_order($order);
-        }
-    }
-
-
-    /**
-     *    set_current_step
-     *
-     * @access    public
-     * @param string $current_step
-     * @return    void
-     */
-    public function set_current_step($current_step)
-    {
-        // grab what step we're on
-        $this->current_step = isset($this->reg_steps[ $current_step ])
-            ? $this->reg_steps[ $current_step ]
-            : reset(
-                $this->reg_steps
-            );
-        // verify instance
-        if ($this->current_step instanceof EE_SPCO_Reg_Step) {
-            // we don't want to repeat completed steps if this is the first time through SPCO
-            if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
-                // so advance to the next step
-                $this->set_next_step();
-                if ($this->next_step instanceof EE_SPCO_Reg_Step) {
-                    // and attempt to set it as the current step
-                    $this->set_current_step($this->next_step->slug());
-                }
-                return;
-            }
-            $this->current_step->set_is_current_step(true);
-        } else {
-            EE_Error::add_error(
-                __('The current step could not be set.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     *    set_next_step
-     * advances the reg_steps array pointer and sets the next step, then reverses pointer back to the current step
-     *
-     * @access    public
-     * @return    void
-     */
-    public function set_next_step()
-    {
-        // set pointer to start of array
-        reset($this->reg_steps);
-        // if there is more than one step
-        if (count($this->reg_steps) > 1) {
-            // advance to the current step and set pointer
-            while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
-                next($this->reg_steps);
-            }
-        }
-        // advance one more spot ( if it exists )
-        $this->next_step = next($this->reg_steps);
-        // verify instance
-        $this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : null;
-        // then back to current step to reset
-        prev($this->reg_steps);
-    }
-
-
-    /**
-     *    get_next_reg_step
-     *    this simply returns the next step from reg_steps array
-     *
-     * @access    public
-     * @return    EE_SPCO_Reg_Step | null
-     */
-    public function get_next_reg_step()
-    {
-        $next = next($this->reg_steps);
-        prev($this->reg_steps);
-        return $next instanceof EE_SPCO_Reg_Step ? $next : null;
-    }
-
-
-    /**
-     * get_prev_reg_step
-     *    this simply returns the previous step from reg_steps array
-     *
-     * @access    public
-     * @return    EE_SPCO_Reg_Step | null
-     */
-    public function get_prev_reg_step()
-    {
-        $prev = prev($this->reg_steps);
-        next($this->reg_steps);
-        return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
-    }
-
-
-    /**
-     * sort_reg_steps
-     *
-     * @access public
-     * @return void
-     */
-    public function sort_reg_steps()
-    {
-        $reg_step_sorting_callback = apply_filters(
-            'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback',
-            'reg_step_sorting_callback'
-        );
-        uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
-    }
-
-
-    /**
-     * find_reg_step
-     * finds a reg step by the given slug
-     *
-     * @access    public
-     * @param string $reg_step_slug
-     * @return EE_SPCO_Reg_Step|null
-     */
-    public function find_reg_step($reg_step_slug = '')
-    {
-        if (! empty($reg_step_slug)) {
-            // copy reg step array
-            $reg_steps = $this->reg_steps;
-            // set pointer to start of array
-            reset($reg_steps);
-            // if there is more than one step
-            if (count($reg_steps) > 1) {
-                // advance to the current step and set pointer
-                while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
-                    next($reg_steps);
-                }
-                return current($reg_steps);
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * reg_step_sorting_callback
-     *
-     * @access public
-     * @param EE_SPCO_Reg_Step $reg_step_A
-     * @param EE_SPCO_Reg_Step $reg_step_B
-     * @return int
-     */
-    public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B)
-    {
-        // send finalize_registration step to the end of the array
-        if ($reg_step_A->slug() === 'finalize_registration') {
-            return 1;
-        } elseif ($reg_step_B->slug() === 'finalize_registration') {
-            return -1;
-        }
-        if ($reg_step_A->order() === $reg_step_B->order()) {
-            return 0;
-        }
-        return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     *
-     * @access    public
-     * @param    EE_SPCO_Reg_Step $reg_step
-     * @throws \EE_Error
-     */
-    public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step)
-    {
-        // call set_reg_step_initiated ???
-        if (// first time visiting SPCO ?
-            ! $this->revisit
-            && (
-                // and displaying the reg step form for the first time ?
-                $this->action === 'display_spco_reg_step'
-                // or initializing the final step
-                || $reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration
-            )
-        ) {
-            // set the start time for this reg step
-            if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
-                            $reg_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    set_reg_step_JSON_info
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_reg_step_JSON_info()
-    {
-        EE_Registry::$i18n_js_strings['reg_steps'] = array();
-        // pass basic reg step data to JS
-        foreach ($this->reg_steps as $reg_step) {
-            EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
-        }
-        // reset reg step html
-        // $this->json_response->set_reg_step_html('');
-    }
-
-
-    /**
-     *    reset_reg_steps
-     *
-     * @access public
-     * @return void
-     */
-    public function reset_reg_steps()
-    {
-        $this->sort_reg_steps();
-        $this->set_current_step(EE_Registry::instance()->REQ->get('step'));
-        $this->set_next_step();
-        // the text that appears on the reg step form submit button
-        $this->current_step->set_submit_button_text();
-        $this->set_reg_step_JSON_info();
-    }
-
-
-    /**
-     *    get_registration_time_limit
-     *
-     * @access    public
-     * @return        string
-     */
-    public function get_registration_time_limit()
-    {
-
-        $registration_time_limit = (float) (EE_Registry::instance()->SSN->expiration() - time());
-        $time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
-        $registration_time_limit = date($time_limit_format, $registration_time_limit);
-        return apply_filters(
-            'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
-            $registration_time_limit
-        );
-    }
-
-
-    /**
-     * payment_required
-     *
-     * @return boolean
-     */
-    public function payment_required()
-    {
-        // if NOT:
-        //     registration via admin
-        //      completed TXN
-        //      overpaid TXN
-        //      free TXN(total = 0.00)
-        //      then payment required is TRUE
-        return ! ($this->admin_request
-                  || $this->transaction->is_completed()
-                  || $this->transaction->is_overpaid()
-                  || $this->transaction->is_free()) ? true : false;
-    }
-
-
-    /**
-     * get_cart_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @return EE_Cart
-     */
-    public function get_cart_for_transaction($transaction)
-    {
-        $session = EE_Registry::instance()->load_core('Session');
-        $cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
-        // verify cart
-        if (! $cart instanceof EE_Cart) {
-            $cart = EE_Registry::instance()->load_core('Cart');
-        }
-
-        return $cart;
-    }
-
-
-    /**
-     *    initialize_txn_reg_steps_array
-     *
-     * @access public
-     * @return    array
-     */
-    public function initialize_txn_reg_steps_array()
-    {
-        $txn_reg_steps_array = array();
-        foreach ($this->reg_steps as $reg_step) {
-            $txn_reg_steps_array[ $reg_step->slug() ] = false;
-        }
-        return $txn_reg_steps_array;
-    }
-
-
-    /**
-     *    update_txn_reg_steps_array
-     *
-     * @access public
-     * @return    bool
-     * @throws \EE_Error
-     */
-    public function update_txn_reg_steps_array()
-    {
-        $updated = false;
-        foreach ($this->reg_steps as $reg_step) {
-            if ($reg_step->completed()) {
-                $updated = $this->transaction->set_reg_step_completed($reg_step->slug())
-                    ? true
-                    : $updated;
-            }
-        }
-        if ($updated) {
-            $this->transaction->save();
-        }
-        return $updated;
-    }
-
-
-    /**
-     *    stash_transaction_and_checkout
-     *
-     * @access public
-     * @return    void
-     * @throws \EE_Error
-     */
-    public function stash_transaction_and_checkout()
-    {
-        if (! $this->revisit) {
-            $this->update_txn_reg_steps_array();
-        }
-        $this->track_transaction_and_registration_status_updates();
-        // save all data to the db, but suppress errors
-        // $this->save_all_data( FALSE );
-        // cache the checkout in the session
-        EE_Registry::instance()->SSN->set_checkout($this);
-    }
-
-
-    /**
-     *    track_transaction_and_registration_status_updates
-     *    stores whether any updates were made to the TXN or it's related registrations
-     *
-     * @access public
-     * @return void
-     * @throws \EE_Error
-     */
-    public function track_transaction_and_registration_status_updates()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction) {
-            // has there been a TXN status change during this checkout?
-            $this->txn_status_updated = $this->transaction->txn_status_updated();
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
-                if ($registration_processor->reg_status_updated($registration->ID())) {
-                    $this->set_reg_status_updated($registration->ID(), true);
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    visit_allows_processing_of_this_registration
-     *    determines if the current SPCO visit should allow the passed EE_Registration to be used in processing.
-     *    one of the following conditions must be met:
-     *        EITHER:    A) first time thru SPCO -> process ALL registrations ( NOT a revisit )
-     *        OR :        B) primary registrant is editing info -> process ALL registrations ( primary_revisit )
-     *        OR :        C) another registrant is editing info -> ONLY process their registration ( revisit AND their
-     *        reg_url_link matches )
-     *
-     * @access public
-     * @param    EE_Registration $registration
-     * @return    bool
-     * @throws \EE_Error
-     */
-    public function visit_allows_processing_of_this_registration(EE_Registration $registration)
-    {
-        return ! $this->revisit
-               || $this->primary_revisit
-               || (
-                   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
-               )
-            ? true
-            : false;
-    }
-
-
-    /**
-     *    _transaction_has_primary_registration
-     *
-     * @access        private
-     * @return        bool
-     */
-    public function transaction_has_primary_registrant()
-    {
-        return $this->primary_attendee_obj instanceof EE_Attendee ? true : false;
-    }
-
-
-    /**
-     *    save_all_data
-     *    simply loops through the current transaction and saves all data for each registration
-     *
-     * @access public
-     * @param bool $show_errors
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function save_all_data($show_errors = true)
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction) {
-            // save to ensure that TXN has ID
-            $this->transaction->save();
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
-                $this->_save_registration($registration, $show_errors);
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    __(
-                        'A valid Transaction was not found when attempting to save your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration($registration, $show_errors = true)
-    {
-        // verify object
-        if ($registration instanceof EE_Registration) {
-            // should this registration be processed during this visit ?
-            if ($this->visit_allows_processing_of_this_registration($registration)) {
-                // set TXN ID
-                if (! $registration->transaction_ID()) {
-                    $registration->set_transaction_id($this->transaction->ID());
-                }
-                // verify and save the attendee
-                $this->_save_registration_attendee($registration, $show_errors);
-                // save answers to reg form questions
-                $this->_save_registration_answers($registration, $show_errors);
-                // save changes
-                $registration->save();
-                // update txn cache
-                if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
-                    if ($show_errors) {
-                        EE_Error::add_error(
-                            __(
-                                'The newly saved Registration object could not be cached on the Transaction.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    __(
-                        'An invalid Registration object was discovered when attempting to save your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration_attendee($registration, $show_errors = true)
-    {
-        if ($registration->attendee() instanceof EE_Attendee) {
-            // save so that ATT has ID
-            $registration->attendee()->save();
-            if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
-                if ($show_errors) {
-                    EE_Error::add_error(
-                        __(
-                            'The newly saved Attendee object could not be cached on the registration.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } else {
-            if ($show_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        '%1$s||%1$s $attendee = %2$s',
-                        __(
-                            'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.',
-                            'event_espresso'
-                        ),
-                        var_export($registration->attendee(), true)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * _save_question_answers
-     *
-     * @param    EE_Registration $registration
-     * @param bool               $show_errors
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _save_registration_answers($registration, $show_errors = true)
-    {
-        // now save the answers
-        foreach ($registration->answers() as $cache_key => $answer) {
-            // verify object
-            if ($answer instanceof EE_Answer) {
-                $answer->set_registration($registration->ID());
-                $answer->save();
-                if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
-                    if ($show_errors) {
-                        EE_Error::add_error(
-                            __(
-                                'The newly saved Answer object could not be cached on the registration.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            } else {
-                if ($show_errors) {
-                    EE_Error::add_error(
-                        __(
-                            'An invalid Answer object was discovered when attempting to save your registration information.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    refresh_all_entities
-     *   will either refresh the entity map with objects form the db or from the checkout cache
-     *
-     * @access public
-     * @param bool $from_db
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function refresh_all_entities($from_db = false)
-    {
-        $from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
-            ? true
-            : $from_db;
-        // $this->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array('from_db' => $from_db)
-        // );
-        return $from_db ? $this->refresh_from_db() : $this->refresh_entity_map();
-    }
-
-
-    /**
-     *  refresh_entity_map
-     *  simply loops through the current transaction and updates each
-     *  model's entity map using EEM_Base::refresh_entity_map_from_db()
-     *
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function refresh_from_db()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            // pull fresh TXN data from the db
-            $this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
-            // update EE_Checkout's cached primary_attendee object
-            $this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
-            // update EE_Checkout's cached payment object
-            $payment = $this->transaction->last_payment();
-            $this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
-            // update EE_Checkout's cached payment_method object
-            $payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
-            $this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method
-                : $this->payment_method;
-            // now refresh the cart, based on the TXN
-            $this->cart = $this->get_cart_for_transaction($this->transaction);
-        } else {
-            EE_Error::add_error(
-                __(
-                    'A valid Transaction was not found when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _refresh_primary_attendee_obj_from_db
-     *
-     * @param   EE_Transaction $transaction
-     * @return  EE_Attendee | null
-     * @throws \EE_Error
-     */
-    protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction)
-    {
-
-        $primary_attendee_obj = null;
-        // grab the saved registrations from the transaction
-        foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
-            // verify object
-            if ($registration instanceof EE_Registration) {
-                $attendee = $registration->attendee();
-                // verify object && maybe cache primary_attendee_obj ?
-                if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
-                    $primary_attendee_obj = $attendee;
-                }
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'An invalid Registration object was discovered when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $primary_attendee_obj;
-    }
-
-
-    /**
-     *  refresh_entity_map
-     *  simply loops through the current transaction and updates
-     *  each model's entity map using EEM_Base::refresh_entity_map_with()
-     *
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    protected function refresh_entity_map()
-    {
-        // verify the transaction
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            // never cache payment info
-            $this->transaction->clear_cache('Payment');
-            // is the Payment Options Reg Step completed ?
-            if ($this->transaction->reg_step_completed('payment_options')) {
-                // then check for payments and update TXN accordingly
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                $transaction_payments->calculate_total_payments_and_update_status($this->transaction);
-            }
-            // grab the saved registrations from the transaction
-            foreach ($this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration) {
-                $this->_refresh_registration($reg_cache_ID, $registration);
-            }
-            // make sure our cached TXN is added to the model entity mapper
-            $this->transaction = $this->transaction->get_model()->refresh_entity_map_with(
-                $this->transaction->ID(),
-                $this->transaction
-            );
-        } else {
-            EE_Error::add_error(
-                __(
-                    'A valid Transaction was not found when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // verify and update the cart because inaccurate totals are not so much fun
-        if ($this->cart instanceof EE_Cart) {
-            $grand_total = $this->cart->get_grand_total();
-            if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
-                $grand_total->recalculate_total_including_taxes();
-                $grand_total = $grand_total->get_model()->refresh_entity_map_with(
-                    $this->cart->get_grand_total()->ID(),
-                    $this->cart->get_grand_total()
-                );
-            }
-            if ($grand_total instanceof EE_Line_Item) {
-                $this->cart = EE_Cart::instance($grand_total);
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'A valid Cart was not found when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * _refresh_registration
-     *
-     * @param    string | int    $reg_cache_ID
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration($reg_cache_ID, $registration)
-    {
-
-        // verify object
-        if ($registration instanceof EE_Registration) {
-            // update the entity mapper attendee
-            $this->_refresh_registration_attendee($registration);
-            // update the entity mapper answers for reg form questions
-            $this->_refresh_registration_answers($registration);
-            // make sure the cached registration is added to the model entity mapper
-            $registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
-        } else {
-            EE_Error::add_error(
-                __(
-                    'An invalid Registration object was discovered when attempting to update the model entity mapper.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * _save_registration_attendee
-     *
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration_attendee($registration)
-    {
-
-        $attendee = $registration->attendee();
-        // verify object
-        if ($attendee instanceof EE_Attendee && $attendee->ID()) {
-            // make sure the cached attendee is added to the model entity mapper
-            $registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
-            // maybe cache primary_attendee_obj ?
-            if ($registration->is_primary_registrant()) {
-                $this->primary_attendee_obj = $attendee;
-            }
-        }
-    }
-
-
-    /**
-     * _refresh_registration_answers
-     *
-     * @param    EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _refresh_registration_answers($registration)
-    {
-
-        // now update the answers
-        foreach ($registration->answers() as $cache_key => $answer) {
-            // verify object
-            if ($answer instanceof EE_Answer) {
-                if ($answer->ID()) {
-                    // make sure the cached answer is added to the model entity mapper
-                    $answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
-                }
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'An invalid Answer object was discovered when attempting to update the model entity mapper.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    __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
-     * @throws \EE_Error
-     */
-    public function __sleep()
-    {
-        if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
-            $this->primary_attendee_obj = $this->primary_attendee_obj->ID();
-        }        // remove the reg form and the checkout
-        if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
-            $this->transaction = $this->transaction->ID();
-        }        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
-    }
-
-
-    /**
-     *    __wakeup
-     * to conserve db space, we are removing the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
-     * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
-     */
-    public function __wakeup()
-    {
-        if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
-            // $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
-            $this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
-        }
-        if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
-            // $this->transaction is actually just an ID, so use it to get the object from the db
-            $this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
-        }
-        foreach ($this->reg_steps as $reg_step) {
-            $reg_step->checkout = $this;
-        }
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @throws \EE_Error
-     */
-    public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false)
-    {
-        $disabled = true;
-        if (WP_DEBUG && ! $disabled) {
-            $debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
-            $default_data = array(
-                $class                    => $func . '() : ' . $line,
-                'request->step'           => $this->step,
-                'request->action'         => $this->action,
-                'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
-                    $this->current_step->slug() : '',
-                'current_step->completed' => $this->current_step instanceof EE_SPCO_Reg_Step ?
-                    $this->current_step->completed() : '',
-                'txn_status_updated'      => $this->transaction->txn_status_updated(),
-                'reg_status_updated'      => $this->reg_status_updated,
-                'reg_url_link'            => $this->reg_url_link,
-                'REQ'                     => $display_request ? $_REQUEST : '',
-            );
-            if ($this->transaction instanceof EE_Transaction) {
-                $default_data['TXN_status'] = $this->transaction->status_ID();
-                $default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
-                foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
-                    $default_data['registrations'][ $REG_ID ] = $registration->status_ID();
-                }
-                if ($this->transaction->ID()) {
-                    $TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
-                    // don't serialize objects
-                    $info = $this->_strip_objects($info);
-                    if (! isset($debug_data[ $TXN_ID ])) {
-                        $debug_data[ $TXN_ID ] = array();
-                    }
-                    $debug_data[ $TXN_ID ][ microtime() ] = array_merge(
-                        $default_data,
-                        $info
-                    );
-                    update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * _strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public function _strip_objects($info = array())
-    {
-        foreach ((array) $info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = $this->_strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
+	/**
+	 *    whether current request originated from the EE admin
+	 *
+	 * @type bool
+	 */
+	public $admin_request = false;
+
+	/**
+	 * whether returning to edit attendee information or to retry a payment
+	 *
+	 * @type bool
+	 */
+	public $revisit = false;
+
+	/**
+	 * whether the primary registrant is returning to edit attendee information or to retry a payment
+	 *
+	 * @type bool
+	 */
+	public $primary_revisit = false;
+
+	/**
+	 * is registration allowed to progress or halted for some reason such as failing to pass recaptcha?
+	 *
+	 * @type bool
+	 */
+	public $continue_reg = true;
+
+	/**
+	 * redirect to thank you page ?
+	 *
+	 * @type bool
+	 */
+	public $redirect = false;
+
+	/**
+	 * generate the reg form or not ?
+	 *
+	 * @type bool
+	 */
+	public $generate_reg_form = true;
+
+	/**
+	 * process a reg form submission or not ?
+	 *
+	 * @type bool
+	 */
+	public $process_form_submission = false;
+
+	/**
+	 * tracks whether the TXN status modified during this checkout
+	 *
+	 * @type bool
+	 */
+	public $txn_status_updated = false;
+
+	/**
+	 * only triggered to true after absolutely everything has finished.
+	 *
+	 * @type bool
+	 */
+	protected $exit_spco = false;
+
+	/**
+	 * tracks whether any of the TXN's Registrations statuses modified during this checkout
+	 * indexed by registration ID
+	 *
+	 * @type array
+	 */
+	protected $reg_status_updated = array();
+
+	/**
+	 * timestamp when redirected from Ticket Selector to the checkout
+	 *
+	 * @type int
+	 */
+	public $uts = 0;
+
+	/**
+	 * total number of tickets that were in the cart
+	 *
+	 * @type int
+	 */
+	public $total_ticket_count = 0;
+
+	/**
+	 * corresponds loosely to EE_Transaction::remaining()
+	 * but can be modified by SPCO
+	 *
+	 * @type float
+	 */
+	public $amount_owing = 0;
+
+	/**
+	 * the reg step slug from the incoming request
+	 *
+	 * @type string
+	 */
+	public $step = '';
+
+	/**
+	 * the reg step slug for a step being edited
+	 *
+	 * @type string
+	 */
+	public $edit_step = '';
+
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @type string
+	 */
+	public $action = '';
+
+	/**
+	 * reg_url_link for a previously saved registration
+	 *
+	 * @type string
+	 */
+	public $reg_url_link = '';
+
+	/**
+	 * string slug for the payment method that was selected during the payment options step
+	 *
+	 * @type string
+	 */
+	public $selected_method_of_payment = '';
+
+	/**
+	 * base url for the site's registration checkout page - additional url params will be added to this
+	 *
+	 * @type string
+	 */
+	public $reg_page_base_url = '';
+
+	/**
+	 * base url for the site's registration cancelled page - additional url params will be added to this
+	 *
+	 * @type string
+	 */
+	public $cancel_page_url = '';
+
+	/**
+	 * base url for the site's thank you page - additional url params will be added to this
+	 *
+	 * @type string
+	 */
+	public $thank_you_page_url = '';
+
+	/**
+	 * base url for any redirects - additional url params will be added to this
+	 *
+	 * @type string
+	 */
+	public $redirect_url = '';
+
+	/**
+	 * form of POST data for use with off-site gateways
+	 *
+	 * @type string
+	 */
+	public $redirect_form = '';
+
+	/**
+	 * array of query where params to use when retrieving cached registrations from $this->checkout->transaction
+	 *
+	 * @type array
+	 */
+	public $reg_cache_where_params = array();
+
+	/**
+	 * a class for managing and creating the JSON encoded array of data that gets passed back to the client during AJAX
+	 * requests
+	 *
+	 * @type EE_SPCO_JSON_Response
+	 */
+	public $json_response;
+
+	/**
+	 * where we are going next in the reg process
+	 *
+	 * @type EE_SPCO_Reg_Step
+	 */
+	public $next_step;
+
+	/**
+	 * where we are in the reg process
+	 *
+	 * @type EE_SPCO_Reg_Step
+	 */
+	public $current_step;
+
+	/**
+	 *    $_cart - the current cart object
+	 *
+	 * @var EE_CART
+	 */
+	public $cart;
+
+	/**
+	 *    $_transaction - the current transaction object
+	 *
+	 * @var EE_Transaction
+	 */
+	public $transaction;
+
+	/**
+	 *    the related attendee object for the primary registrant
+	 *
+	 * @type EE_Attendee
+	 */
+	public $primary_attendee_obj;
+
+	/**
+	 *    $payment_method - the payment method object for the selected method of payment
+	 *
+	 * @type EE_Payment_Method
+	 */
+	public $payment_method;
+
+	/**
+	 *    $payment - if a payment was successfully made during the reg process,
+	 *    then here it is !!!
+	 *
+	 * @type EE_Payment
+	 */
+	public $payment;
+
+	/**
+	 *    if a payment method was selected that uses an on-site gateway, then this is the billing form
+	 *
+	 * @type EE_Billing_Info_Form | EE_Billing_Attendee_Info_Form
+	 */
+	public $billing_form;
+
+	/**
+	 *    the entire registration form composed of ALL of the subsections generated by the various reg steps
+	 *
+	 * @type EE_Form_Section_Proper
+	 */
+	public $registration_form;
+
+	/**
+	 * array of EE_SPCO_Reg_Step objects
+	 *
+	 * @type EE_SPCO_Reg_Step[]
+	 */
+	public $reg_steps = array();
+
+	/**
+	 * array of EE_Payment_Method objects
+	 *
+	 * @type EE_Payment_Method[]
+	 */
+	public $available_payment_methods = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		$this->reg_page_base_url = EE_Registry::instance()->CFG->core->reg_page_url();
+		$this->thank_you_page_url = EE_Registry::instance()->CFG->core->thank_you_page_url();
+		$this->cancel_page_url = EE_Registry::instance()->CFG->core->cancel_page_url();
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
+		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->ajax;
+		$this->reg_cache_where_params = array(
+			0          => array('REG_deleted' => false),
+			'order_by' => array('REG_count' => 'ASC'),
+		);
+	}
+
+
+	/**
+	 * returns true if ANY reg status was updated during checkout
+	 *
+	 * @return boolean
+	 */
+	public function any_reg_status_updated()
+	{
+		foreach ($this->reg_status_updated as $reg_status) {
+			if ($reg_status) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param $REG_ID
+	 * @return boolean
+	 */
+	public function reg_status_updated($REG_ID)
+	{
+		return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
+	}
+
+
+	/**
+	 * @param $REG_ID
+	 * @param $reg_status
+	 */
+	public function set_reg_status_updated($REG_ID, $reg_status)
+	{
+		$this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * exit_spco
+	 *
+	 * @return bool
+	 */
+	public function exit_spco()
+	{
+		return $this->exit_spco;
+	}
+
+
+	/**
+	 * set_exit_spco
+	 * can ONLY be set by the  Finalize_Registration reg step
+	 */
+	public function set_exit_spco()
+	{
+		if ($this->current_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+			$this->exit_spco = true;
+		}
+	}
+
+
+	/**
+	 *    reset_for_current_request
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function reset_for_current_request()
+	{
+		$this->process_form_submission = false;
+		$this->continue_reg = apply_filters('FHEE__EE_Checkout___construct___continue_reg', true);
+		$this->admin_request = is_admin() && ! EE_Registry::instance()->REQ->front_ajax;
+		$this->continue_reg = true;
+		$this->redirect = false;
+		// don't reset the cached redirect form if we're about to be asked to display it !!!
+		if (EE_Registry::instance()->REQ->get('action', 'display_spco_reg_step') !== 'redirect_form') {
+			$this->redirect_form = '';
+		}
+		$this->redirect_url = '';
+		$this->json_response = new EE_SPCO_JSON_Response();
+		EE_Form_Section_Proper::reset_js_localization();
+	}
+
+
+	/**
+	 *    add_reg_step
+	 *
+	 * @access    public
+	 * @param EE_SPCO_Reg_Step $reg_step_obj
+	 * @return    void
+	 */
+	public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
+	{
+		$this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
+	}
+
+
+	/**
+	 * skip_reg_step
+	 * if the current reg step does not need to run for some reason,
+	 * then this will advance SPCO to the next reg step,
+	 * and mark the skipped step as completed
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function skip_reg_step($reg_step_slug = '')
+	{
+		$step_to_skip = $this->find_reg_step($reg_step_slug);
+		if ($step_to_skip instanceof EE_SPCO_Reg_Step && $step_to_skip->is_current_step()) {
+			$step_to_skip->set_is_current_step(false);
+			$step_to_skip->set_completed();
+			// advance to the next step
+			$this->set_current_step($this->next_step->slug());
+			// also reset the step param in the request in case any other code references that directly
+			EE_Registry::instance()->REQ->set('step', $this->current_step->slug());
+			// since we are skipping a step and setting the current step to be what was previously the next step,
+			// we need to check that the next step is now correct, and not still set to the current step.
+			if ($this->current_step->slug() === $this->next_step->slug()) {
+				// correctly setup the next step
+				$this->set_next_step();
+			}
+			$this->set_reg_step_initiated($this->current_step);
+		}
+	}
+
+
+	/**
+	 *    remove_reg_step
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @param bool   $reset whether to reset reg steps after removal
+	 * @throws EE_Error
+	 */
+	public function remove_reg_step($reg_step_slug = '', $reset = true)
+	{
+		unset($this->reg_steps[ $reg_step_slug ]);
+		if ($this->transaction instanceof EE_Transaction) {
+			// now remove reg step from TXN and save
+			$this->transaction->remove_reg_step($reg_step_slug);
+			$this->transaction->save();
+		}
+		if ($reset) {
+			$this->reset_reg_steps();
+		}
+	}
+
+
+	/**
+	 *    set_reg_step_order
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @param int    $order
+	 * @return    void
+	 */
+	public function set_reg_step_order($reg_step_slug = '', $order = 100)
+	{
+		if (isset($this->reg_steps[ $reg_step_slug ])) {
+			$this->reg_steps[ $reg_step_slug ]->set_order($order);
+		}
+	}
+
+
+	/**
+	 *    set_current_step
+	 *
+	 * @access    public
+	 * @param string $current_step
+	 * @return    void
+	 */
+	public function set_current_step($current_step)
+	{
+		// grab what step we're on
+		$this->current_step = isset($this->reg_steps[ $current_step ])
+			? $this->reg_steps[ $current_step ]
+			: reset(
+				$this->reg_steps
+			);
+		// verify instance
+		if ($this->current_step instanceof EE_SPCO_Reg_Step) {
+			// we don't want to repeat completed steps if this is the first time through SPCO
+			if ($this->continue_reg && ! $this->revisit && $this->current_step->completed()) {
+				// so advance to the next step
+				$this->set_next_step();
+				if ($this->next_step instanceof EE_SPCO_Reg_Step) {
+					// and attempt to set it as the current step
+					$this->set_current_step($this->next_step->slug());
+				}
+				return;
+			}
+			$this->current_step->set_is_current_step(true);
+		} else {
+			EE_Error::add_error(
+				__('The current step could not be set.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 *    set_next_step
+	 * advances the reg_steps array pointer and sets the next step, then reverses pointer back to the current step
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function set_next_step()
+	{
+		// set pointer to start of array
+		reset($this->reg_steps);
+		// if there is more than one step
+		if (count($this->reg_steps) > 1) {
+			// advance to the current step and set pointer
+			while (key($this->reg_steps) !== $this->current_step->slug() && key($this->reg_steps) !== '') {
+				next($this->reg_steps);
+			}
+		}
+		// advance one more spot ( if it exists )
+		$this->next_step = next($this->reg_steps);
+		// verify instance
+		$this->next_step = $this->next_step instanceof EE_SPCO_Reg_Step ? $this->next_step : null;
+		// then back to current step to reset
+		prev($this->reg_steps);
+	}
+
+
+	/**
+	 *    get_next_reg_step
+	 *    this simply returns the next step from reg_steps array
+	 *
+	 * @access    public
+	 * @return    EE_SPCO_Reg_Step | null
+	 */
+	public function get_next_reg_step()
+	{
+		$next = next($this->reg_steps);
+		prev($this->reg_steps);
+		return $next instanceof EE_SPCO_Reg_Step ? $next : null;
+	}
+
+
+	/**
+	 * get_prev_reg_step
+	 *    this simply returns the previous step from reg_steps array
+	 *
+	 * @access    public
+	 * @return    EE_SPCO_Reg_Step | null
+	 */
+	public function get_prev_reg_step()
+	{
+		$prev = prev($this->reg_steps);
+		next($this->reg_steps);
+		return $prev instanceof EE_SPCO_Reg_Step ? $prev : null;
+	}
+
+
+	/**
+	 * sort_reg_steps
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function sort_reg_steps()
+	{
+		$reg_step_sorting_callback = apply_filters(
+			'FHEE__EE_Checkout__sort_reg_steps__reg_step_sorting_callback',
+			'reg_step_sorting_callback'
+		);
+		uasort($this->reg_steps, array($this, $reg_step_sorting_callback));
+	}
+
+
+	/**
+	 * find_reg_step
+	 * finds a reg step by the given slug
+	 *
+	 * @access    public
+	 * @param string $reg_step_slug
+	 * @return EE_SPCO_Reg_Step|null
+	 */
+	public function find_reg_step($reg_step_slug = '')
+	{
+		if (! empty($reg_step_slug)) {
+			// copy reg step array
+			$reg_steps = $this->reg_steps;
+			// set pointer to start of array
+			reset($reg_steps);
+			// if there is more than one step
+			if (count($reg_steps) > 1) {
+				// advance to the current step and set pointer
+				while (key($reg_steps) !== $reg_step_slug && key($reg_steps) !== '') {
+					next($reg_steps);
+				}
+				return current($reg_steps);
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * reg_step_sorting_callback
+	 *
+	 * @access public
+	 * @param EE_SPCO_Reg_Step $reg_step_A
+	 * @param EE_SPCO_Reg_Step $reg_step_B
+	 * @return int
+	 */
+	public function reg_step_sorting_callback(EE_SPCO_Reg_Step $reg_step_A, EE_SPCO_Reg_Step $reg_step_B)
+	{
+		// send finalize_registration step to the end of the array
+		if ($reg_step_A->slug() === 'finalize_registration') {
+			return 1;
+		} elseif ($reg_step_B->slug() === 'finalize_registration') {
+			return -1;
+		}
+		if ($reg_step_A->order() === $reg_step_B->order()) {
+			return 0;
+		}
+		return ($reg_step_A->order() > $reg_step_B->order()) ? 1 : -1;
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 *
+	 * @access    public
+	 * @param    EE_SPCO_Reg_Step $reg_step
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_initiated(EE_SPCO_Reg_Step $reg_step)
+	{
+		// call set_reg_step_initiated ???
+		if (// first time visiting SPCO ?
+			! $this->revisit
+			&& (
+				// and displaying the reg step form for the first time ?
+				$this->action === 'display_spco_reg_step'
+				// or initializing the final step
+				|| $reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration
+			)
+		) {
+			// set the start time for this reg step
+			if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+				if (WP_DEBUG) {
+					EE_Error::add_error(
+						sprintf(
+							__('The "%1$s" registration step was not initialized properly.', 'event_espresso'),
+							$reg_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    set_reg_step_JSON_info
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_reg_step_JSON_info()
+	{
+		EE_Registry::$i18n_js_strings['reg_steps'] = array();
+		// pass basic reg step data to JS
+		foreach ($this->reg_steps as $reg_step) {
+			EE_Registry::$i18n_js_strings['reg_steps'][] = $reg_step->slug();
+		}
+		// reset reg step html
+		// $this->json_response->set_reg_step_html('');
+	}
+
+
+	/**
+	 *    reset_reg_steps
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function reset_reg_steps()
+	{
+		$this->sort_reg_steps();
+		$this->set_current_step(EE_Registry::instance()->REQ->get('step'));
+		$this->set_next_step();
+		// the text that appears on the reg step form submit button
+		$this->current_step->set_submit_button_text();
+		$this->set_reg_step_JSON_info();
+	}
+
+
+	/**
+	 *    get_registration_time_limit
+	 *
+	 * @access    public
+	 * @return        string
+	 */
+	public function get_registration_time_limit()
+	{
+
+		$registration_time_limit = (float) (EE_Registry::instance()->SSN->expiration() - time());
+		$time_limit_format = $registration_time_limit > 60 * MINUTE_IN_SECONDS ? 'H:i:s' : 'i:s';
+		$registration_time_limit = date($time_limit_format, $registration_time_limit);
+		return apply_filters(
+			'FHEE__EE_Checkout__get_registration_time_limit__registration_time_limit',
+			$registration_time_limit
+		);
+	}
+
+
+	/**
+	 * payment_required
+	 *
+	 * @return boolean
+	 */
+	public function payment_required()
+	{
+		// if NOT:
+		//     registration via admin
+		//      completed TXN
+		//      overpaid TXN
+		//      free TXN(total = 0.00)
+		//      then payment required is TRUE
+		return ! ($this->admin_request
+				  || $this->transaction->is_completed()
+				  || $this->transaction->is_overpaid()
+				  || $this->transaction->is_free()) ? true : false;
+	}
+
+
+	/**
+	 * get_cart_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @return EE_Cart
+	 */
+	public function get_cart_for_transaction($transaction)
+	{
+		$session = EE_Registry::instance()->load_core('Session');
+		$cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
+		// verify cart
+		if (! $cart instanceof EE_Cart) {
+			$cart = EE_Registry::instance()->load_core('Cart');
+		}
+
+		return $cart;
+	}
+
+
+	/**
+	 *    initialize_txn_reg_steps_array
+	 *
+	 * @access public
+	 * @return    array
+	 */
+	public function initialize_txn_reg_steps_array()
+	{
+		$txn_reg_steps_array = array();
+		foreach ($this->reg_steps as $reg_step) {
+			$txn_reg_steps_array[ $reg_step->slug() ] = false;
+		}
+		return $txn_reg_steps_array;
+	}
+
+
+	/**
+	 *    update_txn_reg_steps_array
+	 *
+	 * @access public
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	public function update_txn_reg_steps_array()
+	{
+		$updated = false;
+		foreach ($this->reg_steps as $reg_step) {
+			if ($reg_step->completed()) {
+				$updated = $this->transaction->set_reg_step_completed($reg_step->slug())
+					? true
+					: $updated;
+			}
+		}
+		if ($updated) {
+			$this->transaction->save();
+		}
+		return $updated;
+	}
+
+
+	/**
+	 *    stash_transaction_and_checkout
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws \EE_Error
+	 */
+	public function stash_transaction_and_checkout()
+	{
+		if (! $this->revisit) {
+			$this->update_txn_reg_steps_array();
+		}
+		$this->track_transaction_and_registration_status_updates();
+		// save all data to the db, but suppress errors
+		// $this->save_all_data( FALSE );
+		// cache the checkout in the session
+		EE_Registry::instance()->SSN->set_checkout($this);
+	}
+
+
+	/**
+	 *    track_transaction_and_registration_status_updates
+	 *    stores whether any updates were made to the TXN or it's related registrations
+	 *
+	 * @access public
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function track_transaction_and_registration_status_updates()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction) {
+			// has there been a TXN status change during this checkout?
+			$this->txn_status_updated = $this->transaction->txn_status_updated();
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				if ($registration_processor->reg_status_updated($registration->ID())) {
+					$this->set_reg_status_updated($registration->ID(), true);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    visit_allows_processing_of_this_registration
+	 *    determines if the current SPCO visit should allow the passed EE_Registration to be used in processing.
+	 *    one of the following conditions must be met:
+	 *        EITHER:    A) first time thru SPCO -> process ALL registrations ( NOT a revisit )
+	 *        OR :        B) primary registrant is editing info -> process ALL registrations ( primary_revisit )
+	 *        OR :        C) another registrant is editing info -> ONLY process their registration ( revisit AND their
+	 *        reg_url_link matches )
+	 *
+	 * @access public
+	 * @param    EE_Registration $registration
+	 * @return    bool
+	 * @throws \EE_Error
+	 */
+	public function visit_allows_processing_of_this_registration(EE_Registration $registration)
+	{
+		return ! $this->revisit
+			   || $this->primary_revisit
+			   || (
+				   $this->revisit && $this->reg_url_link === $registration->reg_url_link()
+			   )
+			? true
+			: false;
+	}
+
+
+	/**
+	 *    _transaction_has_primary_registration
+	 *
+	 * @access        private
+	 * @return        bool
+	 */
+	public function transaction_has_primary_registrant()
+	{
+		return $this->primary_attendee_obj instanceof EE_Attendee ? true : false;
+	}
+
+
+	/**
+	 *    save_all_data
+	 *    simply loops through the current transaction and saves all data for each registration
+	 *
+	 * @access public
+	 * @param bool $show_errors
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function save_all_data($show_errors = true)
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction) {
+			// save to ensure that TXN has ID
+			$this->transaction->save();
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $registration) {
+				$this->_save_registration($registration, $show_errors);
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					__(
+						'A valid Transaction was not found when attempting to save your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration($registration, $show_errors = true)
+	{
+		// verify object
+		if ($registration instanceof EE_Registration) {
+			// should this registration be processed during this visit ?
+			if ($this->visit_allows_processing_of_this_registration($registration)) {
+				// set TXN ID
+				if (! $registration->transaction_ID()) {
+					$registration->set_transaction_id($this->transaction->ID());
+				}
+				// verify and save the attendee
+				$this->_save_registration_attendee($registration, $show_errors);
+				// save answers to reg form questions
+				$this->_save_registration_answers($registration, $show_errors);
+				// save changes
+				$registration->save();
+				// update txn cache
+				if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+					if ($show_errors) {
+						EE_Error::add_error(
+							__(
+								'The newly saved Registration object could not be cached on the Transaction.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					__(
+						'An invalid Registration object was discovered when attempting to save your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration_attendee($registration, $show_errors = true)
+	{
+		if ($registration->attendee() instanceof EE_Attendee) {
+			// save so that ATT has ID
+			$registration->attendee()->save();
+			if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+				if ($show_errors) {
+					EE_Error::add_error(
+						__(
+							'The newly saved Attendee object could not be cached on the registration.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} else {
+			if ($show_errors) {
+				EE_Error::add_error(
+					sprintf(
+						'%1$s||%1$s $attendee = %2$s',
+						__(
+							'Either no Attendee information was found, or an invalid Attendee object was discovered when attempting to save your registration information.',
+							'event_espresso'
+						),
+						var_export($registration->attendee(), true)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * _save_question_answers
+	 *
+	 * @param    EE_Registration $registration
+	 * @param bool               $show_errors
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _save_registration_answers($registration, $show_errors = true)
+	{
+		// now save the answers
+		foreach ($registration->answers() as $cache_key => $answer) {
+			// verify object
+			if ($answer instanceof EE_Answer) {
+				$answer->set_registration($registration->ID());
+				$answer->save();
+				if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+					if ($show_errors) {
+						EE_Error::add_error(
+							__(
+								'The newly saved Answer object could not be cached on the registration.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			} else {
+				if ($show_errors) {
+					EE_Error::add_error(
+						__(
+							'An invalid Answer object was discovered when attempting to save your registration information.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    refresh_all_entities
+	 *   will either refresh the entity map with objects form the db or from the checkout cache
+	 *
+	 * @access public
+	 * @param bool $from_db
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function refresh_all_entities($from_db = false)
+	{
+		$from_db = $this->current_step->is_final_step() || $this->action === 'process_gateway_response'
+			? true
+			: $from_db;
+		// $this->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array('from_db' => $from_db)
+		// );
+		return $from_db ? $this->refresh_from_db() : $this->refresh_entity_map();
+	}
+
+
+	/**
+	 *  refresh_entity_map
+	 *  simply loops through the current transaction and updates each
+	 *  model's entity map using EEM_Base::refresh_entity_map_from_db()
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function refresh_from_db()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			// pull fresh TXN data from the db
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_from_db($this->transaction->ID());
+			// update EE_Checkout's cached primary_attendee object
+			$this->primary_attendee_obj = $this->_refresh_primary_attendee_obj_from_db($this->transaction);
+			// update EE_Checkout's cached payment object
+			$payment = $this->transaction->last_payment();
+			$this->payment = $payment instanceof EE_Payment ? $payment : $this->payment;
+			// update EE_Checkout's cached payment_method object
+			$payment_method = $this->payment instanceof EE_Payment ? $this->payment->payment_method() : null;
+			$this->payment_method = $payment_method instanceof EE_Payment_Method ? $payment_method
+				: $this->payment_method;
+			// now refresh the cart, based on the TXN
+			$this->cart = $this->get_cart_for_transaction($this->transaction);
+		} else {
+			EE_Error::add_error(
+				__(
+					'A valid Transaction was not found when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _refresh_primary_attendee_obj_from_db
+	 *
+	 * @param   EE_Transaction $transaction
+	 * @return  EE_Attendee | null
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_primary_attendee_obj_from_db(EE_Transaction $transaction)
+	{
+
+		$primary_attendee_obj = null;
+		// grab the saved registrations from the transaction
+		foreach ($transaction->registrations($this->reg_cache_where_params, true) as $registration) {
+			// verify object
+			if ($registration instanceof EE_Registration) {
+				$attendee = $registration->attendee();
+				// verify object && maybe cache primary_attendee_obj ?
+				if ($attendee instanceof EE_Attendee && $registration->is_primary_registrant()) {
+					$primary_attendee_obj = $attendee;
+				}
+			} else {
+				EE_Error::add_error(
+					__(
+						'An invalid Registration object was discovered when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $primary_attendee_obj;
+	}
+
+
+	/**
+	 *  refresh_entity_map
+	 *  simply loops through the current transaction and updates
+	 *  each model's entity map using EEM_Base::refresh_entity_map_with()
+	 *
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	protected function refresh_entity_map()
+	{
+		// verify the transaction
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			// never cache payment info
+			$this->transaction->clear_cache('Payment');
+			// is the Payment Options Reg Step completed ?
+			if ($this->transaction->reg_step_completed('payment_options')) {
+				// then check for payments and update TXN accordingly
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				$transaction_payments->calculate_total_payments_and_update_status($this->transaction);
+			}
+			// grab the saved registrations from the transaction
+			foreach ($this->transaction->registrations($this->reg_cache_where_params) as $reg_cache_ID => $registration) {
+				$this->_refresh_registration($reg_cache_ID, $registration);
+			}
+			// make sure our cached TXN is added to the model entity mapper
+			$this->transaction = $this->transaction->get_model()->refresh_entity_map_with(
+				$this->transaction->ID(),
+				$this->transaction
+			);
+		} else {
+			EE_Error::add_error(
+				__(
+					'A valid Transaction was not found when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// verify and update the cart because inaccurate totals are not so much fun
+		if ($this->cart instanceof EE_Cart) {
+			$grand_total = $this->cart->get_grand_total();
+			if ($grand_total instanceof EE_Line_Item && $grand_total->ID()) {
+				$grand_total->recalculate_total_including_taxes();
+				$grand_total = $grand_total->get_model()->refresh_entity_map_with(
+					$this->cart->get_grand_total()->ID(),
+					$this->cart->get_grand_total()
+				);
+			}
+			if ($grand_total instanceof EE_Line_Item) {
+				$this->cart = EE_Cart::instance($grand_total);
+			} else {
+				EE_Error::add_error(
+					__(
+						'A valid Cart was not found when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * _refresh_registration
+	 *
+	 * @param    string | int    $reg_cache_ID
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration($reg_cache_ID, $registration)
+	{
+
+		// verify object
+		if ($registration instanceof EE_Registration) {
+			// update the entity mapper attendee
+			$this->_refresh_registration_attendee($registration);
+			// update the entity mapper answers for reg form questions
+			$this->_refresh_registration_answers($registration);
+			// make sure the cached registration is added to the model entity mapper
+			$registration->get_model()->refresh_entity_map_with($reg_cache_ID, $registration);
+		} else {
+			EE_Error::add_error(
+				__(
+					'An invalid Registration object was discovered when attempting to update the model entity mapper.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * _save_registration_attendee
+	 *
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration_attendee($registration)
+	{
+
+		$attendee = $registration->attendee();
+		// verify object
+		if ($attendee instanceof EE_Attendee && $attendee->ID()) {
+			// make sure the cached attendee is added to the model entity mapper
+			$registration->attendee()->get_model()->refresh_entity_map_with($attendee->ID(), $attendee);
+			// maybe cache primary_attendee_obj ?
+			if ($registration->is_primary_registrant()) {
+				$this->primary_attendee_obj = $attendee;
+			}
+		}
+	}
+
+
+	/**
+	 * _refresh_registration_answers
+	 *
+	 * @param    EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _refresh_registration_answers($registration)
+	{
+
+		// now update the answers
+		foreach ($registration->answers() as $cache_key => $answer) {
+			// verify object
+			if ($answer instanceof EE_Answer) {
+				if ($answer->ID()) {
+					// make sure the cached answer is added to the model entity mapper
+					$answer->get_model()->refresh_entity_map_with($answer->ID(), $answer);
+				}
+			} else {
+				EE_Error::add_error(
+					__(
+						'An invalid Answer object was discovered when attempting to update the model entity mapper.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    __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
+	 * @throws \EE_Error
+	 */
+	public function __sleep()
+	{
+		if ($this->primary_attendee_obj instanceof EE_Attendee && $this->primary_attendee_obj->ID()) {
+			$this->primary_attendee_obj = $this->primary_attendee_obj->ID();
+		}        // remove the reg form and the checkout
+		if ($this->transaction instanceof EE_Transaction && $this->transaction->ID()) {
+			$this->transaction = $this->transaction->ID();
+		}        // remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('billing_form', 'registration_form'));
+	}
+
+
+	/**
+	 *    __wakeup
+	 * to conserve db space, we are removing the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
+	 * this will reinstate the EE_Checkout object on each EE_SPCO_Reg_Step object
+	 */
+	public function __wakeup()
+	{
+		if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
+			// $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
+			$this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
+		}
+		if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
+			// $this->transaction is actually just an ID, so use it to get the object from the db
+			$this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
+		}
+		foreach ($this->reg_steps as $reg_step) {
+			$reg_step->checkout = $this;
+		}
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @throws \EE_Error
+	 */
+	public function log($class = '', $func = '', $line = '', $info = array(), $display_request = false)
+	{
+		$disabled = true;
+		if (WP_DEBUG && ! $disabled) {
+			$debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
+			$default_data = array(
+				$class                    => $func . '() : ' . $line,
+				'request->step'           => $this->step,
+				'request->action'         => $this->action,
+				'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
+					$this->current_step->slug() : '',
+				'current_step->completed' => $this->current_step instanceof EE_SPCO_Reg_Step ?
+					$this->current_step->completed() : '',
+				'txn_status_updated'      => $this->transaction->txn_status_updated(),
+				'reg_status_updated'      => $this->reg_status_updated,
+				'reg_url_link'            => $this->reg_url_link,
+				'REQ'                     => $display_request ? $_REQUEST : '',
+			);
+			if ($this->transaction instanceof EE_Transaction) {
+				$default_data['TXN_status'] = $this->transaction->status_ID();
+				$default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
+				foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
+					$default_data['registrations'][ $REG_ID ] = $registration->status_ID();
+				}
+				if ($this->transaction->ID()) {
+					$TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+					// don't serialize objects
+					$info = $this->_strip_objects($info);
+					if (! isset($debug_data[ $TXN_ID ])) {
+						$debug_data[ $TXN_ID ] = array();
+					}
+					$debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+						$default_data,
+						$info
+					);
+					update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * _strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public function _strip_objects($info = array())
+	{
+		foreach ((array) $info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = $this->_strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
 }

Spacing +33 added lines, -33 removed lines

@@ -313,7 +313,7 @@ 
      */
     public function reg_status_updated($REG_ID)
     {
-        return isset($this->reg_status_updated[ $REG_ID ]) ? $this->reg_status_updated[ $REG_ID ] : false;
+        return isset($this->reg_status_updated[$REG_ID]) ? $this->reg_status_updated[$REG_ID] : false;
     }
 
 
@@ -323,7 +323,7 @@ 
      */
     public function set_reg_status_updated($REG_ID, $reg_status)
     {
-        $this->reg_status_updated[ $REG_ID ] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
+        $this->reg_status_updated[$REG_ID] = filter_var($reg_status, FILTER_VALIDATE_BOOLEAN);
     }
 
 
@@ -382,7 +382,7 @@ 
      */
     public function add_reg_step(EE_SPCO_Reg_Step $reg_step_obj)
     {
-        $this->reg_steps[ $reg_step_obj->slug() ] = $reg_step_obj;
+        $this->reg_steps[$reg_step_obj->slug()] = $reg_step_obj;
     }
 
 
@@ -428,7 +428,7 @@ 
      */
     public function remove_reg_step($reg_step_slug = '', $reset = true)
     {
-        unset($this->reg_steps[ $reg_step_slug ]);
+        unset($this->reg_steps[$reg_step_slug]);
         if ($this->transaction instanceof EE_Transaction) {
             // now remove reg step from TXN and save
             $this->transaction->remove_reg_step($reg_step_slug);
@@ -450,8 +450,8 @@ 
      */
     public function set_reg_step_order($reg_step_slug = '', $order = 100)
     {
-        if (isset($this->reg_steps[ $reg_step_slug ])) {
-            $this->reg_steps[ $reg_step_slug ]->set_order($order);
+        if (isset($this->reg_steps[$reg_step_slug])) {
+            $this->reg_steps[$reg_step_slug]->set_order($order);
         }
     }
 
@@ -466,8 +466,8 @@ 
     public function set_current_step($current_step)
     {
         // grab what step we're on
-        $this->current_step = isset($this->reg_steps[ $current_step ])
-            ? $this->reg_steps[ $current_step ]
+        $this->current_step = isset($this->reg_steps[$current_step])
+            ? $this->reg_steps[$current_step]
             : reset(
                 $this->reg_steps
             );
@@ -578,7 +578,7 @@ 
      */
     public function find_reg_step($reg_step_slug = '')
     {
-        if (! empty($reg_step_slug)) {
+        if ( ! empty($reg_step_slug)) {
             // copy reg step array
             $reg_steps = $this->reg_steps;
             // set pointer to start of array
@@ -639,7 +639,7 @@ 
             )
         ) {
             // set the start time for this reg step
-            if (! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
+            if ( ! $this->transaction->set_reg_step_initiated($reg_step->slug())) {
                 if (WP_DEBUG) {
                     EE_Error::add_error(
                         sprintf(
@@ -742,7 +742,7 @@ 
         $session = EE_Registry::instance()->load_core('Session');
         $cart = $transaction instanceof EE_Transaction ? EE_Cart::get_cart_from_txn($transaction, $session) : null;
         // verify cart
-        if (! $cart instanceof EE_Cart) {
+        if ( ! $cart instanceof EE_Cart) {
             $cart = EE_Registry::instance()->load_core('Cart');
         }
 
@@ -760,7 +760,7 @@ 
     {
         $txn_reg_steps_array = array();
         foreach ($this->reg_steps as $reg_step) {
-            $txn_reg_steps_array[ $reg_step->slug() ] = false;
+            $txn_reg_steps_array[$reg_step->slug()] = false;
         }
         return $txn_reg_steps_array;
     }
@@ -799,7 +799,7 @@ 
      */
     public function stash_transaction_and_checkout()
     {
-        if (! $this->revisit) {
+        if ( ! $this->revisit) {
             $this->update_txn_reg_steps_array();
         }
         $this->track_transaction_and_registration_status_updates();
@@ -926,7 +926,7 @@ 
             // should this registration be processed during this visit ?
             if ($this->visit_allows_processing_of_this_registration($registration)) {
                 // set TXN ID
-                if (! $registration->transaction_ID()) {
+                if ( ! $registration->transaction_ID()) {
                     $registration->set_transaction_id($this->transaction->ID());
                 }
                 // verify and save the attendee
@@ -936,7 +936,7 @@ 
                 // save changes
                 $registration->save();
                 // update txn cache
-                if (! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
+                if ( ! $this->transaction->update_cache_after_object_save('Registration', $registration)) {
                     if ($show_errors) {
                         EE_Error::add_error(
                             __(
@@ -979,7 +979,7 @@ 
         if ($registration->attendee() instanceof EE_Attendee) {
             // save so that ATT has ID
             $registration->attendee()->save();
-            if (! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
+            if ( ! $registration->update_cache_after_object_save('Attendee', $registration->attendee())) {
                 if ($show_errors) {
                     EE_Error::add_error(
                         __(
@@ -1028,7 +1028,7 @@ 
             if ($answer instanceof EE_Answer) {
                 $answer->set_registration($registration->ID());
                 $answer->save();
-                if (! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
+                if ( ! $registration->update_cache_after_object_save('Answer', $answer, $cache_key)) {
                     if ($show_errors) {
                         EE_Error::add_error(
                             __(
@@ -1349,11 +1349,11 @@ 
      */
     public function __wakeup()
     {
-        if (! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
+        if ( ! $this->primary_attendee_obj instanceof EE_Attendee && absint($this->primary_attendee_obj) !== 0) {
             // $this->primary_attendee_obj is actually just an ID, so use it to get the object from the db
             $this->primary_attendee_obj = EEM_Attendee::instance()->get_one_by_ID($this->primary_attendee_obj);
         }
-        if (! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
+        if ( ! $this->transaction instanceof EE_Transaction && absint($this->transaction) !== 0) {
             // $this->transaction is actually just an ID, so use it to get the object from the db
             $this->transaction = EEM_Transaction::instance()->get_one_by_ID($this->transaction);
         }
@@ -1377,9 +1377,9 @@ 
     {
         $disabled = true;
         if (WP_DEBUG && ! $disabled) {
-            $debug_data = get_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), array());
+            $debug_data = get_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), array());
             $default_data = array(
-                $class                    => $func . '() : ' . $line,
+                $class                    => $func.'() : '.$line,
                 'request->step'           => $this->step,
                 'request->action'         => $this->action,
                 'current_step->slug'      => $this->current_step instanceof EE_SPCO_Reg_Step ?
@@ -1395,20 +1395,20 @@ 
                 $default_data['TXN_status'] = $this->transaction->status_ID();
                 $default_data['TXN_reg_steps'] = $this->transaction->reg_steps();
                 foreach ($this->transaction->registrations($this->reg_cache_where_params) as $REG_ID => $registration) {
-                    $default_data['registrations'][ $REG_ID ] = $registration->status_ID();
+                    $default_data['registrations'][$REG_ID] = $registration->status_ID();
                 }
                 if ($this->transaction->ID()) {
-                    $TXN_ID = 'EE_Transaction: ' . $this->transaction->ID();
+                    $TXN_ID = 'EE_Transaction: '.$this->transaction->ID();
                     // don't serialize objects
                     $info = $this->_strip_objects($info);
-                    if (! isset($debug_data[ $TXN_ID ])) {
-                        $debug_data[ $TXN_ID ] = array();
+                    if ( ! isset($debug_data[$TXN_ID])) {
+                        $debug_data[$TXN_ID] = array();
                     }
-                    $debug_data[ $TXN_ID ][ microtime() ] = array_merge(
+                    $debug_data[$TXN_ID][microtime()] = array_merge(
                         $default_data,
                         $info
                     );
-                    update_option('EE_DEBUG_SPCO_' . EE_Session::instance()->id(), $debug_data);
+                    update_option('EE_DEBUG_SPCO_'.EE_Session::instance()->id(), $debug_data);
                 }
             }
         }
@@ -1425,17 +1425,17 @@ 
     {
         foreach ((array) $info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = $this->_strip_objects($value);
+                $info[$key] = $this->_strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : 0;
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;

caffeinated/EE_Caf_Messages.class.php

Indentation +799 added lines, -799 removed lines

@@ -13,803 +13,803 @@
 {
 
 
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-
-
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter(
-            'FHEE__EE_Email_messenger__get_validator_config',
-            array($this, 'email_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Email_messenger__get_template_fields',
-            array($this, 'email_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_template_fields',
-            array($this, 'html_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_validator_config',
-            array($this, 'html_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter(
-            'FHEE__EE_Pdf_messenger__get_validator_config',
-            array($this, 'pdf_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'),
-            5,
-            7
-        );
-        add_filter(
-            'FHEE__EE_Messages_Base__get_valid_shortcodes',
-            array($this, 'message_types_valid_shortcodes'),
-            5,
-            2
-        );
-
-        // shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'),
-            5,
-            5
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'),
-            5,
-            5
-        );
-
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-
-        /**
-         * @since 4.3.0
-         */
-        // eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-
-
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-
-        return $dir_ref;
-    }
-
-
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-
-        // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-
-        // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
-
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
-            switch ($template_file_prefix) {
-                case 'question_list_admin':
-                case 'question_list_attendee':
-                case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template(
-                        $path,
-                        array(),
-                        true
-                    );
-                    break;
-
-                case 'attendee_list_attendee':
-                    $contents = '';
-                    break;
-
-                case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
-                case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-
-        return $contents;
-    }
-
-
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        // make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt',
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
-            }
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[ANSWER_*]'] = __(
-            'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (strpos($shortcode, '[ANSWER_*') === false
-            || ! isset($extra_data['data']->questions)
-            || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-
-        // let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        // now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if ($question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
-            ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
-                    'ANS_value',
-                    'no_wpautop'
-                );
-            }
-        }
-
-        // nothing!
-        return $parsed;
-    }
-
-
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]'] = __(
-            'This will be parsed to the Title given for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_DESCRIPTION]'] = __(
-            'This will be parsed to the description for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_NAME_OR_DATES]'] = __(
-            'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (! $data instanceof EE_Datetime) {
-            return ''; // get out because we can only parse with the datetime object.
-        }
-
-        switch ($shortcode) {
-            case '[DTT_NAME]':
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]':
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]':
-                return $data->get_dtt_display_name(true);
-                break;
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
-            'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]':
-                $att = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
-                    : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers = array();
-
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-
-                // if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                // if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
-
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
-            'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        // register newsletter message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
-            ),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-
-        // register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-
-        // register registration declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-
-        // register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-
-
-        // register payment failed message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-
-
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-
-
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        return $question_list;
-    }
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+
+
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_validator_config',
+			array($this, 'email_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_template_fields',
+			array($this, 'email_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_template_fields',
+			array($this, 'html_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_validator_config',
+			array($this, 'html_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter(
+			'FHEE__EE_Pdf_messenger__get_validator_config',
+			array($this, 'pdf_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'),
+			5,
+			7
+		);
+		add_filter(
+			'FHEE__EE_Messages_Base__get_valid_shortcodes',
+			array($this, 'message_types_valid_shortcodes'),
+			5,
+			2
+		);
+
+		// shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'),
+			5,
+			5
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'),
+			5,
+			5
+		);
+
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+
+		/**
+		 * @since 4.3.0
+		 */
+		// eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+
+
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+
+		return $dir_ref;
+	}
+
+
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+
+		// we're only modifying templates for the default template pack
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+
+		// the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
+			switch ($template_file_prefix) {
+				case 'question_list_admin':
+				case 'question_list_attendee':
+				case 'question_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_admin':
+					$path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template(
+						$path,
+						array(),
+						true
+					);
+					break;
+
+				case 'attendee_list_attendee':
+					$contents = '';
+					break;
+
+				case 'event_list_attendee':
+					$path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
+				case 'content_attendee':
+					$path = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_content_attendee':
+					$path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_subject_attendee':
+					$path = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+
+		return $contents;
+	}
+
+
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		// make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt',
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[ $context ][] = 'question_list';
+				$valid_shortcodes[ $context ][] = 'question';
+			}
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[ANSWER_*]'] = __(
+			'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (strpos($shortcode, '[ANSWER_*') === false
+			|| ! isset($extra_data['data']->questions)
+			|| ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+
+		// let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array(
+			$extra_data
+		) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array(
+			$extra_data
+		) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+
+		if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		// now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if ($question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+			) {
+				return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+					'ANS_value',
+					'no_wpautop'
+				);
+			}
+		}
+
+		// nothing!
+		return $parsed;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]'] = __(
+			'This will be parsed to the Title given for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_DESCRIPTION]'] = __(
+			'This will be parsed to the description for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_NAME_OR_DATES]'] = __(
+			'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (! $data instanceof EE_Datetime) {
+			return ''; // get out because we can only parse with the datetime object.
+		}
+
+		switch ($shortcode) {
+			case '[DTT_NAME]':
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]':
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]':
+				return $data->get_dtt_display_name(true);
+				break;
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
+			'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]':
+				$att = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee
+					? $recipient->attendees[ $att->ID() ]['reg_objs']
+					: array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers = array();
+
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+
+				// if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				// if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
+			'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
+				if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
+					? $recipient->registrations[ $registration->ID() ]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		// register newsletter message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'                                    => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+			),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+
+		// register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+
+		// register registration declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+
+		// register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+
+
+		// register payment failed message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+
+
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/',
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+
+
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				// first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+		return $question_list;
+	}
 }

Spacing +44 added lines, -44 removed lines

@@ -130,7 +130,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
 
         return $dir_ref;
     }
@@ -246,32 +246,32 @@ 
     ) {
 
         // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $contents;
         }
 
         // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix = $messenger->name.'_'.$message_type->name.'_';
 
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
 
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             switch ($template_file_prefix) {
                 case 'question_list_admin':
                 case 'question_list_attendee':
                 case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template(
                         $path,
                         array(),
@@ -284,31 +284,31 @@ 
                     break;
 
                 case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
             switch ($template_file_prefix) {
                 case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
+                    $path = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
+                    $path = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -339,8 +339,8 @@ 
         if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
             $contexts = array_keys($msg->get_contexts());
             foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
+                $valid_shortcodes[$context][] = 'question_list';
+                $valid_shortcodes[$context][] = 'question';
             }
         }
 
@@ -383,7 +383,7 @@ 
             $extra_data
         ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
 
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -391,9 +391,9 @@ 
         foreach ($aee->questions as $ansid => $question) {
             if ($question instanceof EE_Question
                 && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
             ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty(
                     'ANS_value',
                     'no_wpautop'
                 );
@@ -454,7 +454,7 @@ 
     public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
     {
 
-        if (! $data instanceof EE_Datetime) {
+        if ( ! $data instanceof EE_Datetime) {
             return ''; // get out because we can only parse with the datetime object.
         }
 
@@ -507,7 +507,7 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -515,7 +515,7 @@ 
             case '[RECIPIENT_QUESTION_LIST]':
                 $att = $recipient->att_obj;
                 $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
+                    ? $recipient->attendees[$att->ID()]['reg_objs']
                     : array();
                 $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
                 $answers = array();
@@ -529,12 +529,12 @@ 
                 if ($data['data'] instanceof EE_Messages_Addressee) {
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -546,12 +546,12 @@ 
                     $event = $data['data'];
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -562,7 +562,7 @@ 
 
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
 
@@ -619,18 +619,18 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
         switch ($shortcode) {
             case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
+                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+                    ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
                 if (empty($answers)) {
                     return '';
@@ -639,11 +639,11 @@ 
                     ? $data['template']['question_list']
                     : $extra_data['template']['question_list'];
                 $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+                $answers = $recipient->registrations[$registration->ID()]['ans_objs'];
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -676,7 +676,7 @@ 
         $setup_args = array(
             'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/',
             ),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
@@ -687,7 +687,7 @@ 
         // register payment reminder message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -697,7 +697,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -707,7 +707,7 @@ 
         // register registration declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -717,7 +717,7 @@ 
         // register registration cancelled message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -728,7 +728,7 @@ 
         // register payment failed message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -738,7 +738,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -758,7 +758,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
+                EE_CAF_LIBRARIES.'shortcodes/',
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
@@ -792,9 +792,9 @@ 
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
                 // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
                 $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
+                if ( ! $question instanceof EE_Question
                     || (
                         $question instanceof EE_Question
                         && $question->admin_only()