eventespresso / event-espresso-core

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +467 added lines, -467 removed lines

@@ -41,486 +41,486 @@
  */
 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
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $event_id = (int) $job_parameters->request_datum('EVT_ID', '0');
-        $DTT_ID = (int) $job_parameters->request_datum('DTT_ID', '0');
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(esc_html__('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()
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        $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($this->count_units_to_process($query_params));
-        // 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'),
-            $DTT_ID
-        );
-        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,
-            esc_html__('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
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$event_id = (int) $job_parameters->request_datum('EVT_ID', '0');
+		$DTT_ID = (int) $job_parameters->request_datum('DTT_ID', '0');
+		if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(esc_html__('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()
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		$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($this->count_units_to_process($query_params));
+		// 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'),
+			$DTT_ID
+		);
+		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,
+			esc_html__('Registrations report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename()
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
-            sprintf(
-                "event-espresso-registrations-%s.csv",
-                str_replace(array(':', ' '), '-', current_time('mysql'))
-            )
-        );
-    }
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename()
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
+			sprintf(
+				"event-espresso-registrations-%s.csv",
+				str_replace(array(':', ' '), '-', 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
-     * @throws EE_Error
-     */
-    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]),
-            );
-        }
-        // Make sure it's not a system question
-        $question_query_params[0]['OR*not-system-questions'] = [
-            'QST_system' => '',
-            'QST_system*null' => ['IS_NULL']
-        ];
-        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
+	 * @throws EE_Error
+	 */
+	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]),
+			);
+		}
+		// Make sure it's not a system question
+		$question_query_params[0]['OR*not-system-questions'] = [
+			'QST_system' => '',
+			'QST_system*null' => ['IS_NULL']
+		];
+		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
-     * @throws EE_Error
-     */
-    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
+	 * @throws EE_Error
+	 */
+	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
-     * @throws ReflectionException
-     */
-    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(
-                (int) $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'),
-                (int) $job_parameters->request_datum('DTT_ID', '0')
-            );
-            EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
-            $units_processed = count($csv_data);
-        } else {
-            $csv_data = array();
-            $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
+	 * @throws ReflectionException
+	 */
+	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(
+				(int) $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'),
+				(int) $job_parameters->request_datum('DTT_ID', '0')
+			);
+			EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+			$units_processed = count($csv_data);
+		} else {
+			$csv_data = array();
+			$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(esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)),
-            $extra_response_data
-        );
-    }
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(esc_html__('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
-     * @param int $DTT_ID
-     * @return array top-level keys are numeric, next-level keys are column headers
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params, $DTT_ID = 0)
-    {
-        $reg_fields_to_include = [
-            'TXN_ID',
-            'ATT_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        ];
-        $att_fields_to_include = [
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        ];
-        $registrations_csv_ready_array = [];
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        $query_params['limit'] = [$offset, $limit];
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        foreach ($registration_rows as $reg_row) {
-            if (!is_array($reg_row)) {
-                continue;
-            }
-            $reg_csv_array = [];
-            // registration Id
-            $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] = EEH_Export::prepare_value_from_db_for_display(
-                $reg_model,
-                'REG_ID',
-                $reg_row[ $reg_id_field->get_qualified_column() ]
-            );
-            if (! $event_id) {
-                // get the event's name and Id
-                $reg_csv_array[ (string) esc_html__('Event', 'event_espresso') ] = sprintf(
-                    /* translators: 1: event name, 2: event ID */
-                    esc_html__('%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']
-                );
-            }
-            // add attendee columns
-            $reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
-            // add registration columns
-            $reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_model, $reg_csv_array);
-            // get pretty status
-            $stati = EEM_Status::instance()->localized_status(
-                [
-                    $reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
-                    $reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
-                ],
-                false,
-                'sentence'
-            );
-            $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-            $reg_csv_array[ (string) esc_html__("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ];
-            // get pretty transaction status
-            $reg_csv_array[ (string) esc_html__("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ (string) esc_html__('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[ (string) esc_html__('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 = [];
-            $gateway_txn_ids_etc = [];
-            $payment_times = [];
-            if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                $payments_info = EEM_Payment::instance()->get_all_wpdb_results(
-                    [
-                        [
-                            'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                            'STS_ID' => EEM_Payment::status_id_approved,
-                        ],
-                        'force_join' => ['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'
-                );
-                list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
-            }
-            $reg_csv_array[ (string) esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-            $reg_csv_array[ (string) esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-            $reg_csv_array[ (string) esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                ',',
-                $gateway_txn_ids_etc
-            );
-            // 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 = [];
-                foreach (
-                    EEM_Datetime::instance()->get_all_wpdb_results(
-                        [
-                            ['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
-                            'order_by' => ['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 = esc_html__('Unknown', 'event_espresso');
-                $datetimes_strings = [esc_html__('Unknown', 'event_espresso')];
-            }
-            $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-            $reg_csv_array[ (string) esc_html__("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
-            // add answer columns
-            $reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
-            // Include check-in data
-            if ($event_id && $DTT_ID) {
-                // get whether or not the user has checked in
-                $reg_csv_array[ (string) esc_html__('Datetime Check-ins #', 'event_espresso') ] = $reg_model->count_related(
-                    $reg_row['Registration.REG_ID'],
-                    'Checkin',
-                    [
-                        [
-                            'DTT_ID' => $DTT_ID
-                        ]
-                    ]
-                );
-                /** @var EE_Datetime $datetime */
-                $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-                $checkin_rows = EEM_Checkin::instance()->get_all(
-                    [
-                        [
-                            'REG_ID' => $reg_row['Registration.REG_ID'],
-                            'DTT_ID' => $datetime->get('DTT_ID'),
-                        ],
-                    ]
-                );
-                $checkins = [];
-                foreach ($checkin_rows as $checkin_row) {
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    if ($checkin_value) {
-                        $checkins[] = $checkin_value;
-                    }
-                }
-                $datetime_name = CheckinsCSV::getDatetineLabel($datetime);
-                $reg_csv_array[ (string) $datetime_name ] = implode(' --- ', $checkins);
-            } elseif ($event_id) {
-                // get whether or not the user has checked in
-                $reg_csv_array[ (string) esc_html__('Event Check-ins #', 'event_espresso') ] = $reg_model->count_related(
-                    $reg_row['Registration.REG_ID'],
-                    'Checkin'
-                );
-                $datetimes = EEM_Datetime::instance()->get_all(
-                    [
-                        [
-                            'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
-                        ],
-                        'order_by' => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_row = EEM_Checkin::instance()->get_one(
-                        [
-                            [
-                                'REG_ID' => $reg_row['Registration.REG_ID'],
-                                'DTT_ID' => $datetime->get('DTT_ID'),
-                            ],
-                            'limit' => 1,
-                            'order_by' => [
-                                'CHK_ID' => 'DESC'
-                            ]
-                        ]
-                    );
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    $datetime_name = CheckinsCSV::getDatetineLabel($datetime);
-                    $reg_csv_array[ (string) $datetime_name ] = $checkin_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 when using: all rows in the CSV should have the same columns.
-             * @param array $reg_csv_array keys are the column names, values are their cell values
-             * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results()
-             */
-            $registrations_csv_ready_array[] = apply_filters(
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__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 = [];
-            $model_and_fields_to_include = [
-                '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
+	 * @param int $DTT_ID
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params, $DTT_ID = 0)
+	{
+		$reg_fields_to_include = [
+			'TXN_ID',
+			'ATT_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		];
+		$att_fields_to_include = [
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		];
+		$registrations_csv_ready_array = [];
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		$query_params['limit'] = [$offset, $limit];
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		foreach ($registration_rows as $reg_row) {
+			if (!is_array($reg_row)) {
+				continue;
+			}
+			$reg_csv_array = [];
+			// registration Id
+			$reg_id_field = $reg_model->field_settings_for('REG_ID');
+			$reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] = EEH_Export::prepare_value_from_db_for_display(
+				$reg_model,
+				'REG_ID',
+				$reg_row[ $reg_id_field->get_qualified_column() ]
+			);
+			if (! $event_id) {
+				// get the event's name and Id
+				$reg_csv_array[ (string) esc_html__('Event', 'event_espresso') ] = sprintf(
+					/* translators: 1: event name, 2: event ID */
+					esc_html__('%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']
+				);
+			}
+			// add attendee columns
+			$reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
+			// add registration columns
+			$reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_model, $reg_csv_array);
+			// get pretty status
+			$stati = EEM_Status::instance()->localized_status(
+				[
+					$reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
+					$reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
+				],
+				false,
+				'sentence'
+			);
+			$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
+			$reg_csv_array[ (string) esc_html__("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ];
+			// get pretty transaction status
+			$reg_csv_array[ (string) esc_html__("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
+			$reg_csv_array[ (string) esc_html__('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[ (string) esc_html__('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 = [];
+			$gateway_txn_ids_etc = [];
+			$payment_times = [];
+			if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+				$payments_info = EEM_Payment::instance()->get_all_wpdb_results(
+					[
+						[
+							'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+							'STS_ID' => EEM_Payment::status_id_approved,
+						],
+						'force_join' => ['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'
+				);
+				list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
+			}
+			$reg_csv_array[ (string) esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
+			$reg_csv_array[ (string) esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
+			$reg_csv_array[ (string) esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+				',',
+				$gateway_txn_ids_etc
+			);
+			// 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 = [];
+				foreach (
+					EEM_Datetime::instance()->get_all_wpdb_results(
+						[
+							['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
+							'order_by' => ['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 = esc_html__('Unknown', 'event_espresso');
+				$datetimes_strings = [esc_html__('Unknown', 'event_espresso')];
+			}
+			$reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+			$reg_csv_array[ (string) esc_html__("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+			// add answer columns
+			$reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
+			// Include check-in data
+			if ($event_id && $DTT_ID) {
+				// get whether or not the user has checked in
+				$reg_csv_array[ (string) esc_html__('Datetime Check-ins #', 'event_espresso') ] = $reg_model->count_related(
+					$reg_row['Registration.REG_ID'],
+					'Checkin',
+					[
+						[
+							'DTT_ID' => $DTT_ID
+						]
+					]
+				);
+				/** @var EE_Datetime $datetime */
+				$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+				$checkin_rows = EEM_Checkin::instance()->get_all(
+					[
+						[
+							'REG_ID' => $reg_row['Registration.REG_ID'],
+							'DTT_ID' => $datetime->get('DTT_ID'),
+						],
+					]
+				);
+				$checkins = [];
+				foreach ($checkin_rows as $checkin_row) {
+					/** @var EE_Checkin $checkin_row */
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					if ($checkin_value) {
+						$checkins[] = $checkin_value;
+					}
+				}
+				$datetime_name = CheckinsCSV::getDatetineLabel($datetime);
+				$reg_csv_array[ (string) $datetime_name ] = implode(' --- ', $checkins);
+			} elseif ($event_id) {
+				// get whether or not the user has checked in
+				$reg_csv_array[ (string) esc_html__('Event Check-ins #', 'event_espresso') ] = $reg_model->count_related(
+					$reg_row['Registration.REG_ID'],
+					'Checkin'
+				);
+				$datetimes = EEM_Datetime::instance()->get_all(
+					[
+						[
+							'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
+						],
+						'order_by' => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					/** @var EE_Checkin $checkin_row */
+					$checkin_row = EEM_Checkin::instance()->get_one(
+						[
+							[
+								'REG_ID' => $reg_row['Registration.REG_ID'],
+								'DTT_ID' => $datetime->get('DTT_ID'),
+							],
+							'limit' => 1,
+							'order_by' => [
+								'CHK_ID' => 'DESC'
+							]
+						]
+					);
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					$datetime_name = CheckinsCSV::getDatetineLabel($datetime);
+					$reg_csv_array[ (string) $datetime_name ] = $checkin_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 when using: all rows in the CSV should have the same columns.
+			 * @param array $reg_csv_array keys are the column names, values are their cell values
+			 * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results()
+			 */
+			$registrations_csv_ready_array[] = apply_filters(
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__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 = [];
+			$model_and_fields_to_include = [
+				'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
-     *
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_units_to_process($query_params)
-    {
-        return EEM_Registration::instance()->count(
-            array_diff_key(
-                $query_params,
-                array_flip(
-                    ['limit']
-                )
-            )
-        );
-    }
+	/**
+	 * Counts total unit to process
+	 *
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_units_to_process($query_params)
+	{
+		return EEM_Registration::instance()->count(
+			array_diff_key(
+				$query_params,
+				array_flip(
+					['limit']
+				)
+			)
+		);
+	}
 
 
-    /**
-     * 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 JobStepResponse
-     * @throws EE_Error
-     */
-    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, esc_html__('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 JobStepResponse
+	 * @throws EE_Error
+	 */
+	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, esc_html__('Cleaned up temporary file', 'event_espresso'));
+	}
 }

Spacing +23 added lines, -23 removed lines

@@ -58,7 +58,7 @@ 
     {
         $event_id = (int) $job_parameters->request_datum('EVT_ID', '0');
         $DTT_ID = (int) $job_parameters->request_datum('DTT_ID', '0');
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+        if ( ! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
             throw new BatchRequestException(esc_html__('You do not have permission to view registrations', 'event_espresso'));
         }
         $filepath = $this->create_file_from_job_with_name(
@@ -91,7 +91,7 @@ 
         } else {
             $query_params['force_join'][] = 'Event';
         }
-        if (! isset($query_params['force_join'])) {
+        if ( ! isset($query_params['force_join'])) {
             $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
         }
         $job_parameters->add_extra_data('query_params', $query_params);
@@ -184,10 +184,10 @@ 
         $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);
+                $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;
+                $question_where_params['Question_Group.Event.Registration.'.$key] = $val;
             }
         }
         return $question_where_params;
@@ -277,20 +277,20 @@ 
         $query_params['limit'] = [$offset, $limit];
         $registration_rows = $reg_model->get_all_wpdb_results($query_params);
         foreach ($registration_rows as $reg_row) {
-            if (!is_array($reg_row)) {
+            if ( ! is_array($reg_row)) {
                 continue;
             }
             $reg_csv_array = [];
             // registration Id
             $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] = EEH_Export::prepare_value_from_db_for_display(
+            $reg_csv_array[EEH_Export::get_column_name_for_field($reg_id_field)] = EEH_Export::prepare_value_from_db_for_display(
                 $reg_model,
                 'REG_ID',
-                $reg_row[ $reg_id_field->get_qualified_column() ]
+                $reg_row[$reg_id_field->get_qualified_column()]
             );
-            if (! $event_id) {
+            if ( ! $event_id) {
                 // get the event's name and Id
-                $reg_csv_array[ (string) esc_html__('Event', 'event_espresso') ] = sprintf(
+                $reg_csv_array[(string) esc_html__('Event', 'event_espresso')] = sprintf(
                     /* translators: 1: event name, 2: event ID */
                     esc_html__('%1$s (%2$s)', 'event_espresso'),
                     EEH_Export::prepare_value_from_db_for_display(
@@ -315,17 +315,17 @@ 
                 'sentence'
             );
             $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-            $reg_csv_array[ (string) esc_html__("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ];
+            $reg_csv_array[(string) esc_html__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
             // get pretty transaction status
-            $reg_csv_array[ (string) esc_html__("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ (string) esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+            $reg_csv_array[(string) esc_html__("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
+            $reg_csv_array[(string) esc_html__('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[ (string) esc_html__('Amount Paid', 'event_espresso') ] = $is_primary_reg
+            $reg_csv_array[(string) esc_html__('Amount Paid', 'event_espresso')] = $is_primary_reg
                 ? EEH_Export::prepare_value_from_db_for_display(
                     EEM_Transaction::instance(),
                     'TXN_paid',
@@ -349,9 +349,9 @@ 
                 );
                 list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
             }
-            $reg_csv_array[ (string) esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-            $reg_csv_array[ (string) esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-            $reg_csv_array[ (string) esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+            $reg_csv_array[(string) esc_html__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+            $reg_csv_array[(string) esc_html__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+            $reg_csv_array[(string) esc_html__('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                 ',',
                 $gateway_txn_ids_etc
             );
@@ -383,14 +383,14 @@ 
                 $ticket_name = esc_html__('Unknown', 'event_espresso');
                 $datetimes_strings = [esc_html__('Unknown', 'event_espresso')];
             }
-            $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-            $reg_csv_array[ (string) esc_html__("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings);
+            $reg_csv_array[(string) $ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
+            $reg_csv_array[(string) esc_html__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
             // add answer columns
             $reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
             // Include check-in data
             if ($event_id && $DTT_ID) {
                 // get whether or not the user has checked in
-                $reg_csv_array[ (string) esc_html__('Datetime Check-ins #', 'event_espresso') ] = $reg_model->count_related(
+                $reg_csv_array[(string) esc_html__('Datetime Check-ins #', 'event_espresso')] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin',
                     [
@@ -418,10 +418,10 @@ 
                     }
                 }
                 $datetime_name = CheckinsCSV::getDatetineLabel($datetime);
-                $reg_csv_array[ (string) $datetime_name ] = implode(' --- ', $checkins);
+                $reg_csv_array[(string) $datetime_name] = implode(' --- ', $checkins);
             } elseif ($event_id) {
                 // get whether or not the user has checked in
-                $reg_csv_array[ (string) esc_html__('Event Check-ins #', 'event_espresso') ] = $reg_model->count_related(
+                $reg_csv_array[(string) esc_html__('Event Check-ins #', 'event_espresso')] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin'
                 );
@@ -450,7 +450,7 @@ 
                     );
                     $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
                     $datetime_name = CheckinsCSV::getDatetineLabel($datetime);
-                    $reg_csv_array[ (string) $datetime_name ] = $checkin_value;
+                    $reg_csv_array[(string) $datetime_name] = $checkin_value;
                 }
             }
             /**
@@ -477,7 +477,7 @@ 
                 $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;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = null;
                 }
             }
             $registrations_csv_ready_array[] = $reg_csv_array;

core/domain/services/admin/registrations/list_table/csv_reports/RegistrationCSV.php

Indentation +62 added lines, -62 removed lines

@@ -19,66 +19,66 @@
 class RegistrationCSV
 {
 
-    /**
-     * Adds registration columns to the CSV row
-     *
-     * @param array $fields
-     * @param array $reg_row
-     * @param EEM_Registration $reg_model
-     * @param array $data
-     * @return mixed
-     * @throws EE_Error
-     */
-    public static function addRegistrationColumns(array $fields, array $reg_row, EEM_Registration $reg_model, array $data)
-    {
-        foreach ($fields as $field_name) {
-            $field = $reg_model->field_settings_for($field_name);
-            switch ($field_name) {
-                case 'REG_final_price':
-                    $value = EEH_Export::prepare_value_from_db_for_display(
-                        $reg_model,
-                        $field_name,
-                        $reg_row['Registration.REG_final_price'],
-                        'localized_float'
-                    );
-                    break;
-                case 'REG_count':
-                    $value = sprintf(
-                        /* translators: 1: number of registration in group (REG_count), 2: registration group size (REG_group_size) */
-                        esc_html__('%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']
-                        )
-                    );
-                    break;
-                case 'REG_date':
-                    $value = EEH_Export::prepare_value_from_db_for_display(
-                        $reg_model,
-                        $field_name,
-                        $reg_row['Registration.REG_date'],
-                        'no_html'
-                    );
-                    break;
-                default:
-                    $value = EEH_Export::prepare_value_from_db_for_display(
-                        $reg_model,
-                        $field_name,
-                        $reg_row[ $field->get_qualified_column() ]
-                    );
-            }
-            $data[ EEH_Export::get_column_name_for_field($field) ] = $value;
-            if ($field_name == 'REG_final_price') {
-                // add a column named Currency after the final price
-                $data[ (string) esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
-            }
-        }
-        return $data;
-    }
+	/**
+	 * Adds registration columns to the CSV row
+	 *
+	 * @param array $fields
+	 * @param array $reg_row
+	 * @param EEM_Registration $reg_model
+	 * @param array $data
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public static function addRegistrationColumns(array $fields, array $reg_row, EEM_Registration $reg_model, array $data)
+	{
+		foreach ($fields as $field_name) {
+			$field = $reg_model->field_settings_for($field_name);
+			switch ($field_name) {
+				case 'REG_final_price':
+					$value = EEH_Export::prepare_value_from_db_for_display(
+						$reg_model,
+						$field_name,
+						$reg_row['Registration.REG_final_price'],
+						'localized_float'
+					);
+					break;
+				case 'REG_count':
+					$value = sprintf(
+						/* translators: 1: number of registration in group (REG_count), 2: registration group size (REG_group_size) */
+						esc_html__('%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']
+						)
+					);
+					break;
+				case 'REG_date':
+					$value = EEH_Export::prepare_value_from_db_for_display(
+						$reg_model,
+						$field_name,
+						$reg_row['Registration.REG_date'],
+						'no_html'
+					);
+					break;
+				default:
+					$value = EEH_Export::prepare_value_from_db_for_display(
+						$reg_model,
+						$field_name,
+						$reg_row[ $field->get_qualified_column() ]
+					);
+			}
+			$data[ EEH_Export::get_column_name_for_field($field) ] = $value;
+			if ($field_name == 'REG_final_price') {
+				// add a column named Currency after the final price
+				$data[ (string) esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+			}
+		}
+		return $data;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -70,13 +70,13 @@
                     $value = EEH_Export::prepare_value_from_db_for_display(
                         $reg_model,
                         $field_name,
-                        $reg_row[ $field->get_qualified_column() ]
+                        $reg_row[$field->get_qualified_column()]
                     );
             }
-            $data[ EEH_Export::get_column_name_for_field($field) ] = $value;
+            $data[EEH_Export::get_column_name_for_field($field)] = $value;
             if ($field_name == 'REG_final_price') {
                 // add a column named Currency after the final price
-                $data[ (string) esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+                $data[(string) esc_html__("Currency", "event_espresso")] = EE_Config::instance()->currency->code;
             }
         }
         return $data;

core/domain/services/admin/registrations/list_table/csv_reports/AttendeeCSV.php

Indentation +45 added lines, -45 removed lines

@@ -18,49 +18,49 @@
 class AttendeeCSV
 {
 
-    /**
-     * Adds attendee columns to the CSV row
-     *
-     * @param array $fields
-     * @param array $reg_row
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     */
-    public static function addAttendeeColumns(array $fields, array $reg_row, array $data)
-    {
-        foreach ($fields as $field_name) {
-            $field_obj = EEM_Attendee::instance()->field_settings_for($field_name);
-            if ($reg_row['Attendee_CPT.ID']) {
-                switch ($field_name) {
-                    case 'STA_ID':
-                        $value = EEM_State::instance()->get_var(
-                            [
-                                ['STA_ID' => $reg_row['Attendee_Meta.STA_ID']]
-                            ],
-                            'STA_name'
-                        );
-                        break;
-                    case 'CNT_ISO':
-                        $value = EEM_Country::instance()->get_var(
-                            [
-                                ['CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO']]
-                            ],
-                            'CNT_name'
-                        );
-                        break;
-                    default:
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            EEM_Attendee::instance(),
-                            $field_name,
-                            $reg_row[ $field_obj->get_qualified_column() ]
-                        );
-                }
-            } else {
-                $value = '';
-            }
-            $data[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
-        }
-        return $data;
-    }
+	/**
+	 * Adds attendee columns to the CSV row
+	 *
+	 * @param array $fields
+	 * @param array $reg_row
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function addAttendeeColumns(array $fields, array $reg_row, array $data)
+	{
+		foreach ($fields as $field_name) {
+			$field_obj = EEM_Attendee::instance()->field_settings_for($field_name);
+			if ($reg_row['Attendee_CPT.ID']) {
+				switch ($field_name) {
+					case 'STA_ID':
+						$value = EEM_State::instance()->get_var(
+							[
+								['STA_ID' => $reg_row['Attendee_Meta.STA_ID']]
+							],
+							'STA_name'
+						);
+						break;
+					case 'CNT_ISO':
+						$value = EEM_Country::instance()->get_var(
+							[
+								['CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO']]
+							],
+							'CNT_name'
+						);
+						break;
+					default:
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							EEM_Attendee::instance(),
+							$field_name,
+							$reg_row[ $field_obj->get_qualified_column() ]
+						);
+				}
+			} else {
+				$value = '';
+			}
+			$data[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+		}
+		return $data;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -53,13 +53,13 @@
                         $value = EEH_Export::prepare_value_from_db_for_display(
                             EEM_Attendee::instance(),
                             $field_name,
-                            $reg_row[ $field_obj->get_qualified_column() ]
+                            $reg_row[$field_obj->get_qualified_column()]
                         );
                 }
             } else {
                 $value = '';
             }
-            $data[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+            $data[EEH_Export::get_column_name_for_field($field_obj)] = $value;
         }
         return $data;
     }

core/domain/services/admin/registrations/list_table/csv_reports/PaymentsInfoCSV.php

Indentation +24 added lines, -24 removed lines

@@ -12,28 +12,28 @@
 class PaymentsInfoCSV
 {
 
-    /**
-     * Extracts payment information using the payment records
-     *
-     * @param array $payments_info
-     * @return array
-     */
-    public static function extractPaymentInfo(array $payments_info)
-    {
-        $payment_methods = [];
-        $gateway_txn_ids_etc = [];
-        $payment_times = [];
-        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']
-                : esc_html__('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']
-                : '';
-        }
-        return [$payment_methods, $gateway_txn_ids_etc, $payment_times];
-    }
+	/**
+	 * Extracts payment information using the payment records
+	 *
+	 * @param array $payments_info
+	 * @return array
+	 */
+	public static function extractPaymentInfo(array $payments_info)
+	{
+		$payment_methods = [];
+		$gateway_txn_ids_etc = [];
+		$payment_times = [];
+		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']
+				: esc_html__('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']
+				: '';
+		}
+		return [$payment_methods, $gateway_txn_ids_etc, $payment_times];
+	}
 }

core/domain/services/admin/registrations/list_table/csv_reports/AnswersCSV.php

Indentation +57 added lines, -57 removed lines

@@ -18,61 +18,61 @@
 class AnswersCSV
 {
 
-    /**
-     * Add question / answer columns to the CSV row
-     *
-     * @param array $reg_row
-     * @param array $data
-     * @param array $question_labels
-     * @return mixed
-     * @throws EE_Error
-     */
-    public static function addAnswerColumns(array $reg_row, $data, $question_labels)
-    {
-        // make sure each registration has the same questions in the same order
-        foreach ($question_labels as $question_label) {
-            if (! isset($data[ $question_label ])) {
-                $data[ $question_label ] = null;
-            }
-        }
-        $answers = EEM_Answer::instance()->get_all_wpdb_results([
-            ['REG_ID' => $reg_row['Registration.REG_ID']],
-            'force_join' => ['Question'],
-        ]);
-        // now fill out the questions THEY answered
-        foreach ($answers as $answer_row) {
-            if ($answer_row['Question.QST_system']) {
-                // it's an answer to a system question. That was already displayed as part of the attendee
-                // fields, so don't write it out again thanks.
-                continue;
-            }
-            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(esc_html__('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
-            ) {
-                $data[ $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
-                $data[ $question_label ] = html_entity_decode(
-                    EEH_Export::prepare_value_from_db_for_display(
-                        EEM_Answer::instance(),
-                        'ANS_value',
-                        $answer_row['Answer.ANS_value']
-                    )
-                );
-            }
-        }
-        return $data;
-    }
+	/**
+	 * Add question / answer columns to the CSV row
+	 *
+	 * @param array $reg_row
+	 * @param array $data
+	 * @param array $question_labels
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public static function addAnswerColumns(array $reg_row, $data, $question_labels)
+	{
+		// make sure each registration has the same questions in the same order
+		foreach ($question_labels as $question_label) {
+			if (! isset($data[ $question_label ])) {
+				$data[ $question_label ] = null;
+			}
+		}
+		$answers = EEM_Answer::instance()->get_all_wpdb_results([
+			['REG_ID' => $reg_row['Registration.REG_ID']],
+			'force_join' => ['Question'],
+		]);
+		// now fill out the questions THEY answered
+		foreach ($answers as $answer_row) {
+			if ($answer_row['Question.QST_system']) {
+				// it's an answer to a system question. That was already displayed as part of the attendee
+				// fields, so don't write it out again thanks.
+				continue;
+			}
+			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(esc_html__('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
+			) {
+				$data[ $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
+				$data[ $question_label ] = html_entity_decode(
+					EEH_Export::prepare_value_from_db_for_display(
+						EEM_Answer::instance(),
+						'ANS_value',
+						$answer_row['Answer.ANS_value']
+					)
+				);
+			}
+		}
+		return $data;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -46,8 +46,8 @@ 
     {
         // make sure each registration has the same questions in the same order
         foreach ($question_labels as $question_label) {
-            if (! isset($data[ $question_label ])) {
-                $data[ $question_label ] = null;
+            if ( ! isset($data[$question_label])) {
+                $data[$question_label] = null;
             }
         }
         $answers = EEM_Answer::instance()->get_all_wpdb_results([
@@ -74,12 +74,12 @@ 
                 isset($answer_row['Question.QST_type'])
                 && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state
             ) {
-                $data[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+                $data[$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
-                $data[ $question_label ] = html_entity_decode(
+                $data[$question_label] = html_entity_decode(
                     EEH_Export::prepare_value_from_db_for_display(
                         EEM_Answer::instance(),
                         'ANS_value',

core/db_classes/EE_Export.class.php

Spacing +45 added lines, -45 removed lines

@@ -46,7 +46,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();
     }
 
@@ -173,7 +173,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() : esc_html__('unknown', 'event_espresso'));
+                $filename = 'event-'.($event instanceof EE_Event ? $event->slug() : esc_html__('unknown', 'event_espresso'));
             }
             $event_query_params[0]['EVT_ID'] = $value_to_equal;
             $related_models_query_params[0]['Event.EVT_ID'] = $value_to_equal;
@@ -222,7 +222,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(
                 esc_html__(
                     "'An error occurred and the Event details could not be exported from the database.'",
@@ -249,16 +249,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[ esc_html__('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column(
-                    ) ];
+                    $csv_row[esc_html__('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[ esc_html__(
+                    $csv_row[esc_html__(
                         '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;
@@ -298,7 +298,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(
                 esc_html__(
                     'An error occurred and the Attendee data could not be exported from the database.',
@@ -419,9 +419,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[ esc_html__('Event', 'event_espresso') ] = sprintf(
+                    $reg_csv_array[esc_html__('Event', 'event_espresso')] = sprintf(
                         esc_html__('%1$s (%2$s)', 'event_espresso'),
                         $this->_prepare_value_from_db_for_display(
                             EEM_Event::instance(),
@@ -467,13 +467,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[ esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+                        $reg_csv_array[esc_html__("Currency", "event_espresso")] = EE_Config::instance()->currency->code;
                     }
                 }
                 // get pretty status
@@ -485,23 +485,23 @@ 
                     false,
                     'sentence'
                 );
-                $reg_csv_array[ esc_html__(
+                $reg_csv_array[esc_html__(
                     "Registration Status",
                     'event_espresso'
-                ) ] = $stati[ $reg_row['Registration.STS_ID'] ];
+                )] = $stati[$reg_row['Registration.STS_ID']];
                 // get pretty trnasaction status
-                $reg_csv_array[ esc_html__(
+                $reg_csv_array[esc_html__(
                     "Transaction Status",
                     'event_espresso'
-                ) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+                )] = $stati[$reg_row['TransactionTable.STS_ID']];
+                $reg_csv_array[esc_html__('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[ esc_html__('Amount Paid', 'event_espresso') ] = $is_primary_reg
+                $reg_csv_array[esc_html__('Amount Paid', 'event_espresso')] = $is_primary_reg
                     ? $this->_prepare_value_from_db_for_display(
                         EEM_Transaction::instance(),
                         'TXN_paid',
@@ -525,15 +525,15 @@ 
                     );
                     list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
                 }
-                $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+                $reg_csv_array[esc_html__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+                $reg_csv_array[esc_html__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+                $reg_csv_array[esc_html__('Gateway Transaction ID(s)', 'event_espresso')] = implode(
                     ',',
                     $gateway_txn_ids_etc
                 );
 
                 // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+                $reg_csv_array[esc_html__("Check-Ins", "event_espresso")] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin'
                 );
@@ -565,8 +565,8 @@ 
                     $ticket_name = esc_html__('Unknown', 'event_espresso');
                     $datetimes_strings = array(esc_html__('Unknown', 'event_espresso'));
                 }
-                $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ esc_html__("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[esc_html__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
                 // get datetime(s) of registration
 
                 // add attendee columns
@@ -587,20 +587,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
@@ -620,11 +620,11 @@ 
                         $question_label = sprintf(esc_html__('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']
@@ -650,16 +650,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 = esc_html__('unknown', 'event_espresso');
             }
         } else {
@@ -681,7 +681,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()."]";
     }
 
 
@@ -704,7 +704,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 {
@@ -719,7 +719,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(
                 esc_html__(
                     'An error occurred and the Category details could not be exported from the database.',
@@ -742,8 +742,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(esc_html__("No filename was provided", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
@@ -774,25 +774,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 +780 added lines, -780 removed lines

@@ -17,784 +17,784 @@
  */
 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(
-                            esc_html__('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 void kills execution
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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() : esc_html__('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(
-                esc_html__(
-                    "'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[ esc_html__('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[ esc_html__(
-                        '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
-     * @throws EE_Error
-     */
-    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(
-                esc_html__(
-                    '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 bool|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to
-     *                                      NOT display pretty
-     * @return string
-     * @throws EE_Error
-     */
-    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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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[ esc_html__('Event', 'event_espresso') ] = sprintf(
-                        esc_html__('%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(
-                            esc_html__('%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[ esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
-                    }
-                }
-                // get pretty status
-                $stati = EEM_Status::instance()->localized_status(
-                    array(
-                        $reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
-                        $reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
-                    ),
-                    false,
-                    'sentence'
-                );
-                $reg_csv_array[ esc_html__(
-                    "Registration Status",
-                    'event_espresso'
-                ) ] = $stati[ $reg_row['Registration.STS_ID'] ];
-                // get pretty trnasaction status
-                $reg_csv_array[ esc_html__(
-                    "Transaction Status",
-                    'event_espresso'
-                ) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
-                $reg_csv_array[ esc_html__('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[ esc_html__('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'
-                    );
-                    list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
-                }
-                $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
-                $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
-                $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                    ',',
-                    $gateway_txn_ids_etc
-                );
-
-                // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__("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 = esc_html__('Unknown', 'event_espresso');
-                    $datetimes_strings = array(esc_html__('Unknown', 'event_espresso'));
-                }
-                $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-                $reg_csv_array[ esc_html__("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(esc_html__('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 = esc_html__('unknown', 'event_espresso');
-            }
-        } else {
-            $event_slug = esc_html__('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
-     * @throws EE_Error
-     */
-    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(
-                esc_html__(
-                    '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(esc_html__("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 @return bool on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    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(
+							esc_html__('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 void kills execution
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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() : esc_html__('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(
+				esc_html__(
+					"'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[ esc_html__('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[ esc_html__(
+						'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
+	 * @throws EE_Error
+	 */
+	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(
+				esc_html__(
+					'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 bool|string $pretty_schema true to display pretty, a string to use a specific "Schema", or false to
+	 *                                      NOT display pretty
+	 * @return string
+	 * @throws EE_Error
+	 */
+	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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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[ esc_html__('Event', 'event_espresso') ] = sprintf(
+						esc_html__('%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(
+							esc_html__('%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[ esc_html__("Currency", "event_espresso") ] = EE_Config::instance()->currency->code;
+					}
+				}
+				// get pretty status
+				$stati = EEM_Status::instance()->localized_status(
+					array(
+						$reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
+						$reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
+					),
+					false,
+					'sentence'
+				);
+				$reg_csv_array[ esc_html__(
+					"Registration Status",
+					'event_espresso'
+				) ] = $stati[ $reg_row['Registration.STS_ID'] ];
+				// get pretty trnasaction status
+				$reg_csv_array[ esc_html__(
+					"Transaction Status",
+					'event_espresso'
+				) ] = $stati[ $reg_row['TransactionTable.STS_ID'] ];
+				$reg_csv_array[ esc_html__('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[ esc_html__('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'
+					);
+					list($payment_methods, $gateway_txn_ids_etc, $payment_times) = PaymentsInfoCSV::extractPaymentInfo($payments_info);
+				}
+				$reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times);
+				$reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods);
+				$reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+					',',
+					$gateway_txn_ids_etc
+				);
+
+				// get whether or not the user has checked in
+				$reg_csv_array[ esc_html__("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 = esc_html__('Unknown', 'event_espresso');
+					$datetimes_strings = array(esc_html__('Unknown', 'event_espresso'));
+				}
+				$reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+				$reg_csv_array[ esc_html__("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(esc_html__('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 = esc_html__('unknown', 'event_espresso');
+			}
+		} else {
+			$event_slug = esc_html__('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
+	 * @throws EE_Error
+	 */
+	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(
+				esc_html__(
+					'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(esc_html__("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 @return bool on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	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;
+	}
 }

caffeinated/admin/extend/events/templates/import_page.template.php

Indentation +3 added lines, -3 removed lines

@@ -1,9 +1,9 @@
 <div class="import-area">
     <div class="important-notice">
         <?php esc_html_e(
-            'The import feature has been disabled because of bugs. It is expected to be put back in place soon.',
-            'event_espresso'
-        ); ?>
+			'The import feature has been disabled because of bugs. It is expected to be put back in place soon.',
+			'event_espresso'
+		); ?>
     </div>
     <?php // echo wp_kses($form, \EventEspresso\core\services\request\sanitizers\AllowedTags::getWithFormTags()); ?>
 </div>

modules/ical/EED_Ical.module.php

Spacing +13 added lines, -13 removed lines

@@ -89,24 +89,24 @@ 
             switch ($iCal_type) {
                 // submit buttons appear as buttons and are very compatible with a theme's style
                 case 'submit':
-                    $html .= '<form id="download-iCal-frm-' . $datetime->ID();
-                    $html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >';
+                    $html .= '<form id="download-iCal-frm-'.$datetime->ID();
+                    $html .= '" class="download-iCal-frm" action="'.$URL.'" method="post" >';
                     $html .= '<input type="submit" class="ee-ical-sbmt" value="&#xf145;" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '"/>';
+                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso').'"/>';
                     $html .= '</form>';
                     break;
                 // buttons are just links that have been styled to appear as buttons,
                 // but may not be blend with a theme as well as submit buttons
                 case 'button':
-                    $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL;
-                    $html .= '" title="' . esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+                    $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="'.$URL;
+                    $html .= '" title="'.esc_html__('Add to iCal Calendar', 'event_espresso').'">';
                     $html .= ' <span class="dashicons dashicons-calendar"></span>';
                     $html .= '</a>';
                     break;
                 // links are just links that use the calendar dashicon
                 case 'icon':
-                    $html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+                    $html .= '<a class="ee-ical-lnk" href="'.$URL.'" title="';
+                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso').'">';
                     $html .= ' <span class="dashicons dashicons-calendar"></span>';
                     $html .= '</a>';
                     break;
@@ -147,7 +147,7 @@ 
                     }
 
                     // Generate filename
-                    $filename = $event->slug() . '-' . $datetime->start_date('Y-m-d') . '.ics';
+                    $filename = $event->slug().'-'.$datetime->start_date('Y-m-d').'.ics';
 
                     // Check the datetime status has not been cancelled and set the ics value accordingly
                     $status = $datetime->get_active_status();
@@ -156,7 +156,7 @@ 
                     // Create array of ics details, escape strings, convert timestamps to ics format, etc
                     $ics_data = [
                         'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name,
-                        'UID'            => md5($event->name() . $event->ID() . $datetime->ID()),
+                        'UID'            => md5($event->name().$event->ID().$datetime->ID()),
                         'ORGANIZER'      => EE_Registry::instance()->CFG->organization->email,
                         'DTSTAMP'        => date(EED_Ical::iCal_datetime_format),
                         'LOCATION'       => $location,
@@ -177,9 +177,9 @@ 
                     foreach ($ics_data as $key => $value) {
                         // Description is escaped differently from all all values
                         if ($key === 'DESCRIPTION') {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
+                            $ics_data[$key] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
                         } else {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_data($value);
+                            $ics_data[$key] = EED_Ical::_escape_ICal_data($value);
                         }
                     }
 
@@ -191,7 +191,7 @@ 
 
                     // set headers
                     header('Content-type: text/calendar; charset=utf-8');
-                    header('Content-Disposition: attachment; filename="' . $filename . '"');
+                    header('Content-Disposition: attachment; filename="'.$filename.'"');
                     header('Cache-Control: private, max-age=0, must-revalidate');
                     header('Pragma: public');
                     header('Content-Type: application/octet-stream');
@@ -209,7 +209,7 @@ 
 
                     // Output all remaining values from ics_data.
                     foreach ($ics_data as $key => $value) {
-                        echo wp_kses($key . ':' . $value, AllowedTags::getAllowedTags()) . "\r\n";
+                        echo wp_kses($key.':'.$value, AllowedTags::getAllowedTags())."\r\n";
                     }
 
                     echo "END:VEVENT\r\n";

Indentation +231 added lines, -231 removed lines

@@ -14,235 +14,235 @@
  */
 class EED_Ical extends EED_Module
 {
-    const iCal_datetime_format = 'Ymd\THis\Z';
-
-
-    /**
-     * @return EED_Ical|EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // create download buttons
-        add_filter(
-            'FHEE__espresso_list_of_event_dates__datetime_html',
-            ['EED_Ical', 'generate_add_to_iCal_button'],
-            10,
-            2
-        );
-        // process ics download request
-        EE_Config::register_route('download_ics_file', 'EED_Ical', 'download_ics_file');
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @param $html
-     * @param $datetime
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_add_to_iCal_button($html, $datetime)
-    {
-        // first verify a proper datetime object has been received
-        if ($datetime instanceof EE_Datetime) {
-            // set whether a link or submit button is shown
-            $iCal_type = apply_filters('FHEE__EED_Ical__generate_add_to_iCal_button__iCal_type', 'submit');
-            // generate a link to the route we registered in set_hooks()
-            $URL = add_query_arg(['ee' => 'download_ics_file', 'ics_id' => $datetime->ID()], site_url());
-            $URL = esc_url_Raw($URL);
-            // what type ?
-            switch ($iCal_type) {
-                // submit buttons appear as buttons and are very compatible with a theme's style
-                case 'submit':
-                    $html .= '<form id="download-iCal-frm-' . $datetime->ID();
-                    $html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >';
-                    $html .= '<input type="submit" class="ee-ical-sbmt" value="&#xf145;" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '"/>';
-                    $html .= '</form>';
-                    break;
-                // buttons are just links that have been styled to appear as buttons,
-                // but may not be blend with a theme as well as submit buttons
-                case 'button':
-                    $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL;
-                    $html .= '" title="' . esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
-                    $html .= ' <span class="dashicons dashicons-calendar"></span>';
-                    $html .= '</a>';
-                    break;
-                // links are just links that use the calendar dashicon
-                case 'icon':
-                    $html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
-                    $html .= ' <span class="dashicons dashicons-calendar"></span>';
-                    $html .= '</a>';
-                    break;
-            }
-        }
-        return $html;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function download_ics_file()
-    {
-        $request = self::getRequest();
-        if ($request->requestParamIsSet('ics_id')) {
-            $DTT_ID   = $request->getRequestParam('ics_id', 0, 'int');
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime) {
-                // get related event, venues, and event categories
-                $event = $datetime->event();
-                if ($event instanceof EE_Event) {
-                    // get related category Term object and it's name
-                    $category = $event->first_event_category();
-                    if ($category instanceof EE_Term) {
-                        $category = $category->name();
-                    }
-                    $location = '';
-                    // get first related venue and convert to CSV string
-                    $venue = $event->venues(['limit' => 1]);
-                    if (is_array($venue) && ! empty($venue)) {
-                        $venue = array_shift($venue);
-                        if ($venue instanceof EE_Venue) {
-                            $location = espresso_venue_raw_address('inline', $venue->ID(), false);
-                        }
-                    }
-
-                    // Generate filename
-                    $filename = $event->slug() . '-' . $datetime->start_date('Y-m-d') . '.ics';
-
-                    // Check the datetime status has not been cancelled and set the ics value accordingly
-                    $status = $datetime->get_active_status();
-                    $status = $status === EE_Datetime::cancelled ? 'CANCELLED' : 'CONFIRMED';
-
-                    // Create array of ics details, escape strings, convert timestamps to ics format, etc
-                    $ics_data = [
-                        'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name,
-                        'UID'            => md5($event->name() . $event->ID() . $datetime->ID()),
-                        'ORGANIZER'      => EE_Registry::instance()->CFG->organization->email,
-                        'DTSTAMP'        => date(EED_Ical::iCal_datetime_format),
-                        'LOCATION'       => $location,
-                        'SUMMARY'        => $event->name(),
-                        'DESCRIPTION'    => wp_strip_all_tags($event->description()),
-                        'STATUS'         => $status,
-                        'CATEGORIES'     => $category,
-                        'URL;VALUE=URI'  => get_permalink($event->ID()),
-                        'DTSTART'        => date(EED_Ical::iCal_datetime_format, $datetime->start()),
-                        'DTEND'          => date(EED_Ical::iCal_datetime_format, $datetime->end()),
-                    ];
-
-                    // Filter the values used within the ics output.
-                    // NOTE - all values within ics_data will be escaped automatically.
-                    $ics_data = apply_filters('FHEE__EED_Ical__download_ics_file_ics_data', $ics_data, $datetime);
-
-                    // Escape all ics data
-                    foreach ($ics_data as $key => $value) {
-                        // Description is escaped differently from all all values
-                        if ($key === 'DESCRIPTION') {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
-                        } else {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_data($value);
-                        }
-                    }
-
-                    // Pull the organizer name from ics_data and remove it from the array.
-                    $organizer_name = isset($ics_data['ORGANIZER_NAME'])
-                        ? $ics_data['ORGANIZER_NAME']
-                        : '';
-                    unset($ics_data['ORGANIZER_NAME']);
-
-                    // set headers
-                    header('Content-type: text/calendar; charset=utf-8');
-                    header('Content-Disposition: attachment; filename="' . $filename . '"');
-                    header('Cache-Control: private, max-age=0, must-revalidate');
-                    header('Pragma: public');
-                    header('Content-Type: application/octet-stream');
-                    header('Content-Type: application/force-download');
-                    header('Cache-Control: no-cache, must-revalidate');
-                    header('Content-Transfer-Encoding: binary');
-                    header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // past date
-                    ini_set('zlib.output_compression', '0');
-                    // echo the output
-                    echo "BEGIN:VCALENDAR\r\n";
-                    echo "VERSION:2.0\r\n";
-                    echo "PRODID:-//{$organizer_name}//NONSGML PDA Calendar Version 1.0//EN\r\n";
-                    echo "CALSCALE:GREGORIAN\r\n";
-                    echo "BEGIN:VEVENT\r\n";
-
-                    // Output all remaining values from ics_data.
-                    foreach ($ics_data as $key => $value) {
-                        echo wp_kses($key . ':' . $value, AllowedTags::getAllowedTags()) . "\r\n";
-                    }
-
-                    echo "END:VEVENT\r\n";
-                    echo "END:VCALENDAR\r\n";
-                }
-            }
-        }
-        die();
-    }
-
-
-    /**
-     *    _escape_ICal_data
-     *
-     * @param string $string
-     * @return    string
-     */
-    private static function _escape_ICal_data($string = '')
-    {
-        return preg_replace('/([\,;])/', '\\\$1', $string);
-    }
-
-
-    /**
-     *    _escape_ICal_description
-     *
-     * @param string $description
-     * @return    string
-     */
-    private static function _escape_ICal_description($description = '')
-    {
-        // Escape special chars within the description
-        $description = EED_Ical::_escape_ICal_data($description);
-        // Remove line breaks and output in iCal format
-        return str_replace(["\r\n", "\n"], '\n', $description);
-    }
+	const iCal_datetime_format = 'Ymd\THis\Z';
+
+
+	/**
+	 * @return EED_Ical|EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// create download buttons
+		add_filter(
+			'FHEE__espresso_list_of_event_dates__datetime_html',
+			['EED_Ical', 'generate_add_to_iCal_button'],
+			10,
+			2
+		);
+		// process ics download request
+		EE_Config::register_route('download_ics_file', 'EED_Ical', 'download_ics_file');
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @param $html
+	 * @param $datetime
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_add_to_iCal_button($html, $datetime)
+	{
+		// first verify a proper datetime object has been received
+		if ($datetime instanceof EE_Datetime) {
+			// set whether a link or submit button is shown
+			$iCal_type = apply_filters('FHEE__EED_Ical__generate_add_to_iCal_button__iCal_type', 'submit');
+			// generate a link to the route we registered in set_hooks()
+			$URL = add_query_arg(['ee' => 'download_ics_file', 'ics_id' => $datetime->ID()], site_url());
+			$URL = esc_url_Raw($URL);
+			// what type ?
+			switch ($iCal_type) {
+				// submit buttons appear as buttons and are very compatible with a theme's style
+				case 'submit':
+					$html .= '<form id="download-iCal-frm-' . $datetime->ID();
+					$html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >';
+					$html .= '<input type="submit" class="ee-ical-sbmt" value="&#xf145;" title="';
+					$html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '"/>';
+					$html .= '</form>';
+					break;
+				// buttons are just links that have been styled to appear as buttons,
+				// but may not be blend with a theme as well as submit buttons
+				case 'button':
+					$html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL;
+					$html .= '" title="' . esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+					$html .= ' <span class="dashicons dashicons-calendar"></span>';
+					$html .= '</a>';
+					break;
+				// links are just links that use the calendar dashicon
+				case 'icon':
+					$html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="';
+					$html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+					$html .= ' <span class="dashicons dashicons-calendar"></span>';
+					$html .= '</a>';
+					break;
+			}
+		}
+		return $html;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function download_ics_file()
+	{
+		$request = self::getRequest();
+		if ($request->requestParamIsSet('ics_id')) {
+			$DTT_ID   = $request->getRequestParam('ics_id', 0, 'int');
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime) {
+				// get related event, venues, and event categories
+				$event = $datetime->event();
+				if ($event instanceof EE_Event) {
+					// get related category Term object and it's name
+					$category = $event->first_event_category();
+					if ($category instanceof EE_Term) {
+						$category = $category->name();
+					}
+					$location = '';
+					// get first related venue and convert to CSV string
+					$venue = $event->venues(['limit' => 1]);
+					if (is_array($venue) && ! empty($venue)) {
+						$venue = array_shift($venue);
+						if ($venue instanceof EE_Venue) {
+							$location = espresso_venue_raw_address('inline', $venue->ID(), false);
+						}
+					}
+
+					// Generate filename
+					$filename = $event->slug() . '-' . $datetime->start_date('Y-m-d') . '.ics';
+
+					// Check the datetime status has not been cancelled and set the ics value accordingly
+					$status = $datetime->get_active_status();
+					$status = $status === EE_Datetime::cancelled ? 'CANCELLED' : 'CONFIRMED';
+
+					// Create array of ics details, escape strings, convert timestamps to ics format, etc
+					$ics_data = [
+						'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name,
+						'UID'            => md5($event->name() . $event->ID() . $datetime->ID()),
+						'ORGANIZER'      => EE_Registry::instance()->CFG->organization->email,
+						'DTSTAMP'        => date(EED_Ical::iCal_datetime_format),
+						'LOCATION'       => $location,
+						'SUMMARY'        => $event->name(),
+						'DESCRIPTION'    => wp_strip_all_tags($event->description()),
+						'STATUS'         => $status,
+						'CATEGORIES'     => $category,
+						'URL;VALUE=URI'  => get_permalink($event->ID()),
+						'DTSTART'        => date(EED_Ical::iCal_datetime_format, $datetime->start()),
+						'DTEND'          => date(EED_Ical::iCal_datetime_format, $datetime->end()),
+					];
+
+					// Filter the values used within the ics output.
+					// NOTE - all values within ics_data will be escaped automatically.
+					$ics_data = apply_filters('FHEE__EED_Ical__download_ics_file_ics_data', $ics_data, $datetime);
+
+					// Escape all ics data
+					foreach ($ics_data as $key => $value) {
+						// Description is escaped differently from all all values
+						if ($key === 'DESCRIPTION') {
+							$ics_data[ $key ] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
+						} else {
+							$ics_data[ $key ] = EED_Ical::_escape_ICal_data($value);
+						}
+					}
+
+					// Pull the organizer name from ics_data and remove it from the array.
+					$organizer_name = isset($ics_data['ORGANIZER_NAME'])
+						? $ics_data['ORGANIZER_NAME']
+						: '';
+					unset($ics_data['ORGANIZER_NAME']);
+
+					// set headers
+					header('Content-type: text/calendar; charset=utf-8');
+					header('Content-Disposition: attachment; filename="' . $filename . '"');
+					header('Cache-Control: private, max-age=0, must-revalidate');
+					header('Pragma: public');
+					header('Content-Type: application/octet-stream');
+					header('Content-Type: application/force-download');
+					header('Cache-Control: no-cache, must-revalidate');
+					header('Content-Transfer-Encoding: binary');
+					header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // past date
+					ini_set('zlib.output_compression', '0');
+					// echo the output
+					echo "BEGIN:VCALENDAR\r\n";
+					echo "VERSION:2.0\r\n";
+					echo "PRODID:-//{$organizer_name}//NONSGML PDA Calendar Version 1.0//EN\r\n";
+					echo "CALSCALE:GREGORIAN\r\n";
+					echo "BEGIN:VEVENT\r\n";
+
+					// Output all remaining values from ics_data.
+					foreach ($ics_data as $key => $value) {
+						echo wp_kses($key . ':' . $value, AllowedTags::getAllowedTags()) . "\r\n";
+					}
+
+					echo "END:VEVENT\r\n";
+					echo "END:VCALENDAR\r\n";
+				}
+			}
+		}
+		die();
+	}
+
+
+	/**
+	 *    _escape_ICal_data
+	 *
+	 * @param string $string
+	 * @return    string
+	 */
+	private static function _escape_ICal_data($string = '')
+	{
+		return preg_replace('/([\,;])/', '\\\$1', $string);
+	}
+
+
+	/**
+	 *    _escape_ICal_description
+	 *
+	 * @param string $description
+	 * @return    string
+	 */
+	private static function _escape_ICal_description($description = '')
+	{
+		// Escape special chars within the description
+		$description = EED_Ical::_escape_ICal_data($description);
+		// Remove line breaks and output in iCal format
+		return str_replace(["\r\n", "\n"], '\n', $description);
+	}
 }

modules/gateways/Invoice/lib/templates/invoice_body.template.php

Indentation +74 added lines, -74 removed lines

@@ -76,20 +76,20 @@ 
         </thead>
         <tbody>
         <?php
-        /**
-         * Recursive function for traversing all the sub-items of each line item
-         * and displaying them in the table
-         *
-         * @param EE_Line_Item $line_item
-         * @param boolean      $odd for indicating whether to style this line item as an 'odd' or 'even'
-         */
-        function ee_invoice_display_line_item(EE_Line_Item $line_item, $show_line_item_description, $odd = false)
-        {
-            switch ($line_item->type()) {
-                case EEM_Line_Item::type_total:
-                    foreach ($line_item->children() as $child_line_item) {
-                        ee_invoice_display_line_item($child_line_item, $show_line_item_description);
-                    } ?>
+		/**
+		 * Recursive function for traversing all the sub-items of each line item
+		 * and displaying them in the table
+		 *
+		 * @param EE_Line_Item $line_item
+		 * @param boolean      $odd for indicating whether to style this line item as an 'odd' or 'even'
+		 */
+		function ee_invoice_display_line_item(EE_Line_Item $line_item, $show_line_item_description, $odd = false)
+		{
+			switch ($line_item->type()) {
+				case EEM_Line_Item::type_total:
+					foreach ($line_item->children() as $child_line_item) {
+						ee_invoice_display_line_item($child_line_item, $show_line_item_description);
+					} ?>
                     <tr>
                         <td colspan="<?php echo ($show_line_item_description ? 5 : 4) ?>">
                             <hr>
@@ -101,50 +101,50 @@ 
                         <td class="total"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
+					break;
 
 
-                case EEM_Line_Item::type_sub_total:
-                    foreach ($line_item->children() as $child_line_item) {
-                        // $odd = !$odd;
-                        ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
-                    } ?>
+				case EEM_Line_Item::type_sub_total:
+					foreach ($line_item->children() as $child_line_item) {
+						// $odd = !$odd;
+						ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
+					} ?>
                     <tr class="total_tr odd">
                         <td colspan="<?php echo ($show_line_item_description ? 2 : 1) ?>">&nbsp;</td>
                         <td colspan="2" class="total" id="total_currency">
                             <?php esc_html_e(
-                                'Sub-Total',
-                                'event_espresso'
-                            ); ?></td>
+								'Sub-Total',
+								'event_espresso'
+							); ?></td>
                         <td class="total"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
+					break;
 
 
-                case EEM_Line_Item::type_tax_sub_total:
-                    foreach ($line_item->children() as $child_line_item) {
-                        $odd = ! $odd;
-                        ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
-                    } ?>
+				case EEM_Line_Item::type_tax_sub_total:
+					foreach ($line_item->children() as $child_line_item) {
+						$odd = ! $odd;
+						ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
+					} ?>
                     <tr class="total_tr odd">
                         <td colspan="<?php echo ($show_line_item_description ? 2 : 1) ?>">&nbsp;</td>
                         <td colspan="2" class="total" id="total_currency">
                             <?php esc_html_e(
-                                'Tax Total',
-                                'event_espresso'
-                            ); ?></td>
+								'Tax Total',
+								'event_espresso'
+							); ?></td>
                         <td class="total"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
+					break;
 
 
-                case EEM_Line_Item::type_line_item:
-                    $subitems = $line_item->children();
-                    $has_subitems = count($subitems) > 1;
-                    if ($has_subitems) {
-                        ?>
+				case EEM_Line_Item::type_line_item:
+					$subitems = $line_item->children();
+					$has_subitems = count($subitems) > 1;
+					if ($has_subitems) {
+						?>
                         <tr class="item <?php echo ($odd ? 'odd' : ''); ?>">
                             <td class="item_l"><?php echo esc_html($line_item->name()) ?></td>
                             <?php if ($show_line_item_description) { ?>
@@ -155,18 +155,18 @@ 
                             <td class="item_c"><?php echo esc_html($line_item->unit_price_no_code()) ?></td>
 
                             <td class="item_r"> <?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags());
-                                echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
+								echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
                             <?php // <td class="item_l"><?php  $datetimes_strings = array(); foreach($datetimes as $datetime){ $datetimes_strings[]= $datetime->start_date_and_time();} echo implode(", ",$datetimes_strings);
-                            ?>
+							?>
                         </tr>
                         <?php
-                        if ($has_subitems) {
-                            foreach ($line_item->children() as $child_line_item) {
-                                ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
-                            }
-                        }
-                    } else {// no subitems - just show this line item
-                        ?>
+						if ($has_subitems) {
+							foreach ($line_item->children() as $child_line_item) {
+								ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
+							}
+						}
+					} else {// no subitems - just show this line item
+						?>
                         <tr class="item <?php echo ($odd ? 'odd' : ''); ?>">
                             <td class="item_l"><?php echo esc_html($line_item->name()); ?></td>
                             <?php if ($show_line_item_description) { ?>
@@ -175,15 +175,15 @@ 
                             <td class="item_l"><?php echo esc_html($line_item->quantity()); ?></td>
                             <td class="item_c"><?php echo wp_kses($line_item->unit_price_no_code(), AllowedTags::getAllowedTags()); ?></td>
                             <td class="item_r"> <?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags());
-                                echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
+								echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
                             <?php // <td class="item_l"><?php  $datetimes_strings = array(); foreach($datetimes as $datetime){ $datetimes_strings[]= $datetime->start_date_and_time();} echo implode(", ",$datetimes_strings);
-                            ?>
+							?>
                         </tr>
                     <?php }
 
-                    break;
-                case EEM_Line_Item::type_sub_line_item:
-                    ?>
+					break;
+				case EEM_Line_Item::type_sub_line_item:
+					?>
                     <tr class="item subitem-row">
                         <td class="item_l subitem"><?php echo esc_html($line_item->name()); ?></td>
                         <?php if ($show_line_item_description) { ?>
@@ -199,9 +199,9 @@ 
                         <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
-                case EEM_Line_Item::type_tax:
-                    ?>
+					break;
+				case EEM_Line_Item::type_tax:
+					?>
                     <tr class="item sub-item tax-total">
                     <td class="item_l"><?php echo esc_html($line_item->name()); ?></td>
                     <?php if ($show_line_item_description) { ?>
@@ -211,15 +211,15 @@ 
 
                     <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr><?php
-                    break;
-            }
-        }
+					break;
+			}
+		}
 
-        $c = false;
-        /* @var $transaction EE_Transaction */
-        $total_line_item = $transaction->total_line_item();
-        ee_invoice_display_line_item($total_line_item, $show_line_item_description);
-        ?>
+		$c = false;
+		/* @var $transaction EE_Transaction */
+		$total_line_item = $transaction->total_line_item();
+		ee_invoice_display_line_item($total_line_item, $show_line_item_description);
+		?>
         </tbody>
 
     </table>
@@ -238,11 +238,11 @@ 
         </thead>
         <tbody>
         <?php
-        $c = false;
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                /* @var $payment EE_Payment */
-                ?>
+		$c = false;
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				/* @var $payment EE_Payment */
+				?>
                 <tr class='item <?php echo(($c = ! $c) ? ' odd' : '') ?>'>
                     <td><?php $payment->e('PAY_gateway') ?></td>
                     <td><?php echo esc_html($payment->timestamp('D M j, Y')); ?></td>
@@ -252,17 +252,17 @@ 
                     <td class='item_r'><?php echo EEH_Template::format_currency($payment->amount()); ?></td>
                 </tr>
             <?php }
-        } else {
-            ?>
+		} else {
+			?>
             <tr class='item'>
                 <td class='aln-cntr' colspan=6>
                     <?php esc_html_e(
-                        "No approved payments have been received",
-                        'event_espresso'
-                    ) ?></td>
+						"No approved payments have been received",
+						'event_espresso'
+					) ?></td>
             </tr>
         <?php }
-        ?>
+		?>
         </tbody>
         <tfoot>
         <tr class='total_tr'>