eventespresso / event-espresso-core

core/db_classes/EE_Datetime_Ticket.class.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +24 added lines, -24 removed lines

@@ -9,30 +9,30 @@
 class EE_Datetime_Ticket extends EE_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
+	 * @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);
-    }
+	/**
+	 * @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);
+	}
 }

core/db_classes/EE_Event.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -838,7 +838,7 @@ 
     /**
      * calculate spaces remaining based on "saleable" tickets
      *
-     * @param array $tickets
+     * @param EE_Base_Class[] $tickets
      * @param bool  $filtered
      * @return int|float
      * @throws EE_Error
@@ -1078,7 +1078,7 @@ 
      *
      * @access public
      * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
+     * @return string void|string
      * @throws EE_Error
      */
     public function pretty_active_status($echo = true)

Spacing +9 added lines, -9 removed lines

@@ -69,7 +69,7 @@ 
      */
     public function getAvailableSpacesCalculator()
     {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+        if ( ! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
             $this->available_spaces_calculator = new EventSpacesCalculator($this);
         }
         return $this->available_spaces_calculator;
@@ -211,7 +211,7 @@ 
      */
     public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
     {
-        if (! empty($this->_Primary_Datetime)) {
+        if ( ! empty($this->_Primary_Datetime)) {
             return $this->_Primary_Datetime;
         }
         $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
@@ -234,7 +234,7 @@ 
     {
         // first get all datetimes
         $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
+        if ( ! $datetimes) {
             return array();
         }
         $datetime_ids = array();
@@ -427,7 +427,7 @@ 
     public function short_description($num_words = 55, $more = null, $not_full_desc = false)
     {
         $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
+        if ( ! empty($short_desc) || $not_full_desc) {
             return $short_desc;
         }
         $full_desc = $this->get('EVT_desc');
@@ -881,7 +881,7 @@ 
         );
         $all_expired = true;
         foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
+            if ( ! $ticket->is_expired()) {
                 $all_expired = false;
                 break;
             }
@@ -970,7 +970,7 @@ 
      */
     public function is_sold_out($actual = false)
     {
-        if (! $actual) {
+        if ( ! $actual) {
             return $this->status() === EEM_Event::sold_out;
         }
         return $this->perform_sold_out_status_check();
@@ -1015,11 +1015,11 @@ 
     public function get_active_status($reset = false)
     {
         // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
+        if ( ! empty($this->_active_status) && ! $reset) {
             return $this->_active_status;
         }
         // first check if event id is present on this object
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return false;
         }
         $where_params_for_event = array(array('EVT_ID' => $this->ID()));
@@ -1104,7 +1104,7 @@ 
     public function get_number_of_tickets_sold()
     {
         $tkt_sold = 0;
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             return 0;
         }
         $datetimes = $this->datetimes();

Indentation +1353 added lines, -1353 removed lines

@@ -13,1357 +13,1357 @@
 class EE_Event extends EE_CPT_Base implements EEI_Line_Item_Object, EEI_Admin_Links, EEI_Has_Icon, EEI_Event
 {
 
-    /**
-     * cached value for the the logical active status for the event
-     *
-     * @see get_active_status()
-     * @var string
-     */
-    protected $_active_status = '';
-
-    /**
-     * This is just used for caching the Primary Datetime for the Event on initial retrieval
-     *
-     * @var EE_Datetime
-     */
-    protected $_Primary_Datetime;
-
-    /**
-     * @var EventSpacesCalculator $available_spaces_calculator
-     */
-    protected $available_spaces_calculator;
-
-
-    /**
-     * @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_Event
-     * @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_Event
-     * @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 EventSpacesCalculator
-     * @throws \EE_Error
-     */
-    public function getAvailableSpacesCalculator()
-    {
-        if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
-            $this->available_spaces_calculator = new EventSpacesCalculator($this);
-        }
-        return $this->available_spaces_calculator;
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'status':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     *    set_status
-     * Checks if event status is being changed to SOLD OUT
-     * and updates event meta data with previous event status
-     * so that we can revert things if/when the event is no longer sold out
-     *
-     * @access public
-     * @param string $new_status
-     * @param bool   $use_default
-     * @return void
-     * @throws EE_Error
-     */
-    public function set_status($new_status = null, $use_default = false)
-    {
-        // if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
-        if (empty($new_status) && ! $use_default) {
-            return;
-        }
-        // get current Event status
-        $old_status = $this->status();
-        // if status has changed
-        if ($old_status !== $new_status) {
-            // TO sold_out
-            if ($new_status === EEM_Event::sold_out) {
-                // save the previous event status so that we can revert if the event is no longer sold out
-                $this->add_post_meta('_previous_event_status', $old_status);
-                do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
-                // OR FROM  sold_out
-            } elseif ($old_status === EEM_Event::sold_out) {
-                $this->delete_post_meta('_previous_event_status');
-                do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
-            }
-            // clear out the active status so that it gets reset the next time it is requested
-            $this->_active_status = null;
-            // update status
-            parent::set('status', $new_status, $use_default);
-            do_action('AHEE__EE_Event__set_status__after_update', $this);
-            return;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('status', $new_status, $use_default);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes($query_params = array())
-    {
-        return $this->get_many_related('Datetime', $query_params);
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
-     *
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_in_chronological_order()
-    {
-        return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
-    }
-
-
-    /**
-     * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
-     * @darren, we should probably UNSET timezone on the EEM_Datetime model
-     * after running our query, so that this timezone isn't set for EVERY query
-     * on EEM_Datetime for the rest of the request, no?
-     *
-     * @param boolean $show_expired whether or not to include expired events
-     * @param boolean $show_deleted whether or not to include deleted events
-     * @param null    $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
-    {
-        return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
-            $this->ID(),
-            $show_expired,
-            $show_deleted,
-            $limit
-        );
-    }
-
-
-    /**
-     * Returns one related datetime. Mostly only used by some legacy code.
-     *
-     * @return EE_Base_Class|EE_Datetime
-     * @throws EE_Error
-     */
-    public function first_datetime()
-    {
-        return $this->get_first_related('Datetime');
-    }
-
-
-    /**
-     * Returns the 'primary' datetime for the event
-     *
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
-    {
-        if (! empty($this->_Primary_Datetime)) {
-            return $this->_Primary_Datetime;
-        }
-        $this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
-            $this->ID(),
-            $try_to_exclude_expired,
-            $try_to_exclude_deleted
-        );
-        return $this->_Primary_Datetime;
-    }
-
-
-    /**
-     * Gets all the tickets available for purchase of this event
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        // first get all datetimes
-        $datetimes = $this->datetimes_ordered();
-        if (! $datetimes) {
-            return array();
-        }
-        $datetime_ids = array();
-        foreach ($datetimes as $datetime) {
-            $datetime_ids[] = $datetime->ID();
-        }
-        $where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
-        // if incoming $query_params has where conditions let's merge but not override existing.
-        if (is_array($query_params) && isset($query_params[0])) {
-            $where_params = array_merge($query_params[0], $where_params);
-            unset($query_params[0]);
-        }
-        // now add $where_params to $query_params
-        $query_params[0] = $where_params;
-        return EEM_Ticket::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * get all unexpired untrashed tickets
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     */
-    public function active_tickets()
-    {
-        return $this->tickets(
-            array(
-                array(
-                    'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'  => false,
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function additional_limit()
-    {
-        return $this->get('EVT_additional_limit');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function allow_overflow()
-    {
-        return $this->get('EVT_allow_overflow');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function created()
-    {
-        return $this->get('EVT_created');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('EVT_desc');
-    }
-
-
-    /**
-     * Runs do_shortcode and wpautop on the description
-     *
-     * @return string of html
-     * @throws EE_Error
-     */
-    public function description_filtered()
-    {
-        return $this->get_pretty('EVT_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_description()
-    {
-        return $this->get('EVT_display_desc');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function display_ticket_selector()
-    {
-        return (bool) $this->get('EVT_display_ticket_selector');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function external_url()
-    {
-        return $this->get('EVT_external_URL');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function member_only()
-    {
-        return $this->get('EVT_member_only');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('EVT_phone');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function modified()
-    {
-        return $this->get('EVT_modified');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('EVT_name');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('EVT_order');
-    }
-
-
-    /**
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function default_registration_status()
-    {
-        $event_default_registration_status = $this->get('EVT_default_registration_status');
-        return ! empty($event_default_registration_status)
-            ? $event_default_registration_status
-            : EE_Registry::instance()->CFG->registration->default_STS_ID;
-    }
-
-
-    /**
-     * @param int  $num_words
-     * @param null $more
-     * @param bool $not_full_desc
-     * @return bool|string
-     * @throws EE_Error
-     */
-    public function short_description($num_words = 55, $more = null, $not_full_desc = false)
-    {
-        $short_desc = $this->get('EVT_short_desc');
-        if (! empty($short_desc) || $not_full_desc) {
-            return $short_desc;
-        }
-        $full_desc = $this->get('EVT_desc');
-        return wp_trim_words($full_desc, $num_words, $more);
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function slug()
-    {
-        return $this->get('EVT_slug');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function timezone_string()
-    {
-        return $this->get('EVT_timezone_string');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function visible_on()
-    {
-        return $this->get('EVT_visible_on');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('EVT_wp_user');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function donations()
-    {
-        return $this->get('EVT_donations');
-    }
-
-
-    /**
-     * @param $limit
-     * @throws EE_Error
-     */
-    public function set_additional_limit($limit)
-    {
-        $this->set('EVT_additional_limit', $limit);
-    }
-
-
-    /**
-     * @param $created
-     * @throws EE_Error
-     */
-    public function set_created($created)
-    {
-        $this->set('EVT_created', $created);
-    }
-
-
-    /**
-     * @param $desc
-     * @throws EE_Error
-     */
-    public function set_description($desc)
-    {
-        $this->set('EVT_desc', $desc);
-    }
-
-
-    /**
-     * @param $display_desc
-     * @throws EE_Error
-     */
-    public function set_display_description($display_desc)
-    {
-        $this->set('EVT_display_desc', $display_desc);
-    }
-
-
-    /**
-     * @param $display_ticket_selector
-     * @throws EE_Error
-     */
-    public function set_display_ticket_selector($display_ticket_selector)
-    {
-        $this->set('EVT_display_ticket_selector', $display_ticket_selector);
-    }
-
-
-    /**
-     * @param $external_url
-     * @throws EE_Error
-     */
-    public function set_external_url($external_url)
-    {
-        $this->set('EVT_external_URL', $external_url);
-    }
-
-
-    /**
-     * @param $member_only
-     * @throws EE_Error
-     */
-    public function set_member_only($member_only)
-    {
-        $this->set('EVT_member_only', $member_only);
-    }
-
-
-    /**
-     * @param $event_phone
-     * @throws EE_Error
-     */
-    public function set_event_phone($event_phone)
-    {
-        $this->set('EVT_phone', $event_phone);
-    }
-
-
-    /**
-     * @param $modified
-     * @throws EE_Error
-     */
-    public function set_modified($modified)
-    {
-        $this->set('EVT_modified', $modified);
-    }
-
-
-    /**
-     * @param $name
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('EVT_name', $name);
-    }
-
-
-    /**
-     * @param $order
-     * @throws EE_Error
-     */
-    public function set_order($order)
-    {
-        $this->set('EVT_order', $order);
-    }
-
-
-    /**
-     * @param $short_desc
-     * @throws EE_Error
-     */
-    public function set_short_description($short_desc)
-    {
-        $this->set('EVT_short_desc', $short_desc);
-    }
-
-
-    /**
-     * @param $slug
-     * @throws EE_Error
-     */
-    public function set_slug($slug)
-    {
-        $this->set('EVT_slug', $slug);
-    }
-
-
-    /**
-     * @param $timezone_string
-     * @throws EE_Error
-     */
-    public function set_timezone_string($timezone_string)
-    {
-        $this->set('EVT_timezone_string', $timezone_string);
-    }
-
-
-    /**
-     * @param $visible_on
-     * @throws EE_Error
-     */
-    public function set_visible_on($visible_on)
-    {
-        $this->set('EVT_visible_on', $visible_on);
-    }
-
-
-    /**
-     * @param $wp_user
-     * @throws EE_Error
-     */
-    public function set_wp_user($wp_user)
-    {
-        $this->set('EVT_wp_user', $wp_user);
-    }
-
-
-    /**
-     * @param $default_registration_status
-     * @throws EE_Error
-     */
-    public function set_default_registration_status($default_registration_status)
-    {
-        $this->set('EVT_default_registration_status', $default_registration_status);
-    }
-
-
-    /**
-     * @param $donations
-     * @throws EE_Error
-     */
-    public function set_donations($donations)
-    {
-        $this->set('EVT_donations', $donations);
-    }
-
-
-    /**
-     * Adds a venue to this event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function add_venue($venue_id_or_obj)
-    {
-        return $this->_add_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Removes a venue from the event
-     *
-     * @param EE_Venue /int $venue_id_or_obj
-     * @return EE_Base_Class|EE_Venue
-     * @throws EE_Error
-     */
-    public function remove_venue($venue_id_or_obj)
-    {
-        return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
-    }
-
-
-    /**
-     * Gets all the venues related ot the event. May provide additional $query_params if desired
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Venue[]
-     * @throws EE_Error
-     */
-    public function venues($query_params = array())
-    {
-        return $this->get_many_related('Venue', $query_params);
-    }
-
-
-    /**
-     * check if event id is present and if event is published
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    private function _has_ID_and_is_published()
-    {
-        // first check if event id is present and not NULL,
-        // then check if this event is published (or any of the equivalent "published" statuses)
-        return
-            $this->ID() && $this->ID() !== null
-            && (
-                $this->status() === 'publish'
-                || $this->status() === EEM_Event::sold_out
-                || $this->status() === EEM_Event::postponed
-                || $this->status() === EEM_Event::cancelled
-            );
-    }
-
-
-    /**
-     * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
-     *
-     * @access public
-     * @return boolean true yes, false no
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $upcoming = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is active then we return false.
-                if ($datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check upcoming status
-                $upcoming = $datetime->is_upcoming();
-            }
-        }
-        return $upcoming;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $active = false;
-        // next let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is expired then we continue cause one of the other datetimes might be active.
-                if ($datetime->is_expired()) {
-                    continue;
-                }
-                // if this dtt is upcoming then we return false.
-                if ($datetime->is_upcoming()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $active = $datetime->is_active();
-            }
-        }
-        return $active;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        // check if event id is present and if this event is published
-        if ($this->is_inactive()) {
-            return false;
-        }
-        // set initial value
-        $expired = false;
-        // first let's get all datetimes and loop through them
-        $datetimes = $this->datetimes_in_chronological_order();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                // if this dtt is upcoming or active then we return false.
-                if ($datetime->is_upcoming() || $datetime->is_active()) {
-                    return false;
-                }
-                // otherwise let's check active status
-                $expired = $datetime->is_expired();
-            }
-        }
-        return $expired;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    public function is_inactive()
-    {
-        // check if event id is present and if this event is published
-        if ($this->_has_ID_and_is_published()) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @param array $tickets
-     * @param bool  $filtered
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining($tickets = array(), $filtered = true)
-    {
-        $this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
-        $spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
-        return $filtered
-            ? apply_filters(
-                'FHEE_EE_Event__spaces_remaining',
-                $spaces_remaining,
-                $this,
-                $tickets
-            )
-            : $spaces_remaining;
-    }
-
-
-    /**
-     *    perform_sold_out_status_check
-     *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
-     *    available... if NOT, then the event status will get toggled to 'sold_out'
-     *
-     * @return bool    return the ACTUAL sold out state.
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function perform_sold_out_status_check()
-    {
-        // get all unexpired untrashed tickets
-        $tickets = $this->tickets(
-            array(
-                array('TKT_deleted' => false),
-                'order_by' => array('TKT_qty' => 'ASC'),
-            )
-        );
-        $all_expired = true;
-        foreach ($tickets as $ticket) {
-            if (! $ticket->is_expired()) {
-                $all_expired = false;
-                break;
-            }
-        }
-        // if all the tickets are just expired, then don't update the event status to sold out
-        if ($all_expired) {
-            return true;
-        }
-        $spaces_remaining = $this->spaces_remaining($tickets);
-        if ($spaces_remaining < 1) {
-            if ($this->status() !== EEM_Event::post_status_private) {
-                $this->set_status(EEM_Event::sold_out);
-                $this->save();
-            }
-            $sold_out = true;
-        } else {
-            $sold_out = false;
-            // was event previously marked as sold out ?
-            if ($this->status() === EEM_Event::sold_out) {
-                // revert status to previous value, if it was set
-                $previous_event_status = $this->get_post_meta('_previous_event_status', true);
-                if ($previous_event_status) {
-                    $this->set_status($previous_event_status);
-                    $this->save();
-                }
-            }
-        }
-        do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
-        return $sold_out;
-    }
-
-
-    /**
-     * This returns the total remaining spaces for sale on this event.
-     *
-     * @uses EE_Event::total_available_spaces()
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function spaces_remaining_for_sale()
-    {
-        return $this->total_available_spaces(true);
-    }
-
-
-    /**
-     * This returns the total spaces available for an event
-     * while considering all the qtys on the tickets and the reg limits
-     * on the datetimes attached to this event.
-     *
-     * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
-     *                              If this is false, then we return the most tickets that could ever be sold
-     *                              for this event with the datetime and tickets setup on the event under optimal
-     *                              selling conditions.  Otherwise we return a live calculation of spaces available
-     *                              based on tickets sold.  Depending on setup and stage of sales, this
-     *                              may appear to equal remaining tickets.  However, the more tickets are
-     *                              sold out, the more accurate the "live" total is.
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function total_available_spaces($consider_sold = false)
-    {
-        $spaces_available = $consider_sold
-            ? $this->getAvailableSpacesCalculator()->spacesRemaining()
-            : $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
-        return apply_filters(
-            'FHEE_EE_Event__total_available_spaces__spaces_available',
-            $spaces_available,
-            $this,
-            $this->getAvailableSpacesCalculator()->getDatetimes(),
-            $this->getAvailableSpacesCalculator()->getActiveTickets()
-        );
-    }
-
-
-    /**
-     * Checks if the event is set to sold out
-     *
-     * @param  bool $actual whether or not to perform calculations to not only figure the
-     *                      actual status but also to flip the status if necessary to sold
-     *                      out If false, we just check the existing status of the event
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function is_sold_out($actual = false)
-    {
-        if (! $actual) {
-            return $this->status() === EEM_Event::sold_out;
-        }
-        return $this->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Checks if the event is marked as postponed
-     *
-     * @return boolean
-     */
-    public function is_postponed()
-    {
-        return $this->status() === EEM_Event::postponed;
-    }
-
-
-    /**
-     * Checks if the event is marked as cancelled
-     *
-     * @return boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status() === EEM_Event::cancelled;
-    }
-
-
-    /**
-     * Get the logical active status in a hierarchical order for all the datetimes.  Note
-     * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
-     * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
-     * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
-     * the event is considered expired.
-     * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
-     * status set on the EVENT when it is not published and thus is done
-     *
-     * @param bool $reset
-     * @return bool | string - based on EE_Datetime active constants or FALSE if error.
-     * @throws EE_Error
-     */
-    public function get_active_status($reset = false)
-    {
-        // if the active status has already been set, then just use that value (unless we are resetting it)
-        if (! empty($this->_active_status) && ! $reset) {
-            return $this->_active_status;
-        }
-        // first check if event id is present on this object
-        if (! $this->ID()) {
-            return false;
-        }
-        $where_params_for_event = array(array('EVT_ID' => $this->ID()));
-        // if event is published:
-        if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
-            // active?
-            if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                EE_Datetime::active,
-                $where_params_for_event
-            ) > 0) {
-                $this->_active_status = EE_Datetime::active;
-            } else {
-                // upcoming?
-                if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                    EE_Datetime::upcoming,
-                    $where_params_for_event
-                ) > 0) {
-                    $this->_active_status = EE_Datetime::upcoming;
-                } else {
-                    // expired?
-                    if (EEM_Datetime::instance()->get_datetime_count_for_status(
-                        EE_Datetime::expired,
-                        $where_params_for_event
-                    ) > 0
-                    ) {
-                        $this->_active_status = EE_Datetime::expired;
-                    } else {
-                        // it would be odd if things make it this far because it basically means there are no datetime's
-                        // attached to the event.  So in this case it will just be considered inactive.
-                        $this->_active_status = EE_Datetime::inactive;
-                    }
-                }
-            }
-        } else {
-            // the event is not published, so let's just set it's active status according to its' post status
-            switch ($this->status()) {
-                case EEM_Event::sold_out:
-                    $this->_active_status = EE_Datetime::sold_out;
-                    break;
-                case EEM_Event::cancelled:
-                    $this->_active_status = EE_Datetime::cancelled;
-                    break;
-                case EEM_Event::postponed:
-                    $this->_active_status = EE_Datetime::postponed;
-                    break;
-                default:
-                    $this->_active_status = EE_Datetime::inactive;
-            }
-        }
-        return $this->_active_status;
-    }
-
-
-    /**
-     *    pretty_active_status
-     *
-     * @access public
-     * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
-     * @return mixed void|string
-     * @throws EE_Error
-     */
-    public function pretty_active_status($echo = true)
-    {
-        $active_status = $this->get_active_status();
-        $status = '<span class="ee-status event-active-status-'
-                  . $active_status
-                  . '">'
-                  . EEH_Template::pretty_status($active_status, false, 'sentence')
-                  . '</span>';
-        if ($echo) {
-            echo $status;
-            return '';
-        }
-        return $status;
-    }
-
-
-    /**
-     * @return bool|int
-     * @throws EE_Error
-     */
-    public function get_number_of_tickets_sold()
-    {
-        $tkt_sold = 0;
-        if (! $this->ID()) {
-            return 0;
-        }
-        $datetimes = $this->datetimes();
-        foreach ($datetimes as $datetime) {
-            if ($datetime instanceof EE_Datetime) {
-                $tkt_sold += $datetime->sold();
-            }
-        }
-        return $tkt_sold;
-    }
-
-
-    /**
-     * This just returns a count of all the registrations for this event
-     *
-     * @access  public
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_count_of_all_registrations()
-    {
-        return EEM_Event::instance()->count_related($this, 'Registration');
-    }
-
-
-    /**
-     * This returns the ticket with the earliest start time that is
-     * available for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_earliest_start_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the ticket with the latest end time that is available
-     * for this event (across all datetimes attached to the event)
-     *
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     */
-    public function get_ticket_with_latest_end_time()
-    {
-        $where['Datetime.EVT_ID'] = $this->ID();
-        $query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
-        return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
-    }
-
-
-    /**
-     * This returns the number of different ticket types currently on sale for this event.
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function countTicketsOnSale()
-    {
-        $where = array(
-            'Datetime.EVT_ID' => $this->ID(),
-            'TKT_start_date'  => array('<', time()),
-            'TKT_end_date'    => array('>', time()),
-        );
-        return EEM_Ticket::instance()->count(array($where));
-    }
-
-
-    /**
-     * This returns whether there are any tickets on sale for this event.
-     *
-     * @return bool true = YES tickets on sale.
-     * @throws EE_Error
-     */
-    public function tickets_on_sale()
-    {
-        return $this->countTicketsOnSale() > 0;
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end. Overrides parent
-     * to check for an external URL first
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_permalink()
-    {
-        if ($this->external_url()) {
-            return $this->external_url();
-        }
-        return parent::get_permalink();
-    }
-
-
-    /**
-     * Gets the first term for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class|EE_Term|null
-     * @throws EE_Error
-     */
-    public function first_event_category($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_one($query_params);
-    }
-
-
-    /**
-     * Gets all terms for 'espresso_event_categories' we can find
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Term[]
-     * @throws EE_Error
-     */
-    public function get_all_event_categories($query_params = array())
-    {
-        $query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-        $query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
-        return EEM_Term::instance()->get_all($query_params);
-    }
-
-
-    /**
-     * Adds a question group to this event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be added for the primary
-     *                                           registrant, if false will be added for others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     */
-    public function add_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        $extra = $for_primary
-            ? array('EQG_primary' => 1)
-            : array();
-        return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra);
-    }
-
-
-    /**
-     * Removes a question group from the event
-     *
-     * @param EE_Question_Group|int $question_group_id_or_obj
-     * @param bool                  $for_primary if true, the question group will be removed from the primary
-     *                                           registrant, if false will be removed from others. default: false
-     * @return EE_Base_Class|EE_Question_Group
-     * @throws EE_Error
-     */
-    public function remove_question_group($question_group_id_or_obj, $for_primary = false)
-    {
-        $where = $for_primary
-            ? array('EQG_primary' => 1)
-            : array();
-        return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where);
-    }
-
-
-    /**
-     * Gets all the question groups, ordering them by QSG_order ascending
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Question_Group[]
-     * @throws EE_Error
-     */
-    public function question_groups($query_params = array())
-    {
-        $query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
-        return $this->get_many_related('Question_Group', $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-flag"></span>';
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'edit',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default_event_settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Implementation for EEI_Admin_Links interface method.
-     *
-     * @see EEI_Admin_Links for comments
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_events',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * cached value for the the logical active status for the event
+	 *
+	 * @see get_active_status()
+	 * @var string
+	 */
+	protected $_active_status = '';
+
+	/**
+	 * This is just used for caching the Primary Datetime for the Event on initial retrieval
+	 *
+	 * @var EE_Datetime
+	 */
+	protected $_Primary_Datetime;
+
+	/**
+	 * @var EventSpacesCalculator $available_spaces_calculator
+	 */
+	protected $available_spaces_calculator;
+
+
+	/**
+	 * @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_Event
+	 * @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_Event
+	 * @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 EventSpacesCalculator
+	 * @throws \EE_Error
+	 */
+	public function getAvailableSpacesCalculator()
+	{
+		if (! $this->available_spaces_calculator instanceof EventSpacesCalculator) {
+			$this->available_spaces_calculator = new EventSpacesCalculator($this);
+		}
+		return $this->available_spaces_calculator;
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'status', $status ) can be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'status':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 *    set_status
+	 * Checks if event status is being changed to SOLD OUT
+	 * and updates event meta data with previous event status
+	 * so that we can revert things if/when the event is no longer sold out
+	 *
+	 * @access public
+	 * @param string $new_status
+	 * @param bool   $use_default
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function set_status($new_status = null, $use_default = false)
+	{
+		// if nothing is set, and we aren't explicitly wanting to reset the status, then just leave
+		if (empty($new_status) && ! $use_default) {
+			return;
+		}
+		// get current Event status
+		$old_status = $this->status();
+		// if status has changed
+		if ($old_status !== $new_status) {
+			// TO sold_out
+			if ($new_status === EEM_Event::sold_out) {
+				// save the previous event status so that we can revert if the event is no longer sold out
+				$this->add_post_meta('_previous_event_status', $old_status);
+				do_action('AHEE__EE_Event__set_status__to_sold_out', $this, $old_status, $new_status);
+				// OR FROM  sold_out
+			} elseif ($old_status === EEM_Event::sold_out) {
+				$this->delete_post_meta('_previous_event_status');
+				do_action('AHEE__EE_Event__set_status__from_sold_out', $this, $old_status, $new_status);
+			}
+			// clear out the active status so that it gets reset the next time it is requested
+			$this->_active_status = null;
+			// update status
+			parent::set('status', $new_status, $use_default);
+			do_action('AHEE__EE_Event__set_status__after_update', $this);
+			return;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('status', $new_status, $use_default);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes($query_params = array())
+	{
+		return $this->get_many_related('Datetime', $query_params);
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by DTT_EVT_start in ascending order
+	 *
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_in_chronological_order()
+	{
+		return $this->get_many_related('Datetime', array('order_by' => array('DTT_EVT_start' => 'ASC')));
+	}
+
+
+	/**
+	 * Gets all the datetimes for this event, ordered by the DTT_order on the datetime.
+	 * @darren, we should probably UNSET timezone on the EEM_Datetime model
+	 * after running our query, so that this timezone isn't set for EVERY query
+	 * on EEM_Datetime for the rest of the request, no?
+	 *
+	 * @param boolean $show_expired whether or not to include expired events
+	 * @param boolean $show_deleted whether or not to include deleted events
+	 * @param null    $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function datetimes_ordered($show_expired = true, $show_deleted = false, $limit = null)
+	{
+		return EEM_Datetime::instance($this->_timezone)->get_datetimes_for_event_ordered_by_DTT_order(
+			$this->ID(),
+			$show_expired,
+			$show_deleted,
+			$limit
+		);
+	}
+
+
+	/**
+	 * Returns one related datetime. Mostly only used by some legacy code.
+	 *
+	 * @return EE_Base_Class|EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function first_datetime()
+	{
+		return $this->get_first_related('Datetime');
+	}
+
+
+	/**
+	 * Returns the 'primary' datetime for the event
+	 *
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function primary_datetime($try_to_exclude_expired = true, $try_to_exclude_deleted = true)
+	{
+		if (! empty($this->_Primary_Datetime)) {
+			return $this->_Primary_Datetime;
+		}
+		$this->_Primary_Datetime = EEM_Datetime::instance($this->_timezone)->get_primary_datetime_for_event(
+			$this->ID(),
+			$try_to_exclude_expired,
+			$try_to_exclude_deleted
+		);
+		return $this->_Primary_Datetime;
+	}
+
+
+	/**
+	 * Gets all the tickets available for purchase of this event
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		// first get all datetimes
+		$datetimes = $this->datetimes_ordered();
+		if (! $datetimes) {
+			return array();
+		}
+		$datetime_ids = array();
+		foreach ($datetimes as $datetime) {
+			$datetime_ids[] = $datetime->ID();
+		}
+		$where_params = array('Datetime.DTT_ID' => array('IN', $datetime_ids));
+		// if incoming $query_params has where conditions let's merge but not override existing.
+		if (is_array($query_params) && isset($query_params[0])) {
+			$where_params = array_merge($query_params[0], $where_params);
+			unset($query_params[0]);
+		}
+		// now add $where_params to $query_params
+		$query_params[0] = $where_params;
+		return EEM_Ticket::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * get all unexpired untrashed tickets
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 */
+	public function active_tickets()
+	{
+		return $this->tickets(
+			array(
+				array(
+					'TKT_end_date' => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'  => false,
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function additional_limit()
+	{
+		return $this->get('EVT_additional_limit');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function allow_overflow()
+	{
+		return $this->get('EVT_allow_overflow');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function created()
+	{
+		return $this->get('EVT_created');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('EVT_desc');
+	}
+
+
+	/**
+	 * Runs do_shortcode and wpautop on the description
+	 *
+	 * @return string of html
+	 * @throws EE_Error
+	 */
+	public function description_filtered()
+	{
+		return $this->get_pretty('EVT_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_description()
+	{
+		return $this->get('EVT_display_desc');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function display_ticket_selector()
+	{
+		return (bool) $this->get('EVT_display_ticket_selector');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function external_url()
+	{
+		return $this->get('EVT_external_URL');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function member_only()
+	{
+		return $this->get('EVT_member_only');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('EVT_phone');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function modified()
+	{
+		return $this->get('EVT_modified');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('EVT_name');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('EVT_order');
+	}
+
+
+	/**
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function default_registration_status()
+	{
+		$event_default_registration_status = $this->get('EVT_default_registration_status');
+		return ! empty($event_default_registration_status)
+			? $event_default_registration_status
+			: EE_Registry::instance()->CFG->registration->default_STS_ID;
+	}
+
+
+	/**
+	 * @param int  $num_words
+	 * @param null $more
+	 * @param bool $not_full_desc
+	 * @return bool|string
+	 * @throws EE_Error
+	 */
+	public function short_description($num_words = 55, $more = null, $not_full_desc = false)
+	{
+		$short_desc = $this->get('EVT_short_desc');
+		if (! empty($short_desc) || $not_full_desc) {
+			return $short_desc;
+		}
+		$full_desc = $this->get('EVT_desc');
+		return wp_trim_words($full_desc, $num_words, $more);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function slug()
+	{
+		return $this->get('EVT_slug');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function timezone_string()
+	{
+		return $this->get('EVT_timezone_string');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function visible_on()
+	{
+		return $this->get('EVT_visible_on');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('EVT_wp_user');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function donations()
+	{
+		return $this->get('EVT_donations');
+	}
+
+
+	/**
+	 * @param $limit
+	 * @throws EE_Error
+	 */
+	public function set_additional_limit($limit)
+	{
+		$this->set('EVT_additional_limit', $limit);
+	}
+
+
+	/**
+	 * @param $created
+	 * @throws EE_Error
+	 */
+	public function set_created($created)
+	{
+		$this->set('EVT_created', $created);
+	}
+
+
+	/**
+	 * @param $desc
+	 * @throws EE_Error
+	 */
+	public function set_description($desc)
+	{
+		$this->set('EVT_desc', $desc);
+	}
+
+
+	/**
+	 * @param $display_desc
+	 * @throws EE_Error
+	 */
+	public function set_display_description($display_desc)
+	{
+		$this->set('EVT_display_desc', $display_desc);
+	}
+
+
+	/**
+	 * @param $display_ticket_selector
+	 * @throws EE_Error
+	 */
+	public function set_display_ticket_selector($display_ticket_selector)
+	{
+		$this->set('EVT_display_ticket_selector', $display_ticket_selector);
+	}
+
+
+	/**
+	 * @param $external_url
+	 * @throws EE_Error
+	 */
+	public function set_external_url($external_url)
+	{
+		$this->set('EVT_external_URL', $external_url);
+	}
+
+
+	/**
+	 * @param $member_only
+	 * @throws EE_Error
+	 */
+	public function set_member_only($member_only)
+	{
+		$this->set('EVT_member_only', $member_only);
+	}
+
+
+	/**
+	 * @param $event_phone
+	 * @throws EE_Error
+	 */
+	public function set_event_phone($event_phone)
+	{
+		$this->set('EVT_phone', $event_phone);
+	}
+
+
+	/**
+	 * @param $modified
+	 * @throws EE_Error
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('EVT_modified', $modified);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('EVT_name', $name);
+	}
+
+
+	/**
+	 * @param $order
+	 * @throws EE_Error
+	 */
+	public function set_order($order)
+	{
+		$this->set('EVT_order', $order);
+	}
+
+
+	/**
+	 * @param $short_desc
+	 * @throws EE_Error
+	 */
+	public function set_short_description($short_desc)
+	{
+		$this->set('EVT_short_desc', $short_desc);
+	}
+
+
+	/**
+	 * @param $slug
+	 * @throws EE_Error
+	 */
+	public function set_slug($slug)
+	{
+		$this->set('EVT_slug', $slug);
+	}
+
+
+	/**
+	 * @param $timezone_string
+	 * @throws EE_Error
+	 */
+	public function set_timezone_string($timezone_string)
+	{
+		$this->set('EVT_timezone_string', $timezone_string);
+	}
+
+
+	/**
+	 * @param $visible_on
+	 * @throws EE_Error
+	 */
+	public function set_visible_on($visible_on)
+	{
+		$this->set('EVT_visible_on', $visible_on);
+	}
+
+
+	/**
+	 * @param $wp_user
+	 * @throws EE_Error
+	 */
+	public function set_wp_user($wp_user)
+	{
+		$this->set('EVT_wp_user', $wp_user);
+	}
+
+
+	/**
+	 * @param $default_registration_status
+	 * @throws EE_Error
+	 */
+	public function set_default_registration_status($default_registration_status)
+	{
+		$this->set('EVT_default_registration_status', $default_registration_status);
+	}
+
+
+	/**
+	 * @param $donations
+	 * @throws EE_Error
+	 */
+	public function set_donations($donations)
+	{
+		$this->set('EVT_donations', $donations);
+	}
+
+
+	/**
+	 * Adds a venue to this event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function add_venue($venue_id_or_obj)
+	{
+		return $this->_add_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Removes a venue from the event
+	 *
+	 * @param EE_Venue /int $venue_id_or_obj
+	 * @return EE_Base_Class|EE_Venue
+	 * @throws EE_Error
+	 */
+	public function remove_venue($venue_id_or_obj)
+	{
+		return $this->_remove_relation_to($venue_id_or_obj, 'Venue');
+	}
+
+
+	/**
+	 * Gets all the venues related ot the event. May provide additional $query_params if desired
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Venue[]
+	 * @throws EE_Error
+	 */
+	public function venues($query_params = array())
+	{
+		return $this->get_many_related('Venue', $query_params);
+	}
+
+
+	/**
+	 * check if event id is present and if event is published
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	private function _has_ID_and_is_published()
+	{
+		// first check if event id is present and not NULL,
+		// then check if this event is published (or any of the equivalent "published" statuses)
+		return
+			$this->ID() && $this->ID() !== null
+			&& (
+				$this->status() === 'publish'
+				|| $this->status() === EEM_Event::sold_out
+				|| $this->status() === EEM_Event::postponed
+				|| $this->status() === EEM_Event::cancelled
+			);
+	}
+
+
+	/**
+	 * This simply compares the internal dates with NOW and determines if the event is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean true yes, false no
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$upcoming = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be upcoming.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is active then we return false.
+				if ($datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check upcoming status
+				$upcoming = $datetime->is_upcoming();
+			}
+		}
+		return $upcoming;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$active = false;
+		// next let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is expired then we continue cause one of the other datetimes might be active.
+				if ($datetime->is_expired()) {
+					continue;
+				}
+				// if this dtt is upcoming then we return false.
+				if ($datetime->is_upcoming()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$active = $datetime->is_active();
+			}
+		}
+		return $active;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		// check if event id is present and if this event is published
+		if ($this->is_inactive()) {
+			return false;
+		}
+		// set initial value
+		$expired = false;
+		// first let's get all datetimes and loop through them
+		$datetimes = $this->datetimes_in_chronological_order();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				// if this dtt is upcoming or active then we return false.
+				if ($datetime->is_upcoming() || $datetime->is_active()) {
+					return false;
+				}
+				// otherwise let's check active status
+				$expired = $datetime->is_expired();
+			}
+		}
+		return $expired;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function is_inactive()
+	{
+		// check if event id is present and if this event is published
+		if ($this->_has_ID_and_is_published()) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @param array $tickets
+	 * @param bool  $filtered
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining($tickets = array(), $filtered = true)
+	{
+		$this->getAvailableSpacesCalculator()->setActiveTickets($tickets);
+		$spaces_remaining = $this->getAvailableSpacesCalculator()->spacesRemaining();
+		return $filtered
+			? apply_filters(
+				'FHEE_EE_Event__spaces_remaining',
+				$spaces_remaining,
+				$this,
+				$tickets
+			)
+			: $spaces_remaining;
+	}
+
+
+	/**
+	 *    perform_sold_out_status_check
+	 *    checks all of this events's datetime  reg_limit - sold values to determine if ANY datetimes have spaces
+	 *    available... if NOT, then the event status will get toggled to 'sold_out'
+	 *
+	 * @return bool    return the ACTUAL sold out state.
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function perform_sold_out_status_check()
+	{
+		// get all unexpired untrashed tickets
+		$tickets = $this->tickets(
+			array(
+				array('TKT_deleted' => false),
+				'order_by' => array('TKT_qty' => 'ASC'),
+			)
+		);
+		$all_expired = true;
+		foreach ($tickets as $ticket) {
+			if (! $ticket->is_expired()) {
+				$all_expired = false;
+				break;
+			}
+		}
+		// if all the tickets are just expired, then don't update the event status to sold out
+		if ($all_expired) {
+			return true;
+		}
+		$spaces_remaining = $this->spaces_remaining($tickets);
+		if ($spaces_remaining < 1) {
+			if ($this->status() !== EEM_Event::post_status_private) {
+				$this->set_status(EEM_Event::sold_out);
+				$this->save();
+			}
+			$sold_out = true;
+		} else {
+			$sold_out = false;
+			// was event previously marked as sold out ?
+			if ($this->status() === EEM_Event::sold_out) {
+				// revert status to previous value, if it was set
+				$previous_event_status = $this->get_post_meta('_previous_event_status', true);
+				if ($previous_event_status) {
+					$this->set_status($previous_event_status);
+					$this->save();
+				}
+			}
+		}
+		do_action('AHEE__EE_Event__perform_sold_out_status_check__end', $this, $sold_out, $spaces_remaining, $tickets);
+		return $sold_out;
+	}
+
+
+	/**
+	 * This returns the total remaining spaces for sale on this event.
+	 *
+	 * @uses EE_Event::total_available_spaces()
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spaces_remaining_for_sale()
+	{
+		return $this->total_available_spaces(true);
+	}
+
+
+	/**
+	 * This returns the total spaces available for an event
+	 * while considering all the qtys on the tickets and the reg limits
+	 * on the datetimes attached to this event.
+	 *
+	 * @param   bool $consider_sold Whether to consider any tickets that have already sold in our calculation.
+	 *                              If this is false, then we return the most tickets that could ever be sold
+	 *                              for this event with the datetime and tickets setup on the event under optimal
+	 *                              selling conditions.  Otherwise we return a live calculation of spaces available
+	 *                              based on tickets sold.  Depending on setup and stage of sales, this
+	 *                              may appear to equal remaining tickets.  However, the more tickets are
+	 *                              sold out, the more accurate the "live" total is.
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function total_available_spaces($consider_sold = false)
+	{
+		$spaces_available = $consider_sold
+			? $this->getAvailableSpacesCalculator()->spacesRemaining()
+			: $this->getAvailableSpacesCalculator()->totalSpacesAvailable();
+		return apply_filters(
+			'FHEE_EE_Event__total_available_spaces__spaces_available',
+			$spaces_available,
+			$this,
+			$this->getAvailableSpacesCalculator()->getDatetimes(),
+			$this->getAvailableSpacesCalculator()->getActiveTickets()
+		);
+	}
+
+
+	/**
+	 * Checks if the event is set to sold out
+	 *
+	 * @param  bool $actual whether or not to perform calculations to not only figure the
+	 *                      actual status but also to flip the status if necessary to sold
+	 *                      out If false, we just check the existing status of the event
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function is_sold_out($actual = false)
+	{
+		if (! $actual) {
+			return $this->status() === EEM_Event::sold_out;
+		}
+		return $this->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Checks if the event is marked as postponed
+	 *
+	 * @return boolean
+	 */
+	public function is_postponed()
+	{
+		return $this->status() === EEM_Event::postponed;
+	}
+
+
+	/**
+	 * Checks if the event is marked as cancelled
+	 *
+	 * @return boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status() === EEM_Event::cancelled;
+	}
+
+
+	/**
+	 * Get the logical active status in a hierarchical order for all the datetimes.  Note
+	 * Basically, we order the datetimes by EVT_start_date.  Then first test on whether the event is published.  If its
+	 * NOT published then we test for whether its expired or not.  IF it IS published then we test first on whether an
+	 * event has any active dates.  If no active dates then we check for any upcoming dates.  If no upcoming dates then
+	 * the event is considered expired.
+	 * NOTE: this method does NOT calculate whether the datetimes are sold out when event is published.  Sold Out is a
+	 * status set on the EVENT when it is not published and thus is done
+	 *
+	 * @param bool $reset
+	 * @return bool | string - based on EE_Datetime active constants or FALSE if error.
+	 * @throws EE_Error
+	 */
+	public function get_active_status($reset = false)
+	{
+		// if the active status has already been set, then just use that value (unless we are resetting it)
+		if (! empty($this->_active_status) && ! $reset) {
+			return $this->_active_status;
+		}
+		// first check if event id is present on this object
+		if (! $this->ID()) {
+			return false;
+		}
+		$where_params_for_event = array(array('EVT_ID' => $this->ID()));
+		// if event is published:
+		if ($this->status() === EEM_Event::post_status_publish || $this->status() === EEM_Event::post_status_private) {
+			// active?
+			if (EEM_Datetime::instance()->get_datetime_count_for_status(
+				EE_Datetime::active,
+				$where_params_for_event
+			) > 0) {
+				$this->_active_status = EE_Datetime::active;
+			} else {
+				// upcoming?
+				if (EEM_Datetime::instance()->get_datetime_count_for_status(
+					EE_Datetime::upcoming,
+					$where_params_for_event
+				) > 0) {
+					$this->_active_status = EE_Datetime::upcoming;
+				} else {
+					// expired?
+					if (EEM_Datetime::instance()->get_datetime_count_for_status(
+						EE_Datetime::expired,
+						$where_params_for_event
+					) > 0
+					) {
+						$this->_active_status = EE_Datetime::expired;
+					} else {
+						// it would be odd if things make it this far because it basically means there are no datetime's
+						// attached to the event.  So in this case it will just be considered inactive.
+						$this->_active_status = EE_Datetime::inactive;
+					}
+				}
+			}
+		} else {
+			// the event is not published, so let's just set it's active status according to its' post status
+			switch ($this->status()) {
+				case EEM_Event::sold_out:
+					$this->_active_status = EE_Datetime::sold_out;
+					break;
+				case EEM_Event::cancelled:
+					$this->_active_status = EE_Datetime::cancelled;
+					break;
+				case EEM_Event::postponed:
+					$this->_active_status = EE_Datetime::postponed;
+					break;
+				default:
+					$this->_active_status = EE_Datetime::inactive;
+			}
+		}
+		return $this->_active_status;
+	}
+
+
+	/**
+	 *    pretty_active_status
+	 *
+	 * @access public
+	 * @param boolean $echo whether to return (FALSE), or echo out the result (TRUE)
+	 * @return mixed void|string
+	 * @throws EE_Error
+	 */
+	public function pretty_active_status($echo = true)
+	{
+		$active_status = $this->get_active_status();
+		$status = '<span class="ee-status event-active-status-'
+				  . $active_status
+				  . '">'
+				  . EEH_Template::pretty_status($active_status, false, 'sentence')
+				  . '</span>';
+		if ($echo) {
+			echo $status;
+			return '';
+		}
+		return $status;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @throws EE_Error
+	 */
+	public function get_number_of_tickets_sold()
+	{
+		$tkt_sold = 0;
+		if (! $this->ID()) {
+			return 0;
+		}
+		$datetimes = $this->datetimes();
+		foreach ($datetimes as $datetime) {
+			if ($datetime instanceof EE_Datetime) {
+				$tkt_sold += $datetime->sold();
+			}
+		}
+		return $tkt_sold;
+	}
+
+
+	/**
+	 * This just returns a count of all the registrations for this event
+	 *
+	 * @access  public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_count_of_all_registrations()
+	{
+		return EEM_Event::instance()->count_related($this, 'Registration');
+	}
+
+
+	/**
+	 * This returns the ticket with the earliest start time that is
+	 * available for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_earliest_start_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_start_date' => 'ASC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the ticket with the latest end time that is available
+	 * for this event (across all datetimes attached to the event)
+	 *
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 */
+	public function get_ticket_with_latest_end_time()
+	{
+		$where['Datetime.EVT_ID'] = $this->ID();
+		$query_params = array($where, 'order_by' => array('TKT_end_date' => 'DESC'));
+		return EE_Registry::instance()->load_model('Ticket')->get_one($query_params);
+	}
+
+
+	/**
+	 * This returns the number of different ticket types currently on sale for this event.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function countTicketsOnSale()
+	{
+		$where = array(
+			'Datetime.EVT_ID' => $this->ID(),
+			'TKT_start_date'  => array('<', time()),
+			'TKT_end_date'    => array('>', time()),
+		);
+		return EEM_Ticket::instance()->count(array($where));
+	}
+
+
+	/**
+	 * This returns whether there are any tickets on sale for this event.
+	 *
+	 * @return bool true = YES tickets on sale.
+	 * @throws EE_Error
+	 */
+	public function tickets_on_sale()
+	{
+		return $this->countTicketsOnSale() > 0;
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end. Overrides parent
+	 * to check for an external URL first
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_permalink()
+	{
+		if ($this->external_url()) {
+			return $this->external_url();
+		}
+		return parent::get_permalink();
+	}
+
+
+	/**
+	 * Gets the first term for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class|EE_Term|null
+	 * @throws EE_Error
+	 */
+	public function first_event_category($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_one($query_params);
+	}
+
+
+	/**
+	 * Gets all terms for 'espresso_event_categories' we can find
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Term[]
+	 * @throws EE_Error
+	 */
+	public function get_all_event_categories($query_params = array())
+	{
+		$query_params[0]['Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+		$query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $this->ID();
+		return EEM_Term::instance()->get_all($query_params);
+	}
+
+
+	/**
+	 * Adds a question group to this event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be added for the primary
+	 *                                           registrant, if false will be added for others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 */
+	public function add_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		$extra = $for_primary
+			? array('EQG_primary' => 1)
+			: array();
+		return $this->_add_relation_to($question_group_id_or_obj, 'Question_Group', $extra);
+	}
+
+
+	/**
+	 * Removes a question group from the event
+	 *
+	 * @param EE_Question_Group|int $question_group_id_or_obj
+	 * @param bool                  $for_primary if true, the question group will be removed from the primary
+	 *                                           registrant, if false will be removed from others. default: false
+	 * @return EE_Base_Class|EE_Question_Group
+	 * @throws EE_Error
+	 */
+	public function remove_question_group($question_group_id_or_obj, $for_primary = false)
+	{
+		$where = $for_primary
+			? array('EQG_primary' => 1)
+			: array();
+		return $this->_remove_relation_to($question_group_id_or_obj, 'Question_Group', $where);
+	}
+
+
+	/**
+	 * Gets all the question groups, ordering them by QSG_order ascending
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Question_Group[]
+	 * @throws EE_Error
+	 */
+	public function question_groups($query_params = array())
+	{
+		$query_params = ! empty($query_params) ? $query_params : array('order_by' => array('QSG_order' => 'ASC'));
+		return $this->get_many_related('Question_Group', $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-flag"></span>';
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'edit',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default_event_settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Implementation for EEI_Admin_Links interface method.
+	 *
+	 * @see EEI_Admin_Links for comments
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_events',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

core/db_classes/EE_Extra_Meta.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
      * Sets FK_ID
      *
      * @param int $FK_ID
-     * @return boolean
+     * @return boolean|null
      */
     public function set_FK_ID($FK_ID)
     {
@@ -69,7 +69,7 @@ 
      * Sets model
      *
      * @param string $model
-     * @return boolean
+     * @return boolean|null
      */
     public function set_model($model)
     {
@@ -92,7 +92,7 @@ 
      * Sets key
      *
      * @param string $key
-     * @return boolean
+     * @return boolean|null
      */
     public function set_key($key)
     {
@@ -115,7 +115,7 @@ 
      * Sets value
      *
      * @param string $value
-     * @return boolean
+     * @return boolean|null
      */
     public function set_value($value)
     {

Indentation +111 added lines, -111 removed lines

@@ -10,115 +10,115 @@
 class EE_Extra_Meta extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Extra_Meta|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Extra_Meta
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets FK_ID
-     *
-     * @return int
-     */
-    public function FK_ID()
-    {
-        return $this->get('FK_ID');
-    }
-
-
-    /**
-     * Sets FK_ID
-     *
-     * @param int $FK_ID
-     * @return boolean
-     */
-    public function set_FK_ID($FK_ID)
-    {
-        $this->set('FK_ID', $FK_ID);
-    }
-
-
-    /**
-     * Gets model
-     *
-     * @return string
-     */
-    public function model()
-    {
-        return $this->get('EXM_model');
-    }
-
-
-    /**
-     * Sets model
-     *
-     * @param string $model
-     * @return boolean
-     */
-    public function set_model($model)
-    {
-        $this->set('EXM_model', $model);
-    }
-
-
-    /**
-     * Gets key
-     *
-     * @return string
-     */
-    public function key()
-    {
-        return $this->get('EXM_key');
-    }
-
-
-    /**
-     * Sets key
-     *
-     * @param string $key
-     * @return boolean
-     */
-    public function set_key($key)
-    {
-        $this->set('EXM_key', $key);
-    }
-
-
-    /**
-     * Gets value
-     *
-     * @return string
-     */
-    public function value()
-    {
-        return $this->get('EXM_value');
-    }
-
-
-    /**
-     * Sets value
-     *
-     * @param string $value
-     * @return boolean
-     */
-    public function set_value($value)
-    {
-        $this->set('EXM_value', $value);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Extra_Meta|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Extra_Meta
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets FK_ID
+	 *
+	 * @return int
+	 */
+	public function FK_ID()
+	{
+		return $this->get('FK_ID');
+	}
+
+
+	/**
+	 * Sets FK_ID
+	 *
+	 * @param int $FK_ID
+	 * @return boolean
+	 */
+	public function set_FK_ID($FK_ID)
+	{
+		$this->set('FK_ID', $FK_ID);
+	}
+
+
+	/**
+	 * Gets model
+	 *
+	 * @return string
+	 */
+	public function model()
+	{
+		return $this->get('EXM_model');
+	}
+
+
+	/**
+	 * Sets model
+	 *
+	 * @param string $model
+	 * @return boolean
+	 */
+	public function set_model($model)
+	{
+		$this->set('EXM_model', $model);
+	}
+
+
+	/**
+	 * Gets key
+	 *
+	 * @return string
+	 */
+	public function key()
+	{
+		return $this->get('EXM_key');
+	}
+
+
+	/**
+	 * Sets key
+	 *
+	 * @param string $key
+	 * @return boolean
+	 */
+	public function set_key($key)
+	{
+		$this->set('EXM_key', $key);
+	}
+
+
+	/**
+	 * Gets value
+	 *
+	 * @return string
+	 */
+	public function value()
+	{
+		return $this->get('EXM_value');
+	}
+
+
+	/**
+	 * Sets value
+	 *
+	 * @param string $value
+	 * @return boolean
+	 */
+	public function set_value($value)
+	{
+		$this->set('EXM_value', $value);
+	}
 }

core/db_classes/EE_Import.class.php

Doc Comments +4 added lines, -8 removed lines

@@ -87,7 +87,6 @@ 
      *
      * @param    string $title  - heading for the form
      * @param    string $intro  - additional text explaing what to do
-     * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
      * @param    string $action - EE Admin page route array "action" that form will direct to
      * @param    string $type   - type of file to import
      *                          @ return    string
@@ -130,7 +129,7 @@ 
     /**
      * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
      * @access public
-     * @return boolean success
+     * @return boolean|null success
      */
     public function import()
     {
@@ -304,9 +303,7 @@ 
      * @access public
      * @param array $csv_data_array - the array containing the csv data produced from
      *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws \EE_Error
      */
     public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
@@ -459,7 +456,7 @@ 
      * to the newly-inserted real ID.
      *
      * @param type $csv_data_array
-     * @param type $export_from_site_a_to_b
+     * @param boolean $export_from_site_a_to_b
      * @param type $old_db_to_new_db_mapping
      * @return array updated $old_db_to_new_db_mapping
      */
@@ -626,7 +623,6 @@ 
      * @param type     $id_in_csv
      * @param type     $model_object_data
      * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
      * @return
      */
     protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
@@ -758,7 +754,7 @@ 
      * @param type   $object_id
      * @param string $model_name
      * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
+     * @param boolean   $export_from_site_a_to_b
      * @return int
      */
     protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)

Indentation +950 added lines, -950 removed lines

@@ -14,91 +14,91 @@ 
 class EE_Import implements ResettableInterface
 {
 
-    const do_insert = 'insert';
-    const do_update = 'update';
-    const do_nothing = 'nothing';
-
-
-    // instance of the EE_Import object
-    private static $_instance = null;
-
-    private static $_csv_array = array();
-
-    /**
-     *
-     * @var array of model names
-     */
-    private static $_model_list = array();
-
-    private static $_columns_to_save = array();
-
-    protected $_total_inserts = 0;
-    protected $_total_updates = 0;
-    protected $_total_insert_errors = 0;
-    protected $_total_update_errors = 0;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        $this->_total_inserts = 0;
-        $this->_total_updates = 0;
-        $this->_total_insert_errors = 0;
-        $this->_total_update_errors = 0;
-    }
-
-
-    /**
-     *    @ singleton method used to instantiate class object
-     *    @ access public
-     *
-     * @return EE_Import
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Resets the importer
-     *
-     * @return EE_Import
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *    @ generates HTML for a file upload input and form
-     *    @ access    public
-     *
-     * @param    string $title  - heading for the form
-     * @param    string $intro  - additional text explaing what to do
-     * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
-     * @param    string $action - EE Admin page route array "action" that form will direct to
-     * @param    string $type   - type of file to import
-     *                          @ return    string
-     */
-    public function upload_form($title, $intro, $form_url, $action, $type)
-    {
-
-        $form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
-
-        ob_start();
-        ?>
+	const do_insert = 'insert';
+	const do_update = 'update';
+	const do_nothing = 'nothing';
+
+
+	// instance of the EE_Import object
+	private static $_instance = null;
+
+	private static $_csv_array = array();
+
+	/**
+	 *
+	 * @var array of model names
+	 */
+	private static $_model_list = array();
+
+	private static $_columns_to_save = array();
+
+	protected $_total_inserts = 0;
+	protected $_total_updates = 0;
+	protected $_total_insert_errors = 0;
+	protected $_total_update_errors = 0;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		$this->_total_inserts = 0;
+		$this->_total_updates = 0;
+		$this->_total_insert_errors = 0;
+		$this->_total_update_errors = 0;
+	}
+
+
+	/**
+	 *    @ singleton method used to instantiate class object
+	 *    @ access public
+	 *
+	 * @return EE_Import
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Resets the importer
+	 *
+	 * @return EE_Import
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *    @ generates HTML for a file upload input and form
+	 *    @ access    public
+	 *
+	 * @param    string $title  - heading for the form
+	 * @param    string $intro  - additional text explaing what to do
+	 * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
+	 * @param    string $action - EE Admin page route array "action" that form will direct to
+	 * @param    string $type   - type of file to import
+	 *                          @ return    string
+	 */
+	public function upload_form($title, $intro, $form_url, $action, $type)
+	{
+
+		$form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
+
+		ob_start();
+		?>
         <div class="ee-upload-form-dv">
             <h3><?php echo $title; ?></h3>
             <p><?php echo $intro; ?></p>
@@ -114,874 +114,874 @@ 
                 <b><?php _e('Attention', 'event_espresso'); ?></b><br/>
                 <?php echo sprintf(__('Accepts .%s file types only.', 'event_espresso'), $type); ?>
                 <?php echo __(
-                    'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
-                    'event_espresso'
-                ); ?>
+					'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
+					'event_espresso'
+				); ?>
             </p>
 
         </div>
 
         <?php
-        $uploader = ob_get_clean();
-        return $uploader;
-    }
-
-
-    /**
-     * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
-     * @access public
-     * @return boolean success
-     */
-    public function import()
-    {
-
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-
-        if (isset($_REQUEST['import'])) {
-            if (isset($_POST['csv_submitted'])) {
-                switch ($_FILES['file']['error'][0]) {
-                    case UPLOAD_ERR_OK:
-                        $error_msg = false;
-                        break;
-                    case UPLOAD_ERR_INI_SIZE:
-                        $error_msg = __(
-                            "'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_FORM_SIZE:
-                        $error_msg = __(
-                            'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_PARTIAL:
-                        $error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_FILE:
-                        $error_msg = __('No file was uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_TMP_DIR:
-                        $error_msg = __('Missing a temporary folder.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_CANT_WRITE:
-                        $error_msg = __('Failed to write file to disk.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_EXTENSION:
-                        $error_msg = __('File upload stopped by extension.', "event_espresso");
-                        break;
-                    default:
-                        $error_msg = __(
-                            'An unknown error occurred and the file could not be uploaded',
-                            "event_espresso"
-                        );
-                        break;
-                }
-
-                if (! $error_msg) {
-                    $filename = $_FILES['file']['name'][0];
-                    $file_ext = substr(strrchr($filename, '.'), 1);
-                    $file_type = $_FILES['file']['type'][0];
-                    $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
-
-                    if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
-                        if ($filesize < $max_upload || true) {
-                            $wp_upload_dir = str_replace(array('\\', '/'), DS, wp_upload_dir());
-                            $path_to_file = $wp_upload_dir['basedir'] . DS . 'espresso' . DS . $filename;
-
-                            if (move_uploaded_file($temp_file, $path_to_file)) {
-                                // convert csv to array
-                                $this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
-
-                                // was data successfully stored in an array?
-                                if (is_array($this->csv_array)) {
-                                    $import_what = str_replace('csv_import_', '', $_REQUEST['action']);
-                                    $import_what = str_replace('_', ' ', ucwords($import_what));
-                                    $processed_data = $this->csv_array;
-                                    $this->columns_to_save = false;
-
-                                    // if any imports require funcky processing, we'll catch them in the switch
-                                    switch ($_REQUEST['action']) {
-                                        case "import_events":
-                                        case "event_list":
-                                            $import_what = 'Event Details';
-                                            break;
-
-                                        case 'groupon_import_csv':
-                                            $import_what = 'Groupon Codes';
-                                            $processed_data = $this->process_groupon_codes();
-                                            break;
-                                    }
-                                    // save processed codes to db
-                                    if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
-                                        return true;
-                                    }
-                                } else {
-                                    // no array? must be an error
-                                    EE_Error::add_error(
-                                        sprintf(__("No file seems to have been uploaded", "event_espresso")),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    return false;
-                                }
-                            } else {
-                                EE_Error::add_error(
-                                    sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                        } else {
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        "%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
-                                        "event_espresso"
-                                    ),
-                                    $filename,
-                                    $max_upload
-                                ),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                            return false;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                }
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
-     *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
-     *    next level being numeric indexes adn each value representing a model object, and the last layer down
-     *    being keys of model fields and their proposed values.
-     *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
-     *    If the CSV data says (in the metadata row) that it's from the SAME database,
-     *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
-     *    IDs DON'T exist in the database, they're treated as temporary IDs,
-     *    which can used elsewhere to refer to the same object. Once an item
-     *    with a temporary ID gets inserted, we record its mapping from temporary
-     *    ID to real ID, and use the real ID in place of the temporary ID
-     *    when that temporary ID was used as a foreign key.
-     *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
-     *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
-     *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
-     *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
-     *    An important exception are non-auto-increment primary keys. If one entry in the
-     *    CSV file has the same ID as one in the DB, we assume they are meant to be
-     *    the same item, and instead update the item in the DB with that same ID.
-     *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
-     *    time you import a CSV from a different site, we remember their mappings, and
-     * will try to update the item in the DB instead of inserting another item (eg
-     * if we previously imported an event with temporary ID 1, and then it got a
-     * real ID of 123, we remember that. So the next time we import an event with
-     * temporary ID, from the same site, we know that it's real ID is 123, and will
-     * update that event, instead of adding a new event).
-     *
-     * @access public
-     * @param array $csv_data_array - the array containing the csv data produced from
-     *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
-    {
-        $success = false;
-        $error = false;
-        // whther to treat this import as if it's data froma different database or not
-        // ie, if it IS from a different database, ignore foreign keys whihf
-        $export_from_site_a_to_b = true;
-        // first level of array is not table information but a table name was passed to the function
-        // array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
-        if ($model_name) {
-            $csv_data_array = array($csv_data_array);
-        }
-        // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
-        $old_site_url = 'none-specified';
-        // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
-            // ok so its metadata, dont try to save it to ehte db obviously...
-            if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from the same database, so attempting to update data",
-                            "event_espresso"
-                        )
-                    )
-                );
-                $export_from_site_a_to_b = false;
-            } else {
-                $old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
-                            "event_espresso"
-                        ),
-                        $old_site_url,
-                        site_url()
-                    )
-                );
-            };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
-        }
-        /**
-         * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
-         * the value will be the newly-inserted ID.
-         * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
-         */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
-        if ($old_db_to_new_db_mapping) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        "We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
-                        "event_espresso"
-                    ),
-                    $old_site_url,
-                    site_url()
-                )
-            );
-        }
-        $old_db_to_new_db_mapping = $this->save_data_rows_to_db(
-            $csv_data_array,
-            $export_from_site_a_to_b,
-            $old_db_to_new_db_mapping
-        );
-
-        // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
-
-        if ($this->_total_updates > 0) {
-            EE_Error::add_success(
-                sprintf(
-                    __("%s existing records in the database were updated.", "event_espresso"),
-                    $this->_total_updates
-                )
-            );
-            $success = true;
-        }
-        if ($this->_total_inserts > 0) {
-            EE_Error::add_success(
-                sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
-            );
-            $success = true;
-        }
-
-        if ($this->_total_update_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_update_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-        if ($this->_total_insert_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_insert_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-
-        // lastly, we need to update the datetime and ticket sold amounts
-        // as those may have been affected by this
-        EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
-
-        // if there was at least one success and absolutely no errors
-        if ($success && ! $error) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Processes the array of data, given the knowledge that it's from the same database or a different one,
-     * and the mapping from temporary IDs to real IDs.
-     * If the data is from a different database, we treat the primary keys and their corresponding
-     * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
-     * in the real target database. As items are inserted, their temporary primary keys
-     * are mapped to the real IDs in the target database. Also, before doing any update or
-     * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
-     * An exception: string primary keys are treated as real IDs, or else we'd need to
-     * dynamically generate new string primary keys which would be very awkard for the country table etc.
-     * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
-     * combination of fields) to create a unique string identifying the row and store
-     * those in the mapping.
-     *
-     * If the data is from the same database, we usually treat primary keys as real IDs.
-     * An exception is if there is nothing in the database for that ID. If that's the case,
-     * we need to insert a new row for that ID, and then map from the non-existent ID
-     * to the newly-inserted real ID.
-     *
-     * @param type $csv_data_array
-     * @param type $export_from_site_a_to_b
-     * @param type $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
-    {
-        foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
-            // now check that assumption was correct. If
-            if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
-                $model_name = $model_name_in_csv_data;
-            } else {
-                // no table info in the array and no table name passed to the function?? FAIL
-                EE_Error::add_error(
-                    __(
-                        'No table information was specified and/or found, therefore the import could not be completed',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /* @var $model EEM_Base */
-            $model = EE_Registry::instance()->load_model($model_name);
-
-            // so without further ado, scanning all the data provided for primary keys and their inital values
-            foreach ($model_data_from_import as $model_object_data) {
-                // before we do ANYTHING, make sure the csv row wasn't just completely blank
-                $row_is_completely_empty = true;
-                foreach ($model_object_data as $field) {
-                    if ($field) {
-                        $row_is_completely_empty = false;
-                    }
-                }
-                if ($row_is_completely_empty) {
-                    continue;
-                }
-                // find the PK in the row of data (or a combined key if
-                // there is no primary key)
-                if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    $id_in_csv = $model->get_index_primary_key_string($model_object_data);
-                }
-
-
-                $model_object_data = $this->_replace_temp_ids_with_mappings(
-                    $model_object_data,
-                    $model,
-                    $old_db_to_new_db_mapping,
-                    $export_from_site_a_to_b
-                );
-                // now we need to decide if we're going to add a new model object given the $model_object_data,
-                // or just update.
-                if ($export_from_site_a_to_b) {
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {// this is just a re-import
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                }
-                if ($what_to_do == self::do_nothing) {
-                    continue;
-                }
-
-                // double-check we actually want to insert, if that's what we're planning
-                // based on whether this item would be unique in the DB or not
-                if ($what_to_do == self::do_insert) {
-                    // we're supposed to be inserting. But wait, will this thing
-                    // be acceptable if inserted?
-                    $conflicting = $model->get_one_conflicting($model_object_data, false);
-                    if ($conflicting) {
-                        // ok, this item would conflict if inserted. Just update the item that it conflicts with.
-                        $what_to_do = self::do_update;
-                        // and if this model has a primary key, remember its mapping
-                        if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
-                        } else {
-                            // we want to update this conflicting item, instead of inserting a conflicting item
-                            // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
-                            // for the WHERE conditions in the update). At the time of this comment, there were no models like this
-                            foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
-                                    $key_field->get_name()
-                                );
-                            }
-                        }
-                    }
-                }
-                if ($what_to_do == self::do_insert) {
-                    $old_db_to_new_db_mapping = $this->_insert_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } elseif ($what_to_do == self::do_update) {
-                    $old_db_to_new_db_mapping = $this->_update_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
-                                'event_espresso'
-                            ),
-                            $what_to_do
-                        )
-                    );
-                }
-            }
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Decides whether or not to insert, given that this data is from another database.
-     * So, if the primary key of this $model_object_data already exists in the database,
-     * it's just a coincidence and we should still insert. The only time we should
-     * update is when we know what it maps to, or there's something that would
-     * conflict (and we should instead just update that conflicting thing)
-     *
-     * @param string   $id_in_csv
-     * @param array    $model_object_data        by reference so it can be modified
-     * @param EEM_Base $model
-     * @param array    $old_db_to_new_db_mapping by reference so it can be modified
-     * @return string one of the consts on this class that starts with do_*
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
-        $id_in_csv,
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping
-    ) {
-        $model_name = $model->get_this_model_name();
-        // if it's a site-to-site export-and-import, see if this modelobject's id
-        // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * If this thing basically already exists in the database, we want to update it;
-     * otherwise insert it (ie, someone tweaked the CSV file, or the item was
-     * deleted in the database so it should be re-inserted)
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
-        $id_in_csv,
-        $model_object_data,
-        $model
-    ) {
-        // in this case, check if this thing ACTUALLY exists in the database
-        if ($model->get_one_conflicting($model_object_data)) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
-     * with their mapped real IDs. Eg, if importing from site A to B, the mapping
-     * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
-     * So this function searches for any event temp Ids called "my_event_id" and
-     * replaces them with 123.
-     * Also, if there is no temp ID for the INT foreign keys from another database,
-     * replaces them with 0 or the field's default.
-     *
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @param boolean  $export_from_site_a_to_b
-     * @return array updated model object data with temp IDs removed
-     */
-    protected function _replace_temp_ids_with_mappings(
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping,
-        $export_from_site_a_to_b
-    ) {
-        // if this model object's primary key is in the mapping, replace it
-        if ($model->has_primary_key_field() &&
-            $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
-            isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
-            )) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
-        }
-
-        try {
-            $model_name_field = $model->get_field_containing_related_model_name();
-            $models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
-        } catch (EE_Error $e) {
-            $model_name_field = null;
-            $models_pointed_to_by_model_name_field = array();
-        }
-        foreach ($model->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
-                $models_pointed_to = $field_obj->get_model_names_pointed_to();
-                $found_a_mapping = false;
-                foreach ($models_pointed_to as $model_pointed_to_by_fk) {
-                    if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
-                        if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
-                                $model_pointed_to_by_fk,
-                                $old_db_to_new_db_mapping,
-                                $export_from_site_a_to_b
-                            );
-                            $found_a_mapping = true;
-                            break;
-                        }
-                    } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
-                            $model_pointed_to_by_fk,
-                            $old_db_to_new_db_mapping,
-                            $export_from_site_a_to_b
-                        );
-                        $found_a_mapping = true;
-                    }
-                    // once we've found a mapping for this field no need to continue
-                    if ($found_a_mapping) {
-                        break;
-                    }
-                }
-            } else {
-                // it's a string foreign key (which we leave alone, because those are things
-                // like country names, which we'd really rather not make 2 USAs etc (we'd actually
-                // prefer to just update one)
-                // or it's just a regular value that ought to be replaced
-            }
-        }
-        //
-        if ($model instanceof EEM_Term_Taxonomy) {
-            $model_object_data = $this->_handle_split_term_ids($model_object_data);
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
-     * this term-taxonomy refers to may be out-of-date so we need to update it.
-     * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
-     *
-     * @param type $model_object_data
-     * @return array new model object data
-     */
-    protected function _handle_split_term_ids($model_object_data)
-    {
-        if (isset($model_object_data['term_id'])
-            && isset($model_object_data['taxonomy'])
-            && apply_filters(
-                'FHEE__EE_Import__handle_split_term_ids__function_exists',
-                function_exists('wp_get_split_term'),
-                $model_object_data
-            )) {
-            $new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
-            if ($new_term_id) {
-                $model_object_data['term_id'] = $new_term_id;
-            }
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * Given the object's ID and its model's name, find it int he mapping data,
-     * bearing in mind where it came from
-     *
-     * @param type   $object_id
-     * @param string $model_name
-     * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
-     * @return int
-     */
-    protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
-    {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
-        } elseif ($object_id == '0' || $object_id == '') {
-            // leave as-is
-            return $object_id;
-        } elseif ($export_from_site_a_to_b) {
-            // we couldn't find a mapping for this, and it's from a different site,
-            // so blank it out
-            return null;
-        } elseif (! $export_from_site_a_to_b) {
-            // we coudln't find a mapping for this, but it's from thsi DB anyway
-            // so let's just leave it as-is
-            return $object_id;
-        }
-    }
-
-    /**
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        // remove the primary key, if there is one (we don't want it for inserts OR updates)
-        // we'll put it back in if we need it
-        if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
-        } else {
-            $effective_id = $model->get_index_primary_key_string($model_object_data);
-        }
-        // the model takes care of validating the CSV's input
-        try {
-            $new_id = $model->insert($model_object_data);
-            if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
-                $this->_total_inserts++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        $new_id,
-                        implode(",", $model_object_data)
-                    )
-                );
-            } else {
-                $this->_total_insert_errors++;
-                // put the ID used back in there for the error message
-                if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        __("Could not insert new %s with the csv data: %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        http_build_query($model_object_data)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } catch (EE_Error $e) {
-            $this->_total_insert_errors++;
-            if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
-            }
-            EE_Error::add_error(
-                sprintf(
-                    __("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
-                    $model->get_this_model_name(),
-                    implode(",", $model_object_data),
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Given the model object data, finds the row to update and updates it
-     *
-     * @param string|int $id_in_csv
-     * @param array      $model_object_data
-     * @param EEM_Base   $model
-     * @param array      $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        try {
-            // let's keep two copies of the model object data:
-            // one for performing an update, one for everthing else
-            $model_object_data_for_update = $model_object_data;
-            if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
-                // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
-            } elseif ($model->get_combined_primary_key_fields() > 1) {
-                $conditions = array();
-                foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
-                }
-            } else {
-                $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
-            }
-
-            $success = $model->update($model_object_data_for_update, array($conditions));
-            if ($success) {
-                $this->_total_updates++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully updated %s with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        implode(",", $model_object_data_for_update)
-                    )
-                );
-                // we should still record the mapping even though it was an update
-                // because if we were going to insert somethign but it was going to conflict
-                // we would have last-minute decided to update. So we'd like to know what we updated
-                // and so we record what record ended up being updated using the mapping
-                if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    // no primary key just a combined key
-                    $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
-                }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
-            } else {
-                $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
-                    // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
-                    $this->_total_update_errors++;
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                "Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            http_build_query($model_object_data),
-                            http_build_query($conditions)
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                } else {
-                    $this->_total_updates++;
-                    EE_Error::add_success(
-                        sprintf(
-                            __(
-                                "%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            implode(",", $model_object_data)
-                        )
-                    );
-                }
-            }
-        } catch (EE_Error $e) {
-            $this->_total_update_errors++;
-            $basic_message = sprintf(
-                __("Could not update %s with the csv data: %s because %s", "event_espresso"),
-                $model->get_this_model_name(),
-                implode(",", $model_object_data),
-                $e->getMessage()
-            );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
-            EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Gets the number of inserts performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_inserts()
-    {
-        return $this->_total_inserts;
-    }
-
-    /**
-     *  Gets the number of insert errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_insert_errors()
-    {
-        return $this->_total_insert_errors;
-    }
-
-    /**
-     *  Gets the number of updates performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_updates()
-    {
-        return $this->_total_updates;
-    }
-
-    /**
-     *  Gets the number of update errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_update_errors()
-    {
-        return $this->_total_update_errors;
-    }
+		$uploader = ob_get_clean();
+		return $uploader;
+	}
+
+
+	/**
+	 * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
+	 * @access public
+	 * @return boolean success
+	 */
+	public function import()
+	{
+
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+
+		if (isset($_REQUEST['import'])) {
+			if (isset($_POST['csv_submitted'])) {
+				switch ($_FILES['file']['error'][0]) {
+					case UPLOAD_ERR_OK:
+						$error_msg = false;
+						break;
+					case UPLOAD_ERR_INI_SIZE:
+						$error_msg = __(
+							"'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_FORM_SIZE:
+						$error_msg = __(
+							'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_PARTIAL:
+						$error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_FILE:
+						$error_msg = __('No file was uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_TMP_DIR:
+						$error_msg = __('Missing a temporary folder.', "event_espresso");
+						break;
+					case UPLOAD_ERR_CANT_WRITE:
+						$error_msg = __('Failed to write file to disk.', "event_espresso");
+						break;
+					case UPLOAD_ERR_EXTENSION:
+						$error_msg = __('File upload stopped by extension.', "event_espresso");
+						break;
+					default:
+						$error_msg = __(
+							'An unknown error occurred and the file could not be uploaded',
+							"event_espresso"
+						);
+						break;
+				}
+
+				if (! $error_msg) {
+					$filename = $_FILES['file']['name'][0];
+					$file_ext = substr(strrchr($filename, '.'), 1);
+					$file_type = $_FILES['file']['type'][0];
+					$temp_file = $_FILES['file']['tmp_name'][0];
+					$filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+
+					if ($file_ext == 'csv') {
+						$max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+						if ($filesize < $max_upload || true) {
+							$wp_upload_dir = str_replace(array('\\', '/'), DS, wp_upload_dir());
+							$path_to_file = $wp_upload_dir['basedir'] . DS . 'espresso' . DS . $filename;
+
+							if (move_uploaded_file($temp_file, $path_to_file)) {
+								// convert csv to array
+								$this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
+
+								// was data successfully stored in an array?
+								if (is_array($this->csv_array)) {
+									$import_what = str_replace('csv_import_', '', $_REQUEST['action']);
+									$import_what = str_replace('_', ' ', ucwords($import_what));
+									$processed_data = $this->csv_array;
+									$this->columns_to_save = false;
+
+									// if any imports require funcky processing, we'll catch them in the switch
+									switch ($_REQUEST['action']) {
+										case "import_events":
+										case "event_list":
+											$import_what = 'Event Details';
+											break;
+
+										case 'groupon_import_csv':
+											$import_what = 'Groupon Codes';
+											$processed_data = $this->process_groupon_codes();
+											break;
+									}
+									// save processed codes to db
+									if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
+										return true;
+									}
+								} else {
+									// no array? must be an error
+									EE_Error::add_error(
+										sprintf(__("No file seems to have been uploaded", "event_espresso")),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									return false;
+								}
+							} else {
+								EE_Error::add_error(
+									sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+						} else {
+							EE_Error::add_error(
+								sprintf(
+									__(
+										"%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
+										"event_espresso"
+									),
+									$filename,
+									$max_upload
+								),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+							return false;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				}
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
+	 *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
+	 *    next level being numeric indexes adn each value representing a model object, and the last layer down
+	 *    being keys of model fields and their proposed values.
+	 *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
+	 *    If the CSV data says (in the metadata row) that it's from the SAME database,
+	 *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
+	 *    IDs DON'T exist in the database, they're treated as temporary IDs,
+	 *    which can used elsewhere to refer to the same object. Once an item
+	 *    with a temporary ID gets inserted, we record its mapping from temporary
+	 *    ID to real ID, and use the real ID in place of the temporary ID
+	 *    when that temporary ID was used as a foreign key.
+	 *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
+	 *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
+	 *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
+	 *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
+	 *    An important exception are non-auto-increment primary keys. If one entry in the
+	 *    CSV file has the same ID as one in the DB, we assume they are meant to be
+	 *    the same item, and instead update the item in the DB with that same ID.
+	 *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
+	 *    time you import a CSV from a different site, we remember their mappings, and
+	 * will try to update the item in the DB instead of inserting another item (eg
+	 * if we previously imported an event with temporary ID 1, and then it got a
+	 * real ID of 123, we remember that. So the next time we import an event with
+	 * temporary ID, from the same site, we know that it's real ID is 123, and will
+	 * update that event, instead of adding a new event).
+	 *
+	 * @access public
+	 * @param array $csv_data_array - the array containing the csv data produced from
+	 *                              EE_CSV::import_csv_to_model_data_array()
+	 * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
+	 *                              fields they will be saved to
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
+	{
+		$success = false;
+		$error = false;
+		// whther to treat this import as if it's data froma different database or not
+		// ie, if it IS from a different database, ignore foreign keys whihf
+		$export_from_site_a_to_b = true;
+		// first level of array is not table information but a table name was passed to the function
+		// array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
+		if ($model_name) {
+			$csv_data_array = array($csv_data_array);
+		}
+		// begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
+		$old_site_url = 'none-specified';
+		// hanlde metadata
+		if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
+			$csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+			// ok so its metadata, dont try to save it to ehte db obviously...
+			if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from the same database, so attempting to update data",
+							"event_espresso"
+						)
+					)
+				);
+				$export_from_site_a_to_b = false;
+			} else {
+				$old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
+							"event_espresso"
+						),
+						$old_site_url,
+						site_url()
+					)
+				);
+			};
+			unset($csv_data_array[ EE_CSV::metadata_header ]);
+		}
+		/**
+		 * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
+		 * the value will be the newly-inserted ID.
+		 * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
+		 */
+		$old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+		if ($old_db_to_new_db_mapping) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						"We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
+						"event_espresso"
+					),
+					$old_site_url,
+					site_url()
+				)
+			);
+		}
+		$old_db_to_new_db_mapping = $this->save_data_rows_to_db(
+			$csv_data_array,
+			$export_from_site_a_to_b,
+			$old_db_to_new_db_mapping
+		);
+
+		// save the mapping from old db to new db in case they try re-importing the same data from the same website again
+		update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+
+		if ($this->_total_updates > 0) {
+			EE_Error::add_success(
+				sprintf(
+					__("%s existing records in the database were updated.", "event_espresso"),
+					$this->_total_updates
+				)
+			);
+			$success = true;
+		}
+		if ($this->_total_inserts > 0) {
+			EE_Error::add_success(
+				sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
+			);
+			$success = true;
+		}
+
+		if ($this->_total_update_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
+						"event_espresso"
+					),
+					$this->_total_update_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+		if ($this->_total_insert_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
+						"event_espresso"
+					),
+					$this->_total_insert_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+
+		// lastly, we need to update the datetime and ticket sold amounts
+		// as those may have been affected by this
+		EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
+
+		// if there was at least one success and absolutely no errors
+		if ($success && ! $error) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Processes the array of data, given the knowledge that it's from the same database or a different one,
+	 * and the mapping from temporary IDs to real IDs.
+	 * If the data is from a different database, we treat the primary keys and their corresponding
+	 * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
+	 * in the real target database. As items are inserted, their temporary primary keys
+	 * are mapped to the real IDs in the target database. Also, before doing any update or
+	 * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
+	 * An exception: string primary keys are treated as real IDs, or else we'd need to
+	 * dynamically generate new string primary keys which would be very awkard for the country table etc.
+	 * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
+	 * combination of fields) to create a unique string identifying the row and store
+	 * those in the mapping.
+	 *
+	 * If the data is from the same database, we usually treat primary keys as real IDs.
+	 * An exception is if there is nothing in the database for that ID. If that's the case,
+	 * we need to insert a new row for that ID, and then map from the non-existent ID
+	 * to the newly-inserted real ID.
+	 *
+	 * @param type $csv_data_array
+	 * @param type $export_from_site_a_to_b
+	 * @param type $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
+	{
+		foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
+			// now check that assumption was correct. If
+			if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
+				$model_name = $model_name_in_csv_data;
+			} else {
+				// no table info in the array and no table name passed to the function?? FAIL
+				EE_Error::add_error(
+					__(
+						'No table information was specified and/or found, therefore the import could not be completed',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/* @var $model EEM_Base */
+			$model = EE_Registry::instance()->load_model($model_name);
+
+			// so without further ado, scanning all the data provided for primary keys and their inital values
+			foreach ($model_data_from_import as $model_object_data) {
+				// before we do ANYTHING, make sure the csv row wasn't just completely blank
+				$row_is_completely_empty = true;
+				foreach ($model_object_data as $field) {
+					if ($field) {
+						$row_is_completely_empty = false;
+					}
+				}
+				if ($row_is_completely_empty) {
+					continue;
+				}
+				// find the PK in the row of data (or a combined key if
+				// there is no primary key)
+				if ($model->has_primary_key_field()) {
+					$id_in_csv = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					$id_in_csv = $model->get_index_primary_key_string($model_object_data);
+				}
+
+
+				$model_object_data = $this->_replace_temp_ids_with_mappings(
+					$model_object_data,
+					$model,
+					$old_db_to_new_db_mapping,
+					$export_from_site_a_to_b
+				);
+				// now we need to decide if we're going to add a new model object given the $model_object_data,
+				// or just update.
+				if ($export_from_site_a_to_b) {
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {// this is just a re-import
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				}
+				if ($what_to_do == self::do_nothing) {
+					continue;
+				}
+
+				// double-check we actually want to insert, if that's what we're planning
+				// based on whether this item would be unique in the DB or not
+				if ($what_to_do == self::do_insert) {
+					// we're supposed to be inserting. But wait, will this thing
+					// be acceptable if inserted?
+					$conflicting = $model->get_one_conflicting($model_object_data, false);
+					if ($conflicting) {
+						// ok, this item would conflict if inserted. Just update the item that it conflicts with.
+						$what_to_do = self::do_update;
+						// and if this model has a primary key, remember its mapping
+						if ($model->has_primary_key_field()) {
+							$old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
+							$model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+						} else {
+							// we want to update this conflicting item, instead of inserting a conflicting item
+							// so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
+							// for the WHERE conditions in the update). At the time of this comment, there were no models like this
+							foreach ($model->get_combined_primary_key_fields() as $key_field) {
+								$model_object_data[ $key_field->get_name() ] = $conflicting->get(
+									$key_field->get_name()
+								);
+							}
+						}
+					}
+				}
+				if ($what_to_do == self::do_insert) {
+					$old_db_to_new_db_mapping = $this->_insert_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} elseif ($what_to_do == self::do_update) {
+					$old_db_to_new_db_mapping = $this->_update_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
+								'event_espresso'
+							),
+							$what_to_do
+						)
+					);
+				}
+			}
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Decides whether or not to insert, given that this data is from another database.
+	 * So, if the primary key of this $model_object_data already exists in the database,
+	 * it's just a coincidence and we should still insert. The only time we should
+	 * update is when we know what it maps to, or there's something that would
+	 * conflict (and we should instead just update that conflicting thing)
+	 *
+	 * @param string   $id_in_csv
+	 * @param array    $model_object_data        by reference so it can be modified
+	 * @param EEM_Base $model
+	 * @param array    $old_db_to_new_db_mapping by reference so it can be modified
+	 * @return string one of the consts on this class that starts with do_*
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
+		$id_in_csv,
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping
+	) {
+		$model_name = $model->get_this_model_name();
+		// if it's a site-to-site export-and-import, see if this modelobject's id
+		// in the old data that we know of
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * If this thing basically already exists in the database, we want to update it;
+	 * otherwise insert it (ie, someone tweaked the CSV file, or the item was
+	 * deleted in the database so it should be re-inserted)
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
+		$id_in_csv,
+		$model_object_data,
+		$model
+	) {
+		// in this case, check if this thing ACTUALLY exists in the database
+		if ($model->get_one_conflicting($model_object_data)) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
+	 * with their mapped real IDs. Eg, if importing from site A to B, the mapping
+	 * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
+	 * So this function searches for any event temp Ids called "my_event_id" and
+	 * replaces them with 123.
+	 * Also, if there is no temp ID for the INT foreign keys from another database,
+	 * replaces them with 0 or the field's default.
+	 *
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @param boolean  $export_from_site_a_to_b
+	 * @return array updated model object data with temp IDs removed
+	 */
+	protected function _replace_temp_ids_with_mappings(
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping,
+		$export_from_site_a_to_b
+	) {
+		// if this model object's primary key is in the mapping, replace it
+		if ($model->has_primary_key_field() &&
+			$model->get_primary_key_field()->is_auto_increment() &&
+			isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+			isset(
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+			)) {
+			$model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
+			) ][ $model_object_data[ $model->primary_key_name() ] ];
+		}
+
+		try {
+			$model_name_field = $model->get_field_containing_related_model_name();
+			$models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
+		} catch (EE_Error $e) {
+			$model_name_field = null;
+			$models_pointed_to_by_model_name_field = array();
+		}
+		foreach ($model->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
+				$models_pointed_to = $field_obj->get_model_names_pointed_to();
+				$found_a_mapping = false;
+				foreach ($models_pointed_to as $model_pointed_to_by_fk) {
+					if ($model_name_field) {
+						$value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+						if ($value_of_model_name_field == $model_pointed_to_by_fk) {
+							$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+								$model_object_data[ $field_obj->get_name() ],
+								$model_pointed_to_by_fk,
+								$old_db_to_new_db_mapping,
+								$export_from_site_a_to_b
+							);
+							$found_a_mapping = true;
+							break;
+						}
+					} else {
+						$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+							$model_object_data[ $field_obj->get_name() ],
+							$model_pointed_to_by_fk,
+							$old_db_to_new_db_mapping,
+							$export_from_site_a_to_b
+						);
+						$found_a_mapping = true;
+					}
+					// once we've found a mapping for this field no need to continue
+					if ($found_a_mapping) {
+						break;
+					}
+				}
+			} else {
+				// it's a string foreign key (which we leave alone, because those are things
+				// like country names, which we'd really rather not make 2 USAs etc (we'd actually
+				// prefer to just update one)
+				// or it's just a regular value that ought to be replaced
+			}
+		}
+		//
+		if ($model instanceof EEM_Term_Taxonomy) {
+			$model_object_data = $this->_handle_split_term_ids($model_object_data);
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
+	 * this term-taxonomy refers to may be out-of-date so we need to update it.
+	 * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
+	 *
+	 * @param type $model_object_data
+	 * @return array new model object data
+	 */
+	protected function _handle_split_term_ids($model_object_data)
+	{
+		if (isset($model_object_data['term_id'])
+			&& isset($model_object_data['taxonomy'])
+			&& apply_filters(
+				'FHEE__EE_Import__handle_split_term_ids__function_exists',
+				function_exists('wp_get_split_term'),
+				$model_object_data
+			)) {
+			$new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
+			if ($new_term_id) {
+				$model_object_data['term_id'] = $new_term_id;
+			}
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * Given the object's ID and its model's name, find it int he mapping data,
+	 * bearing in mind where it came from
+	 *
+	 * @param type   $object_id
+	 * @param string $model_name
+	 * @param array  $old_db_to_new_db_mapping
+	 * @param type   $export_from_site_a_to_b
+	 * @return int
+	 */
+	protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
+	{
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
+			return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+		} elseif ($object_id == '0' || $object_id == '') {
+			// leave as-is
+			return $object_id;
+		} elseif ($export_from_site_a_to_b) {
+			// we couldn't find a mapping for this, and it's from a different site,
+			// so blank it out
+			return null;
+		} elseif (! $export_from_site_a_to_b) {
+			// we coudln't find a mapping for this, but it's from thsi DB anyway
+			// so let's just leave it as-is
+			return $object_id;
+		}
+	}
+
+	/**
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		// remove the primary key, if there is one (we don't want it for inserts OR updates)
+		// we'll put it back in if we need it
+		if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
+			$effective_id = $model_object_data[ $model->primary_key_name() ];
+			unset($model_object_data[ $model->primary_key_name() ]);
+		} else {
+			$effective_id = $model->get_index_primary_key_string($model_object_data);
+		}
+		// the model takes care of validating the CSV's input
+		try {
+			$new_id = $model->insert($model_object_data);
+			if ($new_id) {
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+				$this->_total_inserts++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						$new_id,
+						implode(",", $model_object_data)
+					)
+				);
+			} else {
+				$this->_total_insert_errors++;
+				// put the ID used back in there for the error message
+				if ($model->has_primary_key_field()) {
+					$model_object_data[ $model->primary_key_name() ] = $effective_id;
+				}
+				EE_Error::add_error(
+					sprintf(
+						__("Could not insert new %s with the csv data: %s", "event_espresso"),
+						$model->get_this_model_name(),
+						http_build_query($model_object_data)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} catch (EE_Error $e) {
+			$this->_total_insert_errors++;
+			if ($model->has_primary_key_field()) {
+				$model_object_data[ $model->primary_key_name() ] = $effective_id;
+			}
+			EE_Error::add_error(
+				sprintf(
+					__("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
+					$model->get_this_model_name(),
+					implode(",", $model_object_data),
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Given the model object data, finds the row to update and updates it
+	 *
+	 * @param string|int $id_in_csv
+	 * @param array      $model_object_data
+	 * @param EEM_Base   $model
+	 * @param array      $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		try {
+			// let's keep two copies of the model object data:
+			// one for performing an update, one for everthing else
+			$model_object_data_for_update = $model_object_data;
+			if ($model->has_primary_key_field()) {
+				$conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+				// remove the primary key because we shouldn't use it for updating
+				unset($model_object_data_for_update[ $model->primary_key_name() ]);
+			} elseif ($model->get_combined_primary_key_fields() > 1) {
+				$conditions = array();
+				foreach ($model->get_combined_primary_key_fields() as $key_field) {
+					$conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+				}
+			} else {
+				$model->primary_key_name(
+				);// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+			}
+
+			$success = $model->update($model_object_data_for_update, array($conditions));
+			if ($success) {
+				$this->_total_updates++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully updated %s with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						implode(",", $model_object_data_for_update)
+					)
+				);
+				// we should still record the mapping even though it was an update
+				// because if we were going to insert somethign but it was going to conflict
+				// we would have last-minute decided to update. So we'd like to know what we updated
+				// and so we record what record ended up being updated using the mapping
+				if ($model->has_primary_key_field()) {
+					$new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					// no primary key just a combined key
+					$new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
+				}
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+			} else {
+				$matched_items = $model->get_all(array($conditions));
+				if (! $matched_items) {
+					// no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
+					$this->_total_update_errors++;
+					EE_Error::add_error(
+						sprintf(
+							__(
+								"Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							http_build_query($model_object_data),
+							http_build_query($conditions)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				} else {
+					$this->_total_updates++;
+					EE_Error::add_success(
+						sprintf(
+							__(
+								"%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							implode(",", $model_object_data)
+						)
+					);
+				}
+			}
+		} catch (EE_Error $e) {
+			$this->_total_update_errors++;
+			$basic_message = sprintf(
+				__("Could not update %s with the csv data: %s because %s", "event_espresso"),
+				$model->get_this_model_name(),
+				implode(",", $model_object_data),
+				$e->getMessage()
+			);
+			$debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+			EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Gets the number of inserts performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_inserts()
+	{
+		return $this->_total_inserts;
+	}
+
+	/**
+	 *  Gets the number of insert errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_insert_errors()
+	{
+		return $this->_total_insert_errors;
+	}
+
+	/**
+	 *  Gets the number of updates performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_updates()
+	{
+		return $this->_total_updates;
+	}
+
+	/**
+	 *  Gets the number of update errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_update_errors()
+	{
+		return $this->_total_update_errors;
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -135,7 +135,7 @@ 
     public function import()
     {
 
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
+        require_once(EE_CLASSES.'EE_CSV.class.php');
         $this->EE_CSV = EE_CSV::instance();
 
         if (isset($_REQUEST['import'])) {
@@ -179,18 +179,18 @@ 
                         break;
                 }
 
-                if (! $error_msg) {
+                if ( ! $error_msg) {
                     $filename = $_FILES['file']['name'][0];
                     $file_ext = substr(strrchr($filename, '.'), 1);
                     $file_type = $_FILES['file']['type'][0];
                     $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+                    $filesize = $_FILES['file']['size'][0] / 1024; // convert from bytes to KB
 
                     if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+                        $max_upload = $this->EE_CSV->get_max_upload_size(); // max upload size in KB
                         if ($filesize < $max_upload || true) {
                             $wp_upload_dir = str_replace(array('\\', '/'), DS, wp_upload_dir());
-                            $path_to_file = $wp_upload_dir['basedir'] . DS . 'espresso' . DS . $filename;
+                            $path_to_file = $wp_upload_dir['basedir'].DS.'espresso'.DS.$filename;
 
                             if (move_uploaded_file($temp_file, $path_to_file)) {
                                 // convert csv to array
@@ -324,8 +324,8 @@ 
         // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
         $old_site_url = 'none-specified';
         // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+        if (isset($csv_data_array[EE_CSV::metadata_header])) {
+            $csv_metadata = array_shift($csv_data_array[EE_CSV::metadata_header]);
             // ok so its metadata, dont try to save it to ehte db obviously...
             if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
                 EE_Error::add_attention(
@@ -350,14 +350,14 @@ 
                     )
                 );
             };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
+            unset($csv_data_array[EE_CSV::metadata_header]);
         }
         /**
          * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
          * the value will be the newly-inserted ID.
          * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
          */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from'.sanitize_title($old_site_url), array());
         if ($old_db_to_new_db_mapping) {
             EE_Error::add_attention(
                 sprintf(
@@ -377,7 +377,7 @@ 
         );
 
         // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+        update_option('ee_id_mapping_from'.sanitize_title($old_site_url), $old_db_to_new_db_mapping);
 
         if ($this->_total_updates > 0) {
             EE_Error::add_success(
@@ -500,7 +500,7 @@ 
                 // find the PK in the row of data (or a combined key if
                 // there is no primary key)
                 if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
+                    $id_in_csv = $model_object_data[$model->primary_key_name()];
                 } else {
                     $id_in_csv = $model->get_index_primary_key_string($model_object_data);
                 }
@@ -544,14 +544,14 @@ 
                         $what_to_do = self::do_update;
                         // and if this model has a primary key, remember its mapping
                         if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+                            $old_db_to_new_db_mapping[$model_name][$id_in_csv] = $conflicting->ID();
+                            $model_object_data[$model->primary_key_name()] = $conflicting->ID();
                         } else {
                             // we want to update this conflicting item, instead of inserting a conflicting item
                             // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
                             // for the WHERE conditions in the update). At the time of this comment, there were no models like this
                             foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
+                                $model_object_data[$key_field->get_name()] = $conflicting->get(
                                     $key_field->get_name()
                                 );
                             }
@@ -611,7 +611,7 @@ 
         $model_name = $model->get_this_model_name();
         // if it's a site-to-site export-and-import, see if this modelobject's id
         // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+        if (isset($old_db_to_new_db_mapping[$model_name][$id_in_csv])) {
             return self::do_update;
         } else {
             return self::do_insert;
@@ -666,12 +666,12 @@ 
         // if this model object's primary key is in the mapping, replace it
         if ($model->has_primary_key_field() &&
             $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+            isset($old_db_to_new_db_mapping[$model->get_this_model_name()]) &&
             isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$model_object_data[$model->primary_key_name()]]
             )) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
+            $model_object_data[$model->primary_key_name()] = $old_db_to_new_db_mapping[$model->get_this_model_name(
+            )][$model_object_data[$model->primary_key_name()]];
         }
 
         try {
@@ -687,10 +687,10 @@ 
                 $found_a_mapping = false;
                 foreach ($models_pointed_to as $model_pointed_to_by_fk) {
                     if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+                        $value_of_model_name_field = $model_object_data[$model_name_field->get_name()];
                         if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
+                            $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                                $model_object_data[$field_obj->get_name()],
                                 $model_pointed_to_by_fk,
                                 $old_db_to_new_db_mapping,
                                 $export_from_site_a_to_b
@@ -699,8 +699,8 @@ 
                             break;
                         }
                     } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
+                        $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                            $model_object_data[$field_obj->get_name()],
                             $model_pointed_to_by_fk,
                             $old_db_to_new_db_mapping,
                             $export_from_site_a_to_b
@@ -763,8 +763,8 @@ 
      */
     protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
     {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+        if (isset($old_db_to_new_db_mapping[$model_name][$object_id])) {
+            return $old_db_to_new_db_mapping[$model_name][$object_id];
         } elseif ($object_id == '0' || $object_id == '') {
             // leave as-is
             return $object_id;
@@ -772,7 +772,7 @@ 
             // we couldn't find a mapping for this, and it's from a different site,
             // so blank it out
             return null;
-        } elseif (! $export_from_site_a_to_b) {
+        } elseif ( ! $export_from_site_a_to_b) {
             // we coudln't find a mapping for this, but it's from thsi DB anyway
             // so let's just leave it as-is
             return $object_id;
@@ -792,8 +792,8 @@ 
         // remove the primary key, if there is one (we don't want it for inserts OR updates)
         // we'll put it back in if we need it
         if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
+            $effective_id = $model_object_data[$model->primary_key_name()];
+            unset($model_object_data[$model->primary_key_name()]);
         } else {
             $effective_id = $model->get_index_primary_key_string($model_object_data);
         }
@@ -801,7 +801,7 @@ 
         try {
             $new_id = $model->insert($model_object_data);
             if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_id;
                 $this->_total_inserts++;
                 EE_Error::add_success(
                     sprintf(
@@ -815,7 +815,7 @@ 
                 $this->_total_insert_errors++;
                 // put the ID used back in there for the error message
                 if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                    $model_object_data[$model->primary_key_name()] = $effective_id;
                 }
                 EE_Error::add_error(
                     sprintf(
@@ -831,7 +831,7 @@ 
         } catch (EE_Error $e) {
             $this->_total_insert_errors++;
             if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                $model_object_data[$model->primary_key_name()] = $effective_id;
             }
             EE_Error::add_error(
                 sprintf(
@@ -864,17 +864,17 @@ 
             // one for performing an update, one for everthing else
             $model_object_data_for_update = $model_object_data;
             if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+                $conditions = array($model->primary_key_name() => $model_object_data[$model->primary_key_name()]);
                 // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
+                unset($model_object_data_for_update[$model->primary_key_name()]);
             } elseif ($model->get_combined_primary_key_fields() > 1) {
                 $conditions = array();
                 foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+                    $conditions[$key_field->get_name()] = $model_object_data[$key_field->get_name()];
                 }
             } else {
                 $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+                ); // this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
             }
 
             $success = $model->update($model_object_data_for_update, array($conditions));
@@ -892,15 +892,15 @@ 
                 // we would have last-minute decided to update. So we'd like to know what we updated
                 // and so we record what record ended up being updated using the mapping
                 if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+                    $new_key_for_mapping = $model_object_data[$model->primary_key_name()];
                 } else {
                     // no primary key just a combined key
                     $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
                 }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_key_for_mapping;
             } else {
                 $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
+                if ( ! $matched_items) {
                     // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
                     $this->_total_update_errors++;
                     EE_Error::add_error(
@@ -939,7 +939,7 @@ 
                 implode(",", $model_object_data),
                 $e->getMessage()
             );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+            $debug_message = $basic_message.' Stack trace: '.$e->getTraceAsString();
             EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
         }
         return $old_db_to_new_db_mapping;

core/db_classes/EE_Post_Meta.class.php

Doc Comments +4 added lines, -4 removed lines

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

Indentation +108 added lines, -108 removed lines

@@ -10,112 +10,112 @@
 class EE_Post_Meta extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta|mixed
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Post_Meta
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Gets meta_id
-     *
-     * @return int
-     */
-    public function meta_id()
-    {
-        return $this->get('meta_id');
-    }
-
-
-    /**
-     * Sets meta_id
-     *
-     * @param int $meta_id
-     * @return boolean
-     */
-    public function set_meta_id($meta_id)
-    {
-        return $this->set('meta_id', $meta_id);
-    }
-
-    /**
-     * Gets post_id
-     *
-     * @return int
-     */
-    public function post_id()
-    {
-        return $this->get('post_id');
-    }
-
-
-    /**
-     * Sets post_id
-     *
-     * @param int $post_id
-     * @return boolean
-     */
-    public function set_post_id($post_id)
-    {
-        return $this->set('post_id', $post_id);
-    }
-
-    /**
-     * Gets meta_key
-     *
-     * @return string
-     */
-    public function meta_key()
-    {
-        return $this->get('meta_key');
-    }
-
-
-    /**
-     * Sets meta_key
-     *
-     * @param string $meta_key
-     * @return boolean
-     */
-    public function set_meta_key($meta_key)
-    {
-        return $this->set('meta_key', $meta_key);
-    }
-
-    /**
-     * Gets meta_value
-     *
-     * @return mixed
-     */
-    public function meta_value()
-    {
-        return $this->get('meta_value');
-    }
-
-
-    /**
-     * Sets meta_value
-     *
-     * @param mixed $meta_value
-     * @return boolean
-     */
-    public function set_meta_value($meta_value)
-    {
-        return $this->set('meta_value', $meta_value);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta|mixed
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Post_Meta
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Gets meta_id
+	 *
+	 * @return int
+	 */
+	public function meta_id()
+	{
+		return $this->get('meta_id');
+	}
+
+
+	/**
+	 * Sets meta_id
+	 *
+	 * @param int $meta_id
+	 * @return boolean
+	 */
+	public function set_meta_id($meta_id)
+	{
+		return $this->set('meta_id', $meta_id);
+	}
+
+	/**
+	 * Gets post_id
+	 *
+	 * @return int
+	 */
+	public function post_id()
+	{
+		return $this->get('post_id');
+	}
+
+
+	/**
+	 * Sets post_id
+	 *
+	 * @param int $post_id
+	 * @return boolean
+	 */
+	public function set_post_id($post_id)
+	{
+		return $this->set('post_id', $post_id);
+	}
+
+	/**
+	 * Gets meta_key
+	 *
+	 * @return string
+	 */
+	public function meta_key()
+	{
+		return $this->get('meta_key');
+	}
+
+
+	/**
+	 * Sets meta_key
+	 *
+	 * @param string $meta_key
+	 * @return boolean
+	 */
+	public function set_meta_key($meta_key)
+	{
+		return $this->set('meta_key', $meta_key);
+	}
+
+	/**
+	 * Gets meta_value
+	 *
+	 * @return mixed
+	 */
+	public function meta_value()
+	{
+		return $this->get('meta_value');
+	}
+
+
+	/**
+	 * Sets meta_value
+	 *
+	 * @param mixed $meta_value
+	 * @return boolean
+	 */
+	public function set_meta_value($meta_value)
+	{
+		return $this->set('meta_value', $meta_value);
+	}
 }

core/db_classes/EE_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);
+	}
 }