eventespresso / event-espresso-core

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +504 added lines, -504 removed lines

@@ -19,523 +19,523 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            $this->get_filename($event_id)
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
-        } else {
-            $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';
-            }
-        }
-        if (! isset($query_params['force_join'])) {
-            $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
-        }
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size(
-            \EEM_Registration::instance()->count(
-                array_diff_key(
-                    $query_params,
-                    array_flip(
-                        array('limit')
-                    )
-                )
-            )
-        );
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $job_parameters->extra_datum('question_labels'),
-            $job_parameters->extra_datum('query_params')
-        );
-        \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
-        // if we actually processed a row there, record it
-        if ($job_parameters->job_size()) {
-            $job_parameters->mark_processed(1);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            __('Registrations report started successfully...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			$this->get_filename($event_id)
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
+		} else {
+			$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';
+			}
+		}
+		if (! isset($query_params['force_join'])) {
+			$query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
+		}
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size(
+			\EEM_Registration::instance()->count(
+				array_diff_key(
+					$query_params,
+					array_flip(
+						array('limit')
+					)
+				)
+			)
+		);
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$job_parameters->extra_datum('question_labels'),
+			$job_parameters->extra_datum('query_params')
+		);
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
+		// if we actually processed a row there, record it
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			__('Registrations report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename()
-    {
-        return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql')));
-    }
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename()
+	{
+		return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql')));
+	}
 
 
-    /**
-     * Gets the questions which are to be used for this report, so they
-     * can be remembered for later
-     *
-     * @param array $registration_query_params
-     * @return array question admin labels to be used for this report
-     */
-    protected function _get_question_labels($registration_query_params)
-    {
-        $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null;
-        $question_query_params = array();
-        if ($where !== null) {
-            $question_query_params = array(
-                $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
-            );
-        }
-        $question_query_params[0]['QST_system'] = array(
-            'NOT_IN',
-            array_keys(\EEM_Attendee::instance()->system_question_to_attendee_field_mapping()),
-        );
-        if (apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
-            false,
-            $registration_query_params
-        )) {
-            $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL');
-        }
-        $question_query_params['group_by'] = array('QST_ID');
-        return array_unique(\EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
-    }
+	/**
+	 * Gets the questions which are to be used for this report, so they
+	 * can be remembered for later
+	 *
+	 * @param array $registration_query_params
+	 * @return array question admin labels to be used for this report
+	 */
+	protected function _get_question_labels($registration_query_params)
+	{
+		$where = isset($registration_query_params[0]) ? $registration_query_params[0] : null;
+		$question_query_params = array();
+		if ($where !== null) {
+			$question_query_params = array(
+				$this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
+			);
+		}
+		$question_query_params[0]['QST_system'] = array(
+			'NOT_IN',
+			array_keys(\EEM_Attendee::instance()->system_question_to_attendee_field_mapping()),
+		);
+		if (apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
+			false,
+			$registration_query_params
+		)) {
+			$question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL');
+		}
+		$question_query_params['group_by'] = array('QST_ID');
+		return array_unique(\EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
+	}
 
 
-    /**
-     * Takes where params meant for registrations and changes them to work for questions
-     *
-     * @param array $reg_where_params
-     * @return array
-     */
-    protected function _change_registration_where_params_to_question_where_params($reg_where_params)
-    {
-        $question_where_params = array();
-        foreach ($reg_where_params as $key => $val) {
-            if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
-            }
-        }
-        return $question_where_params;
-    }
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 */
+	protected function _change_registration_where_params_to_question_where_params($reg_where_params)
+	{
+		$question_where_params = array();
+		foreach ($reg_where_params as $key => $val) {
+			if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+			}
+		}
+		return $question_where_params;
+	}
 
 
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws \EE_Error
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params')
-            );
-            \EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
-            $units_processed = count($csv_data);
-        } else {
-            $units_processed = 0;
-        }
-        $job_parameters->mark_processed($units_processed);
-        $extra_response_data = array(
-            'file_url' => '',
-        );
-        if ($units_processed < $batch_size) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-        }
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws \EE_Error
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				$job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params')
+			);
+			\EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+			$units_processed = count($csv_data);
+		} else {
+			$units_processed = 0;
+		}
+		$job_parameters->mark_processed($units_processed);
+		$extra_response_data = array(
+			'file_url' => '',
+		);
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+		}
 
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)),
-            $extra_response_data
-        );
-    }
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)),
+			$extra_response_data
+		);
+	}
 
 
-    /**
-     * Gets the csv data for a batch of registrations
-     *
-     * @param int|null $event_id
-     * @param int      $offset
-     * @param int      $limit
-     * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
-     * @param array    $query_params    for using where querying the model
-     * @return array top-level keys are numeric, next-level keys are column headers
-     */
-    public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
-    {
-        $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['limit'] = array($offset, $limit);
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        $registration_ids = array();
-        foreach ($registration_rows as $reg_row) {
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
-        }
-        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'),
-                        \EEH_Export::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 = \EEH_Export::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(
-                            __('%1$s of %2$s', 'event_espresso'),
-                            \EEH_Export::prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_count',
-                                $reg_row['Registration.REG_count']
-                            ),
-                            \EEH_Export::prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_group_size',
-                                $reg_row['Registration.REG_group_size']
-                            )
-                        );
-                    } elseif ($field_name == 'REG_date') {
-                        $value = \EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_date'],
-                            'no_html'
-                        );
-                    } else {
-                        $value = \EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
-                        );
-                    }
-                    $reg_csv_array[ \EEH_Export::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 transaction 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
-                    ? \EEH_Export::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
-                    ? \EEH_Export::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 = \EEH_Export::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[] = \EEH_Export::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 = \EEH_Export::prepare_value_from_db_for_display(
-                                \EEM_Attendee::instance(),
-                                $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
-                            );
-                        }
-                    } else {
-                        $value = '';
-                    }
-                    $reg_csv_array[ \EEH_Export::get_column_name_for_field($field_obj) ] = $value;
-                }
-                // make sure each registration has the same questions in the same order
-                foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[ $question_label ])) {
-                        $reg_csv_array[ $question_label ] = null;
-                    }
-                }
-                $answers = \EEM_Answer::instance()->get_all_wpdb_results(array(
-                    array('REG_ID' => $reg_row['Registration.REG_ID']),
-                    'force_join' => array('Question'),
-                ));
-                // now fill out the questions THEY answered
-                foreach ($answers as $answer_row) {
-                    if ($answer_row['Question.QST_ID']) {
-                        $question_label = \EEH_Export::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 {
-                        // this isn't for html, so don't show html entities
-                        $reg_csv_array[ $question_label ] = html_entity_decode(
-                            \EEH_Export::prepare_value_from_db_for_display(
-                                \EEM_Answer::instance(),
-                                'ANS_value',
-                                $answer_row['Answer.ANS_value']
-                            )
-                        );
-                    }
-                }
-                /**
-                 * Filter to change the contents of each row of the registrations report CSV file.
-                 * This can be used to add or remote columns from the CSV file, or change their values.                 *
-                 * Note: it has this name because originally that's where this filter resided,
-                 * and we've left its name as-is for backward compatibility.
-                 * Note when using: all rows in the CSV should have the same columns.
-                 *
-                 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
-                 *                             in this row
-                 * @param array $reg_row       is the row from the database's wp_esp_registration table
-                 */
-                $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[ \EEH_Export::get_column_name_for_field($field) ] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int      $offset
+	 * @param int      $limit
+	 * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array    $query_params    for using where querying the model
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 */
+	public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
+	{
+		$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['limit'] = array($offset, $limit);
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		$registration_ids = array();
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
+		}
+		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'),
+						\EEH_Export::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 = \EEH_Export::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(
+							__('%1$s of %2$s', 'event_espresso'),
+							\EEH_Export::prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_count',
+								$reg_row['Registration.REG_count']
+							),
+							\EEH_Export::prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_group_size',
+								$reg_row['Registration.REG_group_size']
+							)
+						);
+					} elseif ($field_name == 'REG_date') {
+						$value = \EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_date'],
+							'no_html'
+						);
+					} else {
+						$value = \EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row[ $field->get_qualified_column() ]
+						);
+					}
+					$reg_csv_array[ \EEH_Export::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 transaction 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
+					? \EEH_Export::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
+					? \EEH_Export::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 = \EEH_Export::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[] = \EEH_Export::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 = \EEH_Export::prepare_value_from_db_for_display(
+								\EEM_Attendee::instance(),
+								$att_field_name,
+								$reg_row[ $field_obj->get_qualified_column() ]
+							);
+						}
+					} else {
+						$value = '';
+					}
+					$reg_csv_array[ \EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+				}
+				// make sure each registration has the same questions in the same order
+				foreach ($question_labels as $question_label) {
+					if (! isset($reg_csv_array[ $question_label ])) {
+						$reg_csv_array[ $question_label ] = null;
+					}
+				}
+				$answers = \EEM_Answer::instance()->get_all_wpdb_results(array(
+					array('REG_ID' => $reg_row['Registration.REG_ID']),
+					'force_join' => array('Question'),
+				));
+				// now fill out the questions THEY answered
+				foreach ($answers as $answer_row) {
+					if ($answer_row['Question.QST_ID']) {
+						$question_label = \EEH_Export::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 {
+						// this isn't for html, so don't show html entities
+						$reg_csv_array[ $question_label ] = html_entity_decode(
+							\EEH_Export::prepare_value_from_db_for_display(
+								\EEM_Answer::instance(),
+								'ANS_value',
+								$answer_row['Answer.ANS_value']
+							)
+						);
+					}
+				}
+				/**
+				 * Filter to change the contents of each row of the registrations report CSV file.
+				 * This can be used to add or remote columns from the CSV file, or change their values.                 *
+				 * Note: it has this name because originally that's where this filter resided,
+				 * and we've left its name as-is for backward compatibility.
+				 * Note when using: all rows in the CSV should have the same columns.
+				 *
+				 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
+				 *                             in this row
+				 * @param array $reg_row       is the row from the database's wp_esp_registration table
+				 */
+				$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[ \EEH_Export::get_column_name_for_field($field) ] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
 
 
-    /**
-     * Counts total unit to process
-     *
-     * @deprecated since 4.9.19
-     * @param int|array $event_id
-     * @return int
-     */
-    public function count_units_to_process($event_id)
-    {
-        // use the legacy filter
-        if ($event_id) {
-            $query_params[0]['EVT_ID'] = $event_id;
-        } else {
-            $query_params['force_join'][] = 'Event';
-        }
-        return \EEM_Registration::instance()->count($query_params);
-    }
+	/**
+	 * Counts total unit to process
+	 *
+	 * @deprecated since 4.9.19
+	 * @param int|array $event_id
+	 * @return int
+	 */
+	public function count_units_to_process($event_id)
+	{
+		// use the legacy filter
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
+		}
+		return \EEM_Registration::instance()->count($query_params);
+	}
 
 
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return boolean
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->_file_helper->delete(
-            \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed.
+	 * In this case, we delete the temporary file
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return boolean
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->_file_helper->delete(
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.69.rc.002');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.69.rc.002');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }