eventespresso / event-espresso-core

core/db_classes/EE_Venue.class.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +560 added lines, -560 removed lines

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

modules/single_page_checkout/inc/EE_Checkout.class.php

Doc Comments +2 added lines, -1 removed lines

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

Indentation +1425 added lines, -1425 removed lines

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

Spacing +33 added lines, -33 removed lines

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

caffeinated/admin/new/pricing/Prices_List_Table.class.php

Indentation +216 added lines, -216 removed lines

@@ -16,220 +16,220 @@
 class Prices_List_Table extends EE_Admin_List_Table
 {
 
-    private $_PRT;
-
-    /**
-     * Array of price types.
-     *
-     * @var EE_Price_Type[]
-     */
-    protected $_price_types = array();
-
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->_PRT = EEM_Price_Type::instance();
-        $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
-    }
-
-
-    protected function _setup_data()
-    {
-        $trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
-        $this->_data = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
-        $this->_trashed_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('price', 'event_espresso'),
-            'plural'   => __('prices', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'          => '<input type="checkbox" />', // Render a checkbox instead of text
-            'name'        => __('Name', 'event_espresso'),
-            'type'        => __('Price Type', 'event_espresso'),
-            'description' => __('Description', 'event_espresso'),
-            'amount'      => __('Amount', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            // true means its already sorted
-            'name'   => array('name' => false),
-            'type'   => array('type' => false),
-            'amount' => array('amount' => false),
-        );
-
-        $this->_hidden_columns = array();
-
-        $this->_ajax_sorting_callback = 'update_prices_order';
-    }
-
-
-    protected function _get_table_filters()
-    {
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    /**
-     * overriding parent method so that we can make sure the row isn't sortable for certain items
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class == '' ? 'alternate' : '');
-
-        $new_row = $row_class;
-
-        if ($item->type_obj()->base_type() !== 1 && $item->type_obj()->base_type() !== 4) {
-            $new_row .= ' rowsortable';
-        }
-
-        return ' class="' . $new_row . '"';
-    }
-
-
-    public function column_cb($item)
-    {
-        if ($item->type_obj()->base_type() !== 1) {
-            return sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-                $item->ID()
-            );
-        }
-        return '';
-    }
-
-
-    public function column_name($item)
-    {
-
-        // Build row actions
-        $actions = array();
-        // edit price link
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'pricing_edit_price',
-            $item->ID()
-        )) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'edit_price',
-                'id'     => $item->ID(),
-            ), PRICING_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Price', 'event_espresso') . '">'
-                               . __('Edit', 'event_espresso') . '</a>';
-        }
-
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'edit_price',
-            $item->ID()
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Price', 'event_espresso') . '">'
-              . stripslashes($item->name()) . '</a>'
-            : $item->name();
-
-        if ($item->type_obj()->base_type() !== 1) {
-            if ($this->_view == 'all') {
-                // trash price link
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_trash_price',
-                    $item->ID()
-                )) {
-                    $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'trash_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                        . esc_attr__('Move Price to Trash', 'event_espresso') . '">'
-                                        . __('Move to Trash', 'event_espresso') . '</a>';
-                }
-            } else {
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_restore_price',
-                    $item->ID()
-                )) {
-                    // restore price link
-                    $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'restore_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                          . esc_attr__('Restore Price', 'event_espresso') . '">'
-                                          . __('Restore', 'event_espresso') . '</a>';
-                }
-
-                // delete price link
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_delete_price',
-                    $item->ID()
-                )) {
-                    $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'delete_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
-                                         . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
-                                         . __('Delete Permanently', 'event_espresso') . '</a>';
-                }
-            }
-        }
-
-        // Return the name contents
-        return sprintf(
-            '%1$s <span style="color:silver">(id:%2$s)</span>%3$s',
-            $name_link,
-            $item->ID(),
-            $this->row_actions($actions)
-        );
-    }
-
-
-    public function column_type($item)
-    {
-        return $this->_price_types[ $item->type() ]->name();
-    }
-
-
-    public function column_description($item)
-    {
-        return stripslashes($item->desc());
-    }
-
-
-    public function column_amount($item)
-    {
-        if ($this->_price_types[ $item->type() ]->is_percent()) {
-            return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
-        } else {
-            return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
-        }
-    }
+	private $_PRT;
+
+	/**
+	 * Array of price types.
+	 *
+	 * @var EE_Price_Type[]
+	 */
+	protected $_price_types = array();
+
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->_PRT = EEM_Price_Type::instance();
+		$this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
+	}
+
+
+	protected function _setup_data()
+	{
+		$trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
+		$this->_data = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
+		$this->_trashed_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('price', 'event_espresso'),
+			'plural'   => __('prices', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'          => '<input type="checkbox" />', // Render a checkbox instead of text
+			'name'        => __('Name', 'event_espresso'),
+			'type'        => __('Price Type', 'event_espresso'),
+			'description' => __('Description', 'event_espresso'),
+			'amount'      => __('Amount', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			// true means its already sorted
+			'name'   => array('name' => false),
+			'type'   => array('type' => false),
+			'amount' => array('amount' => false),
+		);
+
+		$this->_hidden_columns = array();
+
+		$this->_ajax_sorting_callback = 'update_prices_order';
+	}
+
+
+	protected function _get_table_filters()
+	{
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	/**
+	 * overriding parent method so that we can make sure the row isn't sortable for certain items
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class == '' ? 'alternate' : '');
+
+		$new_row = $row_class;
+
+		if ($item->type_obj()->base_type() !== 1 && $item->type_obj()->base_type() !== 4) {
+			$new_row .= ' rowsortable';
+		}
+
+		return ' class="' . $new_row . '"';
+	}
+
+
+	public function column_cb($item)
+	{
+		if ($item->type_obj()->base_type() !== 1) {
+			return sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+				$item->ID()
+			);
+		}
+		return '';
+	}
+
+
+	public function column_name($item)
+	{
+
+		// Build row actions
+		$actions = array();
+		// edit price link
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'pricing_edit_price',
+			$item->ID()
+		)) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'edit_price',
+				'id'     => $item->ID(),
+			), PRICING_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
+							   . esc_attr__('Edit Price', 'event_espresso') . '">'
+							   . __('Edit', 'event_espresso') . '</a>';
+		}
+
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'edit_price',
+			$item->ID()
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Price', 'event_espresso') . '">'
+			  . stripslashes($item->name()) . '</a>'
+			: $item->name();
+
+		if ($item->type_obj()->base_type() !== 1) {
+			if ($this->_view == 'all') {
+				// trash price link
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_trash_price',
+					$item->ID()
+				)) {
+					$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'trash_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+										. esc_attr__('Move Price to Trash', 'event_espresso') . '">'
+										. __('Move to Trash', 'event_espresso') . '</a>';
+				}
+			} else {
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_restore_price',
+					$item->ID()
+				)) {
+					// restore price link
+					$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'restore_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
+										  . esc_attr__('Restore Price', 'event_espresso') . '">'
+										  . __('Restore', 'event_espresso') . '</a>';
+				}
+
+				// delete price link
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_delete_price',
+					$item->ID()
+				)) {
+					$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'delete_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
+										 . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
+										 . __('Delete Permanently', 'event_espresso') . '</a>';
+				}
+			}
+		}
+
+		// Return the name contents
+		return sprintf(
+			'%1$s <span style="color:silver">(id:%2$s)</span>%3$s',
+			$name_link,
+			$item->ID(),
+			$this->row_actions($actions)
+		);
+	}
+
+
+	public function column_type($item)
+	{
+		return $this->_price_types[ $item->type() ]->name();
+	}
+
+
+	public function column_description($item)
+	{
+		return stripslashes($item->desc());
+	}
+
+
+	public function column_amount($item)
+	{
+		if ($this->_price_types[ $item->type() ]->is_percent()) {
+			return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
+		} else {
+			return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
+		}
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -28,7 +28,7 @@ 
     public function __construct($admin_page)
     {
         parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+        require_once(EE_MODELS.'EEM_Price_Type.model.php');
         $this->_PRT = EEM_Price_Type::instance();
         $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
     }
@@ -104,7 +104,7 @@ 
             $new_row .= ' rowsortable';
         }
 
-        return ' class="' . $new_row . '"';
+        return ' class="'.$new_row.'"';
     }
 
 
@@ -135,9 +135,9 @@ 
                 'action' => 'edit_price',
                 'id'     => $item->ID(),
             ), PRICING_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Price', 'event_espresso') . '">'
-                               . __('Edit', 'event_espresso') . '</a>';
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'
+                               . esc_attr__('Edit Price', 'event_espresso').'">'
+                               . __('Edit', 'event_espresso').'</a>';
         }
 
         $name_link = EE_Registry::instance()->CAP->current_user_can(
@@ -145,9 +145,9 @@ 
             'edit_price',
             $item->ID()
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Price', 'event_espresso') . '">'
-              . stripslashes($item->name()) . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Price', 'event_espresso').'">'
+              . stripslashes($item->name()).'</a>'
             : $item->name();
 
         if ($item->type_obj()->base_type() !== 1) {
@@ -163,9 +163,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                        . esc_attr__('Move Price to Trash', 'event_espresso') . '">'
-                                        . __('Move to Trash', 'event_espresso') . '</a>';
+                    $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'
+                                        . esc_attr__('Move Price to Trash', 'event_espresso').'">'
+                                        . __('Move to Trash', 'event_espresso').'</a>';
                 }
             } else {
                 if (EE_Registry::instance()->CAP->current_user_can(
@@ -179,9 +179,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                          . esc_attr__('Restore Price', 'event_espresso') . '">'
-                                          . __('Restore', 'event_espresso') . '</a>';
+                    $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'
+                                          . esc_attr__('Restore Price', 'event_espresso').'">'
+                                          . __('Restore', 'event_espresso').'</a>';
                 }
 
                 // delete price link
@@ -195,9 +195,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
-                                         . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
-                                         . __('Delete Permanently', 'event_espresso') . '</a>';
+                    $actions['delete'] = '<a href="'.$delete_lnk_url.'" title="'
+                                         . esc_attr__('Delete Price Permanently', 'event_espresso').'">'
+                                         . __('Delete Permanently', 'event_espresso').'</a>';
                 }
             }
         }
@@ -214,7 +214,7 @@ 
 
     public function column_type($item)
     {
-        return $this->_price_types[ $item->type() ]->name();
+        return $this->_price_types[$item->type()]->name();
     }
 
 
@@ -226,10 +226,10 @@ 
 
     public function column_amount($item)
     {
-        if ($this->_price_types[ $item->type() ]->is_percent()) {
-            return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
+        if ($this->_price_types[$item->type()]->is_percent()) {
+            return '<div class="pad-amnt-rght">'.number_format($item->amount(), 1).'%</div>';
         } else {
-            return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
+            return '<div class="pad-amnt-rght">'.EEH_Template::format_currency($item->amount()).'</div>';
         }
     }
 }

core/db_classes/EE_Taxes.class.php

Indentation +123 added lines, -123 removed lines

@@ -10,138 +10,138 @@
 class EE_Taxes extends EE_Base
 {
 
-    /**
-     * This is used for when EE_Taxes is used statically by the admin
-     *
-     * @var array
-     */
-    private static $_subtotal = array();
+	/**
+	 * This is used for when EE_Taxes is used statically by the admin
+	 *
+	 * @var array
+	 */
+	private static $_subtotal = array();
 
-    /**
-     * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
-     *
-     * @var EE_Price[]
-     */
-    private static $_default_taxes = array();
+	/**
+	 * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
+	 *
+	 * @var EE_Price[]
+	 */
+	private static $_default_taxes = array();
 
 
-    /**
-     * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
-     * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
-     * calc of taxes for tickets listed in the event editor.
-     *
-     * @param  EE_Ticket $ticket incoming EE_Ticket
-     * @return float             total taxes to apply to ticket.
-     * @throws \EE_Error
-     */
-    public static function get_total_taxes_for_admin(EE_Ticket $ticket)
-    {
-        $tax = 0;
-        $total_tax = 0;
-        // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
-            return $tax;
-        }
-        // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
-        $subtotal = self::get_subtotal_for_admin($ticket);
-        // get taxes
-        $taxes = self::get_taxes_for_admin();
-        // apply taxes to subtotal
-        foreach ($taxes as $tax) {
-            // assuming taxes are not cumulative
-            $total_tax += $subtotal * $tax->get('PRC_amount') / 100;
-        }
-        return $total_tax;
-    }
+	/**
+	 * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
+	 * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
+	 * calc of taxes for tickets listed in the event editor.
+	 *
+	 * @param  EE_Ticket $ticket incoming EE_Ticket
+	 * @return float             total taxes to apply to ticket.
+	 * @throws \EE_Error
+	 */
+	public static function get_total_taxes_for_admin(EE_Ticket $ticket)
+	{
+		$tax = 0;
+		$total_tax = 0;
+		// This first checks to see if the given ticket is taxable.
+		if (! $ticket->get('TKT_taxable')) {
+			return $tax;
+		}
+		// get subtotal (notice we're only retrieving a subtotal if there isn't one given)
+		$subtotal = self::get_subtotal_for_admin($ticket);
+		// get taxes
+		$taxes = self::get_taxes_for_admin();
+		// apply taxes to subtotal
+		foreach ($taxes as $tax) {
+			// assuming taxes are not cumulative
+			$total_tax += $subtotal * $tax->get('PRC_amount') / 100;
+		}
+		return $total_tax;
+	}
 
 
-    /**
-     * Gets the total percentage of tax that should be applied to taxable line items
-     *
-     * @return float the percentage of tax that should be added to taxable items
-     * @throws \EE_Error
-     * eg 20 for %20 tax (NOT 0.20, which
-     */
-    public static function get_total_taxes_percentage()
-    {
-        $total_tax_percent = 0;
-        foreach (self::get_taxes_for_admin() as $tax_price) {
-            $total_tax_percent += $tax_price->get('PRC_amount');
-        }
-        return $total_tax_percent;
-    }
+	/**
+	 * Gets the total percentage of tax that should be applied to taxable line items
+	 *
+	 * @return float the percentage of tax that should be added to taxable items
+	 * @throws \EE_Error
+	 * eg 20 for %20 tax (NOT 0.20, which
+	 */
+	public static function get_total_taxes_percentage()
+	{
+		$total_tax_percent = 0;
+		foreach (self::get_taxes_for_admin() as $tax_price) {
+			$total_tax_percent += $tax_price->get('PRC_amount');
+		}
+		return $total_tax_percent;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return float
-     * @throws \EE_Error
-     */
-    public static function get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
-            : self::_get_subtotal_for_admin($ticket);
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public static function get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$TKT_ID = $ticket->ID();
+		return isset(self::$_subtotal[ $TKT_ID ])
+			? self::$_subtotal[ $TKT_ID ]
+			: self::_get_subtotal_for_admin($ticket);
+	}
 
 
-    /**
-     * simply take an incoming ticket and calculate the subtotal for the ticket
-     *
-     * @param  EE_Ticket $ticket
-     * @return float     subtotal calculated from all EE_Price[] on Ticket.
-     * @throws \EE_Error
-     */
-    private static function _get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $subtotal = 0;
-        // get all prices
-        $prices = $ticket->get_many_related(
-            'Price',
-            array(
-                'default_where_conditions' => 'none',
-                'order_by'                 => array('PRC_order' => 'ASC'),
-            )
-        );
-        // let's loop through them (base price is always the first item)
-        foreach ($prices as $price) {
-            if ($price instanceof EE_Price) {
-                $price_type = $price->type_obj();
-                if ($price_type instanceof EE_Price_Type) {
-                    switch ($price->type_obj()->base_type()) {
-                        case 1: // base price
-                        case 3: // surcharges
-                            $subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                        case 2: // discounts
-                            $subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                    }
-                }
-            }
-        }
-        $TKT_ID = $ticket->ID();
-        self::$_subtotal = array($TKT_ID => $subtotal);
-        return $subtotal;
-    }
+	/**
+	 * simply take an incoming ticket and calculate the subtotal for the ticket
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @return float     subtotal calculated from all EE_Price[] on Ticket.
+	 * @throws \EE_Error
+	 */
+	private static function _get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$subtotal = 0;
+		// get all prices
+		$prices = $ticket->get_many_related(
+			'Price',
+			array(
+				'default_where_conditions' => 'none',
+				'order_by'                 => array('PRC_order' => 'ASC'),
+			)
+		);
+		// let's loop through them (base price is always the first item)
+		foreach ($prices as $price) {
+			if ($price instanceof EE_Price) {
+				$price_type = $price->type_obj();
+				if ($price_type instanceof EE_Price_Type) {
+					switch ($price->type_obj()->base_type()) {
+						case 1: // base price
+						case 3: // surcharges
+							$subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+						case 2: // discounts
+							$subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+					}
+				}
+			}
+		}
+		$TKT_ID = $ticket->ID();
+		self::$_subtotal = array($TKT_ID => $subtotal);
+		return $subtotal;
+	}
 
 
-    /**
-     * get all default prices that are a Tax price type (PRT_ID = 4) and return
-     *
-     * @return EE_Price[] EE_Price objects that have PRT_ID == 4
-     * @throws \EE_Error
-     */
-    public static function get_taxes_for_admin()
-    {
-        if (empty(self::$_default_taxes)) {
-            self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
-                array(array('Price_Type.PBT_ID' => 4))
-            );
-        }
-        return self::$_default_taxes;
-    }
+	/**
+	 * get all default prices that are a Tax price type (PRT_ID = 4) and return
+	 *
+	 * @return EE_Price[] EE_Price objects that have PRT_ID == 4
+	 * @throws \EE_Error
+	 */
+	public static function get_taxes_for_admin()
+	{
+		if (empty(self::$_default_taxes)) {
+			self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
+				array(array('Price_Type.PBT_ID' => 4))
+			);
+		}
+		return self::$_default_taxes;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
         $tax = 0;
         $total_tax = 0;
         // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
+        if ( ! $ticket->get('TKT_taxable')) {
             return $tax;
         }
         // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
@@ -80,8 +80,8 @@ 
     public static function get_subtotal_for_admin(EE_Ticket $ticket)
     {
         $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
+        return isset(self::$_subtotal[$TKT_ID])
+            ? self::$_subtotal[$TKT_ID]
             : self::_get_subtotal_for_admin($ticket);
     }
 

core/db_classes/EE_Message_Template.class.php

Indentation +169 added lines, -169 removed lines

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

Spacing +1 added lines, -1 removed lines

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

core/db_classes/EE_Ticket_Price.class.php

Indentation +19 added lines, -19 removed lines

@@ -11,25 +11,25 @@
 class EE_Ticket_Price extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Price|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Price|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '', $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
 
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Price
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Price
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Ticket_Template.class.php

Indentation +19 added lines, -19 removed lines

@@ -12,25 +12,25 @@
 class EE_Ticket_Template extends EE_Base_Class
 {
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Template|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = '')
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Template|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = '')
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone);
+	}
 
 
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Ticket_Template
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Ticket_Template
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Term_Relationship.class.php

Indentation +17 added lines, -17 removed lines

@@ -10,23 +10,23 @@
 class EE_Term_Relationship extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Relationship
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Relationship
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
 
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Term_Relationship
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Term_Relationship
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 }

core/db_classes/EE_Export.class.php

Spacing +45 added lines, -45 removed lines

@@ -44,7 +44,7 @@ 
     {
         $this->_req_data = $request_data;
         $this->today = date("Y-m-d", time());
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
+        require_once(EE_CLASSES.'EE_CSV.class.php');
         $this->EE_CSV = EE_CSV::instance();
     }
 
@@ -167,7 +167,7 @@ 
                 $value_to_equal = $EVT_ID;
                 $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($EVT_ID);
 
-                $filename = 'event-' . ($event instanceof EE_Event ? $event->slug() : __('unknown', 'event_espresso'));
+                $filename = 'event-'.($event instanceof EE_Event ? $event->slug() : __('unknown', 'event_espresso'));
             }
             $event_query_params[0]['EVT_ID'] = $value_to_equal;
             $related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
@@ -216,7 +216,7 @@ 
 
         $filename = $this->generate_filename($filename);
 
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+        if ( ! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
             EE_Error::add_error(
                 __(
                     "'An error occurred and the Event details could not be exported from the database.'",
@@ -243,16 +243,16 @@ 
             foreach (EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
                 if ($field_name == 'STA_ID') {
                     $state_name_field = EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
-                    ) ];
+                    $csv_row[__('State', 'event_espresso')] = $attendee_row[$state_name_field->get_qualified_column(
+                    )];
                 } elseif ($field_name == 'CNT_ISO') {
                     $country_name_field = EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ __(
+                    $csv_row[__(
                         'Country',
                         'event_espresso'
-                    ) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+                    )] = $attendee_row[$country_name_field->get_qualified_column()];
                 } else {
-                    $csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
+                    $csv_row[$field_obj->get_nicename()] = $attendee_row[$field_obj->get_qualified_column()];
                 }
             }
             $csv_data[] = $csv_row;
@@ -291,7 +291,7 @@ 
         $model_data = $this->_get_export_data_for_models($models_to_export);
         $filename = $this->generate_filename('all-attendees');
 
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+        if ( ! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
             EE_Error::add_error(
                 __(
                     'An error occurred and the Attendee data could not be exported from the database.',
@@ -409,9 +409,9 @@ 
         foreach ($registration_rows as $reg_row) {
             if (is_array($reg_row)) {
                 $reg_csv_array = array();
-                if (! $event_id) {
+                if ( ! $event_id) {
                     // get the event's name and Id
-                    $reg_csv_array[ __('Event', 'event_espresso') ] = sprintf(
+                    $reg_csv_array[__('Event', 'event_espresso')] = sprintf(
                         __('%1$s (%2$s)', 'event_espresso'),
                         $this->_prepare_value_from_db_for_display(
                             EEM_Event::instance(),
@@ -457,13 +457,13 @@ 
                         $value = $this->_prepare_value_from_db_for_display(
                             $reg_model,
                             $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
+                            $reg_row[$field->get_qualified_column()]
                         );
                     }
-                    $reg_csv_array[ $this->_get_column_name_for_field($field) ] = $value;
+                    $reg_csv_array[$this->_get_column_name_for_field($field)] = $value;
                     if ($field_name == 'REG_final_price') {
                         // add a column named Currency after the final price
-                        $reg_csv_array[ __("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+                        $reg_csv_array[__("Currency", "event_espresso")] = EE_Config::instance()->currency->code;
                     }
                 }
                 // get pretty status
@@ -475,23 +475,23 @@ 
                     false,
                     'sentence'
                 );
-                $reg_csv_array[ __(
+                $reg_csv_array[__(
                     "Registration Status",
                     'event_espresso'
-                ) ] = $stati[ $reg_row['Registration.STS_ID'] ];
+                )] = $stati[$reg_row['Registration.STS_ID']];
                 // get pretty trnasaction status
-                $reg_csv_array[ __(
+                $reg_csv_array[__(
                     "Transaction Status",
                     'event_espresso'
-                ) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+                )] = $stati[$reg_row['TransactionTable.STS_ID']];
+                $reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
                     ? $this->_prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_total',
                         $reg_row['TransactionTable.TXN_total'],
                         'localized_float'
                     ) : '0.00';
-                $reg_csv_array[ __('Amount Paid', 'event_espresso') ] = $is_primary_reg
+                $reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg
                     ? $this->_prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_paid',
@@ -523,15 +523,15 @@ 
                             ? $payment_method_and_gateway_txn_id['payment_time'] : '';
                     }
                 }
-                $reg_csv_array[ __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ __('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+                $reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+                $reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+                $reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                     ',',
                     $gateway_txn_ids_etc
                 );
 
                 // get whether or not the user has checked in
-                $reg_csv_array[ __("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+                $reg_csv_array[__("Check-Ins", "event_espresso")] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin'
                 );
@@ -561,8 +561,8 @@ 
                     $ticket_name = __('Unknown', 'event_espresso');
                     $datetimes_strings = array(__('Unknown', 'event_espresso'));
                 }
-                $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+                $reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
+                $reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
                 // get datetime(s) of registration
 
                 // add attendee columns
@@ -583,20 +583,20 @@ 
                             $value = $this->_prepare_value_from_db_for_display(
                                 EEM_Attendee::instance(),
                                 $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
+                                $reg_row[$field_obj->get_qualified_column()]
                             );
                         }
                     } else {
                         $value = '';
                     }
 
-                    $reg_csv_array[ $this->_get_column_name_for_field($field_obj) ] = $value;
+                    $reg_csv_array[$this->_get_column_name_for_field($field_obj)] = $value;
                 }
 
                 // make sure each registration has the same questions in the same order
                 foreach ($questions_for_these_regs_rows as $question_row) {
-                    if (! isset($reg_csv_array[ $question_row['Question.QST_admin_label'] ])) {
-                        $reg_csv_array[ $question_row['Question.QST_admin_label'] ] = null;
+                    if ( ! isset($reg_csv_array[$question_row['Question.QST_admin_label']])) {
+                        $reg_csv_array[$question_row['Question.QST_admin_label']] = null;
                     }
                 }
                 // now fill out the questions THEY answered
@@ -614,11 +614,11 @@ 
                         $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
                     }
                     if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+                        $reg_csv_array[$question_label] = EEM_State::instance()->get_state_name_by_ID(
                             $answer_row['Answer.ANS_value']
                         );
                     } else {
-                        $reg_csv_array[ $question_label ] = $this->_prepare_value_from_db_for_display(
+                        $reg_csv_array[$question_label] = $this->_prepare_value_from_db_for_display(
                             EEM_Answer::instance(),
                             'ANS_value',
                             $answer_row['Answer.ANS_value']
@@ -644,16 +644,16 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 foreach ($field_list as $field_name) {
                     $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ $this->_get_column_name_for_field(
+                    $reg_csv_array[$this->_get_column_name_for_field(
                         $field
-                    ) ] = null;// $registration->get($field->get_name());
+                    )] = null; // $registration->get($field->get_name());
                 }
             }
             $registrations_csv_ready_array [] = $reg_csv_array;
         }
         if ($event_id) {
             $event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
-            if (! $event_slug) {
+            if ( ! $event_slug) {
                 $event_slug = __('unknown', 'event_espresso');
             }
         } else {
@@ -674,7 +674,7 @@ 
      */
     protected function _get_column_name_for_field(EE_Model_Field_Base $field)
     {
-        return $field->get_nicename() . "[" . $field->get_name() . "]";
+        return $field->get_nicename()."[".$field->get_name()."]";
     }
 
 
@@ -697,7 +697,7 @@ 
             } else {
                 // generate regular where = clause
                 $EVT_CAT_ID = absint($this->_req_data['EVT_CAT_ID']);
-                $filename = 'event-category#' . $EVT_CAT_ID;
+                $filename = 'event-category#'.$EVT_CAT_ID;
                 $query_params[0]['term_taxonomy_id'] = $EVT_CAT_ID;
             }
         } else {
@@ -712,7 +712,7 @@ 
         $table_data = $this->_get_export_data_for_models($tables_to_export);
         $filename = $this->generate_filename($filename);
 
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
+        if ( ! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
             EE_Error::add_error(
                 __(
                     'An error occurred and the Category details could not be exported from the database.',
@@ -735,8 +735,8 @@ 
     private function generate_filename($export_name = '')
     {
         if ($export_name != '') {
-            $filename = get_bloginfo('name') . '-' . $export_name;
-            $filename = sanitize_key($filename) . '-' . $this->today;
+            $filename = get_bloginfo('name').'-'.$export_name;
+            $filename = sanitize_key($filename).'-'.$this->today;
             return $filename;
         } else {
             EE_Error::add_error(__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
@@ -765,25 +765,25 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 $model_objects = $model->get_all($query_params);
 
-                $table_data[ $model_name ] = array();
+                $table_data[$model_name] = array();
                 foreach ($model_objects as $model_object) {
                     $model_data_array = array();
                     $fields = $model->field_settings();
                     foreach ($fields as $field) {
-                        $column_name = $field->get_nicename() . "[" . $field->get_name() . "]";
+                        $column_name = $field->get_nicename()."[".$field->get_name()."]";
                         if ($field instanceof EE_Datetime_Field) {
                             // $field->set_date_format('Y-m-d');
                             // $field->set_time_format('H:i:s');
-                            $model_data_array[ $column_name ] = $model_object->get_datetime(
+                            $model_data_array[$column_name] = $model_object->get_datetime(
                                 $field->get_name(),
                                 'Y-m-d',
                                 'H:i:s'
                             );
                         } else {
-                            $model_data_array[ $column_name ] = $model_object->get($field->get_name());
+                            $model_data_array[$column_name] = $model_object->get($field->get_name());
                         }
                     }
-                    $table_data[ $model_name ][] = $model_data_array;
+                    $table_data[$model_name][] = $model_data_array;
                 }
             }
         }

Doc Comments +2 added lines, -2 removed lines

@@ -69,7 +69,7 @@ 
     /**
      * @Export Event Espresso data - routes export requests
      * @access public
-     * @return void | bool
+     * @return false|null | bool
      */
     public function export()
     {
@@ -750,7 +750,7 @@ 
      * @access    private
      * @param array $models_to_export keys are model names (eg 'Event', 'Attendee', etc.) and values are arrays of
      *                                query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      */
     private function _get_export_data_for_models($models_to_export = array())
     {

Indentation +773 added lines, -773 removed lines

@@ -16,777 +16,777 @@
 class EE_Export
 {
 
-    const option_prefix = 'ee_report_job_';
-
-
-    // instance of the EE_Export object
-    private static $_instance = null;
-
-    // instance of the EE_CSV object
-    /**
-     *
-     * @var EE_CSV
-     */
-    public $EE_CSV = null;
-
-
-    private $_req_data = array();
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param array $request_data
-     */
-    private function __construct($request_data = array())
-    {
-        $this->_req_data = $request_data;
-        $this->today = date("Y-m-d", time());
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-    }
-
-
-    /**
-     *        @ singleton method used to instantiate class object
-     *        @ access public
-     *
-     * @param array $request_data
-     * @return \EE_Export
-     */
-    public static function instance($request_data = array())
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Export)) {
-            self::$_instance = new self($request_data);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @Export Event Espresso data - routes export requests
-     * @access public
-     * @return void | bool
-     */
-    public function export()
-    {
-        // in case of bulk exports, the "actual" action will be in action2, but first check regular action for "export" keyword
-        if (isset($this->_req_data['action']) && strpos($this->_req_data['action'], 'export') === false) {
-            // check if action2 has export action
-            if (isset($this->_req_data['action2']) && strpos($this->_req_data['action2'], 'export') !== false) {
-                // whoop! there it is!
-                $this->_req_data['action'] = $this->_req_data['action2'];
-            }
-        }
-
-        $this->_req_data['export'] = isset($this->_req_data['export']) ? $this->_req_data['export'] : '';
-
-        switch ($this->_req_data['export']) {
-            case 'report':
-                switch ($this->_req_data['action']) {
-                    case "event":
-                    case "export_events":
-                    case 'all_event_data':
-                        $this->export_all_event_data();
-                        break;
-
-                    case 'registrations_report_for_event':
-                        $this->report_registrations_for_event($this->_req_data['EVT_ID']);
-                        break;
-
-                    case 'attendees':
-                        $this->export_attendees();
-                        break;
-
-                    case 'categories':
-                        $this->export_categories();
-                        break;
-
-                    default:
-                        EE_Error::add_error(
-                            __('An error occurred! The requested export report could not be found.', 'event_espresso'),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                        break;
-                }
-                break; // end of switch export : report
-            default:
-                break;
-        } // end of switch export
-
-        exit;
-    }
-
-    /**
-     * Downloads a CSV file with all the columns, but no data. This should be used for importing
-     *
-     * @return null kills execution
-     */
-    public function export_sample()
-    {
-        $event = EEM_Event::instance()->get_one();
-        $this->_req_data['EVT_ID'] = $event->ID();
-        $this->export_all_event_data();
-    }
-
-
-    /**
-     * @Export data for ALL events
-     * @access public
-     * @return void
-     */
-    public function export_all_event_data()
-    {
-        // are any Event IDs set?
-        $event_query_params = array();
-        $related_models_query_params = array();
-        $related_through_reg_query_params = array();
-        $datetime_ticket_query_params = array();
-        $price_query_params = array();
-        $price_type_query_params = array();
-        $term_query_params = array();
-        $state_country_query_params = array();
-        $question_group_query_params = array();
-        $question_query_params = array();
-        if (isset($this->_req_data['EVT_ID'])) {
-            // do we have an array of IDs ?
-
-            if (is_array($this->_req_data['EVT_ID'])) {
-                $EVT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_ID']);
-                $value_to_equal = array('IN', $EVT_IDs);
-                $filename = 'events';
-            } else {
-                // generate regular where = clause
-                $EVT_ID = absint($this->_req_data['EVT_ID']);
-                $value_to_equal = $EVT_ID;
-                $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($EVT_ID);
-
-                $filename = 'event-' . ($event instanceof EE_Event ? $event->slug() : __('unknown', 'event_espresso'));
-            }
-            $event_query_params[0]['EVT_ID'] = $value_to_equal;
-            $related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
-            $related_through_reg_query_params[0]['Registration.EVT_ID'] = $value_to_equal;
-            $datetime_ticket_query_params[0]['Datetime.EVT_ID'] = $value_to_equal;
-            $price_query_params[0]['Ticket.Datetime.EVT_ID'] = $value_to_equal;
-            $price_type_query_params[0]['Price.Ticket.Datetime.EVT_ID'] = $value_to_equal;
-            $term_query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $value_to_equal;
-            $state_country_query_params[0]['Venue.Event.EVT_ID'] = $value_to_equal;
-            $question_group_query_params[0]['Event.EVT_ID'] = $value_to_equal;
-            $question_query_params[0]['Question_Group.Event.EVT_ID'] = $value_to_equal;
-        } else {
-            $filename = 'all-events';
-        }
-
-
-        // array in the format:  table name =>  query where clause
-        $models_to_export = array(
-            'Event'                   => $event_query_params,
-            'Datetime'                => $related_models_query_params,
-            'Ticket_Template'         => $price_query_params,
-            'Ticket'                  => $datetime_ticket_query_params,
-            'Datetime_Ticket'         => $datetime_ticket_query_params,
-            'Price_Type'              => $price_type_query_params,
-            'Price'                   => $price_query_params,
-            'Ticket_Price'            => $price_query_params,
-            'Term'                    => $term_query_params,
-            'Term_Taxonomy'           => $related_models_query_params,
-            'Term_Relationship'       => $related_models_query_params, // model has NO primary key...
-            'Country'                 => $state_country_query_params,
-            'State'                   => $state_country_query_params,
-            'Venue'                   => $related_models_query_params,
-            'Event_Venue'             => $related_models_query_params,
-            'Question_Group'          => $question_group_query_params,
-            'Event_Question_Group'    => $question_group_query_params,
-            'Question'                => $question_query_params,
-            'Question_Group_Question' => $question_query_params,
-            // 'Transaction'=>$related_through_reg_query_params,
-            // 'Registration'=>$related_models_query_params,
-            // 'Attendee'=>$related_through_reg_query_params,
-            // 'Line_Item'=>
-
-        );
-
-        $model_data = $this->_get_export_data_for_models($models_to_export);
-
-        $filename = $this->generate_filename($filename);
-
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
-            EE_Error::add_error(
-                __(
-                    "'An error occurred and the Event details could not be exported from the database.'",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-    public function report_attendees()
-    {
-        $attendee_rows = EEM_Attendee::instance()->get_all_wpdb_results(
-            array(
-                'force_join' => array('State', 'Country'),
-                'caps'       => EEM_Base::caps_read_admin,
-            )
-        );
-        $csv_data = array();
-        foreach ($attendee_rows as $attendee_row) {
-            $csv_row = array();
-            foreach (EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
-                if ($field_name == 'STA_ID') {
-                    $state_name_field = EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
-                    ) ];
-                } elseif ($field_name == 'CNT_ISO') {
-                    $country_name_field = EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ __(
-                        'Country',
-                        'event_espresso'
-                    ) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
-                } else {
-                    $csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
-                }
-            }
-            $csv_data[] = $csv_row;
-        }
-
-        $filename = $this->generate_filename('contact-list-report');
-
-        $handle = $this->EE_CSV->begin_sending_csv($filename);
-        $this->EE_CSV->write_data_array_to_csv($handle, $csv_data);
-        $this->EE_CSV->end_sending_csv($handle);
-    }
-
-
-    /**
-     * @Export data for ALL attendees
-     * @access public
-     * @return void
-     */
-    public function export_attendees()
-    {
-
-        $states_that_have_an_attendee = EEM_State::instance()->get_all(
-            array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
-        );
-        $countries_that_have_an_attendee = EEM_Country::instance()->get_all(
-            array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
-        );
-        // $states_to_export_query_params
-        $models_to_export = array(
-            'Country'  => array(array('CNT_ISO' => array('IN', array_keys($countries_that_have_an_attendee)))),
-            'State'    => array(array('STA_ID' => array('IN', array_keys($states_that_have_an_attendee)))),
-            'Attendee' => array(),
-        );
-
-
-        $model_data = $this->_get_export_data_for_models($models_to_export);
-        $filename = $this->generate_filename('all-attendees');
-
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
-            EE_Error::add_error(
-                __(
-                    'An error occurred and the Attendee data could not be exported from the database.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-    /**
-     * Shortcut for preparing a database result for display
-     *
-     * @param EEM_Base       $model
-     * @param string         $field_name
-     * @param string         $raw_db_value
-     * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to
-     *                                      NOT display pretty
-     * @return string
-     */
-    protected function _prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
-    {
-        $field_obj = $model->field_settings_for($field_name);
-        $value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $field_obj->set_date_format(
-                EE_CSV::instance()->get_date_format_for_csv($field_obj->get_date_format($pretty_schema)),
-                $pretty_schema
-            );
-            $field_obj->set_time_format(
-                EE_CSV::instance()->get_time_format_for_csv($field_obj->get_time_format($pretty_schema)),
-                $pretty_schema
-            );
-        }
-        if ($pretty_schema === true) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
-        } elseif (is_string($pretty_schema)) {
-            return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
-        } else {
-            return $field_obj->prepare_for_get($value_on_model_obj);
-        }
-    }
-
-    /**
-     * Export a custom CSV of registration info including: A bunch of the reg fields, the time of the event, the price
-     * name, and the questions associated with the registrations
-     *
-     * @param int $event_id
-     */
-    public function report_registrations_for_event($event_id = null)
-    {
-        $reg_fields_to_include = array(
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-
-        );
-        $att_fields_to_include = array(
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        );
-
-        $registrations_csv_ready_array = array();
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        $query_params = apply_filters(
-            'FHEE__EE_Export__report_registration_for_event',
-            array(
-                array(
-                    'OR'                 => array(
-                        // don't include registrations from failed or abandoned transactions...
-                        'Transaction.STS_ID' => array(
-                            'NOT IN',
-                            array(EEM_Transaction::failed_status_code, EEM_Transaction::abandoned_status_code),
-                        ),
-                        // unless the registration is approved, in which case include it regardless of transaction status
-                        'STS_ID'             => EEM_Registration::status_id_approved,
-                    ),
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
-                ),
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
-                'caps'       => EEM_Base::caps_read_admin,
-            ),
-            $event_id
-        );
-        if ($event_id) {
-            $query_params[0]['EVT_ID'] = $event_id;
-        } else {
-            $query_params['force_join'][] = 'Event';
-        }
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        // get all questions which relate to someone in this group
-        $registration_ids = array();
-        foreach ($registration_rows as $reg_row) {
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
-        }
-        // EEM_Question::instance()->show_next_x_db_queries();
-        $questions_for_these_regs_rows = EEM_Question::instance()->get_all_wpdb_results(
-            array(array('Answer.REG_ID' => array('IN', $registration_ids)))
-        );
-        foreach ($registration_rows as $reg_row) {
-            if (is_array($reg_row)) {
-                $reg_csv_array = array();
-                if (! $event_id) {
-                    // get the event's name and Id
-                    $reg_csv_array[ __('Event', 'event_espresso') ] = sprintf(
-                        __('%1$s (%2$s)', 'event_espresso'),
-                        $this->_prepare_value_from_db_for_display(
-                            EEM_Event::instance(),
-                            'EVT_name',
-                            $reg_row['Event_CPT.post_title']
-                        ),
-                        $reg_row['Event_CPT.ID']
-                    );
-                }
-                $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-                /*@var $reg_row EE_Registration */
-                foreach ($reg_fields_to_include as $field_name) {
-                    $field = $reg_model->field_settings_for($field_name);
-                    if ($field_name == 'REG_final_price') {
-                        $value = $this->_prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_final_price'],
-                            'localized_float'
-                        );
-                    } elseif ($field_name == 'REG_count') {
-                        $value = sprintf(
-                            __('%s of %s', 'event_espresso'),
-                            $this->_prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_count',
-                                $reg_row['Registration.REG_count']
-                            ),
-                            $this->_prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_group_size',
-                                $reg_row['Registration.REG_group_size']
-                            )
-                        );
-                    } elseif ($field_name == 'REG_date') {
-                        $value = $this->_prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_date'],
-                            'no_html'
-                        );
-                    } else {
-                        $value = $this->_prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
-                        );
-                    }
-                    $reg_csv_array[ $this->_get_column_name_for_field($field) ] = $value;
-                    if ($field_name == 'REG_final_price') {
-                        // add a column named Currency after the final price
-                        $reg_csv_array[ __("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
-                    }
-                }
-                // get pretty status
-                $stati = EEM_Status::instance()->localized_status(
-                    array(
-                        $reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
-                        $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
-                    ),
-                    false,
-                    'sentence'
-                );
-                $reg_csv_array[ __(
-                    "Registration Status",
-                    'event_espresso'
-                ) ] = $stati[ $reg_row['Registration.STS_ID'] ];
-                // get pretty trnasaction status
-                $reg_csv_array[ __(
-                    "Transaction Status",
-                    'event_espresso'
-                ) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
-                    ? $this->_prepare_value_from_db_for_display(
-                        EEM_Transaction::instance(),
-                        'TXN_total',
-                        $reg_row['TransactionTable.TXN_total'],
-                        'localized_float'
-                    ) : '0.00';
-                $reg_csv_array[ __('Amount Paid', 'event_espresso') ] = $is_primary_reg
-                    ? $this->_prepare_value_from_db_for_display(
-                        EEM_Transaction::instance(),
-                        'TXN_paid',
-                        $reg_row['TransactionTable.TXN_paid'],
-                        'localized_float'
-                    ) : '0.00';
-                $payment_methods = array();
-                $gateway_txn_ids_etc = array();
-                $payment_times = array();
-                if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                    $payments_info = EEM_Payment::instance()->get_all_wpdb_results(
-                        array(
-                            array(
-                                'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                                'STS_ID' => EEM_Payment::status_id_approved,
-                            ),
-                            'force_join' => array('Payment_Method'),
-                        ),
-                        ARRAY_A,
-                        'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                    );
-
-                    foreach ($payments_info as $payment_method_and_gateway_txn_id) {
-                        $payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
-                            ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
-                        $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
-                            ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
-                        $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
-                            ? $payment_method_and_gateway_txn_id['payment_time'] : '';
-                    }
-                }
-                $reg_csv_array[ __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ __('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                    ',',
-                    $gateway_txn_ids_etc
-                );
-
-                // get whether or not the user has checked in
-                $reg_csv_array[ __("Check-Ins", "event_espresso") ] = $reg_model->count_related(
-                    $reg_row['Registration.REG_ID'],
-                    'Checkin'
-                );
-                // get ticket of registration and its price
-                $ticket_model = EE_Registry::instance()->load_model('Ticket');
-                if ($reg_row['Ticket.TKT_ID']) {
-                    $ticket_name = $this->_prepare_value_from_db_for_display(
-                        $ticket_model,
-                        'TKT_name',
-                        $reg_row['Ticket.TKT_name']
-                    );
-                    $datetimes_strings = array();
-                    foreach (EEM_Datetime::instance()->get_all_wpdb_results(
-                        array(
-                            array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
-                            'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                            'default_where_conditions' => 'none',
-                        )
-                    ) as $datetime) {
-                        $datetimes_strings[] = $this->_prepare_value_from_db_for_display(
-                            EEM_Datetime::instance(),
-                            'DTT_EVT_start',
-                            $datetime['Datetime.DTT_EVT_start']
-                        );
-                    }
-                } else {
-                    $ticket_name = __('Unknown', 'event_espresso');
-                    $datetimes_strings = array(__('Unknown', 'event_espresso'));
-                }
-                $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
-                // get datetime(s) of registration
-
-                // add attendee columns
-                foreach ($att_fields_to_include as $att_field_name) {
-                    $field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
-                    if ($reg_row['Attendee_CPT.ID']) {
-                        if ($att_field_name == 'STA_ID') {
-                            $value = EEM_State::instance()->get_var(
-                                array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
-                                'STA_name'
-                            );
-                        } elseif ($att_field_name == 'CNT_ISO') {
-                            $value = EEM_Country::instance()->get_var(
-                                array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
-                                'CNT_name'
-                            );
-                        } else {
-                            $value = $this->_prepare_value_from_db_for_display(
-                                EEM_Attendee::instance(),
-                                $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
-                            );
-                        }
-                    } else {
-                        $value = '';
-                    }
-
-                    $reg_csv_array[ $this->_get_column_name_for_field($field_obj) ] = $value;
-                }
-
-                // make sure each registration has the same questions in the same order
-                foreach ($questions_for_these_regs_rows as $question_row) {
-                    if (! isset($reg_csv_array[ $question_row['Question.QST_admin_label'] ])) {
-                        $reg_csv_array[ $question_row['Question.QST_admin_label'] ] = null;
-                    }
-                }
-                // now fill out the questions THEY answered
-                foreach (EEM_Answer::instance()->get_all_wpdb_results(
-                    array(array('REG_ID' => $reg_row['Registration.REG_ID']), 'force_join' => array('Question'))
-                ) as $answer_row) {
-                    /* @var $answer EE_Answer */
-                    if ($answer_row['Question.QST_ID']) {
-                        $question_label = $this->_prepare_value_from_db_for_display(
-                            EEM_Question::instance(),
-                            'QST_admin_label',
-                            $answer_row['Question.QST_admin_label']
-                        );
-                    } else {
-                        $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
-                    }
-                    if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
-                            $answer_row['Answer.ANS_value']
-                        );
-                    } else {
-                        $reg_csv_array[ $question_label ] = $this->_prepare_value_from_db_for_display(
-                            EEM_Answer::instance(),
-                            'ANS_value',
-                            $answer_row['Answer.ANS_value']
-                        );
-                    }
-                }
-                $registrations_csv_ready_array[] = apply_filters(
-                    'FHEE__EE_Export__report_registrations__reg_csv_array',
-                    $reg_csv_array,
-                    $reg_row
-                );
-            }
-        }
-
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array = array();
-            $model_and_fields_to_include = array(
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            );
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ $this->_get_column_name_for_field(
-                        $field
-                    ) ] = null;// $registration->get($field->get_name());
-                }
-            }
-            $registrations_csv_ready_array [] = $reg_csv_array;
-        }
-        if ($event_id) {
-            $event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
-            if (! $event_slug) {
-                $event_slug = __('unknown', 'event_espresso');
-            }
-        } else {
-            $event_slug = __('all', 'event_espresso');
-        }
-        $filename = sprintf("registrations-for-%s", $event_slug);
-
-        $handle = $this->EE_CSV->begin_sending_csv($filename);
-        $this->EE_CSV->write_data_array_to_csv($handle, $registrations_csv_ready_array);
-        $this->EE_CSV->end_sending_csv($handle);
-    }
-
-    /**
-     * Gets the 'normal' column named for fields
-     *
-     * @param EE_Model_Field_Base $field
-     * @return string
-     */
-    protected function _get_column_name_for_field(EE_Model_Field_Base $field)
-    {
-        return $field->get_nicename() . "[" . $field->get_name() . "]";
-    }
-
-
-    /**
-     * @Export data for ALL events
-     * @access public
-     * @return void
-     */
-    public function export_categories()
-    {
-        // are any Event IDs set?
-        $query_params = array();
-        if (isset($this->_req_data['EVT_CAT_ID'])) {
-            // do we have an array of IDs ?
-            if (is_array($this->_req_data['EVT_CAT_ID'])) {
-                // generate an "IN (CSV)" where clause
-                $EVT_CAT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_CAT_ID']);
-                $filename = 'event-categories';
-                $query_params[0]['term_taxonomy_id'] = array('IN', $EVT_CAT_IDs);
-            } else {
-                // generate regular where = clause
-                $EVT_CAT_ID = absint($this->_req_data['EVT_CAT_ID']);
-                $filename = 'event-category#' . $EVT_CAT_ID;
-                $query_params[0]['term_taxonomy_id'] = $EVT_CAT_ID;
-            }
-        } else {
-            // no IDs means we will d/l the entire table
-            $filename = 'all-categories';
-        }
-
-        $tables_to_export = array(
-            'Term_Taxonomy' => $query_params,
-        );
-
-        $table_data = $this->_get_export_data_for_models($tables_to_export);
-        $filename = $this->generate_filename($filename);
-
-        if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
-            EE_Error::add_error(
-                __(
-                    'An error occurred and the Category details could not be exported from the database.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @process export name to create a suitable filename
-     * @access  private
-     * @param string - export_name
-     * @return string on success, FALSE on fail
-     */
-    private function generate_filename($export_name = '')
-    {
-        if ($export_name != '') {
-            $filename = get_bloginfo('name') . '-' . $export_name;
-            $filename = sanitize_key($filename) . '-' . $this->today;
-            return $filename;
-        } else {
-            EE_Error::add_error(__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return false;
-    }
-
-
-    /**
-     * @recursive function for exporting table data and merging the results with the next results
-     * @access    private
-     * @param array $models_to_export keys are model names (eg 'Event', 'Attendee', etc.) and values are arrays of
-     *                                query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array on success, FALSE on fail
-     */
-    private function _get_export_data_for_models($models_to_export = array())
-    {
-        $table_data = false;
-        if (is_array($models_to_export)) {
-            foreach ($models_to_export as $model_name => $query_params) {
-                // check for a numerically-indexed array. in that case, $model_name is the value!!
-                if (is_int($model_name)) {
-                    $model_name = $query_params;
-                    $query_params = array();
-                }
-                $model = EE_Registry::instance()->load_model($model_name);
-                $model_objects = $model->get_all($query_params);
-
-                $table_data[ $model_name ] = array();
-                foreach ($model_objects as $model_object) {
-                    $model_data_array = array();
-                    $fields = $model->field_settings();
-                    foreach ($fields as $field) {
-                        $column_name = $field->get_nicename() . "[" . $field->get_name() . "]";
-                        if ($field instanceof EE_Datetime_Field) {
-                            // $field->set_date_format('Y-m-d');
-                            // $field->set_time_format('H:i:s');
-                            $model_data_array[ $column_name ] = $model_object->get_datetime(
-                                $field->get_name(),
-                                'Y-m-d',
-                                'H:i:s'
-                            );
-                        } else {
-                            $model_data_array[ $column_name ] = $model_object->get($field->get_name());
-                        }
-                    }
-                    $table_data[ $model_name ][] = $model_data_array;
-                }
-            }
-        }
-        return $table_data;
-    }
+	const option_prefix = 'ee_report_job_';
+
+
+	// instance of the EE_Export object
+	private static $_instance = null;
+
+	// instance of the EE_CSV object
+	/**
+	 *
+	 * @var EE_CSV
+	 */
+	public $EE_CSV = null;
+
+
+	private $_req_data = array();
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param array $request_data
+	 */
+	private function __construct($request_data = array())
+	{
+		$this->_req_data = $request_data;
+		$this->today = date("Y-m-d", time());
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+	}
+
+
+	/**
+	 *        @ singleton method used to instantiate class object
+	 *        @ access public
+	 *
+	 * @param array $request_data
+	 * @return \EE_Export
+	 */
+	public static function instance($request_data = array())
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Export)) {
+			self::$_instance = new self($request_data);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @Export Event Espresso data - routes export requests
+	 * @access public
+	 * @return void | bool
+	 */
+	public function export()
+	{
+		// in case of bulk exports, the "actual" action will be in action2, but first check regular action for "export" keyword
+		if (isset($this->_req_data['action']) && strpos($this->_req_data['action'], 'export') === false) {
+			// check if action2 has export action
+			if (isset($this->_req_data['action2']) && strpos($this->_req_data['action2'], 'export') !== false) {
+				// whoop! there it is!
+				$this->_req_data['action'] = $this->_req_data['action2'];
+			}
+		}
+
+		$this->_req_data['export'] = isset($this->_req_data['export']) ? $this->_req_data['export'] : '';
+
+		switch ($this->_req_data['export']) {
+			case 'report':
+				switch ($this->_req_data['action']) {
+					case "event":
+					case "export_events":
+					case 'all_event_data':
+						$this->export_all_event_data();
+						break;
+
+					case 'registrations_report_for_event':
+						$this->report_registrations_for_event($this->_req_data['EVT_ID']);
+						break;
+
+					case 'attendees':
+						$this->export_attendees();
+						break;
+
+					case 'categories':
+						$this->export_categories();
+						break;
+
+					default:
+						EE_Error::add_error(
+							__('An error occurred! The requested export report could not be found.', 'event_espresso'),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+						break;
+				}
+				break; // end of switch export : report
+			default:
+				break;
+		} // end of switch export
+
+		exit;
+	}
+
+	/**
+	 * Downloads a CSV file with all the columns, but no data. This should be used for importing
+	 *
+	 * @return null kills execution
+	 */
+	public function export_sample()
+	{
+		$event = EEM_Event::instance()->get_one();
+		$this->_req_data['EVT_ID'] = $event->ID();
+		$this->export_all_event_data();
+	}
+
+
+	/**
+	 * @Export data for ALL events
+	 * @access public
+	 * @return void
+	 */
+	public function export_all_event_data()
+	{
+		// are any Event IDs set?
+		$event_query_params = array();
+		$related_models_query_params = array();
+		$related_through_reg_query_params = array();
+		$datetime_ticket_query_params = array();
+		$price_query_params = array();
+		$price_type_query_params = array();
+		$term_query_params = array();
+		$state_country_query_params = array();
+		$question_group_query_params = array();
+		$question_query_params = array();
+		if (isset($this->_req_data['EVT_ID'])) {
+			// do we have an array of IDs ?
+
+			if (is_array($this->_req_data['EVT_ID'])) {
+				$EVT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_ID']);
+				$value_to_equal = array('IN', $EVT_IDs);
+				$filename = 'events';
+			} else {
+				// generate regular where = clause
+				$EVT_ID = absint($this->_req_data['EVT_ID']);
+				$value_to_equal = $EVT_ID;
+				$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($EVT_ID);
+
+				$filename = 'event-' . ($event instanceof EE_Event ? $event->slug() : __('unknown', 'event_espresso'));
+			}
+			$event_query_params[0]['EVT_ID'] = $value_to_equal;
+			$related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
+			$related_through_reg_query_params[0]['Registration.EVT_ID'] = $value_to_equal;
+			$datetime_ticket_query_params[0]['Datetime.EVT_ID'] = $value_to_equal;
+			$price_query_params[0]['Ticket.Datetime.EVT_ID'] = $value_to_equal;
+			$price_type_query_params[0]['Price.Ticket.Datetime.EVT_ID'] = $value_to_equal;
+			$term_query_params[0]['Term_Taxonomy.Event.EVT_ID'] = $value_to_equal;
+			$state_country_query_params[0]['Venue.Event.EVT_ID'] = $value_to_equal;
+			$question_group_query_params[0]['Event.EVT_ID'] = $value_to_equal;
+			$question_query_params[0]['Question_Group.Event.EVT_ID'] = $value_to_equal;
+		} else {
+			$filename = 'all-events';
+		}
+
+
+		// array in the format:  table name =>  query where clause
+		$models_to_export = array(
+			'Event'                   => $event_query_params,
+			'Datetime'                => $related_models_query_params,
+			'Ticket_Template'         => $price_query_params,
+			'Ticket'                  => $datetime_ticket_query_params,
+			'Datetime_Ticket'         => $datetime_ticket_query_params,
+			'Price_Type'              => $price_type_query_params,
+			'Price'                   => $price_query_params,
+			'Ticket_Price'            => $price_query_params,
+			'Term'                    => $term_query_params,
+			'Term_Taxonomy'           => $related_models_query_params,
+			'Term_Relationship'       => $related_models_query_params, // model has NO primary key...
+			'Country'                 => $state_country_query_params,
+			'State'                   => $state_country_query_params,
+			'Venue'                   => $related_models_query_params,
+			'Event_Venue'             => $related_models_query_params,
+			'Question_Group'          => $question_group_query_params,
+			'Event_Question_Group'    => $question_group_query_params,
+			'Question'                => $question_query_params,
+			'Question_Group_Question' => $question_query_params,
+			// 'Transaction'=>$related_through_reg_query_params,
+			// 'Registration'=>$related_models_query_params,
+			// 'Attendee'=>$related_through_reg_query_params,
+			// 'Line_Item'=>
+
+		);
+
+		$model_data = $this->_get_export_data_for_models($models_to_export);
+
+		$filename = $this->generate_filename($filename);
+
+		if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+			EE_Error::add_error(
+				__(
+					"'An error occurred and the Event details could not be exported from the database.'",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+	public function report_attendees()
+	{
+		$attendee_rows = EEM_Attendee::instance()->get_all_wpdb_results(
+			array(
+				'force_join' => array('State', 'Country'),
+				'caps'       => EEM_Base::caps_read_admin,
+			)
+		);
+		$csv_data = array();
+		foreach ($attendee_rows as $attendee_row) {
+			$csv_row = array();
+			foreach (EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
+				if ($field_name == 'STA_ID') {
+					$state_name_field = EEM_State::instance()->field_settings_for('STA_name');
+					$csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
+					) ];
+				} elseif ($field_name == 'CNT_ISO') {
+					$country_name_field = EEM_Country::instance()->field_settings_for('CNT_name');
+					$csv_row[ __(
+						'Country',
+						'event_espresso'
+					) ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+				} else {
+					$csv_row[ $field_obj->get_nicename() ] = $attendee_row[ $field_obj->get_qualified_column() ];
+				}
+			}
+			$csv_data[] = $csv_row;
+		}
+
+		$filename = $this->generate_filename('contact-list-report');
+
+		$handle = $this->EE_CSV->begin_sending_csv($filename);
+		$this->EE_CSV->write_data_array_to_csv($handle, $csv_data);
+		$this->EE_CSV->end_sending_csv($handle);
+	}
+
+
+	/**
+	 * @Export data for ALL attendees
+	 * @access public
+	 * @return void
+	 */
+	public function export_attendees()
+	{
+
+		$states_that_have_an_attendee = EEM_State::instance()->get_all(
+			array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
+		);
+		$countries_that_have_an_attendee = EEM_Country::instance()->get_all(
+			array(0 => array('Attendee.ATT_ID' => array('IS NOT NULL')))
+		);
+		// $states_to_export_query_params
+		$models_to_export = array(
+			'Country'  => array(array('CNT_ISO' => array('IN', array_keys($countries_that_have_an_attendee)))),
+			'State'    => array(array('STA_ID' => array('IN', array_keys($states_that_have_an_attendee)))),
+			'Attendee' => array(),
+		);
+
+
+		$model_data = $this->_get_export_data_for_models($models_to_export);
+		$filename = $this->generate_filename('all-attendees');
+
+		if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $model_data)) {
+			EE_Error::add_error(
+				__(
+					'An error occurred and the Attendee data could not be exported from the database.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+	/**
+	 * Shortcut for preparing a database result for display
+	 *
+	 * @param EEM_Base       $model
+	 * @param string         $field_name
+	 * @param string         $raw_db_value
+	 * @param boolean|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to
+	 *                                      NOT display pretty
+	 * @return string
+	 */
+	protected function _prepare_value_from_db_for_display($model, $field_name, $raw_db_value, $pretty_schema = true)
+	{
+		$field_obj = $model->field_settings_for($field_name);
+		$value_on_model_obj = $field_obj->prepare_for_set_from_db($raw_db_value);
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$field_obj->set_date_format(
+				EE_CSV::instance()->get_date_format_for_csv($field_obj->get_date_format($pretty_schema)),
+				$pretty_schema
+			);
+			$field_obj->set_time_format(
+				EE_CSV::instance()->get_time_format_for_csv($field_obj->get_time_format($pretty_schema)),
+				$pretty_schema
+			);
+		}
+		if ($pretty_schema === true) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj);
+		} elseif (is_string($pretty_schema)) {
+			return $field_obj->prepare_for_pretty_echoing($value_on_model_obj, $pretty_schema);
+		} else {
+			return $field_obj->prepare_for_get($value_on_model_obj);
+		}
+	}
+
+	/**
+	 * Export a custom CSV of registration info including: A bunch of the reg fields, the time of the event, the price
+	 * name, and the questions associated with the registrations
+	 *
+	 * @param int $event_id
+	 */
+	public function report_registrations_for_event($event_id = null)
+	{
+		$reg_fields_to_include = array(
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+
+		);
+		$att_fields_to_include = array(
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		);
+
+		$registrations_csv_ready_array = array();
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		$query_params = apply_filters(
+			'FHEE__EE_Export__report_registration_for_event',
+			array(
+				array(
+					'OR'                 => array(
+						// don't include registrations from failed or abandoned transactions...
+						'Transaction.STS_ID' => array(
+							'NOT IN',
+							array(EEM_Transaction::failed_status_code, EEM_Transaction::abandoned_status_code),
+						),
+						// unless the registration is approved, in which case include it regardless of transaction status
+						'STS_ID'             => EEM_Registration::status_id_approved,
+					),
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
+				),
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
+				'caps'       => EEM_Base::caps_read_admin,
+			),
+			$event_id
+		);
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
+		}
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		// get all questions which relate to someone in this group
+		$registration_ids = array();
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
+		}
+		// EEM_Question::instance()->show_next_x_db_queries();
+		$questions_for_these_regs_rows = EEM_Question::instance()->get_all_wpdb_results(
+			array(array('Answer.REG_ID' => array('IN', $registration_ids)))
+		);
+		foreach ($registration_rows as $reg_row) {
+			if (is_array($reg_row)) {
+				$reg_csv_array = array();
+				if (! $event_id) {
+					// get the event's name and Id
+					$reg_csv_array[ __('Event', 'event_espresso') ] = sprintf(
+						__('%1$s (%2$s)', 'event_espresso'),
+						$this->_prepare_value_from_db_for_display(
+							EEM_Event::instance(),
+							'EVT_name',
+							$reg_row['Event_CPT.post_title']
+						),
+						$reg_row['Event_CPT.ID']
+					);
+				}
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
+				/*@var $reg_row EE_Registration */
+				foreach ($reg_fields_to_include as $field_name) {
+					$field = $reg_model->field_settings_for($field_name);
+					if ($field_name == 'REG_final_price') {
+						$value = $this->_prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_final_price'],
+							'localized_float'
+						);
+					} elseif ($field_name == 'REG_count') {
+						$value = sprintf(
+							__('%s of %s', 'event_espresso'),
+							$this->_prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_count',
+								$reg_row['Registration.REG_count']
+							),
+							$this->_prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_group_size',
+								$reg_row['Registration.REG_group_size']
+							)
+						);
+					} elseif ($field_name == 'REG_date') {
+						$value = $this->_prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_date'],
+							'no_html'
+						);
+					} else {
+						$value = $this->_prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row[ $field->get_qualified_column() ]
+						);
+					}
+					$reg_csv_array[ $this->_get_column_name_for_field($field) ] = $value;
+					if ($field_name == 'REG_final_price') {
+						// add a column named Currency after the final price
+						$reg_csv_array[ __("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+					}
+				}
+				// get pretty status
+				$stati = EEM_Status::instance()->localized_status(
+					array(
+						$reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
+						$reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
+					),
+					false,
+					'sentence'
+				);
+				$reg_csv_array[ __(
+					"Registration Status",
+					'event_espresso'
+				) ] = $stati[ $reg_row['Registration.STS_ID'] ];
+				// get pretty trnasaction status
+				$reg_csv_array[ __(
+					"Transaction Status",
+					'event_espresso'
+				) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
+				$reg_csv_array[ __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+					? $this->_prepare_value_from_db_for_display(
+						EEM_Transaction::instance(),
+						'TXN_total',
+						$reg_row['TransactionTable.TXN_total'],
+						'localized_float'
+					) : '0.00';
+				$reg_csv_array[ __('Amount Paid', 'event_espresso') ] = $is_primary_reg
+					? $this->_prepare_value_from_db_for_display(
+						EEM_Transaction::instance(),
+						'TXN_paid',
+						$reg_row['TransactionTable.TXN_paid'],
+						'localized_float'
+					) : '0.00';
+				$payment_methods = array();
+				$gateway_txn_ids_etc = array();
+				$payment_times = array();
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+					$payments_info = EEM_Payment::instance()->get_all_wpdb_results(
+						array(
+							array(
+								'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+								'STS_ID' => EEM_Payment::status_id_approved,
+							),
+							'force_join' => array('Payment_Method'),
+						),
+						ARRAY_A,
+						'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+					);
+
+					foreach ($payments_info as $payment_method_and_gateway_txn_id) {
+						$payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
+							? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
+						$gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
+							? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
+						$payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
+							? $payment_method_and_gateway_txn_id['payment_time'] : '';
+					}
+				}
+				$reg_csv_array[ __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
+				$reg_csv_array[ __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
+				$reg_csv_array[ __('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+					',',
+					$gateway_txn_ids_etc
+				);
+
+				// get whether or not the user has checked in
+				$reg_csv_array[ __("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+					$reg_row['Registration.REG_ID'],
+					'Checkin'
+				);
+				// get ticket of registration and its price
+				$ticket_model = EE_Registry::instance()->load_model('Ticket');
+				if ($reg_row['Ticket.TKT_ID']) {
+					$ticket_name = $this->_prepare_value_from_db_for_display(
+						$ticket_model,
+						'TKT_name',
+						$reg_row['Ticket.TKT_name']
+					);
+					$datetimes_strings = array();
+					foreach (EEM_Datetime::instance()->get_all_wpdb_results(
+						array(
+							array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
+							'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+							'default_where_conditions' => 'none',
+						)
+					) as $datetime) {
+						$datetimes_strings[] = $this->_prepare_value_from_db_for_display(
+							EEM_Datetime::instance(),
+							'DTT_EVT_start',
+							$datetime['Datetime.DTT_EVT_start']
+						);
+					}
+				} else {
+					$ticket_name = __('Unknown', 'event_espresso');
+					$datetimes_strings = array(__('Unknown', 'event_espresso'));
+				}
+				$reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+				$reg_csv_array[ __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+				// get datetime(s) of registration
+
+				// add attendee columns
+				foreach ($att_fields_to_include as $att_field_name) {
+					$field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
+					if ($reg_row['Attendee_CPT.ID']) {
+						if ($att_field_name == 'STA_ID') {
+							$value = EEM_State::instance()->get_var(
+								array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
+								'STA_name'
+							);
+						} elseif ($att_field_name == 'CNT_ISO') {
+							$value = EEM_Country::instance()->get_var(
+								array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
+								'CNT_name'
+							);
+						} else {
+							$value = $this->_prepare_value_from_db_for_display(
+								EEM_Attendee::instance(),
+								$att_field_name,
+								$reg_row[ $field_obj->get_qualified_column() ]
+							);
+						}
+					} else {
+						$value = '';
+					}
+
+					$reg_csv_array[ $this->_get_column_name_for_field($field_obj) ] = $value;
+				}
+
+				// make sure each registration has the same questions in the same order
+				foreach ($questions_for_these_regs_rows as $question_row) {
+					if (! isset($reg_csv_array[ $question_row['Question.QST_admin_label'] ])) {
+						$reg_csv_array[ $question_row['Question.QST_admin_label'] ] = null;
+					}
+				}
+				// now fill out the questions THEY answered
+				foreach (EEM_Answer::instance()->get_all_wpdb_results(
+					array(array('REG_ID' => $reg_row['Registration.REG_ID']), 'force_join' => array('Question'))
+				) as $answer_row) {
+					/* @var $answer EE_Answer */
+					if ($answer_row['Question.QST_ID']) {
+						$question_label = $this->_prepare_value_from_db_for_display(
+							EEM_Question::instance(),
+							'QST_admin_label',
+							$answer_row['Question.QST_admin_label']
+						);
+					} else {
+						$question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
+					}
+					if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
+						$reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+							$answer_row['Answer.ANS_value']
+						);
+					} else {
+						$reg_csv_array[ $question_label ] = $this->_prepare_value_from_db_for_display(
+							EEM_Answer::instance(),
+							'ANS_value',
+							$answer_row['Answer.ANS_value']
+						);
+					}
+				}
+				$registrations_csv_ready_array[] = apply_filters(
+					'FHEE__EE_Export__report_registrations__reg_csv_array',
+					$reg_csv_array,
+					$reg_row
+				);
+			}
+		}
+
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array = array();
+			$model_and_fields_to_include = array(
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			);
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field = $model->field_settings_for($field_name);
+					$reg_csv_array[ $this->_get_column_name_for_field(
+						$field
+					) ] = null;// $registration->get($field->get_name());
+				}
+			}
+			$registrations_csv_ready_array [] = $reg_csv_array;
+		}
+		if ($event_id) {
+			$event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
+			if (! $event_slug) {
+				$event_slug = __('unknown', 'event_espresso');
+			}
+		} else {
+			$event_slug = __('all', 'event_espresso');
+		}
+		$filename = sprintf("registrations-for-%s", $event_slug);
+
+		$handle = $this->EE_CSV->begin_sending_csv($filename);
+		$this->EE_CSV->write_data_array_to_csv($handle, $registrations_csv_ready_array);
+		$this->EE_CSV->end_sending_csv($handle);
+	}
+
+	/**
+	 * Gets the 'normal' column named for fields
+	 *
+	 * @param EE_Model_Field_Base $field
+	 * @return string
+	 */
+	protected function _get_column_name_for_field(EE_Model_Field_Base $field)
+	{
+		return $field->get_nicename() . "[" . $field->get_name() . "]";
+	}
+
+
+	/**
+	 * @Export data for ALL events
+	 * @access public
+	 * @return void
+	 */
+	public function export_categories()
+	{
+		// are any Event IDs set?
+		$query_params = array();
+		if (isset($this->_req_data['EVT_CAT_ID'])) {
+			// do we have an array of IDs ?
+			if (is_array($this->_req_data['EVT_CAT_ID'])) {
+				// generate an "IN (CSV)" where clause
+				$EVT_CAT_IDs = array_map('sanitize_text_field', $this->_req_data['EVT_CAT_ID']);
+				$filename = 'event-categories';
+				$query_params[0]['term_taxonomy_id'] = array('IN', $EVT_CAT_IDs);
+			} else {
+				// generate regular where = clause
+				$EVT_CAT_ID = absint($this->_req_data['EVT_CAT_ID']);
+				$filename = 'event-category#' . $EVT_CAT_ID;
+				$query_params[0]['term_taxonomy_id'] = $EVT_CAT_ID;
+			}
+		} else {
+			// no IDs means we will d/l the entire table
+			$filename = 'all-categories';
+		}
+
+		$tables_to_export = array(
+			'Term_Taxonomy' => $query_params,
+		);
+
+		$table_data = $this->_get_export_data_for_models($tables_to_export);
+		$filename = $this->generate_filename($filename);
+
+		if (! $this->EE_CSV->export_multiple_model_data_to_csv($filename, $table_data)) {
+			EE_Error::add_error(
+				__(
+					'An error occurred and the Category details could not be exported from the database.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @process export name to create a suitable filename
+	 * @access  private
+	 * @param string - export_name
+	 * @return string on success, FALSE on fail
+	 */
+	private function generate_filename($export_name = '')
+	{
+		if ($export_name != '') {
+			$filename = get_bloginfo('name') . '-' . $export_name;
+			$filename = sanitize_key($filename) . '-' . $this->today;
+			return $filename;
+		} else {
+			EE_Error::add_error(__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return false;
+	}
+
+
+	/**
+	 * @recursive function for exporting table data and merging the results with the next results
+	 * @access    private
+	 * @param array $models_to_export keys are model names (eg 'Event', 'Attendee', etc.) and values are arrays of
+	 *                                query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array on success, FALSE on fail
+	 */
+	private function _get_export_data_for_models($models_to_export = array())
+	{
+		$table_data = false;
+		if (is_array($models_to_export)) {
+			foreach ($models_to_export as $model_name => $query_params) {
+				// check for a numerically-indexed array. in that case, $model_name is the value!!
+				if (is_int($model_name)) {
+					$model_name = $query_params;
+					$query_params = array();
+				}
+				$model = EE_Registry::instance()->load_model($model_name);
+				$model_objects = $model->get_all($query_params);
+
+				$table_data[ $model_name ] = array();
+				foreach ($model_objects as $model_object) {
+					$model_data_array = array();
+					$fields = $model->field_settings();
+					foreach ($fields as $field) {
+						$column_name = $field->get_nicename() . "[" . $field->get_name() . "]";
+						if ($field instanceof EE_Datetime_Field) {
+							// $field->set_date_format('Y-m-d');
+							// $field->set_time_format('H:i:s');
+							$model_data_array[ $column_name ] = $model_object->get_datetime(
+								$field->get_name(),
+								'Y-m-d',
+								'H:i:s'
+							);
+						} else {
+							$model_data_array[ $column_name ] = $model_object->get($field->get_name());
+						}
+					}
+					$table_data[ $model_name ][] = $model_data_array;
+				}
+			}
+		}
+		return $table_data;
+	}
 }