eventespresso / event-espresso-core

core/db_classes/EE_Price.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
      * @param array  $props_n_values  incoming values from the database
      * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
      *                                the website will be used.
-     * @return EE_Attendee
+     * @return EE_Price
      */
     public static function new_instance_from_db($props_n_values = array(), $timezone = null)
     {

Indentation +286 added lines, -286 removed lines

@@ -10,290 +10,290 @@
 class EE_Price extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Price type ID
-     *
-     * @access        public
-     * @param        int $PRT_ID
-     */
-    public function set_type($PRT_ID = 0)
-    {
-        $this->set('PRT_ID', $PRT_ID);
-    }
-
-
-    /**
-     *        Set Price Amount
-     *
-     * @access        public
-     * @param        float $PRC_amount
-     */
-    public function set_amount($PRC_amount = 0.00)
-    {
-        $this->set('PRC_amount', $PRC_amount);
-    }
-
-
-    /**
-     *        Set Price Name
-     *
-     * @access        public
-     * @param        string $PRC_name
-     */
-    public function set_name($PRC_name = '')
-    {
-        $this->set('PRC_name', $PRC_name);
-    }
-
-
-    /**
-     *        Set Price Description
-     *
-     * @access        public
-     * @param        string $PRC_desc
-     */
-    public function set_description($PRC_desc = '')
-    {
-        $this->Set('PRC_desc', $PRC_desc);
-    }
-
-
-    /**
-     *        set is_default
-     *
-     * @access        public
-     * @param        bool $PRC_is_default
-     */
-    public function set_is_default($PRC_is_default = false)
-    {
-        $this->set('PRC_is_default', $PRC_is_default);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $PRC_deleted
-     */
-    public function set_deleted($PRC_deleted = null)
-    {
-        $this->set('PRC_deleted', $PRC_deleted);
-    }
-
-
-    /**
-     *    get Price type
-     *
-     * @access        public
-     * @return        int
-     */
-    public function type()
-    {
-        return $this->get('PRT_ID');
-    }
-
-
-    /**
-     *    get Price Amount
-     *
-     * @access        public
-     * @return        float
-     */
-    public function amount()
-    {
-        return $this->get('PRC_amount');
-    }
-
-
-    /**
-     *    get Price Name
-     *
-     * @access        public
-     * @return        string
-     */
-    public function name()
-    {
-        return $this->get('PRC_name');
-    }
-
-
-    /**
-     *    get Price description
-     *
-     * @access        public
-     * @return        string
-     */
-    public function desc()
-    {
-        return $this->get('PRC_desc');
-    }
-
-
-    /**
-     *    get overrides
-     *
-     * @access        public
-     * @return        int
-     */
-    public function overrides()
-    {
-        return $this->get('PRC_overrides');
-    }
-
-
-    /**
-     *    get order
-     *
-     * @access        public
-     * @return        int
-     */
-    public function order()
-    {
-        return $this->get('PRC_order');
-    }
-
-
-    /**
-     * get the author of the price
-     *
-     * @since 4.5.0
-     *
-     * @return int
-     */
-    public function wp_user()
-    {
-        return $this->get('PRC_wp_user');
-    }
-
-
-    /**
-     *    get is_default
-     *
-     * @access        public
-     * @return        bool
-     */
-    public function is_default()
-    {
-        return $this->get('PRC_is_default');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @access        public
-     * @return        bool
-     */
-    public function deleted()
-    {
-        return $this->get('PRC_deleted');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function parent()
-    {
-        return $this->get('PRC_parent');
-    }
-
-
-    // some helper methods for getting info on the price_type for this price
-
-    /**
-     * return whether the price is a base price or not
-     *
-     * @return boolean
-     */
-    public function is_base_price()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->base_type() === 1;
-    }
-
-
-    /**
-     *
-     * @return EE_Price_Type
-     */
-    public function type_obj()
-    {
-        return $this->get_first_related('Price_Type');
-    }
-
-
-    /**
-     * Simply indicates whether this price increases or decreases the total
-     *
-     * @return boolean true = discount, otherwise adds to the total
-     */
-    public function is_discount()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->is_discount();
-    }
-
-
-    /**
-     * whether the price is a percentage or not
-     *
-     * @return boolean
-     */
-    public function is_percent()
-    {
-        $price_type = $this->type_obj();
-        return $price_type->get('PRT_is_percent');
-    }
-
-
-    /**
-     * return pretty price dependant on whether its a dollar or percent.
-     *
-     * @since 4.4.0
-     *
-     * @return string
-     */
-    public function pretty_price()
-    {
-        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_price_without_currency_symbol()
-    {
-        return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount'));
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Price type ID
+	 *
+	 * @access        public
+	 * @param        int $PRT_ID
+	 */
+	public function set_type($PRT_ID = 0)
+	{
+		$this->set('PRT_ID', $PRT_ID);
+	}
+
+
+	/**
+	 *        Set Price Amount
+	 *
+	 * @access        public
+	 * @param        float $PRC_amount
+	 */
+	public function set_amount($PRC_amount = 0.00)
+	{
+		$this->set('PRC_amount', $PRC_amount);
+	}
+
+
+	/**
+	 *        Set Price Name
+	 *
+	 * @access        public
+	 * @param        string $PRC_name
+	 */
+	public function set_name($PRC_name = '')
+	{
+		$this->set('PRC_name', $PRC_name);
+	}
+
+
+	/**
+	 *        Set Price Description
+	 *
+	 * @access        public
+	 * @param        string $PRC_desc
+	 */
+	public function set_description($PRC_desc = '')
+	{
+		$this->Set('PRC_desc', $PRC_desc);
+	}
+
+
+	/**
+	 *        set is_default
+	 *
+	 * @access        public
+	 * @param        bool $PRC_is_default
+	 */
+	public function set_is_default($PRC_is_default = false)
+	{
+		$this->set('PRC_is_default', $PRC_is_default);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $PRC_deleted
+	 */
+	public function set_deleted($PRC_deleted = null)
+	{
+		$this->set('PRC_deleted', $PRC_deleted);
+	}
+
+
+	/**
+	 *    get Price type
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function type()
+	{
+		return $this->get('PRT_ID');
+	}
+
+
+	/**
+	 *    get Price Amount
+	 *
+	 * @access        public
+	 * @return        float
+	 */
+	public function amount()
+	{
+		return $this->get('PRC_amount');
+	}
+
+
+	/**
+	 *    get Price Name
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function name()
+	{
+		return $this->get('PRC_name');
+	}
+
+
+	/**
+	 *    get Price description
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function desc()
+	{
+		return $this->get('PRC_desc');
+	}
+
+
+	/**
+	 *    get overrides
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function overrides()
+	{
+		return $this->get('PRC_overrides');
+	}
+
+
+	/**
+	 *    get order
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function order()
+	{
+		return $this->get('PRC_order');
+	}
+
+
+	/**
+	 * get the author of the price
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return int
+	 */
+	public function wp_user()
+	{
+		return $this->get('PRC_wp_user');
+	}
+
+
+	/**
+	 *    get is_default
+	 *
+	 * @access        public
+	 * @return        bool
+	 */
+	public function is_default()
+	{
+		return $this->get('PRC_is_default');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @access        public
+	 * @return        bool
+	 */
+	public function deleted()
+	{
+		return $this->get('PRC_deleted');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function parent()
+	{
+		return $this->get('PRC_parent');
+	}
+
+
+	// some helper methods for getting info on the price_type for this price
+
+	/**
+	 * return whether the price is a base price or not
+	 *
+	 * @return boolean
+	 */
+	public function is_base_price()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->base_type() === 1;
+	}
+
+
+	/**
+	 *
+	 * @return EE_Price_Type
+	 */
+	public function type_obj()
+	{
+		return $this->get_first_related('Price_Type');
+	}
+
+
+	/**
+	 * Simply indicates whether this price increases or decreases the total
+	 *
+	 * @return boolean true = discount, otherwise adds to the total
+	 */
+	public function is_discount()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->is_discount();
+	}
+
+
+	/**
+	 * whether the price is a percentage or not
+	 *
+	 * @return boolean
+	 */
+	public function is_percent()
+	{
+		$price_type = $this->type_obj();
+		return $price_type->get('PRT_is_percent');
+	}
+
+
+	/**
+	 * return pretty price dependant on whether its a dollar or percent.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @return string
+	 */
+	public function pretty_price()
+	{
+		return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_price_without_currency_symbol()
+	{
+		return str_replace(EE_Registry::instance()->CFG->currency->sign, '', $this->get_pretty('PRC_amount'));
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
      */
     public function pretty_price()
     {
-        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount') . '%';
+        return ! $this->is_percent() ? $this->get_pretty('PRC_amount') : $this->get('PRC_amount').'%';
     }
 
 

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

@@ -14,661 +14,661 @@
 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 = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Question
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        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;
-            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 = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Question
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		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;
+			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 +431 added lines, -431 removed lines

@@ -13,435 +13,435 @@
 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;
     }
 
@@ -240,9 +240,9 @@ 
             && 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 ])
+            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 ];
+                $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);
             }
         }
@@ -259,7 +259,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();
@@ -272,7 +272,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>';
@@ -281,30 +281,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
@@ -325,9 +325,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,
@@ -337,10 +337,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(
@@ -359,7 +359,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' );
                     // }
@@ -393,7 +393,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)) {
@@ -442,6 +442,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_Question_Option.class.php

Doc Comments +7 added lines, -7 removed lines

@@ -39,7 +39,7 @@ 
      * @param array  $props_n_values  incoming values from the database
      * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
      *                                the website will be used.
-     * @return EE_Attendee
+     * @return EE_Question_Option
      */
     public static function new_instance_from_db($props_n_values = array(), $timezone = null)
     {
@@ -51,7 +51,7 @@ 
      * Sets the option's key value
      *
      * @param string $value
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_value($value)
     {
@@ -63,7 +63,7 @@ 
      * Sets the option's Display Text
      *
      * @param string $text
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_desc($text)
     {
@@ -76,7 +76,7 @@ 
      *
      * @access public
      * @param integer $order
-     * @return bool      $success
+     * @return boolean|null      $success
      */
     public function set_order($order)
     {
@@ -88,7 +88,7 @@ 
      * Sets the ID of the related question
      *
      * @param int $question_ID
-     * @return bool success
+     * @return boolean|null success
      */
     public function set_question_ID($question_ID)
     {
@@ -100,7 +100,7 @@ 
      * Sets the option's opt_group
      *
      * @param string $text
-     * @return bool success
+     * @return string success
      */
     public function set_opt_group($text)
     {
@@ -220,7 +220,7 @@ 
      * Sets QSO_system
      *
      * @param string $QSO_system
-     * @return bool
+     * @return boolean|null
      */
     public function set_system($QSO_system)
     {

Indentation +216 added lines, -216 removed lines

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

core/db_classes/EE_Status.class.php

Doc Comments +5 added lines, -5 removed lines

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

Indentation +138 added lines, -138 removed lines

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

Spacing +1 added lines, -1 removed lines

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

core/db_classes/EE_Term.class.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +70 added lines, -70 removed lines

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

Spacing +1 added lines, -1 removed lines

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

core/db_classes/EE_Term_Taxonomy.class.php

Doc Comments +2 added lines, -2 removed lines

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

Indentation +64 added lines, -64 removed lines

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

core/db_classes/EE_Ticket.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -121,7 +121,8 @@
      *                               relevant status const
      * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
      *               further processing
-     * @return mixed status int if the display string isn't requested
+     * @param boolean $remaining
+     * @return string status int if the display string isn't requested
      * @throws \EE_Error
      */
     public function ticket_status($display = false, $remaining = null)

Spacing +11 added lines, -11 removed lines

@@ -127,7 +127,7 @@ 
     public function ticket_status($display = false, $remaining = null)
     {
         $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
+        if ( ! $remaining) {
             return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
         }
         if ($this->get('TKT_deleted')) {
@@ -245,7 +245,7 @@ 
             : '';
         $last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date($dt_frmt) : '';
 
-        return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
+        return $first_date && $last_date ? $first_date.$conjunction.$last_date : '';
     }
 
 
@@ -272,7 +272,7 @@ 
      */
     public function datetimes($query_params = array())
     {
-        if (! isset($query_params['order_by'])) {
+        if ( ! isset($query_params['order_by'])) {
             $query_params['order_by']['DTT_order'] = 'ASC';
         }
         return $this->get_many_related('Datetime', $query_params);
@@ -317,7 +317,7 @@ 
                 if (empty($tickets_sold['datetime'])) {
                     return $total;
                 }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+                if ( ! empty($dtt_id) && ! isset($tickets_sold['datetime'][$dtt_id])) {
                     EE_Error::add_error(
                         __(
                             'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
@@ -329,7 +329,7 @@ 
                     );
                     return $total;
                 }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][$dtt_id];
                 break;
             default:
                 return $total;
@@ -347,9 +347,9 @@ 
     {
         $datetimes = $this->get_many_related('Datetime');
         $tickets_sold = array();
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+                $tickets_sold['datetime'][$datetime->ID()] = $datetime->get('DTT_sold');
             }
         }
         // Tickets sold
@@ -756,7 +756,7 @@ 
         $sold = $this->sold() + $qty;
         // remove ticket reservation, but don't adjust datetime reservations,  because that will happen
         // via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
-        $this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:" . __LINE__ . ')');
+        $this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:".__LINE__.')');
         $this->_increase_sold_for_datetimes($qty);
         $this->set_sold($sold);
         do_action(
@@ -1300,7 +1300,7 @@ 
         foreach ($this->datetimes() as $datetime) {
             $times[] = $datetime->start_date_and_time();
         }
-        return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
+        return $this->name().' @ '.implode(', ', $times).' for '.$this->pretty_price();
     }
 
 
@@ -1406,7 +1406,7 @@ 
     {
         // get one datetime to use for getting the event
         $datetime = $this->first_datetime();
-        if (! $datetime instanceof \EE_Datetime) {
+        if ( ! $datetime instanceof \EE_Datetime) {
             throw new UnexpectedEntityException(
                 $datetime,
                 'EE_Datetime',
@@ -1417,7 +1417,7 @@ 
             );
         }
         $event = $datetime->event();
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new UnexpectedEntityException(
                 $event,
                 'EE_Event',

Indentation +1460 added lines, -1460 removed lines

@@ -12,1464 +12,1464 @@
 class EE_Ticket extends EE_Soft_Delete_Base_Class implements EEI_Line_Item_Object, EEI_Event_Relation, EEI_Has_Icon
 {
 
-    /**
-     * The following constants are used by the ticket_status() method to indicate whether a ticket is on sale or not.
-     */
-    const sold_out = 'TKS';
-
-    /**
-     *
-     */
-    const expired = 'TKE';
-
-    /**
-     *
-     */
-    const archived = 'TKA';
-
-    /**
-     *
-     */
-    const pending = 'TKP';
-
-    /**
-     *
-     */
-    const onsale = 'TKO';
-
-    /**
-     * extra meta key for tracking ticket reservations
-     *
-     * @type string
-     */
-    const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
-
-    /**
-     * cached result from method of the same name
-     *
-     * @var float $_ticket_total_with_taxes
-     */
-    private $_ticket_total_with_taxes;
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Ticket
-     * @throws \EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Ticket
-     * @throws \EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function parent()
-    {
-        return $this->get('TKT_parent');
-    }
-
-
-    /**
-     * return if a ticket has quantities available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function available($DTT_ID = 0)
-    {
-        // are we checking availability for a particular datetime ?
-        if ($DTT_ID) {
-            // get that datetime object
-            $datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
-            // if  ticket sales for this datetime have exceeded the reg limit...
-            if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
-                return false;
-            }
-        }
-        // datetime is still open for registration, but is this ticket sold out ?
-        return $this->qty() < 1 || $this->qty() > $this->sold() ? true : false;
-    }
-
-
-    /**
-     * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
-     *
-     * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the
-     *                               relevant status const
-     * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
-     *               further processing
-     * @return mixed status int if the display string isn't requested
-     * @throws \EE_Error
-     */
-    public function ticket_status($display = false, $remaining = null)
-    {
-        $remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
-        if (! $remaining) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
-        }
-        if ($this->get('TKT_deleted')) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::archived, false, 'sentence') : EE_Ticket::archived;
-        }
-        if ($this->is_expired()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::expired, false, 'sentence') : EE_Ticket::expired;
-        }
-        if ($this->is_pending()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::pending, false, 'sentence') : EE_Ticket::pending;
-        }
-        if ($this->is_on_sale()) {
-            return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
-        }
-        return '';
-    }
-
-
-    /**
-     * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale
-     * considering ALL the factors used for figuring that out.
-     *
-     * @access public
-     * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
-     * @return boolean         true = tickets remaining, false not.
-     * @throws \EE_Error
-     */
-    public function is_remaining($DTT_ID = 0)
-    {
-        $num_remaining = $this->remaining($DTT_ID);
-        if ($num_remaining === 0) {
-            return false;
-        }
-        if ($num_remaining > 0 && $num_remaining < $this->min()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * return the total number of tickets available for purchase
-     *
-     * @param  int $DTT_ID the primary key for a particular datetime.
-     *                     set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
-    public function remaining($DTT_ID = 0)
-    {
-        return $this->real_quantity_on_ticket('saleable', $DTT_ID);
-    }
-
-
-    /**
-     * Gets min
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function min()
-    {
-        return $this->get('TKT_min');
-    }
-
-
-    /**
-     * return if a ticket is no longer available cause its available dates have expired.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_expired()
-    {
-        return ($this->get_raw('TKT_end_date') < time());
-    }
-
-
-    /**
-     * Return if a ticket is yet to go on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_pending()
-    {
-        return ($this->get_raw('TKT_start_date') > time());
-    }
-
-
-    /**
-     * Return if a ticket is on sale or not
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_on_sale()
-    {
-        return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
-    }
-
-
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @param string $dt_frmt
-     * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
-     *                            the end date ie: Jan 01 "to" Dec 31
-     * @return string
-     * @throws \EE_Error
-     */
-    public function date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        $first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date($dt_frmt)
-            : '';
-        $last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date($dt_frmt) : '';
-
-        return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
-    }
-
-
-    /**
-     * This returns the chronologically first datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
-    public function first_datetime()
-    {
-        $datetimes = $this->datetimes(array('limit' => 1));
-        return reset($datetimes);
-    }
-
-
-    /**
-     * Gets all the datetimes this ticket can be used for attending.
-     * Unless otherwise specified, orders datetimes by start date.
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by']['DTT_order'] = 'ASC';
-        }
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * This returns the chronologically last datetime that this ticket is associated with
-     *
-     * @return EE_Datetime
-     * @throws \EE_Error
-     */
-    public function last_datetime()
-    {
-        $datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
-        return end($datetimes);
-    }
-
-
-    /**
-     * This returns the total tickets sold depending on the given parameters.
-     *
-     * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
-     *                        'ticket' = total ticket sales for all datetimes this ticket is related to
-     *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
-     *                        'datetime' = total ticket sales in the datetime_ticket table.
-     *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
-     *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
-     * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
-     * @return mixed (array|int)          how many tickets have sold
-     * @throws \EE_Error
-     */
-    public function tickets_sold($what = 'ticket', $dtt_id = null)
-    {
-        $total = 0;
-        $tickets_sold = $this->_all_tickets_sold();
-        switch ($what) {
-            case 'ticket':
-                return $tickets_sold['ticket'];
-                break;
-            case 'datetime':
-                if (empty($tickets_sold['datetime'])) {
-                    return $total;
-                }
-                if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
-                    EE_Error::add_error(
-                        __(
-                            'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return $total;
-                }
-                return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
-                break;
-            default:
-                return $total;
-        }
-    }
-
-
-    /**
-     * This returns an array indexed by datetime_id for tickets sold with this ticket.
-     *
-     * @return EE_Ticket[]
-     * @throws \EE_Error
-     */
-    protected function _all_tickets_sold()
-    {
-        $datetimes = $this->get_many_related('Datetime');
-        $tickets_sold = array();
-        if (! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                $tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
-            }
-        }
-        // Tickets sold
-        $tickets_sold['ticket'] = $this->sold();
-        return $tickets_sold;
-    }
-
-
-    /**
-     * This returns the base price object for the ticket.
-     *
-     * @param  bool $return_array whether to return as an array indexed by price id or just the object.
-     * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function base_price($return_array = false)
-    {
-        $_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
-        return $return_array
-            ? $this->get_many_related('Price', array($_where))
-            : $this->get_first_related('Price', array($_where));
-    }
-
-
-    /**
-     * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
-     *
-     * @access public
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
-    public function price_modifiers()
-    {
-        $query_params = array(
-            0 => array(
-                'Price_Type.PBT_ID' => array(
-                    'NOT IN',
-                    array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax),
-                ),
-            ),
-        );
-        return $this->prices($query_params);
-    }
-
-
-    /**
-     * Gets all the prices that combine to form the final price of this ticket
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Price[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function prices($query_params = array())
-    {
-        return $this->get_many_related('Price', $query_params);
-    }
-
-
-    /**
-     * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Datetime_Ticket|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function datetime_tickets($query_params = array())
-    {
-        return $this->get_many_related('Datetime_Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes from the db ordered by DTT_order
-     *
-     * @param boolean $show_expired
-     * @param boolean $show_deleted
-     * @return EE_Datetime[]
-     * @throws \EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted
-        );
-    }
-
-
-    /**
-     * Gets ID
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     * get the author of the ticket.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws \EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('TKT_wp_user');
-    }
-
-
-    /**
-     * Gets the template for the ticket
-     *
-     * @return EE_Ticket_Template|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function template()
-    {
-        return $this->get_first_related('Ticket_Template');
-    }
-
-
-    /**
-     * Simply returns an array of EE_Price objects that are taxes.
-     *
-     * @return EE_Price[]
-     * @throws \EE_Error
-     */
-    public function get_ticket_taxes_for_admin()
-    {
-        return EE_Taxes::get_taxes_for_admin();
-    }
-
-
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
-    public function ticket_price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * @return mixed
-     * @throws \EE_Error
-     */
-    public function pretty_price()
-    {
-        return $this->get_pretty('TKT_price');
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_free()
-    {
-        return $this->get_ticket_total_with_taxes() === (float) 0;
-    }
-
-
-    /**
-     * get_ticket_total_with_taxes
-     *
-     * @param bool $no_cache
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_ticket_total_with_taxes($no_cache = false)
-    {
-        if ($this->_ticket_total_with_taxes === null || $no_cache) {
-            $this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
-        }
-        return (float) $this->_ticket_total_with_taxes;
-    }
-
-
-    public function ensure_TKT_Price_correct()
-    {
-        $this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
-        $this->save();
-    }
-
-
-    /**
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_ticket_subtotal()
-    {
-        return EE_Taxes::get_subtotal_for_admin($this);
-    }
-
-
-    /**
-     * Returns the total taxes applied to this ticket
-     *
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_ticket_taxes_total_for_admin()
-    {
-        return EE_Taxes::get_total_taxes_for_admin($this);
-    }
-
-
-    /**
-     * Sets name
-     *
-     * @param string $name
-     * @throws \EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('TKT_name', $name);
-    }
-
-
-    /**
-     * Gets description
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function description()
-    {
-        return $this->get('TKT_description');
-    }
-
-
-    /**
-     * Sets description
-     *
-     * @param string $description
-     * @throws \EE_Error
-     */
-    public function set_description($description)
-    {
-        $this->set('TKT_description', $description);
-    }
-
-
-    /**
-     * Gets start_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
-    public function start_date($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
-    }
-
-
-    /**
-     * Sets start_date
-     *
-     * @param string $start_date
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_start_date($start_date)
-    {
-        $this->_set_date_time('B', $start_date, 'TKT_start_date');
-    }
-
-
-    /**
-     * Gets end_date
-     *
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @return string
-     * @throws \EE_Error
-     */
-    public function end_date($dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
-    }
-
-
-    /**
-     * Sets end_date
-     *
-     * @param string $end_date
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_end_date($end_date)
-    {
-        $this->_set_date_time('B', $end_date, 'TKT_end_date');
-    }
-
-
-    /**
-     * Sets sell until time
-     *
-     * @since 4.5.0
-     * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
-     * @throws \EE_Error
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'TKT_end_date');
-    }
-
-
-    /**
-     * Sets min
-     *
-     * @param int $min
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_min($min)
-    {
-        $this->set('TKT_min', $min);
-    }
-
-
-    /**
-     * Gets max
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function max()
-    {
-        return $this->get('TKT_max');
-    }
-
-
-    /**
-     * Sets max
-     *
-     * @param int $max
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_max($max)
-    {
-        $this->set('TKT_max', $max);
-    }
-
-
-    /**
-     * Sets price
-     *
-     * @param float $price
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_price($price)
-    {
-        $this->set('TKT_price', $price);
-    }
-
-
-    /**
-     * Gets sold
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function sold()
-    {
-        return $this->get_raw('TKT_sold');
-    }
-
-
-    /**
-     * Sets sold
-     *
-     * @param int $sold
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('TKT_sold', $sold);
-    }
-
-
-    /**
-     * increments sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    public function increase_sold($qty = 1)
-    {
-        $sold = $this->sold() + $qty;
-        // remove ticket reservation, but don't adjust datetime reservations,  because that will happen
-        // via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
-        $this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:" . __LINE__ . ')');
-        $this->_increase_sold_for_datetimes($qty);
-        $this->set_sold($sold);
-        do_action(
-            'AHEE__EE_Ticket__increase_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _increase_sold_for_datetimes($qty = 1)
-    {
-        $datetimes = $this->datetimes();
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->increase_sold($qty);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * decrements (subtracts) sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    public function decrease_sold($qty = 1)
-    {
-        $sold = $this->sold() - $qty;
-        $this->_decrease_sold_for_datetimes($qty);
-        $this->set_sold($sold);
-        do_action(
-            'AHEE__EE_Ticket__decrease_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-    /**
-     * Decreases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _decrease_sold_for_datetimes($qty = 1)
-    {
-        $datetimes = $this->datetimes();
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->decrease_sold($qty);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets qty of reserved tickets
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function reserved()
-    {
-        return $this->get_raw('TKT_reserved');
-    }
-
-
-    /**
-     * Sets reserved
-     *
-     * @param int $reserved
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_reserved($reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, (int) $reserved);
-        $this->set('TKT_reserved', $reserved);
-    }
-
-
-    /**
-     * increments reserved by amount passed by $qty
-     *
-     * @param int    $qty
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function increase_reserved($qty = 1, $source = 'unknown')
-    {
-        $qty = absint($qty);
-        $reserved = $this->reserved() + $qty;
-        if ($reserved
-            && $this->add_extra_meta(
-                EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                "{$qty} from {$source}"
-            )
-        ) {
-            $this->_increase_reserved_for_datetimes($qty);
-            $this->set_reserved($reserved);
-            do_action(
-                'AHEE__EE_Ticket__increase_reserved',
-                $this,
-                $qty,
-                $reserved
-            );
-        }
-    }
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _increase_reserved_for_datetimes($qty = 1)
-    {
-        $datetimes = $this->datetimes();
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->increase_reserved($qty);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * decrements (subtracts) reserved by amount passed by $qty
-     *
-     * @param int    $qty
-     * @param bool   $adjust_datetimes
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
-    {
-        $reserved = $this->reserved() - absint($qty);
-        if ($this->add_extra_meta(
-            EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            "-{$qty} from {$source}"
-        )) {
-            if ($adjust_datetimes) {
-                $this->_decrease_reserved_for_datetimes($qty);
-            }
-            $this->set_reserved($reserved);
-            do_action(
-                'AHEE__EE_Ticket__decrease_reserved',
-                $this,
-                $qty,
-                $reserved
-            );
-        }
-    }
-
-
-    /**
-     * Increases sold on related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _decrease_reserved_for_datetimes($qty = 1)
-    {
-        $datetimes = $this->datetimes();
-        if (is_array($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->decrease_reserved($qty);
-                    $datetime->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
-     *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @return int
-     * @throws \EE_Error
-     */
-    public function qty($context = '')
-    {
-        switch ($context) {
-            case 'reg_limit':
-                return $this->real_quantity_on_ticket();
-            case 'saleable':
-                return $this->real_quantity_on_ticket('saleable');
-            default:
-                return $this->get_raw('TKT_qty');
-        }
-    }
-
-
-    /**
-     * Gets ticket quantity
-     *
-     * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
-     *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
-     *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
-     *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
-     *                            is therefore the truest measure of tickets that can be purchased at the moment
-     * @param  int   $DTT_ID      the primary key for a particular datetime.
-     *                            set to 0 for all related datetimes
-     * @return int
-     * @throws \EE_Error
-     */
-    public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0)
-    {
-        $raw = $this->get_raw('TKT_qty');
-        // return immediately if it's zero
-        if ($raw === 0) {
-            return $raw;
-        }
-        // echo "\n\n<br />Ticket: " . $this->name() . '<br />';
-        // ensure qty doesn't exceed raw value for THIS ticket
-        $qty = min(EE_INF, $raw);
-        // echo "\n . qty: " . $qty . '<br />';
-        // calculate this ticket's total sales and reservations
-        $sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
-        // echo "\n . sold: " . $this->sold() . '<br />';
-        // echo "\n . reserved: " . $this->reserved() . '<br />';
-        // echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
-        // first we need to calculate the maximum number of tickets available for the datetime
-        // do we want data for one datetime or all of them ?
-        $query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
-        $datetimes = $this->datetimes($query_params);
-        if (is_array($datetimes) && ! empty($datetimes)) {
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime->refresh_from_db();
-                    // echo "\n . . datetime name: " . $datetime->name() . '<br />';
-                    // echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
-                    // initialize with no restrictions for each datetime
-                    // but adjust datetime qty based on datetime reg limit
-                    $datetime_qty = min(EE_INF, $datetime->reg_limit());
-                    // echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
-                    // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    // if we want the actual saleable amount, then we need to consider OTHER ticket sales
-                    // and reservations for this datetime, that do NOT include sales and reservations
-                    // for this ticket (so we add $this->sold() and $this->reserved() back in)
-                    if ($context === 'saleable') {
-                        $datetime_qty = max(
-                            $datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
-                            0
-                        );
-                        // echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
-                        // echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
-                        // echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                        $datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
-                        // echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
-                    }
-                    $qty = min($datetime_qty, $qty);
-                    // echo "\n . . qty: " . $qty . '<br />';
-                }
-            }
-        }
-        // NOW that we know the  maximum number of tickets available for the datetime
-        // we can finally factor in the details for this specific ticket
-        if ($qty > 0 && $context === 'saleable') {
-            // and subtract the sales for THIS ticket
-            $qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
-            // echo "\n . qty: " . $qty . '<br />';
-        }
-        // echo "\nFINAL QTY: " . $qty . "<br /><br />";
-        return $qty;
-    }
-
-
-    /**
-     * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
-     *
-     * @param int $qty
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_qty($qty)
-    {
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $qty = min($qty, $datetime->reg_limit());
-            }
-        }
-        $this->set('TKT_qty', $qty);
-    }
-
-
-    /**
-     * Gets uses
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function uses()
-    {
-        return $this->get('TKT_uses');
-    }
-
-
-    /**
-     * Sets uses
-     *
-     * @param int $uses
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_uses($uses)
-    {
-        $this->set('TKT_uses', $uses);
-    }
-
-
-    /**
-     * returns whether ticket is required or not.
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function required()
-    {
-        return $this->get('TKT_required');
-    }
-
-
-    /**
-     * sets the TKT_required property
-     *
-     * @param boolean $required
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_required($required)
-    {
-        $this->set('TKT_required', $required);
-    }
-
-
-    /**
-     * Gets taxable
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function taxable()
-    {
-        return $this->get('TKT_taxable');
-    }
-
-
-    /**
-     * Sets taxable
-     *
-     * @param boolean $taxable
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_taxable($taxable)
-    {
-        $this->set('TKT_taxable', $taxable);
-    }
-
-
-    /**
-     * Gets is_default
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function is_default()
-    {
-        return $this->get('TKT_is_default');
-    }
-
-
-    /**
-     * Sets is_default
-     *
-     * @param boolean $is_default
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_is_default($is_default)
-    {
-        $this->set('TKT_is_default', $is_default);
-    }
-
-
-    /**
-     * Gets order
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function order()
-    {
-        return $this->get('TKT_order');
-    }
-
-
-    /**
-     * Sets order
-     *
-     * @param int $order
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('TKT_order', $order);
-    }
-
-
-    /**
-     * Gets row
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function row()
-    {
-        return $this->get('TKT_row');
-    }
-
-
-    /**
-     * Sets row
-     *
-     * @param int $row
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_row($row)
-    {
-        $this->set('TKT_row', $row);
-    }
-
-
-    /**
-     * Gets deleted
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('TKT_deleted');
-    }
-
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_deleted($deleted)
-    {
-        $this->set('TKT_deleted', $deleted);
-    }
-
-
-    /**
-     * Gets parent
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function parent_ID()
-    {
-        return $this->get('TKT_parent');
-    }
-
-
-    /**
-     * Sets parent
-     *
-     * @param int $parent
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_parent_ID($parent)
-    {
-        $this->set('TKT_parent', $parent);
-    }
-
-
-    /**
-     * Gets a string which is handy for showing in gateways etc that describes the ticket.
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name_and_info()
-    {
-        $times = array();
-        foreach ($this->datetimes() as $datetime) {
-            $times[] = $datetime->start_date_and_time();
-        }
-        return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
-    }
-
-
-    /**
-     * Gets name
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        return $this->get('TKT_name');
-    }
-
-
-    /**
-     * Gets price
-     *
-     * @return float
-     * @throws \EE_Error
-     */
-    public function price()
-    {
-        return $this->get('TKT_price');
-    }
-
-
-    /**
-     * Gets all the registrations for this ticket
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Registration[]|EE_Base_Class[]
-     * @throws \EE_Error
-     */
-    public function registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
-     * into account
-     *
-     * @return int
-     * @throws \EE_Error
-     */
-    public function update_tickets_sold()
-    {
-        $count_regs_for_this_ticket = $this->count_registrations(
-            array(
-                array(
-                    'STS_ID'      => EEM_Registration::status_id_approved,
-                    'REG_deleted' => 0,
-                ),
-            )
-        );
-        $sold = $this->sold();
-        if ($count_regs_for_this_ticket > $sold) {
-            $this->increase_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        } elseif ($count_regs_for_this_ticket < $sold) {
-            $this->decrease_sold($count_regs_for_this_ticket - $sold);
-            $this->save();
-        }
-        return $count_regs_for_this_ticket;
-    }
-
-
-    /**
-     * Counts the registrations for this ticket
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return int
-     */
-    public function count_registrations($query_params = array())
-    {
-        return $this->count_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Implementation for EEI_Has_Icon interface method.
-     *
-     * @see EEI_Visual_Representation for comments
-     * @return string
-     */
-    public function get_icon()
-    {
-        return '<span class="dashicons dashicons-tickets-alt"></span>';
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return EE_Event
-     * @throws \EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function get_related_event()
-    {
-        // get one datetime to use for getting the event
-        $datetime = $this->first_datetime();
-        if (! $datetime instanceof \EE_Datetime) {
-            throw new UnexpectedEntityException(
-                $datetime,
-                'EE_Datetime',
-                sprintf(
-                    __('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        $event = $datetime->event();
-        if (! $event instanceof \EE_Event) {
-            throw new UnexpectedEntityException(
-                $event,
-                'EE_Event',
-                sprintf(
-                    __('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
-                    $this->name()
-                )
-            );
-        }
-        return $event;
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
-    public function get_event_name()
-    {
-        $event = $this->get_related_event();
-        return $event instanceof EE_Event ? $event->name() : '';
-    }
-
-
-    /**
-     * Implementation of the EEI_Event_Relation interface method
-     *
-     * @see EEI_Event_Relation for comments
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws \EE_Error
-     */
-    public function get_event_ID()
-    {
-        $event = $this->get_related_event();
-        return $event instanceof EE_Event ? $event->ID() : 0;
-    }
-
-
-    /**
-     * This simply returns whether a ticket can be permanently deleted or not.
-     * The criteria for determining this is whether the ticket has any related registrations.
-     * If there are none then it can be permanently deleted.
-     *
-     * @return bool
-     */
-    public function is_permanently_deleteable()
-    {
-        return $this->count_registrations() === 0;
-    }
+	/**
+	 * The following constants are used by the ticket_status() method to indicate whether a ticket is on sale or not.
+	 */
+	const sold_out = 'TKS';
+
+	/**
+	 *
+	 */
+	const expired = 'TKE';
+
+	/**
+	 *
+	 */
+	const archived = 'TKA';
+
+	/**
+	 *
+	 */
+	const pending = 'TKP';
+
+	/**
+	 *
+	 */
+	const onsale = 'TKO';
+
+	/**
+	 * extra meta key for tracking ticket reservations
+	 *
+	 * @type string
+	 */
+	const META_KEY_TICKET_RESERVATIONS = 'ticket_reservations';
+
+	/**
+	 * cached result from method of the same name
+	 *
+	 * @var float $_ticket_total_with_taxes
+	 */
+	private $_ticket_total_with_taxes;
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Ticket
+	 * @throws \EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Ticket
+	 * @throws \EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function parent()
+	{
+		return $this->get('TKT_parent');
+	}
+
+
+	/**
+	 * return if a ticket has quantities available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function available($DTT_ID = 0)
+	{
+		// are we checking availability for a particular datetime ?
+		if ($DTT_ID) {
+			// get that datetime object
+			$datetime = $this->get_first_related('Datetime', array(array('DTT_ID' => $DTT_ID)));
+			// if  ticket sales for this datetime have exceeded the reg limit...
+			if ($datetime instanceof EE_Datetime && $datetime->sold_out()) {
+				return false;
+			}
+		}
+		// datetime is still open for registration, but is this ticket sold out ?
+		return $this->qty() < 1 || $this->qty() > $this->sold() ? true : false;
+	}
+
+
+	/**
+	 * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired
+	 *
+	 * @param bool        $display   true = we'll return a localized string, otherwise we just return the value of the
+	 *                               relevant status const
+	 * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save
+	 *               further processing
+	 * @return mixed status int if the display string isn't requested
+	 * @throws \EE_Error
+	 */
+	public function ticket_status($display = false, $remaining = null)
+	{
+		$remaining = is_bool($remaining) ? $remaining : $this->is_remaining();
+		if (! $remaining) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::sold_out, false, 'sentence') : EE_Ticket::sold_out;
+		}
+		if ($this->get('TKT_deleted')) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::archived, false, 'sentence') : EE_Ticket::archived;
+		}
+		if ($this->is_expired()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::expired, false, 'sentence') : EE_Ticket::expired;
+		}
+		if ($this->is_pending()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::pending, false, 'sentence') : EE_Ticket::pending;
+		}
+		if ($this->is_on_sale()) {
+			return $display ? EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence') : EE_Ticket::onsale;
+		}
+		return '';
+	}
+
+
+	/**
+	 * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale
+	 * considering ALL the factors used for figuring that out.
+	 *
+	 * @access public
+	 * @param  int $DTT_ID if an int above 0 is included here then we get a specific dtt.
+	 * @return boolean         true = tickets remaining, false not.
+	 * @throws \EE_Error
+	 */
+	public function is_remaining($DTT_ID = 0)
+	{
+		$num_remaining = $this->remaining($DTT_ID);
+		if ($num_remaining === 0) {
+			return false;
+		}
+		if ($num_remaining > 0 && $num_remaining < $this->min()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * return the total number of tickets available for purchase
+	 *
+	 * @param  int $DTT_ID the primary key for a particular datetime.
+	 *                     set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function remaining($DTT_ID = 0)
+	{
+		return $this->real_quantity_on_ticket('saleable', $DTT_ID);
+	}
+
+
+	/**
+	 * Gets min
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function min()
+	{
+		return $this->get('TKT_min');
+	}
+
+
+	/**
+	 * return if a ticket is no longer available cause its available dates have expired.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_expired()
+	{
+		return ($this->get_raw('TKT_end_date') < time());
+	}
+
+
+	/**
+	 * Return if a ticket is yet to go on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_pending()
+	{
+		return ($this->get_raw('TKT_start_date') > time());
+	}
+
+
+	/**
+	 * Return if a ticket is on sale or not
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_on_sale()
+	{
+		return ($this->get_raw('TKT_start_date') < time() && $this->get_raw('TKT_end_date') > time());
+	}
+
+
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @param string $dt_frmt
+	 * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with
+	 *                            the end date ie: Jan 01 "to" Dec 31
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		$first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date($dt_frmt)
+			: '';
+		$last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date($dt_frmt) : '';
+
+		return $first_date && $last_date ? $first_date . $conjunction . $last_date : '';
+	}
+
+
+	/**
+	 * This returns the chronologically first datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
+	public function first_datetime()
+	{
+		$datetimes = $this->datetimes(array('limit' => 1));
+		return reset($datetimes);
+	}
+
+
+	/**
+	 * Gets all the datetimes this ticket can be used for attending.
+	 * Unless otherwise specified, orders datetimes by start date.
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by']['DTT_order'] = 'ASC';
+		}
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * This returns the chronologically last datetime that this ticket is associated with
+	 *
+	 * @return EE_Datetime
+	 * @throws \EE_Error
+	 */
+	public function last_datetime()
+	{
+		$datetimes = $this->datetimes(array('limit' => 1, 'order_by' => array('DTT_EVT_start' => 'DESC')));
+		return end($datetimes);
+	}
+
+
+	/**
+	 * This returns the total tickets sold depending on the given parameters.
+	 *
+	 * @param  string $what   Can be one of two options: 'ticket', 'datetime'.
+	 *                        'ticket' = total ticket sales for all datetimes this ticket is related to
+	 *                        'datetime' = total ticket sales for a specified datetime (required $dtt_id)
+	 *                        'datetime' = total ticket sales in the datetime_ticket table.
+	 *                        If $dtt_id is not given then we return an array of sales indexed by datetime.
+	 *                        If $dtt_id IS given then we return the tickets sold for that given datetime.
+	 * @param  int    $dtt_id [optional] include the dtt_id with $what = 'datetime'.
+	 * @return mixed (array|int)          how many tickets have sold
+	 * @throws \EE_Error
+	 */
+	public function tickets_sold($what = 'ticket', $dtt_id = null)
+	{
+		$total = 0;
+		$tickets_sold = $this->_all_tickets_sold();
+		switch ($what) {
+			case 'ticket':
+				return $tickets_sold['ticket'];
+				break;
+			case 'datetime':
+				if (empty($tickets_sold['datetime'])) {
+					return $total;
+				}
+				if (! empty($dtt_id) && ! isset($tickets_sold['datetime'][ $dtt_id ])) {
+					EE_Error::add_error(
+						__(
+							'You\'ve requested the amount of tickets sold for a given ticket and datetime, however there are no records for the datetime id you included.  Are you SURE that is a datetime related to this ticket?',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return $total;
+				}
+				return empty($dtt_id) ? $tickets_sold['datetime'] : $tickets_sold['datetime'][ $dtt_id ];
+				break;
+			default:
+				return $total;
+		}
+	}
+
+
+	/**
+	 * This returns an array indexed by datetime_id for tickets sold with this ticket.
+	 *
+	 * @return EE_Ticket[]
+	 * @throws \EE_Error
+	 */
+	protected function _all_tickets_sold()
+	{
+		$datetimes = $this->get_many_related('Datetime');
+		$tickets_sold = array();
+		if (! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				$tickets_sold['datetime'][ $datetime->ID() ] = $datetime->get('DTT_sold');
+			}
+		}
+		// Tickets sold
+		$tickets_sold['ticket'] = $this->sold();
+		return $tickets_sold;
+	}
+
+
+	/**
+	 * This returns the base price object for the ticket.
+	 *
+	 * @param  bool $return_array whether to return as an array indexed by price id or just the object.
+	 * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function base_price($return_array = false)
+	{
+		$_where = array('Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price);
+		return $return_array
+			? $this->get_many_related('Price', array($_where))
+			: $this->get_first_related('Price', array($_where));
+	}
+
+
+	/**
+	 * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price)
+	 *
+	 * @access public
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
+	public function price_modifiers()
+	{
+		$query_params = array(
+			0 => array(
+				'Price_Type.PBT_ID' => array(
+					'NOT IN',
+					array(EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax),
+				),
+			),
+		);
+		return $this->prices($query_params);
+	}
+
+
+	/**
+	 * Gets all the prices that combine to form the final price of this ticket
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Price[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function prices($query_params = array())
+	{
+		return $this->get_many_related('Price', $query_params);
+	}
+
+
+	/**
+	 * Gets all the ticket applicabilities (ie, relations between datetimes and tickets)
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Datetime_Ticket|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function datetime_tickets($query_params = array())
+	{
+		return $this->get_many_related('Datetime_Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes from the db ordered by DTT_order
+	 *
+	 * @param boolean $show_expired
+	 * @param boolean $show_deleted
+	 * @return EE_Datetime[]
+	 * @throws \EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_ticket_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted
+		);
+	}
+
+
+	/**
+	 * Gets ID
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 * get the author of the ticket.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('TKT_wp_user');
+	}
+
+
+	/**
+	 * Gets the template for the ticket
+	 *
+	 * @return EE_Ticket_Template|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function template()
+	{
+		return $this->get_first_related('Ticket_Template');
+	}
+
+
+	/**
+	 * Simply returns an array of EE_Price objects that are taxes.
+	 *
+	 * @return EE_Price[]
+	 * @throws \EE_Error
+	 */
+	public function get_ticket_taxes_for_admin()
+	{
+		return EE_Taxes::get_taxes_for_admin();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function ticket_price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws \EE_Error
+	 */
+	public function pretty_price()
+	{
+		return $this->get_pretty('TKT_price');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_free()
+	{
+		return $this->get_ticket_total_with_taxes() === (float) 0;
+	}
+
+
+	/**
+	 * get_ticket_total_with_taxes
+	 *
+	 * @param bool $no_cache
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_ticket_total_with_taxes($no_cache = false)
+	{
+		if ($this->_ticket_total_with_taxes === null || $no_cache) {
+			$this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin();
+		}
+		return (float) $this->_ticket_total_with_taxes;
+	}
+
+
+	public function ensure_TKT_Price_correct()
+	{
+		$this->set('TKT_price', EE_Taxes::get_subtotal_for_admin($this));
+		$this->save();
+	}
+
+
+	/**
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_ticket_subtotal()
+	{
+		return EE_Taxes::get_subtotal_for_admin($this);
+	}
+
+
+	/**
+	 * Returns the total taxes applied to this ticket
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_ticket_taxes_total_for_admin()
+	{
+		return EE_Taxes::get_total_taxes_for_admin($this);
+	}
+
+
+	/**
+	 * Sets name
+	 *
+	 * @param string $name
+	 * @throws \EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('TKT_name', $name);
+	}
+
+
+	/**
+	 * Gets description
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('TKT_description');
+	}
+
+
+	/**
+	 * Sets description
+	 *
+	 * @param string $description
+	 * @throws \EE_Error
+	 */
+	public function set_description($description)
+	{
+		$this->set('TKT_description', $description);
+	}
+
+
+	/**
+	 * Gets start_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function start_date($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime('TKT_start_date', $dt_frmt, $tm_frmt);
+	}
+
+
+	/**
+	 * Sets start_date
+	 *
+	 * @param string $start_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_start_date($start_date)
+	{
+		$this->_set_date_time('B', $start_date, 'TKT_start_date');
+	}
+
+
+	/**
+	 * Gets end_date
+	 *
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function end_date($dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime('TKT_end_date', $dt_frmt, $tm_frmt);
+	}
+
+
+	/**
+	 * Sets end_date
+	 *
+	 * @param string $end_date
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_end_date($end_date)
+	{
+		$this->_set_date_time('B', $end_date, 'TKT_end_date');
+	}
+
+
+	/**
+	 * Sets sell until time
+	 *
+	 * @since 4.5.0
+	 * @param string $time a string representation of the sell until time (ex 9am or 7:30pm)
+	 * @throws \EE_Error
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'TKT_end_date');
+	}
+
+
+	/**
+	 * Sets min
+	 *
+	 * @param int $min
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_min($min)
+	{
+		$this->set('TKT_min', $min);
+	}
+
+
+	/**
+	 * Gets max
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function max()
+	{
+		return $this->get('TKT_max');
+	}
+
+
+	/**
+	 * Sets max
+	 *
+	 * @param int $max
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_max($max)
+	{
+		$this->set('TKT_max', $max);
+	}
+
+
+	/**
+	 * Sets price
+	 *
+	 * @param float $price
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_price($price)
+	{
+		$this->set('TKT_price', $price);
+	}
+
+
+	/**
+	 * Gets sold
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function sold()
+	{
+		return $this->get_raw('TKT_sold');
+	}
+
+
+	/**
+	 * Sets sold
+	 *
+	 * @param int $sold
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('TKT_sold', $sold);
+	}
+
+
+	/**
+	 * increments sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function increase_sold($qty = 1)
+	{
+		$sold = $this->sold() + $qty;
+		// remove ticket reservation, but don't adjust datetime reservations,  because that will happen
+		// via \EE_Datetime::increase_sold() when \EE_Ticket::_increase_sold_for_datetimes() is called
+		$this->decrease_reserved($qty, false, "TKT: {$this->ID()} (ln:" . __LINE__ . ')');
+		$this->_increase_sold_for_datetimes($qty);
+		$this->set_sold($sold);
+		do_action(
+			'AHEE__EE_Ticket__increase_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _increase_sold_for_datetimes($qty = 1)
+	{
+		$datetimes = $this->datetimes();
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_sold($qty);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * decrements (subtracts) sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function decrease_sold($qty = 1)
+	{
+		$sold = $this->sold() - $qty;
+		$this->_decrease_sold_for_datetimes($qty);
+		$this->set_sold($sold);
+		do_action(
+			'AHEE__EE_Ticket__decrease_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+	/**
+	 * Decreases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _decrease_sold_for_datetimes($qty = 1)
+	{
+		$datetimes = $this->datetimes();
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_sold($qty);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets qty of reserved tickets
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function reserved()
+	{
+		return $this->get_raw('TKT_reserved');
+	}
+
+
+	/**
+	 * Sets reserved
+	 *
+	 * @param int $reserved
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_reserved($reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, (int) $reserved);
+		$this->set('TKT_reserved', $reserved);
+	}
+
+
+	/**
+	 * increments reserved by amount passed by $qty
+	 *
+	 * @param int    $qty
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function increase_reserved($qty = 1, $source = 'unknown')
+	{
+		$qty = absint($qty);
+		$reserved = $this->reserved() + $qty;
+		if ($reserved
+			&& $this->add_extra_meta(
+				EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+				"{$qty} from {$source}"
+			)
+		) {
+			$this->_increase_reserved_for_datetimes($qty);
+			$this->set_reserved($reserved);
+			do_action(
+				'AHEE__EE_Ticket__increase_reserved',
+				$this,
+				$qty,
+				$reserved
+			);
+		}
+	}
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _increase_reserved_for_datetimes($qty = 1)
+	{
+		$datetimes = $this->datetimes();
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->increase_reserved($qty);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * decrements (subtracts) reserved by amount passed by $qty
+	 *
+	 * @param int    $qty
+	 * @param bool   $adjust_datetimes
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function decrease_reserved($qty = 1, $adjust_datetimes = true, $source = 'unknown')
+	{
+		$reserved = $this->reserved() - absint($qty);
+		if ($this->add_extra_meta(
+			EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+			"-{$qty} from {$source}"
+		)) {
+			if ($adjust_datetimes) {
+				$this->_decrease_reserved_for_datetimes($qty);
+			}
+			$this->set_reserved($reserved);
+			do_action(
+				'AHEE__EE_Ticket__decrease_reserved',
+				$this,
+				$qty,
+				$reserved
+			);
+		}
+	}
+
+
+	/**
+	 * Increases sold on related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _decrease_reserved_for_datetimes($qty = 1)
+	{
+		$datetimes = $this->datetimes();
+		if (is_array($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->decrease_reserved($qty);
+					$datetime->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of three values: '', 'reg_limit', or 'saleable'
+	 *                            '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function qty($context = '')
+	{
+		switch ($context) {
+			case 'reg_limit':
+				return $this->real_quantity_on_ticket();
+			case 'saleable':
+				return $this->real_quantity_on_ticket('saleable');
+			default:
+				return $this->get_raw('TKT_qty');
+		}
+	}
+
+
+	/**
+	 * Gets ticket quantity
+	 *
+	 * @param string $context     ticket quantity is somewhat subjective depending on the exact information sought
+	 *                            therefore $context can be one of two values: 'reg_limit', or 'saleable'
+	 *                            REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes
+	 *                            SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and
+	 *                            is therefore the truest measure of tickets that can be purchased at the moment
+	 * @param  int   $DTT_ID      the primary key for a particular datetime.
+	 *                            set to 0 for all related datetimes
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function real_quantity_on_ticket($context = 'reg_limit', $DTT_ID = 0)
+	{
+		$raw = $this->get_raw('TKT_qty');
+		// return immediately if it's zero
+		if ($raw === 0) {
+			return $raw;
+		}
+		// echo "\n\n<br />Ticket: " . $this->name() . '<br />';
+		// ensure qty doesn't exceed raw value for THIS ticket
+		$qty = min(EE_INF, $raw);
+		// echo "\n . qty: " . $qty . '<br />';
+		// calculate this ticket's total sales and reservations
+		$sold_and_reserved_for_this_ticket = $this->sold() + $this->reserved();
+		// echo "\n . sold: " . $this->sold() . '<br />';
+		// echo "\n . reserved: " . $this->reserved() . '<br />';
+		// echo "\n . sold_and_reserved_for_this_ticket: " . $sold_and_reserved_for_this_ticket . '<br />';
+		// first we need to calculate the maximum number of tickets available for the datetime
+		// do we want data for one datetime or all of them ?
+		$query_params = $DTT_ID ? array(array('DTT_ID' => $DTT_ID)) : array();
+		$datetimes = $this->datetimes($query_params);
+		if (is_array($datetimes) && ! empty($datetimes)) {
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime->refresh_from_db();
+					// echo "\n . . datetime name: " . $datetime->name() . '<br />';
+					// echo "\n . . datetime ID: " . $datetime->ID() . '<br />';
+					// initialize with no restrictions for each datetime
+					// but adjust datetime qty based on datetime reg limit
+					$datetime_qty = min(EE_INF, $datetime->reg_limit());
+					// echo "\n . . . datetime reg_limit: " . $datetime->reg_limit() . '<br />';
+					// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					// if we want the actual saleable amount, then we need to consider OTHER ticket sales
+					// and reservations for this datetime, that do NOT include sales and reservations
+					// for this ticket (so we add $this->sold() and $this->reserved() back in)
+					if ($context === 'saleable') {
+						$datetime_qty = max(
+							$datetime_qty - $datetime->sold_and_reserved() + $sold_and_reserved_for_this_ticket,
+							0
+						);
+						// echo "\n . . . datetime sold: " . $datetime->sold() . '<br />';
+						// echo "\n . . . datetime reserved: " . $datetime->reserved() . '<br />';
+						// echo "\n . . . datetime sold_and_reserved: " . $datetime->sold_and_reserved() . '<br />';
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+						$datetime_qty = ! $datetime->sold_out() ? $datetime_qty : 0;
+						// echo "\n . . . datetime_qty: " . $datetime_qty . '<br />';
+					}
+					$qty = min($datetime_qty, $qty);
+					// echo "\n . . qty: " . $qty . '<br />';
+				}
+			}
+		}
+		// NOW that we know the  maximum number of tickets available for the datetime
+		// we can finally factor in the details for this specific ticket
+		if ($qty > 0 && $context === 'saleable') {
+			// and subtract the sales for THIS ticket
+			$qty = max($qty - $sold_and_reserved_for_this_ticket, 0);
+			// echo "\n . qty: " . $qty . '<br />';
+		}
+		// echo "\nFINAL QTY: " . $qty . "<br /><br />";
+		return $qty;
+	}
+
+
+	/**
+	 * Sets qty - IMPORTANT!!! Does NOT allow QTY to be set higher than the lowest reg limit of any related datetimes
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_qty($qty)
+	{
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$qty = min($qty, $datetime->reg_limit());
+			}
+		}
+		$this->set('TKT_qty', $qty);
+	}
+
+
+	/**
+	 * Gets uses
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function uses()
+	{
+		return $this->get('TKT_uses');
+	}
+
+
+	/**
+	 * Sets uses
+	 *
+	 * @param int $uses
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_uses($uses)
+	{
+		$this->set('TKT_uses', $uses);
+	}
+
+
+	/**
+	 * returns whether ticket is required or not.
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function required()
+	{
+		return $this->get('TKT_required');
+	}
+
+
+	/**
+	 * sets the TKT_required property
+	 *
+	 * @param boolean $required
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_required($required)
+	{
+		$this->set('TKT_required', $required);
+	}
+
+
+	/**
+	 * Gets taxable
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function taxable()
+	{
+		return $this->get('TKT_taxable');
+	}
+
+
+	/**
+	 * Sets taxable
+	 *
+	 * @param boolean $taxable
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_taxable($taxable)
+	{
+		$this->set('TKT_taxable', $taxable);
+	}
+
+
+	/**
+	 * Gets is_default
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function is_default()
+	{
+		return $this->get('TKT_is_default');
+	}
+
+
+	/**
+	 * Sets is_default
+	 *
+	 * @param boolean $is_default
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_is_default($is_default)
+	{
+		$this->set('TKT_is_default', $is_default);
+	}
+
+
+	/**
+	 * Gets order
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('TKT_order');
+	}
+
+
+	/**
+	 * Sets order
+	 *
+	 * @param int $order
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('TKT_order', $order);
+	}
+
+
+	/**
+	 * Gets row
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function row()
+	{
+		return $this->get('TKT_row');
+	}
+
+
+	/**
+	 * Sets row
+	 *
+	 * @param int $row
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_row($row)
+	{
+		$this->set('TKT_row', $row);
+	}
+
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('TKT_deleted');
+	}
+
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_deleted($deleted)
+	{
+		$this->set('TKT_deleted', $deleted);
+	}
+
+
+	/**
+	 * Gets parent
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function parent_ID()
+	{
+		return $this->get('TKT_parent');
+	}
+
+
+	/**
+	 * Sets parent
+	 *
+	 * @param int $parent
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_parent_ID($parent)
+	{
+		$this->set('TKT_parent', $parent);
+	}
+
+
+	/**
+	 * Gets a string which is handy for showing in gateways etc that describes the ticket.
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name_and_info()
+	{
+		$times = array();
+		foreach ($this->datetimes() as $datetime) {
+			$times[] = $datetime->start_date_and_time();
+		}
+		return $this->name() . ' @ ' . implode(', ', $times) . ' for ' . $this->pretty_price();
+	}
+
+
+	/**
+	 * Gets name
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('TKT_name');
+	}
+
+
+	/**
+	 * Gets price
+	 *
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function price()
+	{
+		return $this->get('TKT_price');
+	}
+
+
+	/**
+	 * Gets all the registrations for this ticket
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Registration[]|EE_Base_Class[]
+	 * @throws \EE_Error
+	 */
+	public function registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket.
+	 * into account
+	 *
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function update_tickets_sold()
+	{
+		$count_regs_for_this_ticket = $this->count_registrations(
+			array(
+				array(
+					'STS_ID'      => EEM_Registration::status_id_approved,
+					'REG_deleted' => 0,
+				),
+			)
+		);
+		$sold = $this->sold();
+		if ($count_regs_for_this_ticket > $sold) {
+			$this->increase_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		} elseif ($count_regs_for_this_ticket < $sold) {
+			$this->decrease_sold($count_regs_for_this_ticket - $sold);
+			$this->save();
+		}
+		return $count_regs_for_this_ticket;
+	}
+
+
+	/**
+	 * Counts the registrations for this ticket
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return int
+	 */
+	public function count_registrations($query_params = array())
+	{
+		return $this->count_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Implementation for EEI_Has_Icon interface method.
+	 *
+	 * @see EEI_Visual_Representation for comments
+	 * @return string
+	 */
+	public function get_icon()
+	{
+		return '<span class="dashicons dashicons-tickets-alt"></span>';
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return EE_Event
+	 * @throws \EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function get_related_event()
+	{
+		// get one datetime to use for getting the event
+		$datetime = $this->first_datetime();
+		if (! $datetime instanceof \EE_Datetime) {
+			throw new UnexpectedEntityException(
+				$datetime,
+				'EE_Datetime',
+				sprintf(
+					__('The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		$event = $datetime->event();
+		if (! $event instanceof \EE_Event) {
+			throw new UnexpectedEntityException(
+				$event,
+				'EE_Event',
+				sprintf(
+					__('The ticket (%s) is not associated with a valid event.', 'event_espresso'),
+					$this->name()
+				)
+			);
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
+	public function get_event_name()
+	{
+		$event = $this->get_related_event();
+		return $event instanceof EE_Event ? $event->name() : '';
+	}
+
+
+	/**
+	 * Implementation of the EEI_Event_Relation interface method
+	 *
+	 * @see EEI_Event_Relation for comments
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
+	public function get_event_ID()
+	{
+		$event = $this->get_related_event();
+		return $event instanceof EE_Event ? $event->ID() : 0;
+	}
+
+
+	/**
+	 * This simply returns whether a ticket can be permanently deleted or not.
+	 * The criteria for determining this is whether the ticket has any related registrations.
+	 * If there are none then it can be permanently deleted.
+	 *
+	 * @return bool
+	 */
+	public function is_permanently_deleteable()
+	{
+		return $this->count_registrations() === 0;
+	}
 }