eventespresso / event-espresso-core

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;
                 }
             }
         }

Indentation +777 added lines, -777 removed lines

@@ -16,781 +16,781 @@
 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;
+	}
 }

core/db_classes/EE_Answer.class.php

Indentation +138 added lines, -138 removed lines

@@ -10,144 +10,144 @@
 class EE_Answer extends EE_Base_Class
 {
 
-    /**
-     *
-     * @param array $props_n_values
-     * @return EE_Answer
-     */
-    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_Answer
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     *    Set Question ID
-     *
-     * @access        public
-     * @param int $QST_ID
-     */
-    public function set_question($QST_ID = 0)
-    {
-        $this->set('QST_ID', $QST_ID);
-    }
-
-
-    /**
-     *    Set Registration ID
-     *
-     * @access        public
-     * @param int $REG_ID
-     */
-    public function set_registration($REG_ID = 0)
-    {
-        $this->set('REG_ID', $REG_ID);
-    }
-
-
-    /**
-     *    Set Answer value
-     *
-     * @access        public
-     * @param mixed $ANS_value
-     */
-    public function set_value($ANS_value = '')
-    {
-        $this->set('ANS_value', $ANS_value);
-    }
-
-
-    /**
-     *    get Attendee First Name
-     *
-     * @access        public
-     * @return        int
-     */
-    public function registration_ID()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    /**
-     *    get Attendee Last Name
-     *
-     * @access        public
-     * @return        int
-     */
-    public function question_ID()
-    {
-        return $this->get('QST_ID');
-    }
-
-
-    /**
-     *    get Attendee Address
-     *
-     * @access        public
-     * @return        string
-     */
-    public function value()
-    {
-        return $this->get('ANS_value');
-    }
-
-
-    /**
-     * Gets a pretty form of the value (mostly applies to answers that have multiple answers)
-     *
-     * @param null $schema
-     * @return string
-     */
-    public function pretty_value($schema = null)
-    {
-        return $this->get_pretty('ANS_value', $schema);
-    }
-
-
-    /**
-     * Echoes out a pretty value (even for multi-choice options)
-     *
-     * @param string $schema
-     */
-    public function e_value($schema = null)
-    {
-        $this->e('ANS_value', $schema);
-    }
-
-
-    /**
-     * Gets the related EE_Question to this EE_Answer
-     *
-     * @return EE_Question
-     */
-    public function question()
-    {
-        return $this->get_first_related('Question');
-    }
-
-
-    /**
-     * Gets the related EE_Registration to this EE_Answer
-     *
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->get_first_related('Registration');
-    }
+	/**
+	 *
+	 * @param array $props_n_values
+	 * @return EE_Answer
+	 */
+	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_Answer
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 *    Set Question ID
+	 *
+	 * @access        public
+	 * @param int $QST_ID
+	 */
+	public function set_question($QST_ID = 0)
+	{
+		$this->set('QST_ID', $QST_ID);
+	}
+
+
+	/**
+	 *    Set Registration ID
+	 *
+	 * @access        public
+	 * @param int $REG_ID
+	 */
+	public function set_registration($REG_ID = 0)
+	{
+		$this->set('REG_ID', $REG_ID);
+	}
+
+
+	/**
+	 *    Set Answer value
+	 *
+	 * @access        public
+	 * @param mixed $ANS_value
+	 */
+	public function set_value($ANS_value = '')
+	{
+		$this->set('ANS_value', $ANS_value);
+	}
+
+
+	/**
+	 *    get Attendee First Name
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function registration_ID()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	/**
+	 *    get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function question_ID()
+	{
+		return $this->get('QST_ID');
+	}
+
+
+	/**
+	 *    get Attendee Address
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function value()
+	{
+		return $this->get('ANS_value');
+	}
+
+
+	/**
+	 * Gets a pretty form of the value (mostly applies to answers that have multiple answers)
+	 *
+	 * @param null $schema
+	 * @return string
+	 */
+	public function pretty_value($schema = null)
+	{
+		return $this->get_pretty('ANS_value', $schema);
+	}
+
+
+	/**
+	 * Echoes out a pretty value (even for multi-choice options)
+	 *
+	 * @param string $schema
+	 */
+	public function e_value($schema = null)
+	{
+		$this->e('ANS_value', $schema);
+	}
+
+
+	/**
+	 * Gets the related EE_Question to this EE_Answer
+	 *
+	 * @return EE_Question
+	 */
+	public function question()
+	{
+		return $this->get_first_related('Question');
+	}
+
+
+	/**
+	 * Gets the related EE_Registration to this EE_Answer
+	 *
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->get_first_related('Registration');
+	}
 }
 
 /* End of file EE_Answer.class.php */

core/db_classes/EE_Message.class.php

Indentation +867 added lines, -867 removed lines

@@ -10,875 +10,875 @@
 class EE_Message extends EE_Base_Class implements EEI_Admin_Links
 {
 
-    /**
-     * @deprecated 4.9.0  Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_pack;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type null
-     */
-    public $template_variation;
-
-    /**
-     * @deprecated 4.9.0 Added for backward compat with add-on's
-     * @type string
-     */
-    public $content = '';
-
-
-    /**
-     * @type EE_messenger $_messenger
-     */
-    protected $_messenger = null;
-
-    /**
-     * @type EE_message_type $_message_type
-     */
-    protected $_message_type = null;
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
-     *                             format.
-     * @return EE_Message
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
-            EE_Registry::instance()->load_helper('URL');
-            $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
-        }
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values
-     * @param string $timezone
-     * @return EE_Message
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * Gets MSG_token
-     *
-     * @return int
-     */
-    public function MSG_token()
-    {
-        return $this->get('MSG_token');
-    }
-
-
-    /**
-     * Sets MSG_token
-     *
-     * @param int $MSG_token
-     */
-    public function set_MSG_token($MSG_token)
-    {
-        $this->set('MSG_token', $MSG_token);
-    }
-
-
-    /**
-     * Gets GRP_ID
-     *
-     * @return int
-     */
-    public function GRP_ID()
-    {
-        return $this->get('GRP_ID');
-    }
-
-
-    /**
-     * Sets GRP_ID
-     *
-     * @param int $GRP_ID
-     */
-    public function set_GRP_ID($GRP_ID)
-    {
-        $this->set('GRP_ID', $GRP_ID);
-    }
-
-
-    /**
-     * Gets TXN_ID
-     *
-     * @return int
-     */
-    public function TXN_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * Sets TXN_ID
-     *
-     * @param int $TXN_ID
-     */
-    public function set_TXN_ID($TXN_ID)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     * Gets messenger
-     *
-     * @return string
-     */
-    public function messenger()
-    {
-        return $this->get('MSG_messenger');
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param string $messenger
-     */
-    public function set_messenger($messenger)
-    {
-        $this->set('MSG_messenger', $messenger);
-    }
-
-
-    /**
-     * Returns corresponding messenger object for the set messenger on this message
-     *
-     * @return EE_messenger | null
-     */
-    public function messenger_object()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * Sets messenger
-     *
-     * @param EE_messenger $messenger
-     */
-    public function set_messenger_object(EE_messenger $messenger)
-    {
-        $this->_messenger = $messenger;
-    }
-
-
-    /**
-     * validates messenger
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_messenger($throw_exceptions = false)
-    {
-        if ($this->_messenger instanceof EE_messenger) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->messenger()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns the set localized label for the messenger on this message.
-     * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function messenger_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
-    }
-
-
-    /**
-     * Gets message_type
-     *
-     * @return string
-     */
-    public function message_type()
-    {
-        return $this->get('MSG_message_type');
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param string $message_type
-     */
-    public function set_message_type($message_type)
-    {
-        $this->set('MSG_message_type', $message_type);
-    }
-
-
-    /**
-     * Returns the message type object for the set message type on this message
-     *
-     * @return EE_message_type | null
-     */
-    public function message_type_object()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * Sets message_type
-     *
-     * @param EE_message_type $message_type
-     * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
-     *                                        the message type or not.
-     */
-    public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
-    {
-        $this->_message_type = $message_type;
-        if ($set_priority) {
-            $this->set_priority($this->_message_type->get_priority());
-        }
-    }
-
-
-    /**
-     * validates message_type
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function valid_message_type($throw_exceptions = false)
-    {
-        if ($this->_message_type instanceof EE_message_type) {
-            return true;
-        }
-        if ($throw_exceptions) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
-                        'event_espresso'
-                    ),
-                    $this->message_type()
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
-     *
-     * @param bool $throw_exceptions
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function is_valid($throw_exceptions = false)
-    {
-        if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * This validates whether the internal messenger and message type objects are valid for sending.
-     * Three checks are done:
-     * 1. There is a valid messenger object.
-     * 2. There is a valid message type object.
-     * 3. The message type object is active for the messenger.
-     *
-     * @throws EE_Error  But only if $throw_exceptions is set to true.
-     * @param bool $throw_exceptions
-     * @return bool
-     */
-    public function is_valid_for_sending_or_generation($throw_exceptions = false)
-    {
-        $valid = false;
-        if ($this->is_valid($throw_exceptions)) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $valid = $message_resource_manager->is_message_type_active_for_messenger(
-                $this->messenger(),
-                $this->message_type()
-            );
-            if (! $valid && $throw_exceptions) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
-                            'event_espresso'
-                        ),
-                        $this->message_type(),
-                        $this->messenger()
-                    )
-                );
-            }
-        }
-        return $valid;
-    }
-
-
-    /**
-     * This returns the set localized label for the message type on this message.
-     * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
-     * with this message.
-     *
-     * @param   bool $plural whether to return the plural label or not.
-     * @return string
-     */
-    public function message_type_label($plural = false)
-    {
-        $label_type = $plural ? 'plural' : 'singular';
-        $message_type = $this->message_type_object();
-        return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
-            : str_replace(
-                '_',
-                ' ',
-                $this->message_type()
-            );
-    }
-
-
-    /**
-     * Gets context
-     *
-     * @return string
-     */
-    public function context()
-    {
-        return $this->get('MSG_context');
-    }
-
-
-    /**
-     * This returns the corresponding localized label for the given context slug, if possible from installed message
-     * types. Otherwise, this will just return the set context slug on this object.
-     *
-     * @return string
-     */
-    public function context_label()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
-    }
-
-
-    /**
-     * Sets context
-     *
-     * @param string $context
-     */
-    public function set_context($context)
-    {
-        $this->set('MSG_context', $context);
-    }
-
-
-    /**
-     * Gets recipient_ID
-     *
-     * @return int
-     */
-    public function recipient_ID()
-    {
-        return $this->get('MSG_recipient_ID');
-    }
-
-
-    /**
-     * Sets recipient_ID
-     *
-     * @param string $recipient_ID
-     */
-    public function set_recipient_ID($recipient_ID)
-    {
-        $this->set('MSG_recipient_ID', $recipient_ID);
-    }
-
-
-    /**
-     * Gets recipient_type
-     *
-     * @return string
-     */
-    public function recipient_type()
-    {
-        return $this->get('MSG_recipient_type');
-    }
-
-
-    /**
-     * Return the related object matching the recipient type and ID.
-     *
-     * @return EE_Base_Class | null
-     */
-    public function recipient_object()
-    {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
-            return null;
-        }
-
-        return $this->get_first_related($this->recipient_type());
-    }
-
-
-    /**
-     * Sets recipient_type
-     *
-     * @param string $recipient_type
-     */
-    public function set_recipient_type($recipient_type)
-    {
-        $this->set('MSG_recipient_type', $recipient_type);
-    }
-
-
-    /**
-     * Gets content
-     *
-     * @return string
-     */
-    public function content()
-    {
-        return $this->get('MSG_content');
-    }
-
-
-    /**
-     * Sets content
-     *
-     * @param string $content
-     */
-    public function set_content($content)
-    {
-        $this->set('MSG_content', $content);
-    }
-
-
-    /**
-     * Gets subject
-     *
-     * @return string
-     */
-    public function subject()
-    {
-        return $this->get('MSG_subject');
-    }
-
-
-    /**
-     * Sets subject
-     *
-     * @param string $subject
-     */
-    public function set_subject($subject)
-    {
-        $this->set('MSG_subject', $subject);
-    }
-
-
-    /**
-     * Gets to
-     *
-     * @return string
-     */
-    public function to()
-    {
-        $to = $this->get('MSG_to');
-        return empty($to) ? __('No recipient', 'event_espresso') : $to;
-    }
-
-
-    /**
-     * Sets to
-     *
-     * @param string $to
-     */
-    public function set_to($to)
-    {
-        $this->set('MSG_to', $to);
-    }
-
-
-    /**
-     * Gets from
-     *
-     * @return string
-     */
-    public function from()
-    {
-        return $this->get('MSG_from');
-    }
-
-
-    /**
-     * Sets from
-     *
-     * @param string $from
-     */
-    public function set_from($from)
-    {
-        $this->set('MSG_from', $from);
-    }
-
-
-    /**
-     * Gets priority
-     *
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->get('MSG_priority');
-    }
-
-
-    /**
-     * Sets priority
-     * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
-     * this method calls the send_now method to verify that.
-     *
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $priority = $this->send_now() ? EEM_Message::priority_high : $priority;
-        parent::set('MSG_priority', $priority);
-    }
-
-
-    /**
-     * Overrides parent::set method so we can capture any sets for priority.
-     *
-     * @see parent::set() for phpdocs
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        if ($field_name === 'MSG_priority') {
-            $this->set_priority($field_value);
-        }
-        parent::set($field_name, $field_value, $use_default);
-    }
-
-
-    /**
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function send_now()
-    {
-        $send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
-            : $this->priority();
-        return $send_now === EEM_Message::priority_high ? true : false;
-    }
-
-
-    /**
-     * Gets STS_ID
-     *
-     * @return string
-     */
-    public function STS_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Sets STS_ID
-     *
-     * @param string $STS_ID
-     */
-    public function set_STS_ID($STS_ID)
-    {
-        $this->set('STS_ID', $STS_ID);
-    }
-
-
-    /**
-     * Gets created
-     *
-     * @return string
-     */
-    public function created()
-    {
-        return $this->get('MSG_created');
-    }
-
-
-    /**
-     * Sets created
-     *
-     * @param string $created
-     */
-    public function set_created($created)
-    {
-        $this->set('MSG_created', $created);
-    }
-
-
-    /**
-     * Gets modified
-     *
-     * @return string
-     */
-    public function modified()
-    {
-        return $this->get('MSG_modified');
-    }
-
-
-    /**
-     * Sets modified
-     *
-     * @param string $modified
-     */
-    public function set_modified($modified)
-    {
-        $this->set('MSG_modified', $modified);
-    }
-
-
-    /**
-     * Sets generation data for this message.
-     *
-     * @param mixed $data
-     */
-    public function set_generation_data($data)
-    {
-        $this->set_field_or_extra_meta('MSG_generation_data', $data);
-    }
-
-
-    /**
-     * Returns any set generation data for this message.
-     *
-     * @return mixed|null
-     */
-    public function get_generation_data()
-    {
-        return $this->get_field_or_extra_meta('MSG_generation_data');
-    }
-
-
-    /**
-     * Gets any error message.
-     *
-     * @return mixed|null
-     */
-    public function error_message()
-    {
-        return $this->get_field_or_extra_meta('MSG_error');
-    }
-
-
-    /**
-     * Sets an error message.
-     *
-     * @param $message
-     * @return bool|int
-     */
-    public function set_error_message($message)
-    {
-        return $this->set_field_or_extra_meta('MSG_error', $message);
-    }
-
-
-    /**
-     * This retrieves the associated template pack with this message.
-     *
-     * @return EE_Messages_Template_Pack | null
-     */
-    public function get_template_pack()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_pack)) {
-            return $this->template_pack;
-        }
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
-    }
-
-
-    /**
-     * Retrieves the variation used for generating this message.
-     *
-     * @return string
-     */
-    public function get_template_pack_variation()
-    {
-        /**
-         * This is deprecated functionality that will be removed eventually but included here now for backward compat.
-         */
-        if (! empty($this->template_variation)) {
-            return $this->template_variation;
-        }
-
-        /** @type EE_Message_Template_Group $grp */
-        $grp = $this->get_first_related('Message_Template_Group');
-
-        // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
-            $grp = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->messenger(),
-                        'MTP_message_type' => $this->message_type(),
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-        }
-
-        return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        EE_Registry::instance()->load_helper('MSG_Template');
-        switch ($this->STS_ID()) {
-            case EEM_Message::status_failed:
-            case EEM_Message::status_debug_only:
-                return EEH_MSG_Template::generate_error_display_trigger($this);
-                break;
-
-            case EEM_Message::status_sent:
-                return EEH_MSG_Template::generate_browser_trigger($this);
-                break;
-
-            default:
-                return '';
-        }
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     */
-    public function get_admin_settings_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'settings',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_messages',
-                'action' => 'default',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
-     * it.
-     * Note this also SAVES the current message object to the db because it adds an error message to accompany the
-     * status.
-     *
-     */
-    public function set_messenger_is_executing()
-    {
-        $this->set_STS_ID(EEM_Message::status_messenger_executing);
-        $this->set_error_message(
-            esc_html__(
-                'A message with this status indicates that there was a problem that occurred while the message was being
+	/**
+	 * @deprecated 4.9.0  Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_pack;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type null
+	 */
+	public $template_variation;
+
+	/**
+	 * @deprecated 4.9.0 Added for backward compat with add-on's
+	 * @type string
+	 */
+	public $content = '';
+
+
+	/**
+	 * @type EE_messenger $_messenger
+	 */
+	protected $_messenger = null;
+
+	/**
+	 * @type EE_message_type $_message_type
+	 */
+	protected $_message_type = null;
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @param array  $date_formats incoming date formats in an array.  First value is the date_format, second is time
+	 *                             format.
+	 * @return EE_Message
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		// if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
+		if (! $has_object) {
+			EE_Registry::instance()->load_helper('URL');
+			$props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
+		}
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values
+	 * @param string $timezone
+	 * @return EE_Message
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * Gets MSG_token
+	 *
+	 * @return int
+	 */
+	public function MSG_token()
+	{
+		return $this->get('MSG_token');
+	}
+
+
+	/**
+	 * Sets MSG_token
+	 *
+	 * @param int $MSG_token
+	 */
+	public function set_MSG_token($MSG_token)
+	{
+		$this->set('MSG_token', $MSG_token);
+	}
+
+
+	/**
+	 * Gets GRP_ID
+	 *
+	 * @return int
+	 */
+	public function GRP_ID()
+	{
+		return $this->get('GRP_ID');
+	}
+
+
+	/**
+	 * Sets GRP_ID
+	 *
+	 * @param int $GRP_ID
+	 */
+	public function set_GRP_ID($GRP_ID)
+	{
+		$this->set('GRP_ID', $GRP_ID);
+	}
+
+
+	/**
+	 * Gets TXN_ID
+	 *
+	 * @return int
+	 */
+	public function TXN_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * Sets TXN_ID
+	 *
+	 * @param int $TXN_ID
+	 */
+	public function set_TXN_ID($TXN_ID)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 * Gets messenger
+	 *
+	 * @return string
+	 */
+	public function messenger()
+	{
+		return $this->get('MSG_messenger');
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param string $messenger
+	 */
+	public function set_messenger($messenger)
+	{
+		$this->set('MSG_messenger', $messenger);
+	}
+
+
+	/**
+	 * Returns corresponding messenger object for the set messenger on this message
+	 *
+	 * @return EE_messenger | null
+	 */
+	public function messenger_object()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * Sets messenger
+	 *
+	 * @param EE_messenger $messenger
+	 */
+	public function set_messenger_object(EE_messenger $messenger)
+	{
+		$this->_messenger = $messenger;
+	}
+
+
+	/**
+	 * validates messenger
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($throw_exceptions = false)
+	{
+		if ($this->_messenger instanceof EE_messenger) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" messenger set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->messenger()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns the set localized label for the messenger on this message.
+	 * Note, if unable to retrieve the EE_messenger object then will just return the messenger slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function messenger_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$messenger = $this->messenger_object();
+		return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+	}
+
+
+	/**
+	 * Gets message_type
+	 *
+	 * @return string
+	 */
+	public function message_type()
+	{
+		return $this->get('MSG_message_type');
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param string $message_type
+	 */
+	public function set_message_type($message_type)
+	{
+		$this->set('MSG_message_type', $message_type);
+	}
+
+
+	/**
+	 * Returns the message type object for the set message type on this message
+	 *
+	 * @return EE_message_type | null
+	 */
+	public function message_type_object()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * Sets message_type
+	 *
+	 * @param EE_message_type $message_type
+	 * @param bool            $set_priority   This indicates whether to set the priority to whatever the priority is on
+	 *                                        the message type or not.
+	 */
+	public function set_message_type_object(EE_message_type $message_type, $set_priority = false)
+	{
+		$this->_message_type = $message_type;
+		if ($set_priority) {
+			$this->set_priority($this->_message_type->get_priority());
+		}
+	}
+
+
+	/**
+	 * validates message_type
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($throw_exceptions = false)
+	{
+		if ($this->_message_type instanceof EE_message_type) {
+			return true;
+		}
+		if ($throw_exceptions) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The %1$s message type set for this message is missing or invalid. Please double-check the spelling and verify that the correct files exist.',
+						'event_espresso'
+					),
+					$this->message_type()
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * validates messenger and message_type (that they are valid EE_messenger and EE_message_type objects).
+	 *
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function is_valid($throw_exceptions = false)
+	{
+		if ($this->valid_messenger($throw_exceptions) && $this->valid_message_type($throw_exceptions)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * This validates whether the internal messenger and message type objects are valid for sending.
+	 * Three checks are done:
+	 * 1. There is a valid messenger object.
+	 * 2. There is a valid message type object.
+	 * 3. The message type object is active for the messenger.
+	 *
+	 * @throws EE_Error  But only if $throw_exceptions is set to true.
+	 * @param bool $throw_exceptions
+	 * @return bool
+	 */
+	public function is_valid_for_sending_or_generation($throw_exceptions = false)
+	{
+		$valid = false;
+		if ($this->is_valid($throw_exceptions)) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$valid = $message_resource_manager->is_message_type_active_for_messenger(
+				$this->messenger(),
+				$this->message_type()
+			);
+			if (! $valid && $throw_exceptions) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The %1$s message type is not a valid message type for the %2$s messenger so it will not be sent.',
+							'event_espresso'
+						),
+						$this->message_type(),
+						$this->messenger()
+					)
+				);
+			}
+		}
+		return $valid;
+	}
+
+
+	/**
+	 * This returns the set localized label for the message type on this message.
+	 * Note, if unable to retrieve the EE_message_type object then will just return the message type slug saved
+	 * with this message.
+	 *
+	 * @param   bool $plural whether to return the plural label or not.
+	 * @return string
+	 */
+	public function message_type_label($plural = false)
+	{
+		$label_type = $plural ? 'plural' : 'singular';
+		$message_type = $this->message_type_object();
+		return $message_type instanceof EE_message_type
+			? $message_type->label[ $label_type ]
+			: str_replace(
+				'_',
+				' ',
+				$this->message_type()
+			);
+	}
+
+
+	/**
+	 * Gets context
+	 *
+	 * @return string
+	 */
+	public function context()
+	{
+		return $this->get('MSG_context');
+	}
+
+
+	/**
+	 * This returns the corresponding localized label for the given context slug, if possible from installed message
+	 * types. Otherwise, this will just return the set context slug on this object.
+	 *
+	 * @return string
+	 */
+	public function context_label()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$contexts = $message_resource_manager->get_all_contexts();
+		return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+	}
+
+
+	/**
+	 * Sets context
+	 *
+	 * @param string $context
+	 */
+	public function set_context($context)
+	{
+		$this->set('MSG_context', $context);
+	}
+
+
+	/**
+	 * Gets recipient_ID
+	 *
+	 * @return int
+	 */
+	public function recipient_ID()
+	{
+		return $this->get('MSG_recipient_ID');
+	}
+
+
+	/**
+	 * Sets recipient_ID
+	 *
+	 * @param string $recipient_ID
+	 */
+	public function set_recipient_ID($recipient_ID)
+	{
+		$this->set('MSG_recipient_ID', $recipient_ID);
+	}
+
+
+	/**
+	 * Gets recipient_type
+	 *
+	 * @return string
+	 */
+	public function recipient_type()
+	{
+		return $this->get('MSG_recipient_type');
+	}
+
+
+	/**
+	 * Return the related object matching the recipient type and ID.
+	 *
+	 * @return EE_Base_Class | null
+	 */
+	public function recipient_object()
+	{
+		if (! $this->recipient_type() || ! $this->recipient_ID()) {
+			return null;
+		}
+
+		return $this->get_first_related($this->recipient_type());
+	}
+
+
+	/**
+	 * Sets recipient_type
+	 *
+	 * @param string $recipient_type
+	 */
+	public function set_recipient_type($recipient_type)
+	{
+		$this->set('MSG_recipient_type', $recipient_type);
+	}
+
+
+	/**
+	 * Gets content
+	 *
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->get('MSG_content');
+	}
+
+
+	/**
+	 * Sets content
+	 *
+	 * @param string $content
+	 */
+	public function set_content($content)
+	{
+		$this->set('MSG_content', $content);
+	}
+
+
+	/**
+	 * Gets subject
+	 *
+	 * @return string
+	 */
+	public function subject()
+	{
+		return $this->get('MSG_subject');
+	}
+
+
+	/**
+	 * Sets subject
+	 *
+	 * @param string $subject
+	 */
+	public function set_subject($subject)
+	{
+		$this->set('MSG_subject', $subject);
+	}
+
+
+	/**
+	 * Gets to
+	 *
+	 * @return string
+	 */
+	public function to()
+	{
+		$to = $this->get('MSG_to');
+		return empty($to) ? __('No recipient', 'event_espresso') : $to;
+	}
+
+
+	/**
+	 * Sets to
+	 *
+	 * @param string $to
+	 */
+	public function set_to($to)
+	{
+		$this->set('MSG_to', $to);
+	}
+
+
+	/**
+	 * Gets from
+	 *
+	 * @return string
+	 */
+	public function from()
+	{
+		return $this->get('MSG_from');
+	}
+
+
+	/**
+	 * Sets from
+	 *
+	 * @param string $from
+	 */
+	public function set_from($from)
+	{
+		$this->set('MSG_from', $from);
+	}
+
+
+	/**
+	 * Gets priority
+	 *
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->get('MSG_priority');
+	}
+
+
+	/**
+	 * Sets priority
+	 * Note.  Send Now Messengers always override any priority that may be set on a Message.  So
+	 * this method calls the send_now method to verify that.
+	 *
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$priority = $this->send_now() ? EEM_Message::priority_high : $priority;
+		parent::set('MSG_priority', $priority);
+	}
+
+
+	/**
+	 * Overrides parent::set method so we can capture any sets for priority.
+	 *
+	 * @see parent::set() for phpdocs
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		if ($field_name === 'MSG_priority') {
+			$this->set_priority($field_value);
+		}
+		parent::set($field_name, $field_value, $use_default);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function send_now()
+	{
+		$send_now = $this->valid_messenger() && $this->messenger_object()->send_now() ? EEM_Message::priority_high
+			: $this->priority();
+		return $send_now === EEM_Message::priority_high ? true : false;
+	}
+
+
+	/**
+	 * Gets STS_ID
+	 *
+	 * @return string
+	 */
+	public function STS_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Sets STS_ID
+	 *
+	 * @param string $STS_ID
+	 */
+	public function set_STS_ID($STS_ID)
+	{
+		$this->set('STS_ID', $STS_ID);
+	}
+
+
+	/**
+	 * Gets created
+	 *
+	 * @return string
+	 */
+	public function created()
+	{
+		return $this->get('MSG_created');
+	}
+
+
+	/**
+	 * Sets created
+	 *
+	 * @param string $created
+	 */
+	public function set_created($created)
+	{
+		$this->set('MSG_created', $created);
+	}
+
+
+	/**
+	 * Gets modified
+	 *
+	 * @return string
+	 */
+	public function modified()
+	{
+		return $this->get('MSG_modified');
+	}
+
+
+	/**
+	 * Sets modified
+	 *
+	 * @param string $modified
+	 */
+	public function set_modified($modified)
+	{
+		$this->set('MSG_modified', $modified);
+	}
+
+
+	/**
+	 * Sets generation data for this message.
+	 *
+	 * @param mixed $data
+	 */
+	public function set_generation_data($data)
+	{
+		$this->set_field_or_extra_meta('MSG_generation_data', $data);
+	}
+
+
+	/**
+	 * Returns any set generation data for this message.
+	 *
+	 * @return mixed|null
+	 */
+	public function get_generation_data()
+	{
+		return $this->get_field_or_extra_meta('MSG_generation_data');
+	}
+
+
+	/**
+	 * Gets any error message.
+	 *
+	 * @return mixed|null
+	 */
+	public function error_message()
+	{
+		return $this->get_field_or_extra_meta('MSG_error');
+	}
+
+
+	/**
+	 * Sets an error message.
+	 *
+	 * @param $message
+	 * @return bool|int
+	 */
+	public function set_error_message($message)
+	{
+		return $this->set_field_or_extra_meta('MSG_error', $message);
+	}
+
+
+	/**
+	 * This retrieves the associated template pack with this message.
+	 *
+	 * @return EE_Messages_Template_Pack | null
+	 */
+	public function get_template_pack()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_pack)) {
+			return $this->template_pack;
+		}
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack() : null;
+	}
+
+
+	/**
+	 * Retrieves the variation used for generating this message.
+	 *
+	 * @return string
+	 */
+	public function get_template_pack_variation()
+	{
+		/**
+		 * This is deprecated functionality that will be removed eventually but included here now for backward compat.
+		 */
+		if (! empty($this->template_variation)) {
+			return $this->template_variation;
+		}
+
+		/** @type EE_Message_Template_Group $grp */
+		$grp = $this->get_first_related('Message_Template_Group');
+
+		// if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
+		if (! $grp instanceof EE_Message_Template_Group) {
+			$grp = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->messenger(),
+						'MTP_message_type' => $this->message_type(),
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+		}
+
+		return $grp instanceof EE_Message_Template_Group ? $grp->get_template_pack_variation() : '';
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		EE_Registry::instance()->load_helper('MSG_Template');
+		switch ($this->STS_ID()) {
+			case EEM_Message::status_failed:
+			case EEM_Message::status_debug_only:
+				return EEH_MSG_Template::generate_error_display_trigger($this);
+				break;
+
+			case EEM_Message::status_sent:
+				return EEH_MSG_Template::generate_browser_trigger($this);
+				break;
+
+			default:
+				return '';
+		}
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 */
+	public function get_admin_settings_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'settings',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_messages',
+				'action' => 'default',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * This sets the EEM_Message::status_messenger_executing class on the message and the appropriate error message for
+	 * it.
+	 * Note this also SAVES the current message object to the db because it adds an error message to accompany the
+	 * status.
+	 *
+	 */
+	public function set_messenger_is_executing()
+	{
+		$this->set_STS_ID(EEM_Message::status_messenger_executing);
+		$this->set_error_message(
+			esc_html__(
+				'A message with this status indicates that there was a problem that occurred while the message was being
                 processed by the messenger.  It is still possible that the message was sent successfully, but at some
                 point during the processing there was a failure.  This usually is indicative of a timeout issue with PHP 
                 or memory limits being reached.  If you see this repeatedly you may want to consider upgrading the memory 
                 available to PHP on your server.',
-                'event_espresso'
-            )
-        );
-    }
+				'event_espresso'
+			)
+		);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -51,7 +51,7 @@ 
     {
         $has_object = parent::_check_for_object($props_n_values, __CLASS__);
         // if object doesn't exist, let's generate a unique token on instantiation so that its available even before saving to db.
-        if (! $has_object) {
+        if ( ! $has_object) {
             EE_Registry::instance()->load_helper('URL');
             $props_n_values['MSG_token'] = EEH_URL::generate_unique_token();
         }
@@ -219,7 +219,7 @@ 
     {
         $label_type = $plural ? 'plural' : 'singular';
         $messenger = $this->messenger_object();
-        return $messenger instanceof EE_messenger ? $messenger->label[ $label_type ] : $this->messenger();
+        return $messenger instanceof EE_messenger ? $messenger->label[$label_type] : $this->messenger();
     }
 
 
@@ -336,7 +336,7 @@ 
                 $this->messenger(),
                 $this->message_type()
             );
-            if (! $valid && $throw_exceptions) {
+            if ( ! $valid && $throw_exceptions) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -366,7 +366,7 @@ 
         $label_type = $plural ? 'plural' : 'singular';
         $message_type = $this->message_type_object();
         return $message_type instanceof EE_message_type
-            ? $message_type->label[ $label_type ]
+            ? $message_type->label[$label_type]
             : str_replace(
                 '_',
                 ' ',
@@ -397,7 +397,7 @@ 
         /** @type EE_Message_Resource_Manager $message_resource_manager */
         $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $contexts = $message_resource_manager->get_all_contexts();
-        return isset($contexts[ $this->context() ]) ? $contexts[ $this->context() ] : $this->context();
+        return isset($contexts[$this->context()]) ? $contexts[$this->context()] : $this->context();
     }
 
 
@@ -452,7 +452,7 @@ 
      */
     public function recipient_object()
     {
-        if (! $this->recipient_type() || ! $this->recipient_ID()) {
+        if ( ! $this->recipient_type() || ! $this->recipient_ID()) {
             return null;
         }
 
@@ -736,13 +736,13 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_pack)) {
+        if ( ! empty($this->template_pack)) {
             return $this->template_pack;
         }
         /** @type EE_Message_Template_Group $grp */
         $grp = $this->get_first_related('Message_Template_Group');
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -768,7 +768,7 @@ 
         /**
          * This is deprecated functionality that will be removed eventually but included here now for backward compat.
          */
-        if (! empty($this->template_variation)) {
+        if ( ! empty($this->template_variation)) {
             return $this->template_variation;
         }
 
@@ -776,7 +776,7 @@ 
         $grp = $this->get_first_related('Message_Template_Group');
 
         // if no group then let's try to get the first related group by internal messenger and message type (will use global grp).
-        if (! $grp instanceof EE_Message_Template_Group) {
+        if ( ! $grp instanceof EE_Message_Template_Group) {
             $grp = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(

core/db_classes/EE_CSV.class.php

Indentation +669 added lines, -669 removed lines

@@ -16,673 +16,673 @@
 class EE_CSV
 {
 
-    // instance of the EE_CSV object
-    private static $_instance = null;
-
-
-    // multidimensional array to store update & error messages
-    // var $_notices = array( 'updates' => array(), 'errors' => array() );
-
-
-    private $_primary_keys;
-
-    /**
-     *
-     * @var EE_Registry
-     */
-    private $EE;
-    /**
-     * string used for 1st cell in exports, which indicates that the following 2 rows will be metadata keys and values
-     */
-    const metadata_header = 'Event Espresso Export Meta Data';
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        global $wpdb;
-
-        $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('id'),
-        );
-    }
-
-
-    /**
-     *        @ singleton method used to instantiate class object
-     *        @ access public
-     *
-     * @return EE_CSV
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Opens a unicode or utf file (normal file_get_contents has difficulty readin ga unicode file. @see
-     * http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
-     *
-     * @param string $file_path
-     * @return string
-     * @throws EE_Error
-     */
-    private function read_unicode_file($file_path)
-    {
-        $fc = "";
-        $fh = fopen($file_path, "rb");
-        if (! $fh) {
-            throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
-        }
-        $flen = filesize($file_path);
-        $bc = fread($fh, $flen);
-        for ($i = 0; $i < $flen; $i++) {
-            $c = substr($bc, $i, 1);
-            if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
-            }
-        }
-        if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
-            $fc = substr($fc, 2);
-        }
-        return ($fc);
-    }
-
-
-    /**
-     * Generic CSV-functionality to turn an entire CSV file into a single array that's
-     * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
-     * representing each row in the CSV file, and the second-level arrays being each column in that row
-     *
-     * @param string $path_to_file
-     * @return array of arrays. Top-level array has rows, second-level array has each item
-     */
-    public function import_csv_to_multi_dimensional_array($path_to_file)
-    {
-        // needed to deal with Mac line endings
-        ini_set('auto_detect_line_endings', true);
-
-        // because fgetcsv does not correctly deal with backslashed quotes such as \"
-        // we'll read the file into a string
-        $file_contents = $this->read_unicode_file($path_to_file);
-        // replace backslashed quotes with CSV enclosures
-        $file_contents = str_replace('\\"', '"""', $file_contents);
-        // HEY YOU! PUT THAT FILE BACK!!!
-        file_put_contents($path_to_file, $file_contents);
-
-        if (($file_handle = fopen($path_to_file, "r")) !== false) {
-            # Set the parent multidimensional array key to 0.
-            $nn = 0;
-            $csvarray = array();
-
-            // in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions of fgetcsv choke if passed more than 4 - is that crazy or what?
-            if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-                //  PHP 5.2- version
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"')) !== false) {
-                    $csvarray[] = $data;
-                }
-            } else {
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
-                    $csvarray[] = $data;
-                }
-            }
-            # Close the File.
-            fclose($file_handle);
-            return $csvarray;
-        } else {
-            EE_Error::add_error(
-                sprintf(__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * @Import contents of csv file and store values in an array to be manipulated by other functions
-     * @access public
-     * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
-     *                                      If $model_name is provided, assumes that each row in the CSV represents a
-     *                                      model object for that model If $model_name ISN'T provided, assumes that
-     *                                      before model object data, there is a row where the first entry is simply
-     *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
-     *                                      then maybe a row of headers, and then the model data. Eg.
-     *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
-     *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
-     *                                      Forest
-     * @param string  $model_name           model name if we know what model we're importing
-     * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
-     *                                      data
-     * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
-     *               error message like the following array('Event'=>array( array('EVT_ID'=>1,'EVT_name'=>'bob
-     *               party',...), array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
-     *                                      ...
-     *                                      )
-     *                                      'Venue'=>array(
-     *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
-     *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
-     *                                      ...
-     *                                      )
-     *                                      ...
-     *                                      )
-     */
-    public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
-    {
-        $multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
-        if (! $multi_dimensional_array) {
-            return false;
-        }
-        // gotta start somewhere
-        $row = 1;
-        // array to store csv data in
-        $ee_formatted_data = array();
-        // array to store headers (column names)
-        $headers = array();
-        foreach ($multi_dimensional_array as $data) {
-            // if first cell is MODEL, then second cell is the MODEL name
-            if ($data[0] == 'MODEL') {
-                $model_name = $data[1];
-                // don't bother looking for model data in this row. The rest of this
-                // row should be blank
-                // AND pretend this is the first row again
-                $row = 1;
-                // reset headers
-                $headers = array();
-                continue;
-            }
-            if (strpos($data[0], EE_CSV::metadata_header) !== false) {
-                $model_name = EE_CSV::metadata_header;
-                // store like model data, we just won't try importing it etc.
-                $row = 1;
-                continue;
-            }
-
-
-            // how many columns are there?
-            $columns = count($data);
-
-            $model_entry = array();
-            // loop through each column
-            for ($i = 0; $i < $columns; $i++) {
-                // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
-                // do we need to grab the column names?
-                if ($row === 1) {
-                    if ($first_row_is_headers) {
-                        // store the column names to use for keys
-                        $column_name = $data[ $i ];
-                        // check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
-                            continue;
-                        }
-                        $matches = array();
-                        if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
-                        } else {
-                            // now get the db table name from it (the part between square brackets)
-                            $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        __(
-                                            "The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
-                                            "event_espresso"
-                                        ),
-                                        $column_name,
-                                        implode(",", $data)
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                            $headers[ $i ] = $matches[2];
-                        }
-                    } else {
-                        // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ] = $i;
-                    }
-                    // and we need to store csv data
-                } else {
-                    // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                    }
-                }
-            }
-            // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
-            }
-            // advance to next row
-            $row++;
-        }
-
-        // delete the uploaded file
-        unlink($path_to_file);
-        // echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
-        // die();
-
-        // it's good to give back
-        return $ee_formatted_data;
-    }
-
-
-    public function save_csv_to_db($csv_data_array, $model_name = false)
-    {
-        EE_Error::doing_it_wrong(
-            'save_csv_to_db',
-            __(
-                'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
-    }
-
-    /**
-     * Sends HTTP headers to indicate that the browser should download a file,
-     * and starts writing the file to PHP's output. Returns the file handle so other functions can
-     * also write to it
-     *
-     * @param string $new_filename the name of the file that the user will download
-     * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
-     */
-    public function begin_sending_csv($filename)
-    {
-        // grab file extension
-        $ext = substr(strrchr($filename, '.'), 1);
-        if ($ext == '.csv' or $ext == '.xls') {
-            str_replace($ext, '', $filename);
-        }
-        $filename .= '.csv';
-
-        // if somebody's been naughty and already started outputting stuff, trash it
-        // and start writing our stuff.
-        if (ob_get_length()) {
-            @ob_flush();
-            @flush();
-            @ob_end_flush();
-        }
-        @ob_start();
-        header("Pragma: public");
-        header("Expires: 0");
-        header("Pragma: no-cache");
-        header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
-        // header("Content-Type: application/force-download");
-        // header("Content-Type: application/octet-stream");
-        // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
-        header("Content-Type: text/csv; charset=utf-8");
-        do_action('AHEE__EE_CSV__begin_sending_csv__headers');
-        echo apply_filters(
-            'FHEE__EE_CSV__begin_sending_csv__start_writing',
-            "\xEF\xBB\xBF"
-        ); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
-        $fh = fopen('php://output', 'w');
-        return $fh;
-    }
-
-    /**
-     * Writes some meta data to the CSV as a bunch of columns. Initially we're only
-     * mentioning the version and timezone
-     *
-     * @param resource $filehandle
-     */
-    public function write_metadata_to_csv($filehandle)
-    {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
-        $this->fputcsv2($filehandle, $data_row);
-        $meta_data = array(
-            0 => array(
-                'version'        => espresso_version(),
-                'timezone'       => EEH_DTT_Helper::get_timezone(),
-                'time_of_export' => current_time('mysql'),
-                'site_url'       => site_url(),
-            ),
-        );
-        $this->write_data_array_to_csv($filehandle, $meta_data);
-    }
-
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
-     *                                      by string
-     * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
-     *                                      headers in the CSV. Eg, if $data looked like
-     *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
-     *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
-     * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
-     *                 (because we wrote everything there was...nothing)
-     */
-    public function write_data_array_to_csv($filehandle, $data)
-    {
-
-
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "top-level array must be numerically indexed. Does these look like numbers to you? %s",
-                            "event_espresso"
-                        ),
-                        implode(",", array_keys($data))
-                    )
-                );
-            }
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if (EEH_Array::is_associative_array($item_in_top_level_array)) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                echo $this->fputcsv2($filehandle, $keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                echo $this->fputcsv2($filehandle, $data_row);
-            }
-            return true;
-        } else {
-            // no data TO write... so we can assume that's a success
-            return true;
-        }
-        // //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
-        //
-        //
-        // $no_table = TRUE;
-        //
-        // // loop through data and add each row to the file/stream as csv
-        // foreach ( $data as $model_name => $model_data ) {
-        // // test first row to see if it is data or a model name
-        // $model = EE_Registry::instance();->load_model($model_name);
-        // //if the model really exists,
-        // if ( $model ) {
-        //
-        // // we have a table name
-        // $no_table = FALSE;
-        //
-        // // put the tablename into an array cuz that's how fputcsv rolls
-        // $model_name_row = array( 'MODEL', $model_name );
-        //
-        // // add table name to csv output
-        // echo self::fputcsv2($filehandle, $model_name_row);
-        //
-        // // now get the rest of the data
-        // foreach ( $model_data as $row ) {
-        // // output the row
-        // echo self::fputcsv2($filehandle, $row);
-        // }
-        //
-        // }
-        //
-        // if ( $no_table ) {
-        // // no table so just put the data
-        // echo self::fputcsv2($filehandle, $model_data);
-        // }
-        //
-        // } // END OF foreach ( $data )
-    }
-
-    /**
-     * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
-     * Calls exit to prevent polluting the CSV file with other junk
-     *
-     * @param resource $fh filehandle where we're writing the CSV to
-     */
-    public function end_sending_csv($fh)
-    {
-        fclose($fh);
-        exit(0);
-    }
-
-    /**
-     * Given an open file, writes all the model data to it in the format the importer expects.
-     * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($filehandle).
-     *
-     * @param resource $filehandle
-     * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
-     *                                   next layer is numerically indexed to represent each model object (eg, each
-     *                                   individual event), and the last layer has all the attributes o fthat model
-     *                                   object (eg, the event's id, name, etc)
-     * @return boolean success
-     */
-    public function write_model_data_to_csv($filehandle, $model_data_array)
-    {
-        $this->write_metadata_to_csv($filehandle);
-        foreach ($model_data_array as $model_name => $model_instance_arrays) {
-            // first: output a special row stating the model
-            echo $this->fputcsv2($filehandle, array('MODEL', $model_name));
-            // if we have items to put in the CSV, do it normally
-
-            if (! empty($model_instance_arrays)) {
-                $this->write_data_array_to_csv($filehandle, $model_instance_arrays);
-            } else {
-                // echo "no data to write... so just write the headers";
-                // so there's actually NO model objects for that model.
-                // probably still want to show the columns
-                $model = EE_Registry::instance()->load_model($model_name);
-                $column_names = array();
-                foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
-                }
-                $this->write_data_array_to_csv($filehandle, array($column_names));
-            }
-        }
-    }
-
-    /**
-     * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
-     * and dies (in order to avoid other plugins from messing up the csv output)
-     *
-     * @param string $filename         the filename you want to give the file
-     * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
-     * @return bool | void writes CSV file to output and dies
-     */
-    public function export_multiple_model_data_to_csv($filename, $model_data_array)
-    {
-        $filehandle = $this->begin_sending_csv($filename);
-        $this->write_model_data_to_csv($filehandle, $model_data_array);
-        $this->end_sending_csv($filehandle);
-    }
-
-    /**
-     * @Export contents of an array to csv file
-     * @access public
-     * @param array  $data     - the array of data to be converted to csv and exported
-     * @param string $filename - name for newly created csv file
-     * @return TRUE on success, FALSE on fail
-     */
-    public function export_array_to_csv($data = false, $filename = false)
-    {
-
-        // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
-            return false;
-        }
-
-        // no filename?? get outta here
-        if (! $filename) {
-            return false;
-        }
-
-
-        // somebody told me i might need this ???
-        global $wpdb;
-        $prefix = $wpdb->prefix;
-
-
-        $fh = $this->begin_sending_csv($filename);
-
-
-        $this->end_sending_csv($fh);
-    }
-
-
-    /**
-     * @Determine the maximum upload file size based on php.ini settings
-     * @access    public
-     * @param int $percent_of_max - desired percentage of the max upload_mb
-     * @return int KB
-     */
-    public function get_max_upload_size($percent_of_max = false)
-    {
-
-        $max_upload = (int) (ini_get('upload_max_filesize'));
-        $max_post = (int) (ini_get('post_max_size'));
-        $memory_limit = (int) (ini_get('memory_limit'));
-
-        // determine the smallest of the three values from above
-        $upload_mb = min($max_upload, $max_post, $memory_limit);
-
-        // convert MB to KB
-        $upload_mb = $upload_mb * 1024;
-
-        // don't want the full monty? then reduce the max uplaod size
-        if ($percent_of_max) {
-            // is percent_of_max like this -> 50 or like this -> 0.50 ?
-            if ($percent_of_max > 1) {
-                // chnages 50 to 0.50
-                $percent_of_max = $percent_of_max / 100;
-            }
-            // make upload_mb a percentage of the max upload_mb
-            $upload_mb = $upload_mb * $percent_of_max;
-        }
-
-        return $upload_mb;
-    }
-
-
-    /**
-     * @Drop   in replacement for PHP's fputcsv function - but this one works!!!
-     * @access private
-     * @param resource $fh         - file handle - what we are writing to
-     * @param array    $row        - individual row of csv data
-     * @param string   $delimiter  - csv delimiter
-     * @param string   $enclosure  - csv enclosure
-     * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     * @return void
-     */
-    private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = array();
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
-                : $field_value;
-        }
-
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
-    }
-
-
-    // /**
-    //  * @CSV    Import / Export messages
-    //  * @access public
-    //  * @return void
-    //  */
-    // public function csv_admin_notices()
-    // {
-    //
-    //     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
-    //     foreach (array('updates', 'errors') as $type) {
-    //
-    //         // if particular notice type is not empty, then "You've got Mail"
-    //         if (! empty($this->_notices[ $type ])) {
-    //
-    //             // is it an update or an error ?
-    //             $msg_class = $type == 'updates' ? 'updated' : 'error';
-    //             echo '<div id="message" class="' . $msg_class . '">';
-    //             // display each notice, however many that may be
-    //             foreach ($this->_notices[ $type ] as $message) {
-    //                 echo '<p>' . $message . '</p>';
-    //             }
-    //             // wrap it up
-    //             echo '</div>';
-    //         }
-    //     }
-    // }
-
-    /**
-     * Gets the date format to use in teh csv. filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_date_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-    /**
-     * Gets the time format we want to use in CSV reports. Filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_time_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	// instance of the EE_CSV object
+	private static $_instance = null;
+
+
+	// multidimensional array to store update & error messages
+	// var $_notices = array( 'updates' => array(), 'errors' => array() );
+
+
+	private $_primary_keys;
+
+	/**
+	 *
+	 * @var EE_Registry
+	 */
+	private $EE;
+	/**
+	 * string used for 1st cell in exports, which indicates that the following 2 rows will be metadata keys and values
+	 */
+	const metadata_header = 'Event Espresso Export Meta Data';
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		global $wpdb;
+
+		$this->_primary_keys = array(
+			$wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
+			$wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
+			$wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
+			$wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
+			$wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
+			$wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
+			$wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
+			$wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
+			$wpdb->prefix . 'esp_question'                => array('QST_ID'),
+			$wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
+			$wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
+			$wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
+			$wpdb->prefix . 'esp_registration'            => array('REG_ID'),
+			$wpdb->prefix . 'esp_status'                  => array('STS_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'events_detail'               => array('id'),
+			$wpdb->prefix . 'events_category_detail'      => array('id'),
+			$wpdb->prefix . 'events_category_rel'         => array('id'),
+			$wpdb->prefix . 'events_venue'                => array('id'),
+			$wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
+			$wpdb->prefix . 'events_locale'               => array('id'),
+			$wpdb->prefix . 'events_locale_rel'           => array('id'),
+			$wpdb->prefix . 'events_personnel'            => array('id'),
+			$wpdb->prefix . 'events_personnel_rel'        => array('id'),
+		);
+	}
+
+
+	/**
+	 *        @ singleton method used to instantiate class object
+	 *        @ access public
+	 *
+	 * @return EE_CSV
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Opens a unicode or utf file (normal file_get_contents has difficulty readin ga unicode file. @see
+	 * http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
+	 *
+	 * @param string $file_path
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function read_unicode_file($file_path)
+	{
+		$fc = "";
+		$fh = fopen($file_path, "rb");
+		if (! $fh) {
+			throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
+		}
+		$flen = filesize($file_path);
+		$bc = fread($fh, $flen);
+		for ($i = 0; $i < $flen; $i++) {
+			$c = substr($bc, $i, 1);
+			if ((ord($c) != 0) && (ord($c) != 13)) {
+				$fc = $fc . $c;
+			}
+		}
+		if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
+			$fc = substr($fc, 2);
+		}
+		return ($fc);
+	}
+
+
+	/**
+	 * Generic CSV-functionality to turn an entire CSV file into a single array that's
+	 * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
+	 * representing each row in the CSV file, and the second-level arrays being each column in that row
+	 *
+	 * @param string $path_to_file
+	 * @return array of arrays. Top-level array has rows, second-level array has each item
+	 */
+	public function import_csv_to_multi_dimensional_array($path_to_file)
+	{
+		// needed to deal with Mac line endings
+		ini_set('auto_detect_line_endings', true);
+
+		// because fgetcsv does not correctly deal with backslashed quotes such as \"
+		// we'll read the file into a string
+		$file_contents = $this->read_unicode_file($path_to_file);
+		// replace backslashed quotes with CSV enclosures
+		$file_contents = str_replace('\\"', '"""', $file_contents);
+		// HEY YOU! PUT THAT FILE BACK!!!
+		file_put_contents($path_to_file, $file_contents);
+
+		if (($file_handle = fopen($path_to_file, "r")) !== false) {
+			# Set the parent multidimensional array key to 0.
+			$nn = 0;
+			$csvarray = array();
+
+			// in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions of fgetcsv choke if passed more than 4 - is that crazy or what?
+			if (version_compare(PHP_VERSION, '5.3.0') < 0) {
+				//  PHP 5.2- version
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"')) !== false) {
+					$csvarray[] = $data;
+				}
+			} else {
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
+					$csvarray[] = $data;
+				}
+			}
+			# Close the File.
+			fclose($file_handle);
+			return $csvarray;
+		} else {
+			EE_Error::add_error(
+				sprintf(__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * @Import contents of csv file and store values in an array to be manipulated by other functions
+	 * @access public
+	 * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
+	 *                                      If $model_name is provided, assumes that each row in the CSV represents a
+	 *                                      model object for that model If $model_name ISN'T provided, assumes that
+	 *                                      before model object data, there is a row where the first entry is simply
+	 *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
+	 *                                      then maybe a row of headers, and then the model data. Eg.
+	 *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
+	 *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
+	 *                                      Forest
+	 * @param string  $model_name           model name if we know what model we're importing
+	 * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
+	 *                                      data
+	 * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
+	 *               error message like the following array('Event'=>array( array('EVT_ID'=>1,'EVT_name'=>'bob
+	 *               party',...), array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      'Venue'=>array(
+	 *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
+	 *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      ...
+	 *                                      )
+	 */
+	public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
+	{
+		$multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
+		if (! $multi_dimensional_array) {
+			return false;
+		}
+		// gotta start somewhere
+		$row = 1;
+		// array to store csv data in
+		$ee_formatted_data = array();
+		// array to store headers (column names)
+		$headers = array();
+		foreach ($multi_dimensional_array as $data) {
+			// if first cell is MODEL, then second cell is the MODEL name
+			if ($data[0] == 'MODEL') {
+				$model_name = $data[1];
+				// don't bother looking for model data in this row. The rest of this
+				// row should be blank
+				// AND pretend this is the first row again
+				$row = 1;
+				// reset headers
+				$headers = array();
+				continue;
+			}
+			if (strpos($data[0], EE_CSV::metadata_header) !== false) {
+				$model_name = EE_CSV::metadata_header;
+				// store like model data, we just won't try importing it etc.
+				$row = 1;
+				continue;
+			}
+
+
+			// how many columns are there?
+			$columns = count($data);
+
+			$model_entry = array();
+			// loop through each column
+			for ($i = 0; $i < $columns; $i++) {
+				// replace csv_enclosures with backslashed quotes
+				$data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+				// do we need to grab the column names?
+				if ($row === 1) {
+					if ($first_row_is_headers) {
+						// store the column names to use for keys
+						$column_name = $data[ $i ];
+						// check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
+						if (! $column_name) {
+							continue;
+						}
+						$matches = array();
+						if ($model_name == EE_CSV::metadata_header) {
+							$headers[ $i ] = $column_name;
+						} else {
+							// now get the db table name from it (the part between square brackets)
+							$success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
+							if (! $success) {
+								EE_Error::add_error(
+									sprintf(
+										__(
+											"The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
+											"event_espresso"
+										),
+										$column_name,
+										implode(",", $data)
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+							$headers[ $i ] = $matches[2];
+						}
+					} else {
+						// no column names means our final array will just use counters for keys
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+						$headers[ $i ] = $i;
+					}
+					// and we need to store csv data
+				} else {
+					// this column isn' ta header, store it if there is a header for it
+					if (isset($headers[ $i ])) {
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+					}
+				}
+			}
+			// save the row's data IF it's a non-header-row
+			if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
+				$ee_formatted_data[ $model_name ][] = $model_entry;
+			}
+			// advance to next row
+			$row++;
+		}
+
+		// delete the uploaded file
+		unlink($path_to_file);
+		// echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
+		// die();
+
+		// it's good to give back
+		return $ee_formatted_data;
+	}
+
+
+	public function save_csv_to_db($csv_data_array, $model_name = false)
+	{
+		EE_Error::doing_it_wrong(
+			'save_csv_to_db',
+			__(
+				'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
+	}
+
+	/**
+	 * Sends HTTP headers to indicate that the browser should download a file,
+	 * and starts writing the file to PHP's output. Returns the file handle so other functions can
+	 * also write to it
+	 *
+	 * @param string $new_filename the name of the file that the user will download
+	 * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
+	 */
+	public function begin_sending_csv($filename)
+	{
+		// grab file extension
+		$ext = substr(strrchr($filename, '.'), 1);
+		if ($ext == '.csv' or $ext == '.xls') {
+			str_replace($ext, '', $filename);
+		}
+		$filename .= '.csv';
+
+		// if somebody's been naughty and already started outputting stuff, trash it
+		// and start writing our stuff.
+		if (ob_get_length()) {
+			@ob_flush();
+			@flush();
+			@ob_end_flush();
+		}
+		@ob_start();
+		header("Pragma: public");
+		header("Expires: 0");
+		header("Pragma: no-cache");
+		header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
+		// header("Content-Type: application/force-download");
+		// header("Content-Type: application/octet-stream");
+		// header("Content-Type: application/download");
+		header('Content-disposition: attachment; filename=' . $filename);
+		header("Content-Type: text/csv; charset=utf-8");
+		do_action('AHEE__EE_CSV__begin_sending_csv__headers');
+		echo apply_filters(
+			'FHEE__EE_CSV__begin_sending_csv__start_writing',
+			"\xEF\xBB\xBF"
+		); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
+		$fh = fopen('php://output', 'w');
+		return $fh;
+	}
+
+	/**
+	 * Writes some meta data to the CSV as a bunch of columns. Initially we're only
+	 * mentioning the version and timezone
+	 *
+	 * @param resource $filehandle
+	 */
+	public function write_metadata_to_csv($filehandle)
+	{
+		$data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+		$this->fputcsv2($filehandle, $data_row);
+		$meta_data = array(
+			0 => array(
+				'version'        => espresso_version(),
+				'timezone'       => EEH_DTT_Helper::get_timezone(),
+				'time_of_export' => current_time('mysql'),
+				'site_url'       => site_url(),
+			),
+		);
+		$this->write_data_array_to_csv($filehandle, $meta_data);
+	}
+
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
+	 *                                      by string
+	 * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
+	 *                                      headers in the CSV. Eg, if $data looked like
+	 *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
+	 *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
+	 * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
+	 *                 (because we wrote everything there was...nothing)
+	 */
+	public function write_data_array_to_csv($filehandle, $data)
+	{
+
+
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							"top-level array must be numerically indexed. Does these look like numbers to you? %s",
+							"event_espresso"
+						),
+						implode(",", array_keys($data))
+					)
+				);
+			}
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if (EEH_Array::is_associative_array($item_in_top_level_array)) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				echo $this->fputcsv2($filehandle, $keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				echo $this->fputcsv2($filehandle, $data_row);
+			}
+			return true;
+		} else {
+			// no data TO write... so we can assume that's a success
+			return true;
+		}
+		// //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
+		//
+		//
+		// $no_table = TRUE;
+		//
+		// // loop through data and add each row to the file/stream as csv
+		// foreach ( $data as $model_name => $model_data ) {
+		// // test first row to see if it is data or a model name
+		// $model = EE_Registry::instance();->load_model($model_name);
+		// //if the model really exists,
+		// if ( $model ) {
+		//
+		// // we have a table name
+		// $no_table = FALSE;
+		//
+		// // put the tablename into an array cuz that's how fputcsv rolls
+		// $model_name_row = array( 'MODEL', $model_name );
+		//
+		// // add table name to csv output
+		// echo self::fputcsv2($filehandle, $model_name_row);
+		//
+		// // now get the rest of the data
+		// foreach ( $model_data as $row ) {
+		// // output the row
+		// echo self::fputcsv2($filehandle, $row);
+		// }
+		//
+		// }
+		//
+		// if ( $no_table ) {
+		// // no table so just put the data
+		// echo self::fputcsv2($filehandle, $model_data);
+		// }
+		//
+		// } // END OF foreach ( $data )
+	}
+
+	/**
+	 * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
+	 * Calls exit to prevent polluting the CSV file with other junk
+	 *
+	 * @param resource $fh filehandle where we're writing the CSV to
+	 */
+	public function end_sending_csv($fh)
+	{
+		fclose($fh);
+		exit(0);
+	}
+
+	/**
+	 * Given an open file, writes all the model data to it in the format the importer expects.
+	 * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($filehandle).
+	 *
+	 * @param resource $filehandle
+	 * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
+	 *                                   next layer is numerically indexed to represent each model object (eg, each
+	 *                                   individual event), and the last layer has all the attributes o fthat model
+	 *                                   object (eg, the event's id, name, etc)
+	 * @return boolean success
+	 */
+	public function write_model_data_to_csv($filehandle, $model_data_array)
+	{
+		$this->write_metadata_to_csv($filehandle);
+		foreach ($model_data_array as $model_name => $model_instance_arrays) {
+			// first: output a special row stating the model
+			echo $this->fputcsv2($filehandle, array('MODEL', $model_name));
+			// if we have items to put in the CSV, do it normally
+
+			if (! empty($model_instance_arrays)) {
+				$this->write_data_array_to_csv($filehandle, $model_instance_arrays);
+			} else {
+				// echo "no data to write... so just write the headers";
+				// so there's actually NO model objects for that model.
+				// probably still want to show the columns
+				$model = EE_Registry::instance()->load_model($model_name);
+				$column_names = array();
+				foreach ($model->field_settings() as $field) {
+					$column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+				}
+				$this->write_data_array_to_csv($filehandle, array($column_names));
+			}
+		}
+	}
+
+	/**
+	 * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
+	 * and dies (in order to avoid other plugins from messing up the csv output)
+	 *
+	 * @param string $filename         the filename you want to give the file
+	 * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
+	 * @return bool | void writes CSV file to output and dies
+	 */
+	public function export_multiple_model_data_to_csv($filename, $model_data_array)
+	{
+		$filehandle = $this->begin_sending_csv($filename);
+		$this->write_model_data_to_csv($filehandle, $model_data_array);
+		$this->end_sending_csv($filehandle);
+	}
+
+	/**
+	 * @Export contents of an array to csv file
+	 * @access public
+	 * @param array  $data     - the array of data to be converted to csv and exported
+	 * @param string $filename - name for newly created csv file
+	 * @return TRUE on success, FALSE on fail
+	 */
+	public function export_array_to_csv($data = false, $filename = false)
+	{
+
+		// no data file?? get outta here
+		if (! $data or ! is_array($data) or empty($data)) {
+			return false;
+		}
+
+		// no filename?? get outta here
+		if (! $filename) {
+			return false;
+		}
+
+
+		// somebody told me i might need this ???
+		global $wpdb;
+		$prefix = $wpdb->prefix;
+
+
+		$fh = $this->begin_sending_csv($filename);
+
+
+		$this->end_sending_csv($fh);
+	}
+
+
+	/**
+	 * @Determine the maximum upload file size based on php.ini settings
+	 * @access    public
+	 * @param int $percent_of_max - desired percentage of the max upload_mb
+	 * @return int KB
+	 */
+	public function get_max_upload_size($percent_of_max = false)
+	{
+
+		$max_upload = (int) (ini_get('upload_max_filesize'));
+		$max_post = (int) (ini_get('post_max_size'));
+		$memory_limit = (int) (ini_get('memory_limit'));
+
+		// determine the smallest of the three values from above
+		$upload_mb = min($max_upload, $max_post, $memory_limit);
+
+		// convert MB to KB
+		$upload_mb = $upload_mb * 1024;
+
+		// don't want the full monty? then reduce the max uplaod size
+		if ($percent_of_max) {
+			// is percent_of_max like this -> 50 or like this -> 0.50 ?
+			if ($percent_of_max > 1) {
+				// chnages 50 to 0.50
+				$percent_of_max = $percent_of_max / 100;
+			}
+			// make upload_mb a percentage of the max upload_mb
+			$upload_mb = $upload_mb * $percent_of_max;
+		}
+
+		return $upload_mb;
+	}
+
+
+	/**
+	 * @Drop   in replacement for PHP's fputcsv function - but this one works!!!
+	 * @access private
+	 * @param resource $fh         - file handle - what we are writing to
+	 * @param array    $row        - individual row of csv data
+	 * @param string   $delimiter  - csv delimiter
+	 * @param string   $enclosure  - csv enclosure
+	 * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	 * @return void
+	 */
+	private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = array();
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
+				($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+				: $field_value;
+		}
+
+		fwrite($fh, join($delimiter, $output) . PHP_EOL);
+	}
+
+
+	// /**
+	//  * @CSV    Import / Export messages
+	//  * @access public
+	//  * @return void
+	//  */
+	// public function csv_admin_notices()
+	// {
+	//
+	//     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
+	//     foreach (array('updates', 'errors') as $type) {
+	//
+	//         // if particular notice type is not empty, then "You've got Mail"
+	//         if (! empty($this->_notices[ $type ])) {
+	//
+	//             // is it an update or an error ?
+	//             $msg_class = $type == 'updates' ? 'updated' : 'error';
+	//             echo '<div id="message" class="' . $msg_class . '">';
+	//             // display each notice, however many that may be
+	//             foreach ($this->_notices[ $type ] as $message) {
+	//                 echo '<p>' . $message . '</p>';
+	//             }
+	//             // wrap it up
+	//             echo '</div>';
+	//         }
+	//     }
+	// }
+
+	/**
+	 * Gets the date format to use in teh csv. filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_date_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+	/**
+	 * Gets the time format we want to use in CSV reports. Filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_time_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -48,31 +48,31 @@ 
         global $wpdb;
 
         $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('id'),
+            $wpdb->prefix.'esp_answer'                  => array('ANS_ID'),
+            $wpdb->prefix.'esp_attendee'                => array('ATT_ID'),
+            $wpdb->prefix.'esp_datetime'                => array('DTT_ID'),
+            $wpdb->prefix.'esp_event_question_group'    => array('EQG_ID'),
+            $wpdb->prefix.'esp_message_template'        => array('MTP_ID'),
+            $wpdb->prefix.'esp_payment'                 => array('PAY_ID'),
+            $wpdb->prefix.'esp_price'                   => array('PRC_ID'),
+            $wpdb->prefix.'esp_price_type'              => array('PRT_ID'),
+            $wpdb->prefix.'esp_question'                => array('QST_ID'),
+            $wpdb->prefix.'esp_question_group'          => array('QSG_ID'),
+            $wpdb->prefix.'esp_question_group_question' => array('QGQ_ID'),
+            $wpdb->prefix.'esp_question_option'         => array('QSO_ID'),
+            $wpdb->prefix.'esp_registration'            => array('REG_ID'),
+            $wpdb->prefix.'esp_status'                  => array('STS_ID'),
+            $wpdb->prefix.'esp_transaction'             => array('TXN_ID'),
+            $wpdb->prefix.'esp_transaction'             => array('TXN_ID'),
+            $wpdb->prefix.'events_detail'               => array('id'),
+            $wpdb->prefix.'events_category_detail'      => array('id'),
+            $wpdb->prefix.'events_category_rel'         => array('id'),
+            $wpdb->prefix.'events_venue'                => array('id'),
+            $wpdb->prefix.'events_venue_rel'            => array('emeta_id'),
+            $wpdb->prefix.'events_locale'               => array('id'),
+            $wpdb->prefix.'events_locale_rel'           => array('id'),
+            $wpdb->prefix.'events_personnel'            => array('id'),
+            $wpdb->prefix.'events_personnel_rel'        => array('id'),
         );
     }
 
@@ -104,7 +104,7 @@ 
     {
         $fc = "";
         $fh = fopen($file_path, "rb");
-        if (! $fh) {
+        if ( ! $fh) {
             throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
         }
         $flen = filesize($file_path);
@@ -112,7 +112,7 @@ 
         for ($i = 0; $i < $flen; $i++) {
             $c = substr($bc, $i, 1);
             if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
+                $fc = $fc.$c;
             }
         }
         if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
@@ -207,7 +207,7 @@ 
     public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
     {
         $multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
-        if (! $multi_dimensional_array) {
+        if ( ! $multi_dimensional_array) {
             return false;
         }
         // gotta start somewhere
@@ -243,23 +243,23 @@ 
             // loop through each column
             for ($i = 0; $i < $columns; $i++) {
                 // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+                $data[$i] = str_replace('"""', '\\"', $data[$i]);
                 // do we need to grab the column names?
                 if ($row === 1) {
                     if ($first_row_is_headers) {
                         // store the column names to use for keys
-                        $column_name = $data[ $i ];
+                        $column_name = $data[$i];
                         // check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
+                        if ( ! $column_name) {
                             continue;
                         }
                         $matches = array();
                         if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
+                            $headers[$i] = $column_name;
                         } else {
                             // now get the db table name from it (the part between square brackets)
                             $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
+                            if ( ! $success) {
                                 EE_Error::add_error(
                                     sprintf(
                                         __(
@@ -275,24 +275,24 @@ 
                                 );
                                 return false;
                             }
-                            $headers[ $i ] = $matches[2];
+                            $headers[$i] = $matches[2];
                         }
                     } else {
                         // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ] = $i;
+                        $model_entry[$headers[$i]] = $data[$i];
+                        $headers[$i] = $i;
                     }
                     // and we need to store csv data
                 } else {
                     // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
+                    if (isset($headers[$i])) {
+                        $model_entry[$headers[$i]] = $data[$i];
                     }
                 }
             }
             // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
+            if ( ! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
+                $ee_formatted_data[$model_name][] = $model_entry;
             }
             // advance to next row
             $row++;
@@ -353,7 +353,7 @@ 
         // header("Content-Type: application/force-download");
         // header("Content-Type: application/octet-stream");
         // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
+        header('Content-disposition: attachment; filename='.$filename);
         header("Content-Type: text/csv; charset=utf-8");
         do_action('AHEE__EE_CSV__begin_sending_csv__headers');
         echo apply_filters(
@@ -372,7 +372,7 @@ 
      */
     public function write_metadata_to_csv($filehandle)
     {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+        $data_row = array(EE_CSV::metadata_header); // do NOT translate because this exact string is used when importing
         $this->fputcsv2($filehandle, $data_row);
         $meta_data = array(
             0 => array(
@@ -501,7 +501,7 @@ 
             echo $this->fputcsv2($filehandle, array('MODEL', $model_name));
             // if we have items to put in the CSV, do it normally
 
-            if (! empty($model_instance_arrays)) {
+            if ( ! empty($model_instance_arrays)) {
                 $this->write_data_array_to_csv($filehandle, $model_instance_arrays);
             } else {
                 // echo "no data to write... so just write the headers";
@@ -510,7 +510,7 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 $column_names = array();
                 foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+                    $column_names[$field->get_nicename()."[".$field->get_name()."]"] = null;
                 }
                 $this->write_data_array_to_csv($filehandle, array($column_names));
             }
@@ -543,12 +543,12 @@ 
     {
 
         // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
+        if ( ! $data or ! is_array($data) or empty($data)) {
             return false;
         }
 
         // no filename?? get outta here
-        if (! $filename) {
+        if ( ! $filename) {
             return false;
         }
 
@@ -629,11 +629,11 @@ 
             }
 
             $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+                ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure)
                 : $field_value;
         }
 
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
+        fwrite($fh, join($delimiter, $output).PHP_EOL);
     }
 
 

core/db_classes/EE_Extra_Join.class.php

Indentation +19 added lines, -19 removed lines

@@ -12,25 +12,25 @@
 class EE_Extra_Join extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @param null  $timezone
-     * @return EE_Extra_Join|mixed
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null)
-    {
-        $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 null  $timezone
+	 * @return EE_Extra_Join|mixed
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null)
+	{
+		$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 null  $timezone
-     * @return EE_Extra_Join
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @param null  $timezone
+	 * @return EE_Extra_Join
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Currency_Payment_Method.class.php

Indentation +32 added lines, -32 removed lines

@@ -14,40 +14,40 @@
 class EE_Currency_Payment_Method extends EE_Base_Class
 {
 
-    /** Currency to Payment Method Link ID @var CPM_ID */
-    protected $_CPM_ID = null;
-    /** Currency Code @var CUR_code */
-    protected $_CUR_code = null;
-    /** Payment Method ID @var PMD_ID */
-    protected $_PMD_ID = null;
-    protected $_Payment_Method;
-    protected $_Currency;
+	/** Currency to Payment Method Link ID @var CPM_ID */
+	protected $_CPM_ID = null;
+	/** Currency Code @var CUR_code */
+	protected $_CUR_code = null;
+	/** Payment Method ID @var PMD_ID */
+	protected $_PMD_ID = null;
+	protected $_Payment_Method;
+	protected $_Currency;
 
 
-    /**
-     *
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
+	/**
+	 *
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
 
 
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
 }

core/db_classes/EE_Transaction.class.php

Spacing +22 added lines, -22 removed lines

@@ -42,7 +42,7 @@ 
         $txn = $has_object
             ? $has_object
             : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
+        if ( ! $has_object) {
             $txn->set_old_txn_status($txn->status_ID());
         }
         return $txn;
@@ -74,7 +74,7 @@ 
     public function lock()
     {
         // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
+        if ( ! $this->add_extra_meta('lock', time(), true)) {
             // then attempt to remove the lock in case it is expired
             if ($this->_remove_expired_lock()) {
                 // if removal was successful, then try setting lock again
@@ -122,7 +122,7 @@ 
     public function is_locked()
     {
         // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
+        if ( ! $this->_get_lock()) {
             return false;
         }
         // if not, then let's try and remove the lock in case it's expired...
@@ -527,7 +527,7 @@ 
                 $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
                 break;
         }
-        return $icon . $status[ $this->status_ID() ];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -631,7 +631,7 @@ 
     public function invoice_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->invoice_url($type);
@@ -673,7 +673,7 @@ 
     public function receipt_url($type = 'html')
     {
         $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
+        if ( ! $REG instanceof EE_Registration) {
             return '';
         }
         return $REG->receipt_url($type);
@@ -818,7 +818,7 @@ 
     public function total_line_item($create_if_not_found = true)
     {
         $item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total)));
-        if (! $item && $create_if_not_found) {
+        if ( ! $item && $create_if_not_found) {
             $item = EEH_Line_Item::create_total_line_item($this);
         }
         return $item;
@@ -863,7 +863,7 @@ 
     public function billing_info()
     {
         $payment_method = $this->payment_method();
-        if (! $payment_method) {
+        if ( ! $payment_method) {
             EE_Error::add_error(
                 __(
                     'Could not find billing info for transaction because no gateway has been used for it yet',
@@ -876,7 +876,7 @@ 
             return null;
         }
         $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 __(
                     'Cannot get billing info for gateway %s on transaction because no primary registration exists',
@@ -889,7 +889,7 @@ 
             return null;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 __(
                     'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
@@ -1025,7 +1025,7 @@ 
     public function update_based_on_payments()
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -1085,13 +1085,13 @@ 
     private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
     {
         $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
+        if ( ! is_array($reg_steps) || empty($reg_steps)) {
             return false;
         }
         // loop thru reg steps array)
         foreach ($reg_steps as $slug => $reg_step_completed) {
             // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
+            if ( ! $check_all) {
                 // and this is the one
                 if ($slug === $reg_step_slug) {
                     return $reg_step_completed;
@@ -1258,30 +1258,30 @@ 
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
         // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+        if ( ! isset($txn_reg_steps[$reg_step_slug])) {
             return false;
         }
         // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
+        if ($txn_reg_steps[$reg_step_slug] === true) {
             return true;
         }
         // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+        if ($status === true && $txn_reg_steps[$reg_step_slug] === false) {
             return false;
         }
         // if current status value matches the incoming value (no change)
         // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+        if ((int) $txn_reg_steps[$reg_step_slug] === (int) $status) {
             // this will happen in cases where multiple AJAX requests occur during the same step
             return true;
         }
         // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+        if (is_numeric($status) && is_numeric($txn_reg_steps[$reg_step_slug])) {
             // skip the update below, but don't return FALSE so that errors won't be displayed
             return true;
         }
         // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
+        $txn_reg_steps[$reg_step_slug] = $status;
         $this->set_reg_steps($txn_reg_steps);
         $this->save();
         return true;
@@ -1301,7 +1301,7 @@ 
     {
         // get reg steps array
         $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
+        unset($txn_reg_steps[$reg_step_slug]);
         $this->set_reg_steps($txn_reg_steps);
     }
 
@@ -1374,12 +1374,12 @@ 
             return;
         }
         $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Payment) {
                     // kk this TXN should NOT be abandoned
                     $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+                    if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
                         EE_Error::add_attention(
                             sprintf(
                                 esc_html__(

Indentation +1701 added lines, -1701 removed lines

@@ -13,1705 +13,1705 @@
 class EE_Transaction extends EE_Base_Class implements EEI_Transaction
 {
 
-    /**
-     * The length of time in seconds that a lock is applied before being considered expired.
-     * It is not long because a transaction should only be locked for the duration of the request that locked it
-     */
-    const LOCK_EXPIRATION = 2;
-
-    /**
-     * txn status upon initial construction.
-     *
-     * @var string
-     */
-    protected $_old_txn_status;
-
-
-    /**
-     * @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_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    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);
-        $txn = $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-        if (! $has_object) {
-            $txn->set_old_txn_status($txn->status_ID());
-        }
-        return $txn;
-    }
-
-
-    /**
-     * @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_Transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        $txn = new self($props_n_values, true, $timezone);
-        $txn->set_old_txn_status($txn->status_ID());
-        return $txn;
-    }
-
-
-    /**
-     * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
-     * If a lock has already been set, then we will attempt to remove it in case it has expired.
-     * If that also fails, then an exception is thrown.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function lock()
-    {
-        // attempt to set lock, but if that fails...
-        if (! $this->add_extra_meta('lock', time(), true)) {
-            // then attempt to remove the lock in case it is expired
-            if ($this->_remove_expired_lock()) {
-                // if removal was successful, then try setting lock again
-                $this->lock();
-            } else {
-                // but if the lock can not be removed, then throw an exception
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
-                            'event_espresso'
-                        ),
-                        $this->ID()
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * removes transaction lock applied in EE_Transaction::lock()
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function unlock()
-    {
-        return $this->delete_extra_meta('lock');
-    }
-
-
-    /**
-     * Decides whether or not now is the right time to update the transaction.
-     * This is useful because we don't always know if it is safe to update the transaction
-     * and its related data. why?
-     * because it's possible that the transaction is being used in another
-     * request and could overwrite anything we save.
-     * So we want to only update the txn once we know that won't happen.
-     * We also check that the lock isn't expired, and remove it if it is
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_locked()
-    {
-        // if TXN is not locked, then return false immediately
-        if (! $this->_get_lock()) {
-            return false;
-        }
-        // if not, then let's try and remove the lock in case it's expired...
-        // _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
-        // and a positive number if the lock was removed (ie: number of locks deleted),
-        // so we need to return the opposite
-        return ! $this->_remove_expired_lock() ? true : false;
-    }
-
-
-    /**
-     * Gets the meta field indicating that this TXN is locked
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _get_lock()
-    {
-        return (int) $this->get_extra_meta('lock', true, 0);
-    }
-
-
-    /**
-     * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _remove_expired_lock()
-    {
-        $locked = $this->_get_lock();
-        if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
-            return $this->unlock();
-        }
-        return 0;
-    }
-
-
-    /**
-     * Set transaction total
-     *
-     * @param float $total total value of transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_total($total = 0.00)
-    {
-        $this->set('TXN_total', (float) $total);
-    }
-
-
-    /**
-     * Set Total Amount Paid to Date
-     *
-     * @param float $total_paid total amount paid to date (sum of all payments)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_paid($total_paid = 0.00)
-    {
-        $this->set('TXN_paid', (float) $total_paid);
-    }
-
-
-    /**
-     * Set transaction status
-     *
-     * @param string $status        whether the transaction is open, declined, accepted,
-     *                              or any number of custom values that can be set
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_status($status = '')
-    {
-        $this->set('STS_ID', $status);
-    }
-
-
-    /**
-     * Set hash salt
-     *
-     * @param string $hash_salt required for some payment gateways
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_hash_salt($hash_salt = '')
-    {
-        $this->set('TXN_hash_salt', $hash_salt);
-    }
-
-
-    /**
-     * Sets TXN_reg_steps array
-     *
-     * @param array $txn_reg_steps
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_steps(array $txn_reg_steps)
-    {
-        $this->set('TXN_reg_steps', $txn_reg_steps);
-    }
-
-
-    /**
-     * Gets TXN_reg_steps
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_steps()
-    {
-        $TXN_reg_steps = $this->get('TXN_reg_steps');
-        return is_array($TXN_reg_steps) ? (array) $TXN_reg_steps : array();
-    }
-
-
-    /**
-     * @return string of transaction's total cost, with currency symbol and decimal
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_total()
-    {
-        return $this->get_pretty('TXN_total');
-    }
-
-
-    /**
-     * Gets the amount paid in a pretty string (formatted and with currency symbol)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('TXN_paid');
-    }
-
-
-    /**
-     * calculate the amount remaining for this transaction and return;
-     *
-     * @return float amount remaining
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remaining()
-    {
-        return $this->total() - $this->paid();
-    }
-
-
-    /**
-     * get Transaction Total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total()
-    {
-        return (float) $this->get('TXN_total');
-    }
-
-
-    /**
-     * get Total Amount Paid to Date
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function paid()
-    {
-        return (float) $this->get('TXN_paid');
-    }
-
-
-    /**
-     * @return mixed|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_cart_session()
-    {
-        $session_data = (array) $this->get('TXN_session_data');
-        return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
-            ? $session_data['cart']
-            : null;
-    }
-
-
-    /**
-     * get Transaction session data
-     *
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function session_data()
-    {
-        $session_data = $this->get('TXN_session_data');
-        if (empty($session_data)) {
-            $session_data = array(
-                'id'            => null,
-                'user_id'       => null,
-                'ip_address'    => null,
-                'user_agent'    => null,
-                'init_access'   => null,
-                'last_access'   => null,
-                'pages_visited' => array(),
-            );
-        }
-        return $session_data;
-    }
-
-
-    /**
-     * Set session data within the TXN object
-     *
-     * @param EE_Session|array $session_data
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_txn_session_data($session_data)
-    {
-        if ($session_data instanceof EE_Session) {
-            $this->set('TXN_session_data', $session_data->get_session_data(null, true));
-        } else {
-            $this->set('TXN_session_data', $session_data);
-        }
-    }
-
-
-    /**
-     * get Transaction hash salt
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function hash_salt_()
-    {
-        return $this->get('TXN_hash_salt');
-    }
-
-
-    /**
-     * Returns the transaction datetime as either:
-     *            - unix timestamp format ($format = false, $gmt = true)
-     *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
-     *              has no affect with this option)), this also may include a timezone abbreviation if the
-     *              set timezone in this class differs from what the timezone is on the blog.
-     *            - formatted date string including the UTC (timezone) offset (default).
-     *
-     * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
-     * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
-     *                          or no UTC offset applied
-     * @return string | int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function datetime($format = false, $gmt = false)
-    {
-        if ($format) {
-            return $this->get_pretty('TXN_timestamp');
-        }
-        if ($gmt) {
-            return $this->get_raw('TXN_timestamp');
-        }
-        return $this->get('TXN_timestamp');
-    }
-
-
-    /**
-     * Gets registrations on this transaction
-     *
-     * @param array   $query_params array of query parameters
-     * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function registrations($query_params = array(), $get_cached = false)
-    {
-        $query_params = (empty($query_params) || ! is_array($query_params))
-            ? array(
-                'order_by' => array(
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                ),
-            )
-            : $query_params;
-        $query_params = $get_cached ? array() : $query_params;
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
-     * function for getting attendees and how many registrations they each have for an event)
-     *
-     * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendees()
-    {
-        return $this->get_many_related('Attendee', array(array('Registration.Transaction.TXN_ID' => $this->ID())));
-    }
-
-
-    /**
-     * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * gets only approved payments for this transaction
-     *
-     * @return EE_Base_Class[]|EE_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function approved_payments()
-    {
-        EE_Registry::instance()->load_model('Payment');
-        return $this->get_many_related(
-            'Payment',
-            array(
-                array('STS_ID' => EEM_Payment::status_id_approved),
-                'order_by' => array('PAY_timestamp' => 'DESC'),
-            )
-        );
-    }
-
-
-    /**
-     * Gets all payments which have not been approved
-     *
-     * @return EE_Base_Class[]|EEI_Payment[]
-     * @throws EE_Error if a model is misconfigured somehow
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pending_payments()
-    {
-        return $this->get_many_related(
-            'Payment',
-            array(
-                array(
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                ),
-                'order_by' => array(
-                    'PAY_timestamp' => 'DESC',
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * echoes $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * returns a pretty version of the status, good for displaying to users
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->status_ID() => __('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon = '';
-        switch ($this->status_ID()) {
-            case EEM_Transaction::complete_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
-                break;
-            case EEM_Transaction::incomplete_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
-                    : '';
-                break;
-            case EEM_Transaction::abandoned_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Transaction::failed_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
-                break;
-            case EEM_Transaction::overpaid_status_code:
-                $icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
-                break;
-        }
-        return $icon . $status[ $this->status_ID() ];
-    }
-
-
-    /**
-     * get Transaction Status
-     *
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Returns TRUE or FALSE for whether or not this transaction cost any money
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_free()
-    {
-        return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
-    }
-
-
-    /**
-     * Returns whether this transaction is complete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_completed()
-    {
-        return $this->status_ID() === EEM_Transaction::complete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is incomplete
-     * Useful in templates and other logic for deciding if we should ask for another payment...
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Transaction::incomplete_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction is overpaid
-     * Useful in templates and other logic for deciding if monies need to be refunded
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_overpaid()
-    {
-        return $this->status_ID() === EEM_Transaction::overpaid_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction was abandoned
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * but that contact information exists for at least one registrant
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_abandoned()
-    {
-        return $this->status_ID() === EEM_Transaction::abandoned_status_code;
-    }
-
-
-    /**
-     * Returns whether this transaction failed
-     * meaning that the transaction/registration process was somehow interrupted and never completed
-     * and that NO contact information exists for any registrants
-     *
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function failed()
-    {
-        return $this->status_ID() === EEM_Transaction::failed_status_code;
-    }
-
-
-    /**
-     * This returns the url for the invoice of this transaction
-     *
-     * @param string $type 'html' or 'pdf' (default is pdf)
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function invoice_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->invoice_url($type);
-    }
-
-
-    /**
-     * Gets the primary registration only
-     *
-     * @return EE_Base_Class|EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function primary_registration()
-    {
-        $registrations = (array) $this->get_many_related(
-            'Registration',
-            array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT))
-        );
-        foreach ($registrations as $registration) {
-            // valid registration that is NOT cancelled or declined ?
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
-            ) {
-                return $registration;
-            }
-        }
-        // nothing valid found, so just return first thing from array of results
-        return reset($registrations);
-    }
-
-
-    /**
-     * Gets the URL for viewing the receipt
-     *
-     * @param string $type 'pdf' or 'html' (default is 'html')
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function receipt_url($type = 'html')
-    {
-        $REG = $this->primary_registration();
-        if (! $REG instanceof EE_Registration) {
-            return '';
-        }
-        return $REG->receipt_url($type);
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_overview_url()
-    {
-        $primary_registration = $this->primary_registration();
-        return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function gateway_response_on_transaction()
-    {
-        $payment = $this->get_first_related('Payment');
-        return $payment instanceof EE_Payment ? $payment->gateway_response() : '';
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Gets all the extra meta info on this payment
-     *
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Base_Class[]|EE_Extra_Meta
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function extra_meta($query_params = array())
-    {
-        return $this->get_many_related('Extra_Meta', $query_params);
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_registration(EE_Registration $registration)
-    {
-        return $this->_add_relation_to($registration, 'Registration');
-    }
-
-
-    /**
-     * Removes the given registration from being related (even before saving this transaction).
-     * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
-     *
-     * @param int $registration_or_id
-     * @return EE_Base_Class that was removed from being related
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_registration_with_id($registration_or_id)
-    {
-        return $this->_remove_relation_to($registration_or_id, 'Registration');
-    }
-
-
-    /**
-     * Gets all the line items which are for ACTUAL items
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function items_purchased()
-    {
-        return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_line_item)));
-    }
-
-
-    /**
-     * Wrapper for _add_relation_to
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Base_Class the relation was added to
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_line_item(EE_Line_Item $line_item)
-    {
-        return $this->_add_relation_to($line_item, 'Line_Item');
-    }
-
-
-    /**
-     * Gets ALL the line items related to this transaction (unstructured)
-     *
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function line_items($query_params = array())
-    {
-        return $this->get_many_related('Line_Item', $query_params);
-    }
-
-
-    /**
-     * Gets all the line items which are taxes on the total
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_items()
-    {
-        return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax)));
-    }
-
-
-    /**
-     * Gets the total line item (which is a parent of all other related line items,
-     * meaning it takes them all into account on its total)
-     *
-     * @param bool $create_if_not_found
-     * @return \EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function total_line_item($create_if_not_found = true)
-    {
-        $item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total)));
-        if (! $item && $create_if_not_found) {
-            $item = EEH_Line_Item::create_total_line_item($this);
-        }
-        return $item;
-    }
-
-
-    /**
-     * Returns the total amount of tax on this transaction
-     * (assumes there's only one tax subtotal line item)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total()
-    {
-        $tax_line_item = $this->tax_total_line_item();
-        if ($tax_line_item) {
-            return (float) $tax_line_item->total();
-        }
-        return (float) 0;
-    }
-
-
-    /**
-     * Gets the tax subtotal line item (assumes there's only one)
-     *
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function tax_total_line_item()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
-    }
-
-
-    /**
-     * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function billing_info()
-    {
-        $payment_method = $this->payment_method();
-        if (! $payment_method) {
-            EE_Error::add_error(
-                __(
-                    'Could not find billing info for transaction because no gateway has been used for it yet',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $primary_reg = $this->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                __(
-                    'Cannot get billing info for gateway %s on transaction because no primary registration exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                __(
-                    'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $attendee->billing_info_for_payment_method($payment_method);
-    }
-
-
-    /**
-     * Gets PMD_ID
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method_ID()
-    {
-        return $this->get('PMD_ID');
-    }
-
-
-    /**
-     * Sets PMD_ID
-     *
-     * @param int $PMD_ID
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_payment_method_ID($PMD_ID)
-    {
-        $this->set('PMD_ID', $PMD_ID);
-    }
-
-
-    /**
-     * Gets the last-used payment method on this transaction
-     * (we COULD just use the last-made payment, but some payment methods, namely
-     * offline ones, dont' create payments)
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_method()
-    {
-        $pm = $this->get_first_related('Payment_Method');
-        if ($pm instanceof EE_Payment_Method) {
-            return $pm;
-        }
-        $last_payment = $this->last_payment();
-        if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
-            return $last_payment->payment_method();
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the last payment made
-     *
-     * @return EE_Base_Class|EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function last_payment()
-    {
-        return $this->get_first_related('Payment', array('order_by' => array('PAY_ID' => 'desc')));
-    }
-
-
-    /**
-     * Gets all the line items which are unrelated to tickets on this transaction
-     *
-     * @return EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function non_ticket_line_items()
-    {
-        return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
-    }
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @param  boolean $update whether to save the TXN
-     * @return bool whether the TXN was saved
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_status_based_on_total_paid($update = true)
-    {
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
-            $new_txn_status = EEM_Transaction::overpaid_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
-            $new_txn_status = EEM_Transaction::complete_status_code;
-        } elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
-            $new_txn_status = EEM_Transaction::incomplete_status_code;
-        } else {
-            throw new RuntimeException(
-                __('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
-            );
-        }
-        if ($new_txn_status !== $this->status_ID()) {
-            $this->set_status($new_txn_status);
-            if ($update) {
-                return $this->save() ? true : false;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the transaction's status and total_paid based on all the payments
-     * that apply to it
-     *
-     * @deprecated
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_based_on_payments()
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function txn_status_updated()
-    {
-        return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
-    }
-
-
-    /**
-     * _reg_steps_completed
-     * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
-     * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
-     * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
-     *
-     * @param string $reg_step_slug
-     * @param bool   $check_all
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
-    {
-        $reg_steps = $this->reg_steps();
-        if (! is_array($reg_steps) || empty($reg_steps)) {
-            return false;
-        }
-        // loop thru reg steps array)
-        foreach ($reg_steps as $slug => $reg_step_completed) {
-            // if NOT checking ALL steps (only checking one step)
-            if (! $check_all) {
-                // and this is the one
-                if ($slug === $reg_step_slug) {
-                    return $reg_step_completed;
-                }
-                // skip to next reg step in loop
-                continue;
-            }
-            // $check_all must be true, else we would never have gotten to this point
-            if ($slug === $reg_step_slug) {
-                // if we reach this point, then we are testing either:
-                // all_reg_steps_completed_except() or
-                // all_reg_steps_completed_except_final_step(),
-                // and since this is the reg step EXCEPTION being tested
-                // we want to return true (yes true) if this reg step is NOT completed
-                // ie: "is everything completed except the final step?"
-                // "that is correct... the final step is not completed, but all others are."
-                return $reg_step_completed !== true;
-            }
-            if ($reg_step_completed !== true) {
-                // if any reg step is NOT completed, then ALL steps are not completed
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed()
-    {
-        return $this->_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @param string $exception
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except($exception = '')
-    {
-        return $this->_reg_steps_completed($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function all_reg_steps_completed_except_final_step()
-    {
-        return $this->_reg_steps_completed('finalize_registration');
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param string $reg_step_slug
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_step_completed($reg_step_slug)
-    {
-        return $this->_reg_steps_completed($reg_step_slug, false);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @return bool|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function final_reg_step_completed()
-    {
-        return $this->_reg_steps_completed('finalize_registration', false);
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_initiated($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, time());
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, true);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @param string $reg_step_slug
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_step_not_completed($reg_step_slug)
-    {
-        return $this->_set_reg_step_completed_status($reg_step_slug, false);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
-     *
-     * @param  string      $reg_step_slug
-     * @param  boolean|int $status
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _set_reg_step_completed_status($reg_step_slug, $status)
-    {
-        // validate status
-        $status = is_bool($status) || is_int($status) ? $status : false;
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        // if reg step does NOT exist
-        if (! isset($txn_reg_steps[ $reg_step_slug ])) {
-            return false;
-        }
-        // if  we're trying to complete a step that is already completed
-        if ($txn_reg_steps[ $reg_step_slug ] === true) {
-            return true;
-        }
-        // if  we're trying to complete a step that hasn't even started
-        if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
-            return false;
-        }
-        // if current status value matches the incoming value (no change)
-        // type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
-        if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
-            // this will happen in cases where multiple AJAX requests occur during the same step
-            return true;
-        }
-        // if we're trying to set a start time, but it has already been set...
-        if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
-            // skip the update below, but don't return FALSE so that errors won't be displayed
-            return true;
-        }
-        // update completed status
-        $txn_reg_steps[ $reg_step_slug ] = $status;
-        $this->set_reg_steps($txn_reg_steps);
-        $this->save();
-        return true;
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @param string $reg_step_slug
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function remove_reg_step($reg_step_slug)
-    {
-        // get reg steps array
-        $txn_reg_steps = $this->reg_steps();
-        unset($txn_reg_steps[ $reg_step_slug ]);
-        $this->set_reg_steps($txn_reg_steps);
-    }
-
-
-    /**
-     * toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @param bool $save
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_failed_transaction_status($save = true)
-    {
-        // if TXN status is still set as "failed"...
-        if ($this->status_ID() === EEM_Transaction::failed_status_code) {
-            $this->set_status(EEM_Transaction::abandoned_status_code);
-            if ($save) {
-                $this->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_abandoned_transaction_status()
-    {
-        // if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
-        $txn_status = $this->status_ID();
-        if (
-            $txn_status === EEM_Transaction::failed_status_code
-            || $txn_status === EEM_Transaction::abandoned_status_code
-        ) {
-            // if a contact record for the primary registrant has been created
-            if (
-                $this->primary_registration() instanceof EE_Registration
-                && $this->primary_registration()->attendee() instanceof EE_Attendee
-            ) {
-                $this->set_status(EEM_Transaction::incomplete_status_code);
-            } else {
-                // no contact record? yer abandoned!
-                $this->set_status(EEM_Transaction::abandoned_status_code);
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * checks if an Abandoned TXN has any related payments, and if so,
-     * updates the TXN status based on the amount paid
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function verify_abandoned_transaction_status()
-    {
-        if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
-            return;
-        }
-        $payments = $this->get_many_related('Payment');
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                if ($payment instanceof EE_Payment) {
-                    // kk this TXN should NOT be abandoned
-                    $this->update_status_based_on_total_paid();
-                    if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-                        EE_Error::add_attention(
-                            sprintf(
-                                esc_html__(
-                                    'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
-                                    'event_espresso'
-                                ),
-                                $this->ID(),
-                                $this->pretty_status()
-                            )
-                        );
-                    }
-                    // get final reg step status
-                    $finalized = $this->final_reg_step_completed();
-                    // if the 'finalize_registration' step has been initiated (has a timestamp)
-                    // but has not yet been fully completed (TRUE)
-                    if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-                        $this->set_reg_step_completed('finalize_registration');
-                        $this->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @since 4.10.4.p
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function recalculateLineItems()
-    {
-        $total_line_item = $this->total_line_item(false);
-        if ($total_line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
-            return EEH_Line_Item::apply_taxes($total_line_item, true);
-        }
-        return false;
-    }
+	/**
+	 * The length of time in seconds that a lock is applied before being considered expired.
+	 * It is not long because a transaction should only be locked for the duration of the request that locked it
+	 */
+	const LOCK_EXPIRATION = 2;
+
+	/**
+	 * txn status upon initial construction.
+	 *
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+
+	/**
+	 * @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_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	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);
+		$txn = $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+		if (! $has_object) {
+			$txn->set_old_txn_status($txn->status_ID());
+		}
+		return $txn;
+	}
+
+
+	/**
+	 * @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_Transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		$txn = new self($props_n_values, true, $timezone);
+		$txn->set_old_txn_status($txn->status_ID());
+		return $txn;
+	}
+
+
+	/**
+	 * Sets a meta field indicating that this TXN is locked and should not be updated in the db.
+	 * If a lock has already been set, then we will attempt to remove it in case it has expired.
+	 * If that also fails, then an exception is thrown.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function lock()
+	{
+		// attempt to set lock, but if that fails...
+		if (! $this->add_extra_meta('lock', time(), true)) {
+			// then attempt to remove the lock in case it is expired
+			if ($this->_remove_expired_lock()) {
+				// if removal was successful, then try setting lock again
+				$this->lock();
+			} else {
+				// but if the lock can not be removed, then throw an exception
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Could not lock Transaction %1$d because it is already locked, meaning another part of the system is currently editing it. It should already be unlocked by the time you read this, so please refresh the page and try again.',
+							'event_espresso'
+						),
+						$this->ID()
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * removes transaction lock applied in EE_Transaction::lock()
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function unlock()
+	{
+		return $this->delete_extra_meta('lock');
+	}
+
+
+	/**
+	 * Decides whether or not now is the right time to update the transaction.
+	 * This is useful because we don't always know if it is safe to update the transaction
+	 * and its related data. why?
+	 * because it's possible that the transaction is being used in another
+	 * request and could overwrite anything we save.
+	 * So we want to only update the txn once we know that won't happen.
+	 * We also check that the lock isn't expired, and remove it if it is
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_locked()
+	{
+		// if TXN is not locked, then return false immediately
+		if (! $this->_get_lock()) {
+			return false;
+		}
+		// if not, then let's try and remove the lock in case it's expired...
+		// _remove_expired_lock() returns 0 when lock is valid (ie: removed = false)
+		// and a positive number if the lock was removed (ie: number of locks deleted),
+		// so we need to return the opposite
+		return ! $this->_remove_expired_lock() ? true : false;
+	}
+
+
+	/**
+	 * Gets the meta field indicating that this TXN is locked
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _get_lock()
+	{
+		return (int) $this->get_extra_meta('lock', true, 0);
+	}
+
+
+	/**
+	 * If the lock on this transaction is expired, then we want to remove it so that the transaction can be updated
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _remove_expired_lock()
+	{
+		$locked = $this->_get_lock();
+		if ($locked && time() - EE_Transaction::LOCK_EXPIRATION > $locked) {
+			return $this->unlock();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * Set transaction total
+	 *
+	 * @param float $total total value of transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_total($total = 0.00)
+	{
+		$this->set('TXN_total', (float) $total);
+	}
+
+
+	/**
+	 * Set Total Amount Paid to Date
+	 *
+	 * @param float $total_paid total amount paid to date (sum of all payments)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_paid($total_paid = 0.00)
+	{
+		$this->set('TXN_paid', (float) $total_paid);
+	}
+
+
+	/**
+	 * Set transaction status
+	 *
+	 * @param string $status        whether the transaction is open, declined, accepted,
+	 *                              or any number of custom values that can be set
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_status($status = '')
+	{
+		$this->set('STS_ID', $status);
+	}
+
+
+	/**
+	 * Set hash salt
+	 *
+	 * @param string $hash_salt required for some payment gateways
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_hash_salt($hash_salt = '')
+	{
+		$this->set('TXN_hash_salt', $hash_salt);
+	}
+
+
+	/**
+	 * Sets TXN_reg_steps array
+	 *
+	 * @param array $txn_reg_steps
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_steps(array $txn_reg_steps)
+	{
+		$this->set('TXN_reg_steps', $txn_reg_steps);
+	}
+
+
+	/**
+	 * Gets TXN_reg_steps
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_steps()
+	{
+		$TXN_reg_steps = $this->get('TXN_reg_steps');
+		return is_array($TXN_reg_steps) ? (array) $TXN_reg_steps : array();
+	}
+
+
+	/**
+	 * @return string of transaction's total cost, with currency symbol and decimal
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_total()
+	{
+		return $this->get_pretty('TXN_total');
+	}
+
+
+	/**
+	 * Gets the amount paid in a pretty string (formatted and with currency symbol)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('TXN_paid');
+	}
+
+
+	/**
+	 * calculate the amount remaining for this transaction and return;
+	 *
+	 * @return float amount remaining
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remaining()
+	{
+		return $this->total() - $this->paid();
+	}
+
+
+	/**
+	 * get Transaction Total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total()
+	{
+		return (float) $this->get('TXN_total');
+	}
+
+
+	/**
+	 * get Total Amount Paid to Date
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function paid()
+	{
+		return (float) $this->get('TXN_paid');
+	}
+
+
+	/**
+	 * @return mixed|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_cart_session()
+	{
+		$session_data = (array) $this->get('TXN_session_data');
+		return isset($session_data['cart']) && $session_data['cart'] instanceof EE_Cart
+			? $session_data['cart']
+			: null;
+	}
+
+
+	/**
+	 * get Transaction session data
+	 *
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function session_data()
+	{
+		$session_data = $this->get('TXN_session_data');
+		if (empty($session_data)) {
+			$session_data = array(
+				'id'            => null,
+				'user_id'       => null,
+				'ip_address'    => null,
+				'user_agent'    => null,
+				'init_access'   => null,
+				'last_access'   => null,
+				'pages_visited' => array(),
+			);
+		}
+		return $session_data;
+	}
+
+
+	/**
+	 * Set session data within the TXN object
+	 *
+	 * @param EE_Session|array $session_data
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_txn_session_data($session_data)
+	{
+		if ($session_data instanceof EE_Session) {
+			$this->set('TXN_session_data', $session_data->get_session_data(null, true));
+		} else {
+			$this->set('TXN_session_data', $session_data);
+		}
+	}
+
+
+	/**
+	 * get Transaction hash salt
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function hash_salt_()
+	{
+		return $this->get('TXN_hash_salt');
+	}
+
+
+	/**
+	 * Returns the transaction datetime as either:
+	 *            - unix timestamp format ($format = false, $gmt = true)
+	 *            - formatted date string including the UTC (timezone) offset ($format = true ($gmt
+	 *              has no affect with this option)), this also may include a timezone abbreviation if the
+	 *              set timezone in this class differs from what the timezone is on the blog.
+	 *            - formatted date string including the UTC (timezone) offset (default).
+	 *
+	 * @param boolean $format   - whether to return a unix timestamp (default) or formatted date string
+	 * @param boolean $gmt      - whether to return a unix timestamp with UTC offset applied (default)
+	 *                          or no UTC offset applied
+	 * @return string | int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function datetime($format = false, $gmt = false)
+	{
+		if ($format) {
+			return $this->get_pretty('TXN_timestamp');
+		}
+		if ($gmt) {
+			return $this->get_raw('TXN_timestamp');
+		}
+		return $this->get('TXN_timestamp');
+	}
+
+
+	/**
+	 * Gets registrations on this transaction
+	 *
+	 * @param array   $query_params array of query parameters
+	 * @param boolean $get_cached   TRUE to retrieve cached registrations or FALSE to pull from the db
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function registrations($query_params = array(), $get_cached = false)
+	{
+		$query_params = (empty($query_params) || ! is_array($query_params))
+			? array(
+				'order_by' => array(
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+				),
+			)
+			: $query_params;
+		$query_params = $get_cached ? array() : $query_params;
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets all the attendees for this transaction (handy for use with EE_Attendee's get_registrations_for_event
+	 * function for getting attendees and how many registrations they each have for an event)
+	 *
+	 * @return mixed EE_Attendee[] by default, int if $output is set to 'COUNT'
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendees()
+	{
+		return $this->get_many_related('Attendee', array(array('Registration.Transaction.TXN_ID' => $this->ID())));
+	}
+
+
+	/**
+	 * Gets payments for this transaction. Unlike other such functions, order by 'DESC' by default
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * gets only approved payments for this transaction
+	 *
+	 * @return EE_Base_Class[]|EE_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function approved_payments()
+	{
+		EE_Registry::instance()->load_model('Payment');
+		return $this->get_many_related(
+			'Payment',
+			array(
+				array('STS_ID' => EEM_Payment::status_id_approved),
+				'order_by' => array('PAY_timestamp' => 'DESC'),
+			)
+		);
+	}
+
+
+	/**
+	 * Gets all payments which have not been approved
+	 *
+	 * @return EE_Base_Class[]|EEI_Payment[]
+	 * @throws EE_Error if a model is misconfigured somehow
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pending_payments()
+	{
+		return $this->get_many_related(
+			'Payment',
+			array(
+				array(
+					'STS_ID' => EEM_Payment::status_id_pending,
+				),
+				'order_by' => array(
+					'PAY_timestamp' => 'DESC',
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * echoes $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * returns a pretty version of the status, good for displaying to users
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->status_ID() => __('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon = '';
+		switch ($this->status_ID()) {
+			case EEM_Transaction::complete_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
+				break;
+			case EEM_Transaction::incomplete_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>'
+					: '';
+				break;
+			case EEM_Transaction::abandoned_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Transaction::failed_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
+				break;
+			case EEM_Transaction::overpaid_status_code:
+				$icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
+				break;
+		}
+		return $icon . $status[ $this->status_ID() ];
+	}
+
+
+	/**
+	 * get Transaction Status
+	 *
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Returns TRUE or FALSE for whether or not this transaction cost any money
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_free()
+	{
+		return EEH_Money::compare_floats($this->get('TXN_total'), 0, '==');
+	}
+
+
+	/**
+	 * Returns whether this transaction is complete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_completed()
+	{
+		return $this->status_ID() === EEM_Transaction::complete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is incomplete
+	 * Useful in templates and other logic for deciding if we should ask for another payment...
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Transaction::incomplete_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction is overpaid
+	 * Useful in templates and other logic for deciding if monies need to be refunded
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_overpaid()
+	{
+		return $this->status_ID() === EEM_Transaction::overpaid_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction was abandoned
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * but that contact information exists for at least one registrant
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_abandoned()
+	{
+		return $this->status_ID() === EEM_Transaction::abandoned_status_code;
+	}
+
+
+	/**
+	 * Returns whether this transaction failed
+	 * meaning that the transaction/registration process was somehow interrupted and never completed
+	 * and that NO contact information exists for any registrants
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function failed()
+	{
+		return $this->status_ID() === EEM_Transaction::failed_status_code;
+	}
+
+
+	/**
+	 * This returns the url for the invoice of this transaction
+	 *
+	 * @param string $type 'html' or 'pdf' (default is pdf)
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function invoice_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->invoice_url($type);
+	}
+
+
+	/**
+	 * Gets the primary registration only
+	 *
+	 * @return EE_Base_Class|EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function primary_registration()
+	{
+		$registrations = (array) $this->get_many_related(
+			'Registration',
+			array(array('REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT))
+		);
+		foreach ($registrations as $registration) {
+			// valid registration that is NOT cancelled or declined ?
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), EEM_Registration::closed_reg_statuses(), true)
+			) {
+				return $registration;
+			}
+		}
+		// nothing valid found, so just return first thing from array of results
+		return reset($registrations);
+	}
+
+
+	/**
+	 * Gets the URL for viewing the receipt
+	 *
+	 * @param string $type 'pdf' or 'html' (default is 'html')
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function receipt_url($type = 'html')
+	{
+		$REG = $this->primary_registration();
+		if (! $REG instanceof EE_Registration) {
+			return '';
+		}
+		return $REG->receipt_url($type);
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_url()
+	{
+		$primary_registration = $this->primary_registration();
+		return $primary_registration instanceof EE_Registration ? $primary_registration->payment_overview_url() : false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function gateway_response_on_transaction()
+	{
+		$payment = $this->get_first_related('Payment');
+		return $payment instanceof EE_Payment ? $payment->gateway_response() : '';
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Gets all the extra meta info on this payment
+	 *
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Base_Class[]|EE_Extra_Meta
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function extra_meta($query_params = array())
+	{
+		return $this->get_many_related('Extra_Meta', $query_params);
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_registration(EE_Registration $registration)
+	{
+		return $this->_add_relation_to($registration, 'Registration');
+	}
+
+
+	/**
+	 * Removes the given registration from being related (even before saving this transaction).
+	 * If an ID/index is provided and this transaction isn't saved yet, removes it from list of cached relations
+	 *
+	 * @param int $registration_or_id
+	 * @return EE_Base_Class that was removed from being related
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_registration_with_id($registration_or_id)
+	{
+		return $this->_remove_relation_to($registration_or_id, 'Registration');
+	}
+
+
+	/**
+	 * Gets all the line items which are for ACTUAL items
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function items_purchased()
+	{
+		return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_line_item)));
+	}
+
+
+	/**
+	 * Wrapper for _add_relation_to
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Base_Class the relation was added to
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_line_item(EE_Line_Item $line_item)
+	{
+		return $this->_add_relation_to($line_item, 'Line_Item');
+	}
+
+
+	/**
+	 * Gets ALL the line items related to this transaction (unstructured)
+	 *
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function line_items($query_params = array())
+	{
+		return $this->get_many_related('Line_Item', $query_params);
+	}
+
+
+	/**
+	 * Gets all the line items which are taxes on the total
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_items()
+	{
+		return $this->line_items(array(array('LIN_type' => EEM_Line_Item::type_tax)));
+	}
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other related line items,
+	 * meaning it takes them all into account on its total)
+	 *
+	 * @param bool $create_if_not_found
+	 * @return \EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function total_line_item($create_if_not_found = true)
+	{
+		$item = $this->get_first_related('Line_Item', array(array('LIN_type' => EEM_Line_Item::type_total)));
+		if (! $item && $create_if_not_found) {
+			$item = EEH_Line_Item::create_total_line_item($this);
+		}
+		return $item;
+	}
+
+
+	/**
+	 * Returns the total amount of tax on this transaction
+	 * (assumes there's only one tax subtotal line item)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total()
+	{
+		$tax_line_item = $this->tax_total_line_item();
+		if ($tax_line_item) {
+			return (float) $tax_line_item->total();
+		}
+		return (float) 0;
+	}
+
+
+	/**
+	 * Gets the tax subtotal line item (assumes there's only one)
+	 *
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function tax_total_line_item()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->total_line_item());
+	}
+
+
+	/**
+	 * Gets the array of billing info for the gateway and for this transaction's primary registration's attendee.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function billing_info()
+	{
+		$payment_method = $this->payment_method();
+		if (! $payment_method) {
+			EE_Error::add_error(
+				__(
+					'Could not find billing info for transaction because no gateway has been used for it yet',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$primary_reg = $this->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				__(
+					'Cannot get billing info for gateway %s on transaction because no primary registration exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				__(
+					'Cannot get billing info for gateway %s on transaction because the primary registration has no attendee exists',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $attendee->billing_info_for_payment_method($payment_method);
+	}
+
+
+	/**
+	 * Gets PMD_ID
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method_ID()
+	{
+		return $this->get('PMD_ID');
+	}
+
+
+	/**
+	 * Sets PMD_ID
+	 *
+	 * @param int $PMD_ID
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_payment_method_ID($PMD_ID)
+	{
+		$this->set('PMD_ID', $PMD_ID);
+	}
+
+
+	/**
+	 * Gets the last-used payment method on this transaction
+	 * (we COULD just use the last-made payment, but some payment methods, namely
+	 * offline ones, dont' create payments)
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_method()
+	{
+		$pm = $this->get_first_related('Payment_Method');
+		if ($pm instanceof EE_Payment_Method) {
+			return $pm;
+		}
+		$last_payment = $this->last_payment();
+		if ($last_payment instanceof EE_Payment && $last_payment->payment_method()) {
+			return $last_payment->payment_method();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the last payment made
+	 *
+	 * @return EE_Base_Class|EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function last_payment()
+	{
+		return $this->get_first_related('Payment', array('order_by' => array('PAY_ID' => 'desc')));
+	}
+
+
+	/**
+	 * Gets all the line items which are unrelated to tickets on this transaction
+	 *
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function non_ticket_line_items()
+	{
+		return EEM_Line_Item::instance()->get_all_non_ticket_line_items_for_transaction($this->ID());
+	}
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @param  boolean $update whether to save the TXN
+	 * @return bool whether the TXN was saved
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_status_based_on_total_paid($update = true)
+	{
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		if (EEH_Money::compare_floats($this->paid(), $this->total(), '>')) {
+			$new_txn_status = EEM_Transaction::overpaid_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total())) {
+			$new_txn_status = EEM_Transaction::complete_status_code;
+		} elseif (EEH_Money::compare_floats($this->paid(), $this->total(), '<')) {
+			$new_txn_status = EEM_Transaction::incomplete_status_code;
+		} else {
+			throw new RuntimeException(
+				__('The total paid calculation for this transaction is inaccurate.', 'event_espresso')
+			);
+		}
+		if ($new_txn_status !== $this->status_ID()) {
+			$this->set_status($new_txn_status);
+			if ($update) {
+				return $this->save() ? true : false;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the transaction's status and total_paid based on all the payments
+	 * that apply to it
+	 *
+	 * @deprecated
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_based_on_payments()
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function txn_status_updated()
+	{
+		return $this->status_ID() !== $this->_old_txn_status && $this->_old_txn_status !== null;
+	}
+
+
+	/**
+	 * _reg_steps_completed
+	 * if $check_all is TRUE, then returns TRUE if ALL reg steps have been marked as completed,
+	 * if a $reg_step_slug is provided, then this step will be skipped when testing for completion
+	 * if $check_all is FALSE and a $reg_step_slug is provided, then ONLY that reg step will be tested for completion
+	 *
+	 * @param string $reg_step_slug
+	 * @param bool   $check_all
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _reg_steps_completed($reg_step_slug = '', $check_all = true)
+	{
+		$reg_steps = $this->reg_steps();
+		if (! is_array($reg_steps) || empty($reg_steps)) {
+			return false;
+		}
+		// loop thru reg steps array)
+		foreach ($reg_steps as $slug => $reg_step_completed) {
+			// if NOT checking ALL steps (only checking one step)
+			if (! $check_all) {
+				// and this is the one
+				if ($slug === $reg_step_slug) {
+					return $reg_step_completed;
+				}
+				// skip to next reg step in loop
+				continue;
+			}
+			// $check_all must be true, else we would never have gotten to this point
+			if ($slug === $reg_step_slug) {
+				// if we reach this point, then we are testing either:
+				// all_reg_steps_completed_except() or
+				// all_reg_steps_completed_except_final_step(),
+				// and since this is the reg step EXCEPTION being tested
+				// we want to return true (yes true) if this reg step is NOT completed
+				// ie: "is everything completed except the final step?"
+				// "that is correct... the final step is not completed, but all others are."
+				return $reg_step_completed !== true;
+			}
+			if ($reg_step_completed !== true) {
+				// if any reg step is NOT completed, then ALL steps are not completed
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed()
+	{
+		return $this->_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @param string $exception
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except($exception = '')
+	{
+		return $this->_reg_steps_completed($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function all_reg_steps_completed_except_final_step()
+	{
+		return $this->_reg_steps_completed('finalize_registration');
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param string $reg_step_slug
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_step_completed($reg_step_slug)
+	{
+		return $this->_reg_steps_completed($reg_step_slug, false);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function final_reg_step_completed()
+	{
+		return $this->_reg_steps_completed('finalize_registration', false);
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_initiated($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, time());
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, true);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @param string $reg_step_slug
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_step_not_completed($reg_step_slug)
+	{
+		return $this->_set_reg_step_completed_status($reg_step_slug, false);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid reg step slug, this sets the TXN_reg_step completed status which is either:
+	 *
+	 * @param  string      $reg_step_slug
+	 * @param  boolean|int $status
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _set_reg_step_completed_status($reg_step_slug, $status)
+	{
+		// validate status
+		$status = is_bool($status) || is_int($status) ? $status : false;
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		// if reg step does NOT exist
+		if (! isset($txn_reg_steps[ $reg_step_slug ])) {
+			return false;
+		}
+		// if  we're trying to complete a step that is already completed
+		if ($txn_reg_steps[ $reg_step_slug ] === true) {
+			return true;
+		}
+		// if  we're trying to complete a step that hasn't even started
+		if ($status === true && $txn_reg_steps[ $reg_step_slug ] === false) {
+			return false;
+		}
+		// if current status value matches the incoming value (no change)
+		// type casting as int means values should collapse to either 0, 1, or a timestamp like 1234567890
+		if ((int) $txn_reg_steps[ $reg_step_slug ] === (int) $status) {
+			// this will happen in cases where multiple AJAX requests occur during the same step
+			return true;
+		}
+		// if we're trying to set a start time, but it has already been set...
+		if (is_numeric($status) && is_numeric($txn_reg_steps[ $reg_step_slug ])) {
+			// skip the update below, but don't return FALSE so that errors won't be displayed
+			return true;
+		}
+		// update completed status
+		$txn_reg_steps[ $reg_step_slug ] = $status;
+		$this->set_reg_steps($txn_reg_steps);
+		$this->save();
+		return true;
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @param string $reg_step_slug
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function remove_reg_step($reg_step_slug)
+	{
+		// get reg steps array
+		$txn_reg_steps = $this->reg_steps();
+		unset($txn_reg_steps[ $reg_step_slug ]);
+		$this->set_reg_steps($txn_reg_steps);
+	}
+
+
+	/**
+	 * toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @param bool $save
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_failed_transaction_status($save = true)
+	{
+		// if TXN status is still set as "failed"...
+		if ($this->status_ID() === EEM_Transaction::failed_status_code) {
+			$this->set_status(EEM_Transaction::abandoned_status_code);
+			if ($save) {
+				$this->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_abandoned_transaction_status()
+	{
+		// if TXN status has not been updated already due to a payment, and is still set as "failed" or "abandoned"...
+		$txn_status = $this->status_ID();
+		if (
+			$txn_status === EEM_Transaction::failed_status_code
+			|| $txn_status === EEM_Transaction::abandoned_status_code
+		) {
+			// if a contact record for the primary registrant has been created
+			if (
+				$this->primary_registration() instanceof EE_Registration
+				&& $this->primary_registration()->attendee() instanceof EE_Attendee
+			) {
+				$this->set_status(EEM_Transaction::incomplete_status_code);
+			} else {
+				// no contact record? yer abandoned!
+				$this->set_status(EEM_Transaction::abandoned_status_code);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * checks if an Abandoned TXN has any related payments, and if so,
+	 * updates the TXN status based on the amount paid
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function verify_abandoned_transaction_status()
+	{
+		if ($this->status_ID() !== EEM_Transaction::abandoned_status_code) {
+			return;
+		}
+		$payments = $this->get_many_related('Payment');
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Payment) {
+					// kk this TXN should NOT be abandoned
+					$this->update_status_based_on_total_paid();
+					if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+						EE_Error::add_attention(
+							sprintf(
+								esc_html__(
+									'The status for Transaction #%1$d has been updated from "Abandoned" to "%2$s", because at least one payment has been made towards it. If the payment appears in the "Payment Details" table below, you may need to edit its status and/or other details as well.',
+									'event_espresso'
+								),
+								$this->ID(),
+								$this->pretty_status()
+							)
+						);
+					}
+					// get final reg step status
+					$finalized = $this->final_reg_step_completed();
+					// if the 'finalize_registration' step has been initiated (has a timestamp)
+					// but has not yet been fully completed (TRUE)
+					if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+						$this->set_reg_step_completed('finalize_registration');
+						$this->save();
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @since 4.10.4.p
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function recalculateLineItems()
+	{
+		$total_line_item = $this->total_line_item(false);
+		if ($total_line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::resetIsTaxableForTickets($total_line_item);
+			return EEH_Line_Item::apply_taxes($total_line_item, true);
+		}
+		return false;
+	}
 }

core/db_classes/EE_Question_Group.class.php

Indentation +276 added lines, -276 removed lines

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