eventespresso / event-espresso-core

core/db_classes/EE_Post_Meta.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
      * Sets meta_id
      *
      * @param int $meta_id
-     * @return boolean
+     * @return boolean|null
      */
     public function set_meta_id($meta_id)
     {
@@ -68,7 +68,7 @@ 
      * Sets post_id
      *
      * @param int $post_id
-     * @return boolean
+     * @return boolean|null
      */
     public function set_post_id($post_id)
     {
@@ -90,7 +90,7 @@ 
      * Sets meta_key
      *
      * @param string $meta_key
-     * @return boolean
+     * @return boolean|null
      */
     public function set_meta_key($meta_key)
     {
@@ -112,7 +112,7 @@ 
      * Sets meta_value
      *
      * @param mixed $meta_value
-     * @return boolean
+     * @return boolean|null
      */
     public function set_meta_value($meta_value)
     {

Indentation +108 added lines, -108 removed lines

@@ -10,112 +10,112 @@
 class EE_Post_Meta extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta|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_Post_Meta
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets meta_id
-     *
-     * @return int
-     */
-    public function meta_id()
-    {
-        return $this->get('meta_id');
-    }
-
-
-    /**
-     * Sets meta_id
-     *
-     * @param int $meta_id
-     * @return boolean
-     */
-    public function set_meta_id($meta_id)
-    {
-        return $this->set('meta_id', $meta_id);
-    }
-
-    /**
-     * Gets post_id
-     *
-     * @return int
-     */
-    public function post_id()
-    {
-        return $this->get('post_id');
-    }
-
-
-    /**
-     * Sets post_id
-     *
-     * @param int $post_id
-     * @return boolean
-     */
-    public function set_post_id($post_id)
-    {
-        return $this->set('post_id', $post_id);
-    }
-
-    /**
-     * Gets meta_key
-     *
-     * @return string
-     */
-    public function meta_key()
-    {
-        return $this->get('meta_key');
-    }
-
-
-    /**
-     * Sets meta_key
-     *
-     * @param string $meta_key
-     * @return boolean
-     */
-    public function set_meta_key($meta_key)
-    {
-        return $this->set('meta_key', $meta_key);
-    }
-
-    /**
-     * Gets meta_value
-     *
-     * @return mixed
-     */
-    public function meta_value()
-    {
-        return $this->get('meta_value');
-    }
-
-
-    /**
-     * Sets meta_value
-     *
-     * @param mixed $meta_value
-     * @return boolean
-     */
-    public function set_meta_value($meta_value)
-    {
-        return $this->set('meta_value', $meta_value);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta|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_Post_Meta
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets meta_id
+	 *
+	 * @return int
+	 */
+	public function meta_id()
+	{
+		return $this->get('meta_id');
+	}
+
+
+	/**
+	 * Sets meta_id
+	 *
+	 * @param int $meta_id
+	 * @return boolean
+	 */
+	public function set_meta_id($meta_id)
+	{
+		return $this->set('meta_id', $meta_id);
+	}
+
+	/**
+	 * Gets post_id
+	 *
+	 * @return int
+	 */
+	public function post_id()
+	{
+		return $this->get('post_id');
+	}
+
+
+	/**
+	 * Sets post_id
+	 *
+	 * @param int $post_id
+	 * @return boolean
+	 */
+	public function set_post_id($post_id)
+	{
+		return $this->set('post_id', $post_id);
+	}
+
+	/**
+	 * Gets meta_key
+	 *
+	 * @return string
+	 */
+	public function meta_key()
+	{
+		return $this->get('meta_key');
+	}
+
+
+	/**
+	 * Sets meta_key
+	 *
+	 * @param string $meta_key
+	 * @return boolean
+	 */
+	public function set_meta_key($meta_key)
+	{
+		return $this->set('meta_key', $meta_key);
+	}
+
+	/**
+	 * Gets meta_value
+	 *
+	 * @return mixed
+	 */
+	public function meta_value()
+	{
+		return $this->get('meta_value');
+	}
+
+
+	/**
+	 * Sets meta_value
+	 *
+	 * @param mixed $meta_value
+	 * @return boolean
+	 */
+	public function set_meta_value($meta_value)
+	{
+		return $this->set('meta_value', $meta_value);
+	}
 }

core/db_classes/EE_Question.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -371,7 +371,7 @@ 
      * Question, that relationship will be overwritten.
      *
      * @param EE_Question_Option $option
-     * @return boolean success
+     * @return EE_Base_Class success
      */
     public function add_option(EE_Question_Option $option)
     {
@@ -396,7 +396,7 @@ 
      * Marks the option as deleted.
      *
      * @param EE_Question_Option $option
-     * @return boolean success
+     * @return EE_Base_Class success
      */
     public function remove_option(EE_Question_Option $option)
     {

Spacing +3 added lines, -3 removed lines

@@ -335,7 +335,7 @@ 
      */
     public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return array();
         }
         $query_params = array();
@@ -509,7 +509,7 @@ 
             ),
             $input_constructor_args
         );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+        if ( ! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
             $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
         }
         // has this question been answered ?
@@ -647,7 +647,7 @@ 
                     $this,
                     $input_constructor_args
                 );
-                if (! $default_input) {
+                if ( ! $default_input) {
                     $default_input = new EE_Text_Input($input_constructor_args);
                 }
                 $result = $default_input;

Indentation +664 added lines, -664 removed lines

@@ -14,668 +14,668 @@
 class EE_Question extends EE_Soft_Delete_Base_Class implements EEI_Duplicatable
 {
 
-    /**
-     *
-     * @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_Question
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $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_Question
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set    Question display text
-     *
-     * @access        public
-     * @param string $QST_display_text
-     */
-    public function set_display_text($QST_display_text = '')
-    {
-        $this->set('QST_display_text', $QST_display_text);
-    }
-
-
-    /**
-     *        Set    Question admin text
-     *
-     * @access        public
-     * @param        string $QST_admin_label
-     */
-    public function set_admin_label($QST_admin_label = '')
-    {
-        $this->set('QST_admin_label', $QST_admin_label);
-    }
-
-
-    /**
-     *        Set    system name
-     *
-     * @access        public
-     * @param        mixed $QST_system
-     */
-    public function set_system_ID($QST_system = '')
-    {
-        $this->set('QST_system', $QST_system);
-    }
-
-
-    /**
-     *        Set    question's type
-     *
-     * @access        public
-     * @param        string $QST_type
-     */
-    public function set_question_type($QST_type = '')
-    {
-        $this->set('QST_type', $QST_type);
-    }
-
-
-    /**
-     *        Sets whether this question must be answered when presented in a form
-     *
-     * @access        public
-     * @param        bool $QST_required
-     */
-    public function set_required($QST_required = false)
-    {
-        $this->set('QST_required', $QST_required);
-    }
-
-
-    /**
-     *        Set    Question display text
-     *
-     * @access        public
-     * @param        string $QST_required_text
-     */
-    public function set_required_text($QST_required_text = '')
-    {
-        $this->set('QST_required_text', $QST_required_text);
-    }
-
-
-    /**
-     *        Sets the order of this question when placed in a sequence of questions
-     *
-     * @access        public
-     * @param        int $QST_order
-     */
-    public function set_order($QST_order = 0)
-    {
-        $this->set('QST_order', $QST_order);
-    }
-
-
-    /**
-     *        Sets whether the question is admin-only
-     *
-     * @access        public
-     * @param        bool $QST_admin_only
-     */
-    public function set_admin_only($QST_admin_only = false)
-    {
-        $this->set('QST_admin_only', $QST_admin_only);
-    }
-
-
-    /**
-     *        Sets the wordpress user ID on the question
-     *
-     * @access        public
-     * @param        int $QST_wp_user
-     */
-    public function set_wp_user($QST_wp_user = 1)
-    {
-        $this->set('QST_wp_user', $QST_wp_user);
-    }
-
-
-    /**
-     *        Sets whether the question has been deleted
-     *        (we use this boolean instead of actually
-     *        deleting it because when users delete this question
-     *        they really want to remove the question from future
-     *        forms, BUT keep their old answers which depend
-     *        on this record actually existing.
-     *
-     * @access        public
-     * @param    bool $QST_deleted
-     */
-    public function set_deleted($QST_deleted = false)
-    {
-        $this->set('QST_deleted', $QST_deleted);
-    }
-
-
-    /**
-     * returns the text for displaying the question to users
-     *
-     * @access public
-     * @return string
-     */
-    public function display_text()
-    {
-        return $this->get('QST_display_text');
-    }
-
-
-    /**
-     * returns the text for the administrative label
-     *
-     * @access public
-     * @return string
-     */
-    public function admin_label()
-    {
-        return $this->get('QST_admin_label');
-    }
-
-
-    /**
-     * returns the attendee column name for this question
-     *
-     * @access public
-     * @return string
-     */
-    public function system_ID()
-    {
-        return $this->get('QST_system');
-    }
-
-
-    /**
-     * returns either a string of 'text', 'textfield', etc.
-     *
-     * @access public
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->get('QST_required');
-    }
-
-
-    /**
-     * returns the text which should be displayed when a user
-     * doesn't answer this question in a form
-     *
-     * @access public
-     * @return string
-     */
-    public function required_text()
-    {
-        return $this->get('QST_required_text');
-    }
-
-
-    /**
-     * returns the type of this question
-     *
-     * @access public
-     * @return string
-     */
-    public function type()
-    {
-        return $this->get('QST_type');
-    }
-
-
-    /**
-     * returns an integer showing where this question should
-     * be placed in a sequence of questions
-     *
-     * @access public
-     * @return int
-     */
-    public function order()
-    {
-        return $this->get('QST_order');
-    }
-
-
-    /**
-     * returns whether this question should only appears to admins,
-     * or to everyone
-     *
-     * @access public
-     * @return boolean
-     */
-    public function admin_only()
-    {
-        return $this->get('QST_admin_only');
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @access public
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('QST_wp_user');
-    }
-
-
-    /**
-     * returns whether this question has been marked as 'deleted'
-     *
-     * @access public
-     * @return boolean
-     */
-    public function deleted()
-    {
-        return $this->get('QST_deleted');
-    }
-
-
-    /**
-     * Gets an array of related EE_Answer  to this EE_Question
-     *
-     * @return EE_Answer[]
-     */
-    public function answers()
-    {
-        return $this->get_many_related('Answer');
-    }
-
-
-    /**
-     * Boolean check for if there are answers on this question in th db
-     *
-     * @return boolean true = has answers, false = no answers.
-     */
-    public function has_answers()
-    {
-        return $this->count_related('Answer') > 0 ? true : false;
-    }
-
-
-    /**
-     * gets an array of EE_Question_Group which relate to this question
-     *
-     * @return EE_Question_Group[]
-     */
-    public function question_groups()
-    {
-        return $this->get_many_related('Question_Group');
-    }
-
-
-    /**
-     * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
-     *
-     * @param boolean      $notDeletedOptionsOnly            1
-     *                                                       whether to return ALL options, or only the ones which have
-     *                                                       not yet been deleleted
-     * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
-     *                                                       we want to usually only show non-deleted options AND the
-     *                                                       value that was selected for the answer, whether it was
-     *                                                       trashed or not.
-     * @return EE_Question_Option[]
-     */
-    public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
-    {
-        if (! $this->ID()) {
-            return array();
-        }
-        $query_params = array();
-        if ($selected_value_to_always_include) {
-            if (is_array($selected_value_to_always_include)) {
-                $query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
-            } else {
-                $query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
-            }
-        }
-        if ($notDeletedOptionsOnly) {
-            $query_params[0]['OR*options-query']['QSO_deleted'] = false;
-        }
-        // order by QSO_order
-        $query_params['order_by'] = array('QSO_order' => 'ASC');
-        return $this->get_many_related('Question_Option', $query_params);
-    }
-
-
-    /**
-     * returns an array of EE_Question_Options which relate to this question
-     *
-     * @return \EE_Question_Option[]
-     */
-    public function temp_options()
-    {
-        return $this->_model_relations['Question_Option'];
-    }
-
-
-    /**
-     * Adds an option for this question. Note: if the option were previously associated with a different
-     * Question, that relationship will be overwritten.
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function add_option(EE_Question_Option $option)
-    {
-        return $this->_add_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * Adds an option directly to this question without saving to the db
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function add_temp_option(EE_Question_Option $option)
-    {
-        $this->_model_relations['Question_Option'][] = $option;
-        return true;
-    }
-
-
-    /**
-     * Marks the option as deleted.
-     *
-     * @param EE_Question_Option $option
-     * @return boolean success
-     */
-    public function remove_option(EE_Question_Option $option)
-    {
-        return $this->_remove_relation_to($option, 'Question_Option');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function is_system_question()
-    {
-        $system_ID = $this->get('QST_system');
-        return ! empty($system_ID) ? true : false;
-    }
-
-
-    /**
-     * The purpose of this method is set the question order this question order to be the max out of all questions
-     *
-     * @access public
-     * @return void
-     */
-    public function set_order_to_latest()
-    {
-        $latest_order = $this->get_model()->get_latest_question_order();
-        $latest_order++;
-        $this->set('QST_order', $latest_order);
-    }
-
-
-    /**
-     * Retrieves the list of allowed question types from the model.
-     *
-     * @return string[]
-     */
-    private function _allowed_question_types()
-    {
-        $questionModel = $this->get_model();
-        /* @var $questionModel EEM_Question */
-        return $questionModel->allowed_question_types();
-    }
-
-    /**
-     * Duplicates this question and its question options
-     *
-     * @return \EE_Question
-     */
-    public function duplicate($options = array())
-    {
-        $new_question = clone $this;
-        $new_question->set('QST_ID', null);
-        $new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
-        $new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
-        $new_question->set_system_ID(null);
-        $new_question->set_wp_user(get_current_user_id());
-        // if we're duplicating a trashed question, assume we don't want the new one to be trashed
-        $new_question->set_deleted(false);
-        $success = $new_question->save();
-        if ($success) {
-            // we don't totally want to duplicate the question options, because we want them to be for the NEW question
-            foreach ($this->options() as $question_option) {
-                $question_option->duplicate(array('QST_ID' => $new_question->ID()));
-            }
-            return $new_question;
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Returns the question's maximum allowed response size
-     *
-     * @return int|float
-     */
-    public function max()
-    {
-        return $this->get('QST_max');
-    }
-
-    /**
-     * Sets the question's maximum allowed response size
-     *
-     * @param int|float $new_max
-     * @return void
-     */
-    public function set_max($new_max)
-    {
-        $this->set('QST_max', $new_max);
-    }
-
-
-    /**
-     * Creates a form input from this question which can be used in HTML forms
-     *
-     * @param EE_Registration $registration
-     * @param EE_Answer       $answer
-     * @param array           $input_constructor_args
-     * @return EE_Form_Input_Base
-     */
-    public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array())
-    {
-        $identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
-
-        $input_constructor_args = array_merge(
-            array(
-                'required'                          => $this->required() ? true : false,
-                'html_label_text'                   => $this->display_text(),
-                'required_validation_error_message' => $this->required_text(),
-            ),
-            $input_constructor_args
-        );
-        if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
-        }
-        // has this question been answered ?
-        if (
-            $answer instanceof EE_Answer
-            && $answer->value() !== ''
-        ) {
-            // answer gets htmlspecialchars called on it, undo that please
-            // because the form input's display strategy may call esc_attr too
-            // which also does html special characters
-            $values_with_html_special_chars = $answer->value();
-            if (is_array($values_with_html_special_chars)) {
-                $default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
-            } else {
-                $default_value = htmlspecialchars_decode($values_with_html_special_chars);
-            }
-            $input_constructor_args['default'] = $default_value;
-        }
-        $max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
-        if (
-            in_array(
-                $this->type(),
-                EEM_Question::instance()->questionTypesWithMaxLength(),
-                true
-            )
-        ) {
-            $input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
-                null,
-                min($max_max_for_question, $this->max())
-            );
-        }
-        $input_constructor_args = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
-            $input_constructor_args,
-            $registration,
-            $this,
-            $answer
-        );
-
-        $result = null;
-        switch ($this->type()) {
-            // Text
-            case EEM_Question::QST_type_text:
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            // Textarea
-            case EEM_Question::QST_type_textarea:
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                break;
-            // Radio Buttons
-            case EEM_Question::QST_type_radio:
-                $result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
-                break;
-            // Dropdown
-            case EEM_Question::QST_type_dropdown:
-                $result = new EE_Select_Input($this->options(), $input_constructor_args);
-                break;
-            // State Dropdown
-            case EEM_Question::QST_type_state:
-                $state_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__state_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result = new EE_State_Select_Input($state_options, $input_constructor_args);
-                break;
-            // Country Dropdown
-            case EEM_Question::QST_type_country:
-                $country_options = apply_filters(
-                    'FHEE__EE_Question__generate_form_input__country_options',
-                    null,
-                    $this,
-                    $registration,
-                    $answer
-                );
-                $result = new EE_Country_Select_Input($country_options, $input_constructor_args);
-                break;
-            // Checkboxes
-            case EEM_Question::QST_type_checkbox:
-                $result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
-                break;
-            // Date
-            case EEM_Question::QST_type_date:
-                $result = new EE_Datepicker_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_html_textarea:
-                $input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
-                $result = new EE_Text_Area_Input($input_constructor_args);
-                $result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
-                break;
-            case EEM_Question::QST_type_email:
-                    $result = new EE_Email_Input($input_constructor_args);
-                break;
-            // Email confirm
-            case EEM_Question::QST_type_email_confirm:
-                $result = new EE_Email_Confirm_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_us_phone:
-                $result = new EE_Phone_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_int:
-                $result = new EE_Integer_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_decimal:
-                $result = new EE_Float_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_url:
-                $input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy');
-                $result = new EE_Text_Input($input_constructor_args);
-                break;
-            case EEM_Question::QST_type_year:
-                $result = new EE_Year_Input(
-                    $input_constructor_args,
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
-                        true,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
-                        100,
-                        $this
-                    ),
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
-                        100,
-                        $this
-                    )
-                );
-                break;
-            case EEM_Question::QST_type_multi_select:
-                $result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
-                break;
-            // fallback
-            default:
-                $default_input = apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
-                    null,
-                    $this->type(),
-                    $this,
-                    $input_constructor_args
-                );
-                if (! $default_input) {
-                    $default_input = new EE_Text_Input($input_constructor_args);
-                }
-                $result = $default_input;
-        }
-        return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
-    }
-
-
-    /**
-     * Returns whether or not this question type should have question option entries
-     *
-     * @return bool
-     */
-    public function should_have_question_options()
-    {
-        return in_array(
-            $this->type(),
-            $this->_model->question_types_with_options(),
-            true
-        );
-    }
+	/**
+	 *
+	 * @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_Question
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $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_Question
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set    Question display text
+	 *
+	 * @access        public
+	 * @param string $QST_display_text
+	 */
+	public function set_display_text($QST_display_text = '')
+	{
+		$this->set('QST_display_text', $QST_display_text);
+	}
+
+
+	/**
+	 *        Set    Question admin text
+	 *
+	 * @access        public
+	 * @param        string $QST_admin_label
+	 */
+	public function set_admin_label($QST_admin_label = '')
+	{
+		$this->set('QST_admin_label', $QST_admin_label);
+	}
+
+
+	/**
+	 *        Set    system name
+	 *
+	 * @access        public
+	 * @param        mixed $QST_system
+	 */
+	public function set_system_ID($QST_system = '')
+	{
+		$this->set('QST_system', $QST_system);
+	}
+
+
+	/**
+	 *        Set    question's type
+	 *
+	 * @access        public
+	 * @param        string $QST_type
+	 */
+	public function set_question_type($QST_type = '')
+	{
+		$this->set('QST_type', $QST_type);
+	}
+
+
+	/**
+	 *        Sets whether this question must be answered when presented in a form
+	 *
+	 * @access        public
+	 * @param        bool $QST_required
+	 */
+	public function set_required($QST_required = false)
+	{
+		$this->set('QST_required', $QST_required);
+	}
+
+
+	/**
+	 *        Set    Question display text
+	 *
+	 * @access        public
+	 * @param        string $QST_required_text
+	 */
+	public function set_required_text($QST_required_text = '')
+	{
+		$this->set('QST_required_text', $QST_required_text);
+	}
+
+
+	/**
+	 *        Sets the order of this question when placed in a sequence of questions
+	 *
+	 * @access        public
+	 * @param        int $QST_order
+	 */
+	public function set_order($QST_order = 0)
+	{
+		$this->set('QST_order', $QST_order);
+	}
+
+
+	/**
+	 *        Sets whether the question is admin-only
+	 *
+	 * @access        public
+	 * @param        bool $QST_admin_only
+	 */
+	public function set_admin_only($QST_admin_only = false)
+	{
+		$this->set('QST_admin_only', $QST_admin_only);
+	}
+
+
+	/**
+	 *        Sets the wordpress user ID on the question
+	 *
+	 * @access        public
+	 * @param        int $QST_wp_user
+	 */
+	public function set_wp_user($QST_wp_user = 1)
+	{
+		$this->set('QST_wp_user', $QST_wp_user);
+	}
+
+
+	/**
+	 *        Sets whether the question has been deleted
+	 *        (we use this boolean instead of actually
+	 *        deleting it because when users delete this question
+	 *        they really want to remove the question from future
+	 *        forms, BUT keep their old answers which depend
+	 *        on this record actually existing.
+	 *
+	 * @access        public
+	 * @param    bool $QST_deleted
+	 */
+	public function set_deleted($QST_deleted = false)
+	{
+		$this->set('QST_deleted', $QST_deleted);
+	}
+
+
+	/**
+	 * returns the text for displaying the question to users
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function display_text()
+	{
+		return $this->get('QST_display_text');
+	}
+
+
+	/**
+	 * returns the text for the administrative label
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function admin_label()
+	{
+		return $this->get('QST_admin_label');
+	}
+
+
+	/**
+	 * returns the attendee column name for this question
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function system_ID()
+	{
+		return $this->get('QST_system');
+	}
+
+
+	/**
+	 * returns either a string of 'text', 'textfield', etc.
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->get('QST_required');
+	}
+
+
+	/**
+	 * returns the text which should be displayed when a user
+	 * doesn't answer this question in a form
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function required_text()
+	{
+		return $this->get('QST_required_text');
+	}
+
+
+	/**
+	 * returns the type of this question
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->get('QST_type');
+	}
+
+
+	/**
+	 * returns an integer showing where this question should
+	 * be placed in a sequence of questions
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->get('QST_order');
+	}
+
+
+	/**
+	 * returns whether this question should only appears to admins,
+	 * or to everyone
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function admin_only()
+	{
+		return $this->get('QST_admin_only');
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('QST_wp_user');
+	}
+
+
+	/**
+	 * returns whether this question has been marked as 'deleted'
+	 *
+	 * @access public
+	 * @return boolean
+	 */
+	public function deleted()
+	{
+		return $this->get('QST_deleted');
+	}
+
+
+	/**
+	 * Gets an array of related EE_Answer  to this EE_Question
+	 *
+	 * @return EE_Answer[]
+	 */
+	public function answers()
+	{
+		return $this->get_many_related('Answer');
+	}
+
+
+	/**
+	 * Boolean check for if there are answers on this question in th db
+	 *
+	 * @return boolean true = has answers, false = no answers.
+	 */
+	public function has_answers()
+	{
+		return $this->count_related('Answer') > 0 ? true : false;
+	}
+
+
+	/**
+	 * gets an array of EE_Question_Group which relate to this question
+	 *
+	 * @return EE_Question_Group[]
+	 */
+	public function question_groups()
+	{
+		return $this->get_many_related('Question_Group');
+	}
+
+
+	/**
+	 * Returns all the options for this question. By default, it returns only the not-yet-deleted ones.
+	 *
+	 * @param boolean      $notDeletedOptionsOnly            1
+	 *                                                       whether to return ALL options, or only the ones which have
+	 *                                                       not yet been deleleted
+	 * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
+	 *                                                       we want to usually only show non-deleted options AND the
+	 *                                                       value that was selected for the answer, whether it was
+	 *                                                       trashed or not.
+	 * @return EE_Question_Option[]
+	 */
+	public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
+	{
+		if (! $this->ID()) {
+			return array();
+		}
+		$query_params = array();
+		if ($selected_value_to_always_include) {
+			if (is_array($selected_value_to_always_include)) {
+				$query_params[0]['OR*options-query']['QSO_value'] = array('IN', $selected_value_to_always_include);
+			} else {
+				$query_params[0]['OR*options-query']['QSO_value'] = $selected_value_to_always_include;
+			}
+		}
+		if ($notDeletedOptionsOnly) {
+			$query_params[0]['OR*options-query']['QSO_deleted'] = false;
+		}
+		// order by QSO_order
+		$query_params['order_by'] = array('QSO_order' => 'ASC');
+		return $this->get_many_related('Question_Option', $query_params);
+	}
+
+
+	/**
+	 * returns an array of EE_Question_Options which relate to this question
+	 *
+	 * @return \EE_Question_Option[]
+	 */
+	public function temp_options()
+	{
+		return $this->_model_relations['Question_Option'];
+	}
+
+
+	/**
+	 * Adds an option for this question. Note: if the option were previously associated with a different
+	 * Question, that relationship will be overwritten.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function add_option(EE_Question_Option $option)
+	{
+		return $this->_add_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * Adds an option directly to this question without saving to the db
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function add_temp_option(EE_Question_Option $option)
+	{
+		$this->_model_relations['Question_Option'][] = $option;
+		return true;
+	}
+
+
+	/**
+	 * Marks the option as deleted.
+	 *
+	 * @param EE_Question_Option $option
+	 * @return boolean success
+	 */
+	public function remove_option(EE_Question_Option $option)
+	{
+		return $this->_remove_relation_to($option, 'Question_Option');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function is_system_question()
+	{
+		$system_ID = $this->get('QST_system');
+		return ! empty($system_ID) ? true : false;
+	}
+
+
+	/**
+	 * The purpose of this method is set the question order this question order to be the max out of all questions
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_order_to_latest()
+	{
+		$latest_order = $this->get_model()->get_latest_question_order();
+		$latest_order++;
+		$this->set('QST_order', $latest_order);
+	}
+
+
+	/**
+	 * Retrieves the list of allowed question types from the model.
+	 *
+	 * @return string[]
+	 */
+	private function _allowed_question_types()
+	{
+		$questionModel = $this->get_model();
+		/* @var $questionModel EEM_Question */
+		return $questionModel->allowed_question_types();
+	}
+
+	/**
+	 * Duplicates this question and its question options
+	 *
+	 * @return \EE_Question
+	 */
+	public function duplicate($options = array())
+	{
+		$new_question = clone $this;
+		$new_question->set('QST_ID', null);
+		$new_question->set_display_text(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->display_text()));
+		$new_question->set_admin_label(sprintf(__('%s **Duplicate**', 'event_espresso'), $this->admin_label()));
+		$new_question->set_system_ID(null);
+		$new_question->set_wp_user(get_current_user_id());
+		// if we're duplicating a trashed question, assume we don't want the new one to be trashed
+		$new_question->set_deleted(false);
+		$success = $new_question->save();
+		if ($success) {
+			// we don't totally want to duplicate the question options, because we want them to be for the NEW question
+			foreach ($this->options() as $question_option) {
+				$question_option->duplicate(array('QST_ID' => $new_question->ID()));
+			}
+			return $new_question;
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Returns the question's maximum allowed response size
+	 *
+	 * @return int|float
+	 */
+	public function max()
+	{
+		return $this->get('QST_max');
+	}
+
+	/**
+	 * Sets the question's maximum allowed response size
+	 *
+	 * @param int|float $new_max
+	 * @return void
+	 */
+	public function set_max($new_max)
+	{
+		$this->set('QST_max', $new_max);
+	}
+
+
+	/**
+	 * Creates a form input from this question which can be used in HTML forms
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Answer       $answer
+	 * @param array           $input_constructor_args
+	 * @return EE_Form_Input_Base
+	 */
+	public function generate_form_input($registration = null, $answer = null, $input_constructor_args = array())
+	{
+		$identifier = $this->is_system_question() ? $this->system_ID() : $this->ID();
+
+		$input_constructor_args = array_merge(
+			array(
+				'required'                          => $this->required() ? true : false,
+				'html_label_text'                   => $this->display_text(),
+				'required_validation_error_message' => $this->required_text(),
+			),
+			$input_constructor_args
+		);
+		if (! $answer instanceof EE_Answer && $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_registration_question_answer_object($registration, $this->ID());
+		}
+		// has this question been answered ?
+		if (
+			$answer instanceof EE_Answer
+			&& $answer->value() !== ''
+		) {
+			// answer gets htmlspecialchars called on it, undo that please
+			// because the form input's display strategy may call esc_attr too
+			// which also does html special characters
+			$values_with_html_special_chars = $answer->value();
+			if (is_array($values_with_html_special_chars)) {
+				$default_value = array_map('htmlspecialchars_decode', $values_with_html_special_chars);
+			} else {
+				$default_value = htmlspecialchars_decode($values_with_html_special_chars);
+			}
+			$input_constructor_args['default'] = $default_value;
+		}
+		$max_max_for_question = EEM_Question::instance()->absolute_max_for_system_question($this->system_ID());
+		if (
+			in_array(
+				$this->type(),
+				EEM_Question::instance()->questionTypesWithMaxLength(),
+				true
+			)
+		) {
+			$input_constructor_args['validation_strategies'][] = new EE_Max_Length_Validation_Strategy(
+				null,
+				min($max_max_for_question, $this->max())
+			);
+		}
+		$input_constructor_args = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__input_constructor_args',
+			$input_constructor_args,
+			$registration,
+			$this,
+			$answer
+		);
+
+		$result = null;
+		switch ($this->type()) {
+			// Text
+			case EEM_Question::QST_type_text:
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			// Textarea
+			case EEM_Question::QST_type_textarea:
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				break;
+			// Radio Buttons
+			case EEM_Question::QST_type_radio:
+				$result = new EE_Radio_Button_Input($this->options(), $input_constructor_args);
+				break;
+			// Dropdown
+			case EEM_Question::QST_type_dropdown:
+				$result = new EE_Select_Input($this->options(), $input_constructor_args);
+				break;
+			// State Dropdown
+			case EEM_Question::QST_type_state:
+				$state_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__state_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result = new EE_State_Select_Input($state_options, $input_constructor_args);
+				break;
+			// Country Dropdown
+			case EEM_Question::QST_type_country:
+				$country_options = apply_filters(
+					'FHEE__EE_Question__generate_form_input__country_options',
+					null,
+					$this,
+					$registration,
+					$answer
+				);
+				$result = new EE_Country_Select_Input($country_options, $input_constructor_args);
+				break;
+			// Checkboxes
+			case EEM_Question::QST_type_checkbox:
+				$result = new EE_Checkbox_Multi_Input($this->options(), $input_constructor_args);
+				break;
+			// Date
+			case EEM_Question::QST_type_date:
+				$result = new EE_Datepicker_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_html_textarea:
+				$input_constructor_args['validation_strategies'][] = new EE_Simple_HTML_Validation_Strategy();
+				$result = new EE_Text_Area_Input($input_constructor_args);
+				$result->remove_validation_strategy('EE_Plaintext_Validation_Strategy');
+				break;
+			case EEM_Question::QST_type_email:
+					$result = new EE_Email_Input($input_constructor_args);
+				break;
+			// Email confirm
+			case EEM_Question::QST_type_email_confirm:
+				$result = new EE_Email_Confirm_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_us_phone:
+				$result = new EE_Phone_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_int:
+				$result = new EE_Integer_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_decimal:
+				$result = new EE_Float_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_url:
+				$input_constructor_args['validation_strategies'][] = LoaderFactory::getLoader()->getNew('EE_URL_Validation_Strategy');
+				$result = new EE_Text_Input($input_constructor_args);
+				break;
+			case EEM_Question::QST_type_year:
+				$result = new EE_Year_Input(
+					$input_constructor_args,
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__four_digit',
+						true,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__early_range',
+						100,
+						$this
+					),
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__year_question__end_range',
+						100,
+						$this
+					)
+				);
+				break;
+			case EEM_Question::QST_type_multi_select:
+				$result = new EE_Select_Multiple_Input($this->options(), $input_constructor_args);
+				break;
+			// fallback
+			default:
+				$default_input = apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__default',
+					null,
+					$this->type(),
+					$this,
+					$input_constructor_args
+				);
+				if (! $default_input) {
+					$default_input = new EE_Text_Input($input_constructor_args);
+				}
+				$result = $default_input;
+		}
+		return apply_filters('FHEE__EE_Question__generate_form_input__return', $result, $registration, $this, $answer);
+	}
+
+
+	/**
+	 * Returns whether or not this question type should have question option entries
+	 *
+	 * @return bool
+	 */
+	public function should_have_question_options()
+	{
+		return in_array(
+			$this->type(),
+			$this->_model->question_types_with_options(),
+			true
+		);
+	}
 }

core/db_classes/EE_Question_Form_Input.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -241,7 +241,7 @@ 
      *        generate_question_form_inputs_for_object
      *
      * @access    protected
-     * @param bool|object $object $object
+     * @param EE_Base_Class|null $object $object
      * @param    array    $input_types
      * @return        array
      */
@@ -354,7 +354,7 @@ 
      *
      * @access public
      * @param \EE_Question_Option $QSO EE_Question_Option
-     * @return boolean
+     * @return boolean|null
      */
     public function add_temp_option(EE_Question_Option $QSO)
     {
@@ -367,8 +367,8 @@ 
      *
      * @access public
      * @param    string $property
-     * @param    mixed  $value
-     * @return mixed
+     * @param    boolean  $value
+     * @return boolean|null
      */
     public function set($property = null, $value = null)
     {
@@ -416,7 +416,7 @@ 
      *    get_meta
      *
      * @access public
-     * @param mixed $key
+     * @param string $key
      * @return mixed
      */
     public function get_meta($key = false)

Indentation +434 added lines, -434 removed lines

@@ -13,438 +13,438 @@
 class EE_Question_Form_Input
 {
 
-    /**
-     *    EE_Question object
-     *
-     * @access private
-     * @var object
-     */
-    private $_QST = null;
-
-    /**
-     *    EE_Answer object
-     *
-     * @access private
-     * @var object
-     */
-    private $_ANS = null;
-
-    /**
-     *    $_QST_meta
-     * @access private
-     * @var array
-     */
-    private $_QST_meta = array();
-
-    /**
-     *    $QST_input_name
-     * @access private
-     * @var string
-     */
-    private $QST_input_name = '';
-
-    /**
-     *    $QST_input_id
-     * @access private
-     * @var string
-     */
-    private $QST_input_id = '';
-
-    /**
-     *    $QST_input_class
-     * @access private
-     * @var string
-     */
-    private $QST_input_class = '';
-
-    /**
-     * @var bool $QST_disabled
-     */
-    private $QST_disabled = false;
-
-
-    /**
-     * constructor for questions
-     *
-     * @param \EE_Question $QST EE_Question object
-     * @param \EE_Answer   $ANS EE_Answer object
-     * @param array        $q_meta
-     * @access public
-     * @return \EE_Question_Form_Input
-     */
-    public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, $q_meta = array())
-    {
-        if (empty($QST) || empty($ANS)) {
-            EE_Error::add_error(
-                __('An error occurred. A valid EE_Question or EE_Answer object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $this->_QST = $QST;
-        $this->_ANS = $ANS;
-        $this->set_question_form_input_meta($q_meta);
-        $this->set_question_form_input_init();
-    }
-
-
-    /**
-     * sets meta data for the question form input
-     *
-     * @access public
-     * @param array $q_meta
-     * @return void
-     */
-    public function set_question_form_input_meta($q_meta = array())
-    {
-        $default_q_meta = array(
-            'att_nmbr'       => 1,
-            'ticket_id'      => '',
-            'date'           => '',
-            'time'           => '',
-            'input_name'     => '',
-            'input_id'       => '',
-            'input_class'    => '',
-            'input_prefix'   => 'qstn',
-            'append_qstn_id' => true,
-            'htmlentities'   => true,
-            'allow_null'     => false,
-        );
-        $this->_QST_meta = array_merge($default_q_meta, $q_meta);
-    }
-
-
-    /**
-     * set_question_form_input_init
-     *
-     * @access public
-     * @return void
-     */
-    public function set_question_form_input_init()
-    {
-        $qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
-        $this->_set_input_name($qstn_id);
-        $this->_set_input_id($qstn_id);
-        $this->_set_input_class($qstn_id);
-        $this->set_question_form_input_answer($qstn_id);
-    }
-
-
-    /**
-     * set_input_name
-     *
-     * @access private
-     * @param $qstn_id
-     * @return void
-     */
-    private function _set_input_name($qstn_id)
-    {
-        if (! empty($qstn_id)) {
-            $ANS_ID = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
-        }
-        $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
-    }
-
-
-    /**
-     * get property values for question form input
-     *
-     * @access public
-     * @param    string $property
-     * @return mixed
-     */
-    public function get($property = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                return $this->_QST->get($property);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                return $this->_ANS->get($property);
-            } elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
-                return $this->{$property};
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    _question_form_input_property_exists
-     *
-     * @access private
-     * @param    string $classname
-     * @param    string $property
-     * @return boolean
-     */
-    private function _question_form_input_property_exists($classname, $property)
-    {
-        // first try regular property exists method which works as expected in PHP 5.3+
-        $prop = EEH_Class_Tools::has_property($classname, $property);
-        if (! $prop) {
-            // use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
-            $reflector = new ReflectionClass($classname);
-            $prop = $reflector->hasProperty($property);
-        }
-        return $prop;
-    }
-
-
-    /**
-     * set_input_id
-     *
-     * @access private
-     * @param $qstn_id
-     * @return void
-     */
-    private function _set_input_id($qstn_id)
-    {
-        $input_id = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
-            ? $this->_QST_meta['input_id']
-            : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
-        $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $input_id . '-' . $qstn_id
-            : $input_id;
-    }
-
-
-    /**
-     * set_input_class
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_input_class()
-    {
-        $this->QST_input_class = isset($this->_QST_meta['input_class']) ? $this->_QST_meta['input_class'] : '';
-    }
-
-
-    /**
-     * set_question_form_input_answer
-     *
-     * @access public
-     * @param mixed    int | string    $qstn_id
-     * @return void
-     */
-    public function set_question_form_input_answer($qstn_id)
-    {
-        // check for answer in $_REQUEST in case we are reprocessing a form after an error
-        if (
-            isset($this->_QST_meta['EVT_ID'])
-            && isset($this->_QST_meta['att_nmbr'])
-            && isset($this->_QST_meta['date'])
-            && isset($this->_QST_meta['time'])
-            && isset($this->_QST_meta['price_id'])
-        ) {
-            if (
-                isset($_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ])
-            ) {
-                $answer = $_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ];
-                $this->_ANS->set('ANS_value', $answer);
-            }
-        }
-    }
-
-
-    /**
-     *        generate_question_form_inputs_for_object
-     *
-     * @access    protected
-     * @param bool|object $object $object
-     * @param    array    $input_types
-     * @return        array
-     */
-    public static function generate_question_form_inputs_for_object($object = false, $input_types = array())
-    {
-        if (! is_object($object)) {
-            return false;
-        }
-        $inputs = array();
-        $fields = $object->get_model()->field_settings(false);
-        // $pk = $object->ID(); <<< NO!
-        // EEH_Debug_Tools::printr( $object, get_class( $object ) . '<br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // EEH_Debug_Tools::printr( $fields, '$fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        // EEH_Debug_Tools::printr( $input_types, '$input_types  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-        foreach ($fields as $field_ID => $field) {
-            if ($field instanceof EE_Model_Field_Base) {
-                // echo '<h4>$field_ID : ' . $field_ID . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-                // EEH_Debug_Tools::printr( $field, '$field  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                if (isset($input_types[ $field_ID ])) {
-                    // get saved value for field
-                    $value = $object->get($field_ID);
-                    // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-                    // if no saved value, then use default
-                    $value = $value !== null ? $value : $field->get_default_value();
-                    // if ( $field_ID == 'CNT_active' )
-                    // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
-                    // determine question type
-                    $type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
-                    // input name
-                    $input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
-                        : $field_ID;
-                    // css class for input
-                    $class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
-                        ? ' ' . $input_types[ $field_ID ]['class']
-                        : '';
-                    // whether to apply htmlentities to answer
-                    $htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
-                        ? $input_types[ $field_ID ]['htmlentities']
-                        : true;
-                    // whether to apply htmlentities to answer
-                    $label_b4 = isset($input_types[ $field_ID ]['label_b4'])
-                        ? $input_types[ $field_ID ]['label_b4']
-                        : false;
-                    // whether to apply htmlentities to answer
-                    $use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
-                        ? $input_types[ $field_ID ]['use_desc_4_label']
-                        : false;
-                    // whether input is disabled
-                    $disabled = isset($input_types[ $field_ID ]['disabled'])
-                        ? $input_types[ $field_ID ]['disabled']
-                        : false;
-
-                    // create EE_Question_Form_Input object
-                    $QFI = new EE_Question_Form_Input(
-                        EE_Question::new_instance(
-                            array(
-                                'QST_ID'           => 0,
-                                'QST_display_text' => $field->get_nicename(),
-                                'QST_type'         => $type,
-                            )
-                        ),
-                        EE_Answer::new_instance(
-                            array(
-                                'ANS_ID'    => 0,
-                                'QST_ID'    => 0,
-                                'REG_ID'    => 0,
-                                'ANS_value' => $value,
-                            )
-                        ),
-                        array(
-                            'input_id'         => $field_ID . '-' . $object->ID(),
-                            'input_name'       => $input_name,
-                            'input_class'      => $field_ID . $class,
-                            'input_prefix'     => '',
-                            'append_qstn_id'   => false,
-                            'htmlentities'     => $htmlentities,
-                            'label_b4'         => $label_b4,
-                            'use_desc_4_label' => $use_desc_4_label,
-                        )
-                    );
-                    // does question type have options ?
-                    if (
-                        in_array($type, array('DROPDOWN', 'RADIO_BTN', 'CHECKBOX'))
-                        && isset($input_types[ $field_ID ])
-                        && isset($input_types[ $field_ID ]['options'])
-                    ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
-                            $option = stripslashes_deep($option);
-                            $option_id = ! empty($option['id']) ? $option['id'] : 0;
-                            $QSO = EE_Question_Option::new_instance(
-                                array(
-                                    'QSO_value'   => (string) $option_id,
-                                    'QSO_desc'    => $option['text'],
-                                    'QSO_deleted' => false,
-                                )
-                            );
-                            // all QST (and ANS) properties can be accessed indirectly thru QFI
-                            $QFI->add_temp_option($QSO);
-                        }
-                    }
-                    // we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
-                    if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
-                        $QFI->set('QST_disabled', true);
-                    }
-                    // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                    $inputs[ $field_ID ] = $QFI;
-                    // if ( $field_ID == 'CNT_active' ) {
-                    // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                    // }
-                }
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     *    add_temp_option
-     *
-     * @access public
-     * @param \EE_Question_Option $QSO EE_Question_Option
-     * @return boolean
-     */
-    public function add_temp_option(EE_Question_Option $QSO)
-    {
-        $this->_QST->add_temp_option($QSO);
-    }
-
-
-    /**
-     * set property values for question form input
-     *
-     * @access public
-     * @param    string $property
-     * @param    mixed  $value
-     * @return mixed
-     */
-    public function set($property = null, $value = null)
-    {
-        if (! empty($property)) {
-            if (EEM_Question::instance()->has_field($property)) {
-                $this->_QST->set($property, $value);
-            } elseif (EEM_Answer::instance()->has_field($property)) {
-                $this->_ANS->set($property, $value);
-            } elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
-                // echo "<hr>$property is a prop of QFI";
-                $this->{$property} = $value;
-                return true;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    _question_form_input_property_exists
-     *
-     * @access public
-     * @param boolean      $notDeletedOptionsOnly            1
-     *                                                       whether to return ALL options, or only the ones which have
-     *                                                       not yet been deleted
-     * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
-     *                                                       we want to usually only show non-deleted options AND the
-     *                                                       value that was selected for the answer, whether it was
-     *                                                       trashed or not.
-     * @return EE_Question_Option
-     */
-    public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
-    {
-        $temp_options = $this->_QST->temp_options();
-        return ! empty($temp_options)
-            ? $temp_options
-            : $this->_QST->options(
-                $notDeletedOptionsOnly,
-                $selected_value_to_always_include
-            );
-    }
-
-
-    /**
-     *    get_meta
-     *
-     * @access public
-     * @param mixed $key
-     * @return mixed
-     */
-    public function get_meta($key = false)
-    {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
-    }
+	/**
+	 *    EE_Question object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_QST = null;
+
+	/**
+	 *    EE_Answer object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_ANS = null;
+
+	/**
+	 *    $_QST_meta
+	 * @access private
+	 * @var array
+	 */
+	private $_QST_meta = array();
+
+	/**
+	 *    $QST_input_name
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_name = '';
+
+	/**
+	 *    $QST_input_id
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_id = '';
+
+	/**
+	 *    $QST_input_class
+	 * @access private
+	 * @var string
+	 */
+	private $QST_input_class = '';
+
+	/**
+	 * @var bool $QST_disabled
+	 */
+	private $QST_disabled = false;
+
+
+	/**
+	 * constructor for questions
+	 *
+	 * @param \EE_Question $QST EE_Question object
+	 * @param \EE_Answer   $ANS EE_Answer object
+	 * @param array        $q_meta
+	 * @access public
+	 * @return \EE_Question_Form_Input
+	 */
+	public function __construct(EE_Question $QST = null, EE_Answer $ANS = null, $q_meta = array())
+	{
+		if (empty($QST) || empty($ANS)) {
+			EE_Error::add_error(
+				__('An error occurred. A valid EE_Question or EE_Answer object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$this->_QST = $QST;
+		$this->_ANS = $ANS;
+		$this->set_question_form_input_meta($q_meta);
+		$this->set_question_form_input_init();
+	}
+
+
+	/**
+	 * sets meta data for the question form input
+	 *
+	 * @access public
+	 * @param array $q_meta
+	 * @return void
+	 */
+	public function set_question_form_input_meta($q_meta = array())
+	{
+		$default_q_meta = array(
+			'att_nmbr'       => 1,
+			'ticket_id'      => '',
+			'date'           => '',
+			'time'           => '',
+			'input_name'     => '',
+			'input_id'       => '',
+			'input_class'    => '',
+			'input_prefix'   => 'qstn',
+			'append_qstn_id' => true,
+			'htmlentities'   => true,
+			'allow_null'     => false,
+		);
+		$this->_QST_meta = array_merge($default_q_meta, $q_meta);
+	}
+
+
+	/**
+	 * set_question_form_input_init
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_question_form_input_init()
+	{
+		$qstn_id = $this->_QST->system_ID() ? $this->_QST->system_ID() : $this->_QST->ID();
+		$this->_set_input_name($qstn_id);
+		$this->_set_input_id($qstn_id);
+		$this->_set_input_class($qstn_id);
+		$this->set_question_form_input_answer($qstn_id);
+	}
+
+
+	/**
+	 * set_input_name
+	 *
+	 * @access private
+	 * @param $qstn_id
+	 * @return void
+	 */
+	private function _set_input_name($qstn_id)
+	{
+		if (! empty($qstn_id)) {
+			$ANS_ID = $this->get('ANS_ID');
+			$qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+		}
+		$this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
+			: $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+	}
+
+
+	/**
+	 * get property values for question form input
+	 *
+	 * @access public
+	 * @param    string $property
+	 * @return mixed
+	 */
+	public function get($property = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				return $this->_QST->get($property);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				return $this->_ANS->get($property);
+			} elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
+				return $this->{$property};
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    _question_form_input_property_exists
+	 *
+	 * @access private
+	 * @param    string $classname
+	 * @param    string $property
+	 * @return boolean
+	 */
+	private function _question_form_input_property_exists($classname, $property)
+	{
+		// first try regular property exists method which works as expected in PHP 5.3+
+		$prop = EEH_Class_Tools::has_property($classname, $property);
+		if (! $prop) {
+			// use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
+			$reflector = new ReflectionClass($classname);
+			$prop = $reflector->hasProperty($property);
+		}
+		return $prop;
+	}
+
+
+	/**
+	 * set_input_id
+	 *
+	 * @access private
+	 * @param $qstn_id
+	 * @return void
+	 */
+	private function _set_input_id($qstn_id)
+	{
+		$input_id = isset($this->_QST_meta['input_id']) && ! empty($this->_QST_meta['input_id'])
+			? $this->_QST_meta['input_id']
+			: sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
+		$this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
+			? $input_id . '-' . $qstn_id
+			: $input_id;
+	}
+
+
+	/**
+	 * set_input_class
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_input_class()
+	{
+		$this->QST_input_class = isset($this->_QST_meta['input_class']) ? $this->_QST_meta['input_class'] : '';
+	}
+
+
+	/**
+	 * set_question_form_input_answer
+	 *
+	 * @access public
+	 * @param mixed    int | string    $qstn_id
+	 * @return void
+	 */
+	public function set_question_form_input_answer($qstn_id)
+	{
+		// check for answer in $_REQUEST in case we are reprocessing a form after an error
+		if (
+			isset($this->_QST_meta['EVT_ID'])
+			&& isset($this->_QST_meta['att_nmbr'])
+			&& isset($this->_QST_meta['date'])
+			&& isset($this->_QST_meta['time'])
+			&& isset($this->_QST_meta['price_id'])
+		) {
+			if (
+				isset($_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ])
+			) {
+				$answer = $_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ];
+				$this->_ANS->set('ANS_value', $answer);
+			}
+		}
+	}
+
+
+	/**
+	 *        generate_question_form_inputs_for_object
+	 *
+	 * @access    protected
+	 * @param bool|object $object $object
+	 * @param    array    $input_types
+	 * @return        array
+	 */
+	public static function generate_question_form_inputs_for_object($object = false, $input_types = array())
+	{
+		if (! is_object($object)) {
+			return false;
+		}
+		$inputs = array();
+		$fields = $object->get_model()->field_settings(false);
+		// $pk = $object->ID(); <<< NO!
+		// EEH_Debug_Tools::printr( $object, get_class( $object ) . '<br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// EEH_Debug_Tools::printr( $fields, '$fields  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		// EEH_Debug_Tools::printr( $input_types, '$input_types  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+		foreach ($fields as $field_ID => $field) {
+			if ($field instanceof EE_Model_Field_Base) {
+				// echo '<h4>$field_ID : ' . $field_ID . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+				// EEH_Debug_Tools::printr( $field, '$field  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+				if (isset($input_types[ $field_ID ])) {
+					// get saved value for field
+					$value = $object->get($field_ID);
+					// echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+					// if no saved value, then use default
+					$value = $value !== null ? $value : $field->get_default_value();
+					// if ( $field_ID == 'CNT_active' )
+					// echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
+					// determine question type
+					$type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
+					// input name
+					$input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
+						? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
+						: $field_ID;
+					// css class for input
+					$class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
+						? ' ' . $input_types[ $field_ID ]['class']
+						: '';
+					// whether to apply htmlentities to answer
+					$htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
+						? $input_types[ $field_ID ]['htmlentities']
+						: true;
+					// whether to apply htmlentities to answer
+					$label_b4 = isset($input_types[ $field_ID ]['label_b4'])
+						? $input_types[ $field_ID ]['label_b4']
+						: false;
+					// whether to apply htmlentities to answer
+					$use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
+						? $input_types[ $field_ID ]['use_desc_4_label']
+						: false;
+					// whether input is disabled
+					$disabled = isset($input_types[ $field_ID ]['disabled'])
+						? $input_types[ $field_ID ]['disabled']
+						: false;
+
+					// create EE_Question_Form_Input object
+					$QFI = new EE_Question_Form_Input(
+						EE_Question::new_instance(
+							array(
+								'QST_ID'           => 0,
+								'QST_display_text' => $field->get_nicename(),
+								'QST_type'         => $type,
+							)
+						),
+						EE_Answer::new_instance(
+							array(
+								'ANS_ID'    => 0,
+								'QST_ID'    => 0,
+								'REG_ID'    => 0,
+								'ANS_value' => $value,
+							)
+						),
+						array(
+							'input_id'         => $field_ID . '-' . $object->ID(),
+							'input_name'       => $input_name,
+							'input_class'      => $field_ID . $class,
+							'input_prefix'     => '',
+							'append_qstn_id'   => false,
+							'htmlentities'     => $htmlentities,
+							'label_b4'         => $label_b4,
+							'use_desc_4_label' => $use_desc_4_label,
+						)
+					);
+					// does question type have options ?
+					if (
+						in_array($type, array('DROPDOWN', 'RADIO_BTN', 'CHECKBOX'))
+						&& isset($input_types[ $field_ID ])
+						&& isset($input_types[ $field_ID ]['options'])
+					) {
+						foreach ($input_types[ $field_ID ]['options'] as $option) {
+							$option = stripslashes_deep($option);
+							$option_id = ! empty($option['id']) ? $option['id'] : 0;
+							$QSO = EE_Question_Option::new_instance(
+								array(
+									'QSO_value'   => (string) $option_id,
+									'QSO_desc'    => $option['text'],
+									'QSO_deleted' => false,
+								)
+							);
+							// all QST (and ANS) properties can be accessed indirectly thru QFI
+							$QFI->add_temp_option($QSO);
+						}
+					}
+					// we don't want ppl manually changing primary keys cuz that would just lead to total craziness man
+					if ($disabled || $field_ID == $object->get_model()->primary_key_name()) {
+						$QFI->set('QST_disabled', true);
+					}
+					// EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+					$inputs[ $field_ID ] = $QFI;
+					// if ( $field_ID == 'CNT_active' ) {
+					// EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
+					// }
+				}
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 *    add_temp_option
+	 *
+	 * @access public
+	 * @param \EE_Question_Option $QSO EE_Question_Option
+	 * @return boolean
+	 */
+	public function add_temp_option(EE_Question_Option $QSO)
+	{
+		$this->_QST->add_temp_option($QSO);
+	}
+
+
+	/**
+	 * set property values for question form input
+	 *
+	 * @access public
+	 * @param    string $property
+	 * @param    mixed  $value
+	 * @return mixed
+	 */
+	public function set($property = null, $value = null)
+	{
+		if (! empty($property)) {
+			if (EEM_Question::instance()->has_field($property)) {
+				$this->_QST->set($property, $value);
+			} elseif (EEM_Answer::instance()->has_field($property)) {
+				$this->_ANS->set($property, $value);
+			} elseif ($this->_question_form_input_property_exists(__CLASS__, $property)) {
+				// echo "<hr>$property is a prop of QFI";
+				$this->{$property} = $value;
+				return true;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    _question_form_input_property_exists
+	 *
+	 * @access public
+	 * @param boolean      $notDeletedOptionsOnly            1
+	 *                                                       whether to return ALL options, or only the ones which have
+	 *                                                       not yet been deleted
+	 * @param string|array $selected_value_to_always_include , when retrieving options to an ANSWERED question,
+	 *                                                       we want to usually only show non-deleted options AND the
+	 *                                                       value that was selected for the answer, whether it was
+	 *                                                       trashed or not.
+	 * @return EE_Question_Option
+	 */
+	public function options($notDeletedOptionsOnly = true, $selected_value_to_always_include = null)
+	{
+		$temp_options = $this->_QST->temp_options();
+		return ! empty($temp_options)
+			? $temp_options
+			: $this->_QST->options(
+				$notDeletedOptionsOnly,
+				$selected_value_to_always_include
+			);
+	}
+
+
+	/**
+	 *    get_meta
+	 *
+	 * @access public
+	 * @param mixed $key
+	 * @return mixed
+	 */
+	public function get_meta($key = false)
+	{
+		return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+	}
 }

Spacing +32 added lines, -32 removed lines

@@ -141,13 +141,13 @@ 
      */
     private function _set_input_name($qstn_id)
     {
-        if (! empty($qstn_id)) {
+        if ( ! empty($qstn_id)) {
             $ANS_ID = $this->get('ANS_ID');
-            $qstn_id = ! empty($ANS_ID) ? '[' . $qstn_id . '][' . $ANS_ID . ']' : '[' . $qstn_id . ']';
+            $qstn_id = ! empty($ANS_ID) ? '['.$qstn_id.']['.$ANS_ID.']' : '['.$qstn_id.']';
         }
         $this->QST_input_name = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'] . $qstn_id
-            : $this->_QST_meta['input_prefix'] . $this->_QST_meta['input_name'];
+            ? $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'].$qstn_id
+            : $this->_QST_meta['input_prefix'].$this->_QST_meta['input_name'];
     }
 
 
@@ -160,7 +160,7 @@ 
      */
     public function get($property = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 return $this->_QST->get($property);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -185,7 +185,7 @@ 
     {
         // first try regular property exists method which works as expected in PHP 5.3+
         $prop = EEH_Class_Tools::has_property($classname, $property);
-        if (! $prop) {
+        if ( ! $prop) {
             // use reflection for < PHP 5.3 as a double check when property is not found, possible due to access restriction
             $reflector = new ReflectionClass($classname);
             $prop = $reflector->hasProperty($property);
@@ -207,7 +207,7 @@ 
             ? $this->_QST_meta['input_id']
             : sanitize_key(strip_tags($this->_QST->get('QST_display_text')));
         $this->QST_input_id = $this->_QST_meta['append_qstn_id'] && ! empty($qstn_id)
-            ? $input_id . '-' . $qstn_id
+            ? $input_id.'-'.$qstn_id
             : $input_id;
     }
 
@@ -242,9 +242,9 @@ 
             && isset($this->_QST_meta['price_id'])
         ) {
             if (
-                isset($_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ])
+                isset($_REQUEST['qstn'][$this->_QST_meta['EVT_ID']][$this->_QST_meta['att_nmbr']][$this->_QST_meta['date']][$this->_QST_meta['time']][$this->_QST_meta['price_id']][$qstn_id])
             ) {
-                $answer = $_REQUEST['qstn'][ $this->_QST_meta['EVT_ID'] ][ $this->_QST_meta['att_nmbr'] ][ $this->_QST_meta['date'] ][ $this->_QST_meta['time'] ][ $this->_QST_meta['price_id'] ][ $qstn_id ];
+                $answer = $_REQUEST['qstn'][$this->_QST_meta['EVT_ID']][$this->_QST_meta['att_nmbr']][$this->_QST_meta['date']][$this->_QST_meta['time']][$this->_QST_meta['price_id']][$qstn_id];
                 $this->_ANS->set('ANS_value', $answer);
             }
         }
@@ -261,7 +261,7 @@ 
      */
     public static function generate_question_form_inputs_for_object($object = false, $input_types = array())
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             return false;
         }
         $inputs = array();
@@ -274,7 +274,7 @@ 
             if ($field instanceof EE_Model_Field_Base) {
                 // echo '<h4>$field_ID : ' . $field_ID . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
                 // EEH_Debug_Tools::printr( $field, '$field  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                if (isset($input_types[ $field_ID ])) {
+                if (isset($input_types[$field_ID])) {
                     // get saved value for field
                     $value = $object->get($field_ID);
                     // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
@@ -283,30 +283,30 @@ 
                     // if ( $field_ID == 'CNT_active' )
                     // echo '<h4>$value : ' . $value . '  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span></h4>';
                     // determine question type
-                    $type = isset($input_types[ $field_ID ]) ? $input_types[ $field_ID ]['type'] : 'TEXT';
+                    $type = isset($input_types[$field_ID]) ? $input_types[$field_ID]['type'] : 'TEXT';
                     // input name
-                    $input_name = isset($input_types[ $field_ID ]) && isset($input_types[ $field_ID ]['input_name'])
-                        ? $input_types[ $field_ID ]['input_name'] . '[' . $field_ID . ']'
+                    $input_name = isset($input_types[$field_ID]) && isset($input_types[$field_ID]['input_name'])
+                        ? $input_types[$field_ID]['input_name'].'['.$field_ID.']'
                         : $field_ID;
                     // css class for input
-                    $class = isset($input_types[ $field_ID ]['class']) && ! empty($input_types[ $field_ID ]['class'])
-                        ? ' ' . $input_types[ $field_ID ]['class']
+                    $class = isset($input_types[$field_ID]['class']) && ! empty($input_types[$field_ID]['class'])
+                        ? ' '.$input_types[$field_ID]['class']
                         : '';
                     // whether to apply htmlentities to answer
-                    $htmlentities = isset($input_types[ $field_ID ]['htmlentities'])
-                        ? $input_types[ $field_ID ]['htmlentities']
+                    $htmlentities = isset($input_types[$field_ID]['htmlentities'])
+                        ? $input_types[$field_ID]['htmlentities']
                         : true;
                     // whether to apply htmlentities to answer
-                    $label_b4 = isset($input_types[ $field_ID ]['label_b4'])
-                        ? $input_types[ $field_ID ]['label_b4']
+                    $label_b4 = isset($input_types[$field_ID]['label_b4'])
+                        ? $input_types[$field_ID]['label_b4']
                         : false;
                     // whether to apply htmlentities to answer
-                    $use_desc_4_label = isset($input_types[ $field_ID ]['use_desc_4_label'])
-                        ? $input_types[ $field_ID ]['use_desc_4_label']
+                    $use_desc_4_label = isset($input_types[$field_ID]['use_desc_4_label'])
+                        ? $input_types[$field_ID]['use_desc_4_label']
                         : false;
                     // whether input is disabled
-                    $disabled = isset($input_types[ $field_ID ]['disabled'])
-                        ? $input_types[ $field_ID ]['disabled']
+                    $disabled = isset($input_types[$field_ID]['disabled'])
+                        ? $input_types[$field_ID]['disabled']
                         : false;
 
                     // create EE_Question_Form_Input object
@@ -327,9 +327,9 @@ 
                             )
                         ),
                         array(
-                            'input_id'         => $field_ID . '-' . $object->ID(),
+                            'input_id'         => $field_ID.'-'.$object->ID(),
                             'input_name'       => $input_name,
-                            'input_class'      => $field_ID . $class,
+                            'input_class'      => $field_ID.$class,
                             'input_prefix'     => '',
                             'append_qstn_id'   => false,
                             'htmlentities'     => $htmlentities,
@@ -340,10 +340,10 @@ 
                     // does question type have options ?
                     if (
                         in_array($type, array('DROPDOWN', 'RADIO_BTN', 'CHECKBOX'))
-                        && isset($input_types[ $field_ID ])
-                        && isset($input_types[ $field_ID ]['options'])
+                        && isset($input_types[$field_ID])
+                        && isset($input_types[$field_ID]['options'])
                     ) {
-                        foreach ($input_types[ $field_ID ]['options'] as $option) {
+                        foreach ($input_types[$field_ID]['options'] as $option) {
                             $option = stripslashes_deep($option);
                             $option_id = ! empty($option['id']) ? $option['id'] : 0;
                             $QSO = EE_Question_Option::new_instance(
@@ -362,7 +362,7 @@ 
                         $QFI->set('QST_disabled', true);
                     }
                     // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
-                    $inputs[ $field_ID ] = $QFI;
+                    $inputs[$field_ID] = $QFI;
                     // if ( $field_ID == 'CNT_active' ) {
                     // EEH_Debug_Tools::printr( $QFI, '$QFI  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
                     // }
@@ -396,7 +396,7 @@ 
      */
     public function set($property = null, $value = null)
     {
-        if (! empty($property)) {
+        if ( ! empty($property)) {
             if (EEM_Question::instance()->has_field($property)) {
                 $this->_QST->set($property, $value);
             } elseif (EEM_Answer::instance()->has_field($property)) {
@@ -445,6 +445,6 @@ 
      */
     public function get_meta($key = false)
     {
-        return $key && isset($this->_QST_meta[ $key ]) ? $this->_QST_meta[ $key ] : false;
+        return $key && isset($this->_QST_meta[$key]) ? $this->_QST_meta[$key] : false;
     }
 }

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_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');
+	}
 }

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
      */

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;

Indentation +1425 added lines, -1425 removed lines

@@ -15,1430 +15,1430 @@
 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 (
+	/**
+	 *    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;
-    }
+			! $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;
+	}
 }

core/db_classes/EE_Message_Template.class.php

Indentation +169 added lines, -169 removed lines

@@ -13,173 +13,173 @@
 class EE_Message_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param bool $GRP_ID
-     * @throws EE_Error
-     */
-    public function set_group_template_id($GRP_ID = false)
-    {
-        if (! $GRP_ID) {
-            throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
-        }
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * get Group ID
-     *
-     * @access public
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * get User ID
-     *
-     * @access public
-     * @return int
-     */
-    public function user()
-    {
-        return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
-    }
-
-
-    /**
-     * get Message Messenger
-     *
-     * @access public
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger();
-    }
-
-
-    /**
-     * get Message Messenger OBJECT
-     *
-     * @access public
-     * @return object Messenger Object for the given messenger
-     */
-    public function messenger_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->messenger_obj();
-    }
-
-
-    /**
-     * get Message Type
-     *
-     * @access public
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type();
-    }
-
-
-    /**
-     * get Message type OBJECT
-     *
-     * @access public
-     * @return object  Message Type object for the given message type
-     */
-    public function message_type_obj()
-    {
-        return $this->get_first_related('Message_Template_Group')->message_type_obj();
-    }
-
-
-    /**
-     * This returns the set context array configured in the message type object
-     *
-     * @access public
-     * @return array array of contexts and their configuration.
-     */
-    public function contexts_config()
-    {
-        return $this->get_first_related('Message_Template_Group')->contexts_config();
-    }
-
-
-    /**
-     * This returns the context_label for contexts as set in the message type object
-     *
-     * @access public
-     * @return string label for "context"
-     */
-    public function context_label()
-    {
-        return $this->get_first_related('Message_Template_Group')->context_label();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is global
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_global()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_global();
-    }
-
-
-    /**
-     * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
-     *
-     * @return boolean true if it is, false if it isn't
-     */
-    public function is_active()
-    {
-        return $this->get_first_related('Message_Template_Group')->is_active();
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
-     * this template.
-     *
-     * @access public
-     * @param string $context what context we're going to return shortcodes for
-     * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
-     *                        to be merged and returned.
-     * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
-     *               shortcodes found.
-     */
-    public function get_shortcodes($context, $fields = array())
-    {
-        return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param bool $GRP_ID
+	 * @throws EE_Error
+	 */
+	public function set_group_template_id($GRP_ID = false)
+	{
+		if (! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
+		}
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * get Group ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * get User ID
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function user()
+	{
+		return $this->get_first_related('Message_Template_Group')->get('MTP_user_id');
+	}
+
+
+	/**
+	 * get Message Messenger
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger();
+	}
+
+
+	/**
+	 * get Message Messenger OBJECT
+	 *
+	 * @access public
+	 * @return object Messenger Object for the given messenger
+	 */
+	public function messenger_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->messenger_obj();
+	}
+
+
+	/**
+	 * get Message Type
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type();
+	}
+
+
+	/**
+	 * get Message type OBJECT
+	 *
+	 * @access public
+	 * @return object  Message Type object for the given message type
+	 */
+	public function message_type_obj()
+	{
+		return $this->get_first_related('Message_Template_Group')->message_type_obj();
+	}
+
+
+	/**
+	 * This returns the set context array configured in the message type object
+	 *
+	 * @access public
+	 * @return array array of contexts and their configuration.
+	 */
+	public function contexts_config()
+	{
+		return $this->get_first_related('Message_Template_Group')->contexts_config();
+	}
+
+
+	/**
+	 * This returns the context_label for contexts as set in the message type object
+	 *
+	 * @access public
+	 * @return string label for "context"
+	 */
+	public function context_label()
+	{
+		return $this->get_first_related('Message_Template_Group')->context_label();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is global
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_global()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_global();
+	}
+
+
+	/**
+	 * this returns if the template group this template belongs to is active (i.e. turned "on" or not)
+	 *
+	 * @return boolean true if it is, false if it isn't
+	 */
+	public function is_active()
+	{
+		return $this->get_first_related('Message_Template_Group')->is_active();
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the messenger and message_type objects associated with
+	 * this template.
+	 *
+	 * @access public
+	 * @param string $context what context we're going to return shortcodes for
+	 * @param array  $fields  what fields we're returning valid shortcodes for.  If empty then we assume all fields are
+	 *                        to be merged and returned.
+	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no
+	 *               shortcodes found.
+	 */
+	public function get_shortcodes($context, $fields = array())
+	{
+		return $this->get_first_related('Message_Template_Group')->get_shortcodes($context, $fields);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      */
     public function set_group_template_id($GRP_ID = false)
     {
-        if (! $GRP_ID) {
+        if ( ! $GRP_ID) {
             throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
         }
         $this->set('GRP_ID', $GRP_ID);