eventespresso / event-espresso-core

core/libraries/messages/EE_Registration_Base_message_type.lib.php

Indentation +122 added lines, -122 removed lines

@@ -14,126 +14,126 @@
 {
 
 
-    /**
-     * @see parent::get_priority() for documentation.
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_medium;
-    }
-
-
-
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true
-            );
-    }
-
-
-    protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
-    {
-        // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
-    }
-
-
-
-
-    protected function _set_data_handler()
-    {
-        if (is_array($this->_data)) {
-            $data_type = reset($this->_data);
-
-            if (is_array($data_type)) {
-                // grab the first item and see if its a registration.
-                $maybe_reg = isset($data_type[0]) && is_array($data_type[0]) ? reset($data_type[0]) : reset($data_type);
-                if ($maybe_reg instanceof EE_Registration) {
-                    // is $data_type itself just an array of registrations?
-                    if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
-                        $regs = $data_type;
-                    } else {
-                        $regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
-                    }
-
-                    foreach ($regs as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $this->_regs_for_sending[] = $reg->ID();
-                        }
-                    }
-                    $this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
-                    $this->_data_handler = 'Gateways';
-                } else {
-                    $this->_data_handler = 'Gateways';
-                }
-            } else {
-                $this->_data_handler = $data_type instanceof EE_Registration ? 'REG' : 'Gateways';
-            }
-        } else {
-            $this->_data_handler = $this->_data instanceof EE_Registration ? 'REG' : 'Gateways';
-        }
-
-        $this->_single_message = $this->_data_handler == 'REG' ? true : false;
-    }
-
-
-
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
-        if ($context  == 'admin') {
-            // use the registration to get the transaction.
-            $transaction = $registration->transaction();
-
-            // bail early if no transaction
-            if (! $transaction instanceof EE_Transaction) {
-                throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
-            }
-
-            $payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
-            return array( $transaction, $payment );
-        } else {
-            return $registration;
-        }
-    }
-
-
-
-    /**
-     * Setup admin settings for this message type.
-     */
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
-
-
-
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     */
-    protected function _admin_addressees()
-    {
-        if ($this->_single_message) {
-            return array();
-        }
-        return parent::_admin_addressees();
-    }
-
-
-
-    protected function _primary_attendee_addressees()
-    {
-        if ($this->_single_message) {
-            return array();
-        }
-
-        return parent::_primary_attendee_addressees();
-    }
+	/**
+	 * @see parent::get_priority() for documentation.
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_medium;
+	}
+
+
+
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true
+			);
+	}
+
+
+	protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
+	{
+		// this is just a test
+		return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+	}
+
+
+
+
+	protected function _set_data_handler()
+	{
+		if (is_array($this->_data)) {
+			$data_type = reset($this->_data);
+
+			if (is_array($data_type)) {
+				// grab the first item and see if its a registration.
+				$maybe_reg = isset($data_type[0]) && is_array($data_type[0]) ? reset($data_type[0]) : reset($data_type);
+				if ($maybe_reg instanceof EE_Registration) {
+					// is $data_type itself just an array of registrations?
+					if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
+						$regs = $data_type;
+					} else {
+						$regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
+					}
+
+					foreach ($regs as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$this->_regs_for_sending[] = $reg->ID();
+						}
+					}
+					$this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
+					$this->_data_handler = 'Gateways';
+				} else {
+					$this->_data_handler = 'Gateways';
+				}
+			} else {
+				$this->_data_handler = $data_type instanceof EE_Registration ? 'REG' : 'Gateways';
+			}
+		} else {
+			$this->_data_handler = $this->_data instanceof EE_Registration ? 'REG' : 'Gateways';
+		}
+
+		$this->_single_message = $this->_data_handler == 'REG' ? true : false;
+	}
+
+
+
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
+		if ($context  == 'admin') {
+			// use the registration to get the transaction.
+			$transaction = $registration->transaction();
+
+			// bail early if no transaction
+			if (! $transaction instanceof EE_Transaction) {
+				throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
+			}
+
+			$payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+			return array( $transaction, $payment );
+		} else {
+			return $registration;
+		}
+	}
+
+
+
+	/**
+	 * Setup admin settings for this message type.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
+
+
+
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 */
+	protected function _admin_addressees()
+	{
+		if ($this->_single_message) {
+			return array();
+		}
+		return parent::_admin_addressees();
+	}
+
+
+
+	protected function _primary_attendee_addressees()
+	{
+		if ($this->_single_message) {
+			return array();
+		}
+
+		return parent::_primary_attendee_addressees();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -36,7 +36,7 @@ 
     protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
     {
         // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+        return $this->name.' Message Type for '.$messenger->name.' Messenger ';
     }
 
 
@@ -55,7 +55,7 @@ 
                     if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
                         $regs = $data_type;
                     } else {
-                        $regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
+                        $regs = is_array($data_type[0]) ? $data_type[0] : array($maybe_reg);
                     }
 
                     foreach ($regs as $reg) {
@@ -63,7 +63,7 @@ 
                             $this->_regs_for_sending[] = $reg->ID();
                         }
                     }
-                    $this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
+                    $this->_data = isset($this->_data[1]) ? array($maybe_reg->transaction(), null, $this->_data[1]) : array($maybe_reg->transaction());
                     $this->_data_handler = 'Gateways';
                 } else {
                     $this->_data_handler = 'Gateways';
@@ -82,17 +82,17 @@ 
 
     protected function _get_data_for_context($context, EE_Registration $registration, $id)
     {
-        if ($context  == 'admin') {
+        if ($context == 'admin') {
             // use the registration to get the transaction.
             $transaction = $registration->transaction();
 
             // bail early if no transaction
-            if (! $transaction instanceof EE_Transaction) {
+            if ( ! $transaction instanceof EE_Transaction) {
                 throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
             }
 
-            $payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
-            return array( $transaction, $payment );
+            $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array(array('PAY_ID' => $id, 'TXN_ID' => $transaction->ID()))) : 0;
+            return array($transaction, $payment);
         } else {
             return $registration;
         }

core/libraries/batch/JobHandlers/AttendeesReport.php

Indentation +96 added lines, -96 removed lines

@@ -19,106 +19,106 @@
 class AttendeesReport extends JobHandlerFile
 {
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function create_job(JobParameters $job_parameters)
-    {
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
-            throw new BatchRequestException(
-                esc_html__('You do not have permission to view contacts', 'event_espresso')
-            );
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            esc_html__('contact-list-report.csv', 'event_espresso')
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        $job_parameters->set_job_size($this->count_units_to_process());
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data(0, 1);
-        \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__('Contacts report started successfully...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function create_job(JobParameters $job_parameters)
+	{
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
+			throw new BatchRequestException(
+				esc_html__('You do not have permission to view contacts', 'event_espresso')
+			);
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			esc_html__('contact-list-report.csv', 'event_espresso')
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		$job_parameters->set_job_size($this->count_units_to_process());
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data(0, 1);
+		\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__('Contacts report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
-        \EEH_Export::write_data_array_to_csv(
-            $job_parameters->extra_datum('filepath'),
-            $csv_data,
-            false
-        );
-        $units_processed = count($csv_data);
-        $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($csv_data)
-            ),
-            $extra_response_data
-        );
-    }
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
+		\EEH_Export::write_data_array_to_csv(
+			$job_parameters->extra_datum('filepath'),
+			$csv_data,
+			false
+		);
+		$units_processed = count($csv_data);
+		$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($csv_data)
+			),
+			$extra_response_data
+		);
+	}
 
 
-    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'));
-    }
+	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'));
+	}
 
-    public function count_units_to_process()
-    {
-        return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
-    }
+	public function count_units_to_process()
+	{
+		return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
+	}
 
-    public function get_csv_data($offset, $limit)
-    {
-        $attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(
-            array(
-                'limit'      => array($offset, $limit),
-                '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[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
-                }
-            }
-            $csv_data[] = apply_filters(
-                'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row',
-                $csv_row,
-                $attendee_row
-            );
-        }
-        return $csv_data;
-    }
+	public function get_csv_data($offset, $limit)
+	{
+		$attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(
+			array(
+				'limit'      => array($offset, $limit),
+				'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[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
+				}
+			}
+			$csv_data[] = apply_filters(
+				'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row',
+				$csv_row,
+				$attendee_row
+			);
+		}
+		return $csv_data;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
     // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
     public function create_job(JobParameters $job_parameters)
     {
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
+        if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
             throw new BatchRequestException(
                 esc_html__('You do not have permission to view contacts', 'event_espresso')
             );
@@ -105,12 +105,12 @@ 
             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__('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+                    $csv_row[esc_html__('Country', 'event_espresso')] = $attendee_row[$country_name_field->get_qualified_column()];
                 } else {
-                    $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
+                    $csv_row[wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES)] = $attendee_row[$field_obj->get_qualified_column()];
                 }
             }
             $csv_data[] = apply_filters(

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +521 added lines, -521 removed lines

@@ -31,541 +31,541 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(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($event_id)
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
-        } else {
-            $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
-                array(
-                    'OR'                 => array(
-                        // don't include registrations from failed or abandoned transactions...
-                        'Transaction.STS_ID' => array(
-                            'NOT IN',
-                            array(
-                                EEM_Transaction::failed_status_code,
-                                EEM_Transaction::abandoned_status_code,
-                            ),
-                        ),
-                        // unless the registration is approved, in which case include it regardless of transaction status
-                        'STS_ID'             => \EEM_Registration::status_id_approved,
-                    ),
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
-                ),
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
-                'caps'       => \EEM_Base::caps_read_admin,
-            ), $event_id);
-            if ($event_id) {
-                $query_params[0]['EVT_ID'] = $event_id;
-            } else {
-                $query_params['force_join'][] = 'Event';
-            }
-        }
-        if (! isset($query_params['force_join'])) {
-            $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
-        }
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size(
-            \EEM_Registration::instance()->count(
-                array_diff_key(
-                    $query_params,
-                    array_flip(
-                        array('limit')
-                    )
-                )
-            )
-        );
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $job_parameters->extra_datum('question_labels'),
-            $job_parameters->extra_datum('query_params')
-        );
-        EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
-        // if we actually processed a row there, record it
-        if ($job_parameters->job_size()) {
-            $job_parameters->mark_processed(1);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            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
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(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($event_id)
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
+		} else {
+			$query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
+				array(
+					'OR'                 => array(
+						// don't include registrations from failed or abandoned transactions...
+						'Transaction.STS_ID' => array(
+							'NOT IN',
+							array(
+								EEM_Transaction::failed_status_code,
+								EEM_Transaction::abandoned_status_code,
+							),
+						),
+						// unless the registration is approved, in which case include it regardless of transaction status
+						'STS_ID'             => \EEM_Registration::status_id_approved,
+					),
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
+				),
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
+				'caps'       => \EEM_Base::caps_read_admin,
+			), $event_id);
+			if ($event_id) {
+				$query_params[0]['EVT_ID'] = $event_id;
+			} else {
+				$query_params['force_join'][] = 'Event';
+			}
+		}
+		if (! isset($query_params['force_join'])) {
+			$query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
+		}
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size(
+			\EEM_Registration::instance()->count(
+				array_diff_key(
+					$query_params,
+					array_flip(
+						array('limit')
+					)
+				)
+			)
+		);
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$job_parameters->extra_datum('question_labels'),
+			$job_parameters->extra_datum('query_params')
+		);
+		EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
+		// if we actually processed a row there, record it
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			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
-     */
-    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
+	 */
+	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
-     */
-    protected function _change_registration_where_params_to_question_where_params($reg_where_params)
-    {
-        $question_where_params = array();
-        foreach ($reg_where_params as $key => $val) {
-            if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
-            }
-        }
-        return $question_where_params;
-    }
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 */
+	protected function _change_registration_where_params_to_question_where_params($reg_where_params)
+	{
+		$question_where_params = array();
+		foreach ($reg_where_params as $key => $val) {
+			if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+			}
+		}
+		return $question_where_params;
+	}
 
 
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws \EE_Error
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params')
-            );
-            EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
-            $units_processed = count($csv_data);
-        } else {
-            $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
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				$job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params')
+			);
+			EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+			$units_processed = count($csv_data);
+		} else {
+			$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
-     * @return array top-level keys are numeric, next-level keys are column headers
-     * @throws \EE_Error
-     */
-    public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
-    {
-        $reg_fields_to_include = array(
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        );
-        $att_fields_to_include = array(
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        );
-        $registrations_csv_ready_array = array();
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        $query_params['limit'] = array($offset, $limit);
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        $registration_ids = array();
-        foreach ($registration_rows as $reg_row) {
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
-        }
-        foreach ($registration_rows as $reg_row) {
-            if (is_array($reg_row)) {
-                $reg_csv_array = array();
-                if (! $event_id) {
-                    // get the event's name and Id
-                    $reg_csv_array[ (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']
-                    );
-                }
-                $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-                /*@var $reg_row EE_Registration */
-                foreach ($reg_fields_to_include as $field_name) {
-                    $field = $reg_model->field_settings_for($field_name);
-                    if ($field_name == 'REG_final_price') {
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_final_price'],
-                            'localized_float'
-                        );
-                    } elseif ($field_name == 'REG_count') {
-                        $value = sprintf(
-                            /* 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']
-                            )
-                        );
-                    } elseif ($field_name == 'REG_date') {
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_date'],
-                            'no_html'
-                        );
-                    } else {
-                        $value = EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row[ $field->get_qualified_column() ]
-                        );
-                    }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value;
-                    if ($field_name == 'REG_final_price') {
-                        // add a column named Currency after the final price
-                        $reg_csv_array[ (string) 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[ (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 = array();
-                $gateway_txn_ids_etc = array();
-                $payment_times = array();
-                if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                    $payments_info = EEM_Payment::instance()->get_all_wpdb_results(
-                        array(
-                            array(
-                                'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                                'STS_ID' => EEM_Payment::status_id_approved,
-                            ),
-                            'force_join' => array('Payment_Method'),
-                        ),
-                        ARRAY_A,
-                        'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                    );
-                    foreach ($payments_info as $payment_method_and_gateway_txn_id) {
-                        $payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
-                            ? $payment_method_and_gateway_txn_id['name'] : 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'] : '';
-                    }
-                }
-                $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 whether or not the user has checked in
-                $reg_csv_array[ (string) 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 = EEH_Export::prepare_value_from_db_for_display(
-                        $ticket_model,
-                        'TKT_name',
-                        $reg_row['Ticket.TKT_name']
-                    );
-                    $datetimes_strings = array();
-                    foreach (
-                        EEM_Datetime::instance()->get_all_wpdb_results(
-                            array(
-                            array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
-                            'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                            'default_where_conditions' => 'none',
-                            )
-                        ) as $datetime
-                    ) {
-                        $datetimes_strings[] = EEH_Export::prepare_value_from_db_for_display(
-                            EEM_Datetime::instance(),
-                            'DTT_EVT_start',
-                            $datetime['Datetime.DTT_EVT_start']
-                        );
-                    }
-                } else {
-                    $ticket_name = esc_html__('Unknown', 'event_espresso');
-                    $datetimes_strings = array(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);
-                // get datetime(s) of registration
-                // add attendee columns
-                foreach ($att_fields_to_include as $att_field_name) {
-                    $field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
-                    if ($reg_row['Attendee_CPT.ID']) {
-                        if ($att_field_name == 'STA_ID') {
-                            $value = EEM_State::instance()->get_var(
-                                array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
-                                'STA_name'
-                            );
-                        } elseif ($att_field_name == 'CNT_ISO') {
-                            $value = EEM_Country::instance()->get_var(
-                                array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
-                                'CNT_name'
-                            );
-                        } else {
-                            $value = EEH_Export::prepare_value_from_db_for_display(
-                                EEM_Attendee::instance(),
-                                $att_field_name,
-                                $reg_row[ $field_obj->get_qualified_column() ]
-                            );
-                        }
-                    } else {
-                        $value = '';
-                    }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
-                }
-                // make sure each registration has the same questions in the same order
-                foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[ $question_label ])) {
-                        $reg_csv_array[ $question_label ] = null;
-                    }
-                }
-                $answers = EEM_Answer::instance()->get_all_wpdb_results(array(
-                    array('REG_ID' => $reg_row['Registration.REG_ID']),
-                    'force_join' => array('Question'),
-                ));
-                // now fill out the questions THEY answered
-                foreach ($answers as $answer_row) {
-                    if ($answer_row['Question.QST_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
-                    ) {
-                        $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
-                            $answer_row['Answer.ANS_value']
-                        );
-                    } else {
-                        // this isn't for html, so don't show html entities
-                        $reg_csv_array[ $question_label ] = html_entity_decode(
-                            EEH_Export::prepare_value_from_db_for_display(
-                                EEM_Answer::instance(),
-                                'ANS_value',
-                                $answer_row['Answer.ANS_value']
-                            )
-                        );
-                    }
-                }
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int $offset
+	 * @param int $limit
+	 * @param array $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array $query_params for using where querying the model
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 * @throws \EE_Error
+	 */
+	public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
+	{
+		$reg_fields_to_include = array(
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		);
+		$att_fields_to_include = array(
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		);
+		$registrations_csv_ready_array = array();
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		$query_params['limit'] = array($offset, $limit);
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		$registration_ids = array();
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
+		}
+		foreach ($registration_rows as $reg_row) {
+			if (is_array($reg_row)) {
+				$reg_csv_array = array();
+				if (! $event_id) {
+					// get the event's name and Id
+					$reg_csv_array[ (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']
+					);
+				}
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
+				/*@var $reg_row EE_Registration */
+				foreach ($reg_fields_to_include as $field_name) {
+					$field = $reg_model->field_settings_for($field_name);
+					if ($field_name == 'REG_final_price') {
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_final_price'],
+							'localized_float'
+						);
+					} elseif ($field_name == 'REG_count') {
+						$value = sprintf(
+							/* 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']
+							)
+						);
+					} elseif ($field_name == 'REG_date') {
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_date'],
+							'no_html'
+						);
+					} else {
+						$value = EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row[ $field->get_qualified_column() ]
+						);
+					}
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value;
+					if ($field_name == 'REG_final_price') {
+						// add a column named Currency after the final price
+						$reg_csv_array[ (string) 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[ (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 = array();
+				$gateway_txn_ids_etc = array();
+				$payment_times = array();
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+					$payments_info = EEM_Payment::instance()->get_all_wpdb_results(
+						array(
+							array(
+								'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+								'STS_ID' => EEM_Payment::status_id_approved,
+							),
+							'force_join' => array('Payment_Method'),
+						),
+						ARRAY_A,
+						'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+					);
+					foreach ($payments_info as $payment_method_and_gateway_txn_id) {
+						$payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
+							? $payment_method_and_gateway_txn_id['name'] : 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'] : '';
+					}
+				}
+				$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 whether or not the user has checked in
+				$reg_csv_array[ (string) 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 = EEH_Export::prepare_value_from_db_for_display(
+						$ticket_model,
+						'TKT_name',
+						$reg_row['Ticket.TKT_name']
+					);
+					$datetimes_strings = array();
+					foreach (
+						EEM_Datetime::instance()->get_all_wpdb_results(
+							array(
+							array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
+							'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+							'default_where_conditions' => 'none',
+							)
+						) as $datetime
+					) {
+						$datetimes_strings[] = EEH_Export::prepare_value_from_db_for_display(
+							EEM_Datetime::instance(),
+							'DTT_EVT_start',
+							$datetime['Datetime.DTT_EVT_start']
+						);
+					}
+				} else {
+					$ticket_name = esc_html__('Unknown', 'event_espresso');
+					$datetimes_strings = array(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);
+				// get datetime(s) of registration
+				// add attendee columns
+				foreach ($att_fields_to_include as $att_field_name) {
+					$field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
+					if ($reg_row['Attendee_CPT.ID']) {
+						if ($att_field_name == 'STA_ID') {
+							$value = EEM_State::instance()->get_var(
+								array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
+								'STA_name'
+							);
+						} elseif ($att_field_name == 'CNT_ISO') {
+							$value = EEM_Country::instance()->get_var(
+								array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
+								'CNT_name'
+							);
+						} else {
+							$value = EEH_Export::prepare_value_from_db_for_display(
+								EEM_Attendee::instance(),
+								$att_field_name,
+								$reg_row[ $field_obj->get_qualified_column() ]
+							);
+						}
+					} else {
+						$value = '';
+					}
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+				}
+				// make sure each registration has the same questions in the same order
+				foreach ($question_labels as $question_label) {
+					if (! isset($reg_csv_array[ $question_label ])) {
+						$reg_csv_array[ $question_label ] = null;
+					}
+				}
+				$answers = EEM_Answer::instance()->get_all_wpdb_results(array(
+					array('REG_ID' => $reg_row['Registration.REG_ID']),
+					'force_join' => array('Question'),
+				));
+				// now fill out the questions THEY answered
+				foreach ($answers as $answer_row) {
+					if ($answer_row['Question.QST_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
+					) {
+						$reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID(
+							$answer_row['Answer.ANS_value']
+						);
+					} else {
+						// this isn't for html, so don't show html entities
+						$reg_csv_array[ $question_label ] = html_entity_decode(
+							EEH_Export::prepare_value_from_db_for_display(
+								EEM_Answer::instance(),
+								'ANS_value',
+								$answer_row['Answer.ANS_value']
+							)
+						);
+					}
+				}
 
-                /**
-                 * Filter to change the contents of each row of the registrations report CSV file.
-                 * This can be used to add or remote columns from the CSV file, or change their values.
-                 * Note 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 = array();
-            $model_and_fields_to_include = array(
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            );
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
+				/**
+				 * 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 = array();
+			$model_and_fields_to_include = array(
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			);
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field = $model->field_settings_for($field_name);
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
 
 
-    /**
-     * Counts total unit to process
-     *
-     * @deprecated since 4.9.19
-     * @param int|array $event_id
-     * @return int
-     */
-    public function count_units_to_process($event_id)
-    {
-        // use the legacy filter
-        if ($event_id) {
-            $query_params[0]['EVT_ID'] = $event_id;
-        } else {
-            $query_params['force_join'][] = 'Event';
-        }
-        return \EEM_Registration::instance()->count($query_params);
-    }
+	/**
+	 * Counts total unit to process
+	 *
+	 * @deprecated since 4.9.19
+	 * @param int|array $event_id
+	 * @return int
+	 */
+	public function count_units_to_process($event_id)
+	{
+		// use the legacy filter
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
+		}
+		return \EEM_Registration::instance()->count($query_params);
+	}
 
 
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return boolean
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->_file_helper->delete(
-            \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        return new JobStepResponse($job_parameters, 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 boolean
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->_file_helper->delete(
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		return new JobStepResponse($job_parameters, esc_html__('Cleaned up temporary file', 'event_espresso'));
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -45,7 +45,7 @@ 
     public function create_job(JobParameters $job_parameters)
     {
         $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+        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(
@@ -82,7 +82,7 @@ 
                 $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);
@@ -181,10 +181,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,9 +277,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[ (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(
@@ -327,13 +327,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()]
                         );
                     }
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = $value;
                     if ($field_name == 'REG_final_price') {
                         // add a column named Currency after the final price
-                        $reg_csv_array[ (string) esc_html__("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code;
+                        $reg_csv_array[(string) esc_html__("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
                     }
                 }
                 // get pretty status
@@ -345,17 +345,17 @@ 
                     false,
                     'sentence'
                 );
-                $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',
@@ -386,14 +386,14 @@ 
                             ? $payment_method_and_gateway_txn_id['payment_time'] : '';
                     }
                 }
-                $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
                 );
                 // get whether or not the user has checked in
-                $reg_csv_array[ (string) esc_html__("Check-Ins", "event_espresso") ] = $reg_model->count_related(
+                $reg_csv_array[(string) esc_html__("Check-Ins", "event_espresso")] = $reg_model->count_related(
                     $reg_row['Registration.REG_ID'],
                     'Checkin'
                 );
@@ -425,8 +425,8 @@ 
                     $ticket_name = esc_html__('Unknown', 'event_espresso');
                     $datetimes_strings = array(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);
                 // get datetime(s) of registration
                 // add attendee columns
                 foreach ($att_fields_to_include as $att_field_name) {
@@ -446,18 +446,18 @@ 
                             $value = EEH_Export::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[ EEH_Export::get_column_name_for_field($field_obj) ] = $value;
+                    $reg_csv_array[EEH_Export::get_column_name_for_field($field_obj)] = $value;
                 }
                 // make sure each registration has the same questions in the same order
                 foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[ $question_label ])) {
-                        $reg_csv_array[ $question_label ] = null;
+                    if ( ! isset($reg_csv_array[$question_label])) {
+                        $reg_csv_array[$question_label] = null;
                     }
                 }
                 $answers = EEM_Answer::instance()->get_all_wpdb_results(array(
@@ -484,12 +484,12 @@ 
                         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 {
                         // this isn't for html, so don't show html entities
-                        $reg_csv_array[ $question_label ] = html_entity_decode(
+                        $reg_csv_array[$question_label] = html_entity_decode(
                             EEH_Export::prepare_value_from_db_for_display(
                                 EEM_Answer::instance(),
                                 'ANS_value',
@@ -524,7 +524,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/libraries/batch/JobHandlerBaseClasses/JobHandlerFile.php

Indentation +124 added lines, -124 removed lines

@@ -17,135 +17,135 @@
  */
 abstract class JobHandlerFile extends JobHandler
 {
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    const temp_folder_name = 'batch_temp_folder';
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	const temp_folder_name = 'batch_temp_folder';
 
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * @var \EEHI_File
-     */
-    protected $_file_helper = null;
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	/**
+	 * @var \EEHI_File
+	 */
+	protected $_file_helper = null;
 
 
-    /**
-     * JobHandlerFile constructor.
-     *
-     * @param \EEHI_File|null $file_helper
-     */
-    public function __construct(\EEHI_File $file_helper = null)
-    {
-        if (! $file_helper) {
-            $this->_file_helper = new EEH_File();
-        }
-    }
+	/**
+	 * JobHandlerFile constructor.
+	 *
+	 * @param \EEHI_File|null $file_helper
+	 */
+	public function __construct(\EEHI_File $file_helper = null)
+	{
+		if (! $file_helper) {
+			$this->_file_helper = new EEH_File();
+		}
+	}
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * Creates a file
-     *
-     * @param string $job_id
-     * @param string $filename
-     * @param string $filetype
-     * @param string $bom initial content to place in the file.
-     * @return string
-     * @throws \EventEspressoBatchRequest\Helpers\BatchRequestException
-     */
-    public function create_file_from_job_with_name(
-        $job_id,
-        $filename,
-        $filetype = 'application/ms-excel',
-        $bom = "\xEF\xBB\xBF"
-    ) {
-        $filepath = '';
-        try {
-            $base_folder = $this->get_base_folder();
-            $success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                $base_folder . JobHandlerFile::temp_folder_name
-            );
-            if ($success) {
-                $success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id
-                );
-            }
-            if ($success) {
-                $filepath = $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/' . $filename;
-                $success = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
-            }
-            // let's add the .htaccess file so safari will open the file properly
-            if ($success) {
-                $extension = EEH_File::get_file_extension($filepath);
-                EEH_File::write_to_file(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/.htaccess',
-                    'AddType ' . $filetype . ' ' . $extension,
-                    '.htaccess'
-                );
-            }
-            /**
-             * Filters what initial content will be added to the file.
-             * @param string $return_value. By default it's whatever was pased into
-             *                              JobHandlerFile::create_file_from_job_with_name()
-             * @param string $filename
-             * @param string $filetype default 'application/ms-excel'
-             * @param string $filepath
-             */
-            EEH_File::write_to_file(
-                $filepath,
-                apply_filters(
-                    'FHEE__EE_CSV__begin_sending_csv__start_writing',
-                    $bom,
-                    $filename,
-                    $filetype,
-                    $filepath
-                )
-            );
-            // those methods normally fail with an exception, but if not, let's do it
-            if (! $success) {
-                throw new \EE_Error(esc_html__('Could not create temporary file, an unknown error occurred', 'event_espresso'));
-            }
-        } catch (\EE_Error $e) {
-            throw new BatchRequestException(
-                sprintf(
-                    // phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
-                    esc_html__('Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso'),
-                    $job_id,
-                    $e->getMessage()
-                ),
-                500,
-                $e
-            );
-        }
-        return $filepath;
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * Creates a file
+	 *
+	 * @param string $job_id
+	 * @param string $filename
+	 * @param string $filetype
+	 * @param string $bom initial content to place in the file.
+	 * @return string
+	 * @throws \EventEspressoBatchRequest\Helpers\BatchRequestException
+	 */
+	public function create_file_from_job_with_name(
+		$job_id,
+		$filename,
+		$filetype = 'application/ms-excel',
+		$bom = "\xEF\xBB\xBF"
+	) {
+		$filepath = '';
+		try {
+			$base_folder = $this->get_base_folder();
+			$success = $this->_file_helper->ensure_folder_exists_and_is_writable(
+				$base_folder . JobHandlerFile::temp_folder_name
+			);
+			if ($success) {
+				$success = $this->_file_helper->ensure_folder_exists_and_is_writable(
+					$base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id
+				);
+			}
+			if ($success) {
+				$filepath = $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/' . $filename;
+				$success = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
+			}
+			// let's add the .htaccess file so safari will open the file properly
+			if ($success) {
+				$extension = EEH_File::get_file_extension($filepath);
+				EEH_File::write_to_file(
+					$base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/.htaccess',
+					'AddType ' . $filetype . ' ' . $extension,
+					'.htaccess'
+				);
+			}
+			/**
+			 * Filters what initial content will be added to the file.
+			 * @param string $return_value. By default it's whatever was pased into
+			 *                              JobHandlerFile::create_file_from_job_with_name()
+			 * @param string $filename
+			 * @param string $filetype default 'application/ms-excel'
+			 * @param string $filepath
+			 */
+			EEH_File::write_to_file(
+				$filepath,
+				apply_filters(
+					'FHEE__EE_CSV__begin_sending_csv__start_writing',
+					$bom,
+					$filename,
+					$filetype,
+					$filepath
+				)
+			);
+			// those methods normally fail with an exception, but if not, let's do it
+			if (! $success) {
+				throw new \EE_Error(esc_html__('Could not create temporary file, an unknown error occurred', 'event_espresso'));
+			}
+		} catch (\EE_Error $e) {
+			throw new BatchRequestException(
+				sprintf(
+					// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
+					esc_html__('Could not create temporary file for job %1$s, because: %2$s ', 'event_espresso'),
+					$job_id,
+					$e->getMessage()
+				),
+				500,
+				$e
+			);
+		}
+		return $filepath;
+	}
 
-    /**
-     * Gets the URL to download the file
-     *
-     * @param string $filepath
-     * @return string url to file
-     */
-    public function get_url_to_file($filepath)
-    {
-        return str_replace($this->get_base_folder(), $this->get_base_url(), $filepath);
-    }
+	/**
+	 * Gets the URL to download the file
+	 *
+	 * @param string $filepath
+	 * @return string url to file
+	 */
+	public function get_url_to_file($filepath)
+	{
+		return str_replace($this->get_base_folder(), $this->get_base_url(), $filepath);
+	}
 
-    /**
-     * Gets the folder which will contain the "batch_temp_folder"
-     *
-     * @return string
-     */
-    public function get_base_folder()
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_folder',
-            EVENT_ESPRESSO_UPLOAD_DIR
-        );
-    }
+	/**
+	 * Gets the folder which will contain the "batch_temp_folder"
+	 *
+	 * @return string
+	 */
+	public function get_base_folder()
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_folder',
+			EVENT_ESPRESSO_UPLOAD_DIR
+		);
+	}
 
-    public function get_base_url()
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_url',
-            EVENT_ESPRESSO_UPLOAD_URL
-        );
-    }
+	public function get_base_url()
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\JobHandlerBaseClasses\JobHandlerFile__get_base_url',
+			EVENT_ESPRESSO_UPLOAD_URL
+		);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function __construct(\EEHI_File $file_helper = null)
     {
-        if (! $file_helper) {
+        if ( ! $file_helper) {
             $this->_file_helper = new EEH_File();
         }
     }
@@ -60,23 +60,23 @@ 
         try {
             $base_folder = $this->get_base_folder();
             $success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                $base_folder . JobHandlerFile::temp_folder_name
+                $base_folder.JobHandlerFile::temp_folder_name
             );
             if ($success) {
                 $success = $this->_file_helper->ensure_folder_exists_and_is_writable(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id
+                    $base_folder.JobHandlerFile::temp_folder_name.'/'.$job_id
                 );
             }
             if ($success) {
-                $filepath = $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/' . $filename;
+                $filepath = $base_folder.JobHandlerFile::temp_folder_name.'/'.$job_id.'/'.$filename;
                 $success = $this->_file_helper->ensure_file_exists_and_is_writable($filepath);
             }
             // let's add the .htaccess file so safari will open the file properly
             if ($success) {
                 $extension = EEH_File::get_file_extension($filepath);
                 EEH_File::write_to_file(
-                    $base_folder . JobHandlerFile::temp_folder_name . '/' . $job_id . '/.htaccess',
-                    'AddType ' . $filetype . ' ' . $extension,
+                    $base_folder.JobHandlerFile::temp_folder_name.'/'.$job_id.'/.htaccess',
+                    'AddType '.$filetype.' '.$extension,
                     '.htaccess'
                 );
             }
@@ -99,7 +99,7 @@ 
                 )
             );
             // those methods normally fail with an exception, but if not, let's do it
-            if (! $success) {
+            if ( ! $success) {
                 throw new \EE_Error(esc_html__('Could not create temporary file, an unknown error occurred', 'event_espresso'));
             }
         } catch (\EE_Error $e) {

core/libraries/batch/BatchRequestProcessor.php

Indentation +201 added lines, -201 removed lines

@@ -25,215 +25,215 @@
  */
 class BatchRequestProcessor
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Current job's ID (if assigned)
-     *
-     * @var string|null
-     */
-    protected $_job_id;
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Current job's ID (if assigned)
+	 *
+	 * @var string|null
+	 */
+	protected $_job_id;
 
-    /**
-     * Current job's parameters
-     *
-     * @var JobParameters|null
-     */
-    protected $_job_parameters;
-    /**
-     * @var LoaderInterface
-     */
-    private $loader;
+	/**
+	 * Current job's parameters
+	 *
+	 * @var JobParameters|null
+	 */
+	protected $_job_parameters;
+	/**
+	 * @var LoaderInterface
+	 */
+	private $loader;
 
-    /**
-     * BatchRequestProcessor constructor.
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * Creates a job for the specified batch handler class (which should be autoloaded)
-     * and the specified request data
-     *
-     * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface
-     * @param array  $request_data            to be used by the batch job handler
-     * @return JobStepResponse
-     */
-    public function create_job($batch_job_handler_class, $request_data)
-    {
-        try {
-            $this->_job_id = wp_generate_password(15, false);
-            $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
-            $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
-            $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        esc_html__(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        wp_json_encode($request_data)
-                    )
-                );
-            }
-            $success = $this->_job_parameters->save(true);
-            if (! $success) {
-                throw new BatchRequestException(
-                    sprintf(
-                        esc_html__(
-                            'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->_job_id,
-                        wp_json_encode($request_data)
-                    )
-                );
-            }
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'create_job');
-        }
-        return $response;
-    }
+	/**
+	 * BatchRequestProcessor constructor.
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * Creates a job for the specified batch handler class (which should be autoloaded)
+	 * and the specified request data
+	 *
+	 * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface
+	 * @param array  $request_data            to be used by the batch job handler
+	 * @return JobStepResponse
+	 */
+	public function create_job($batch_job_handler_class, $request_data)
+	{
+		try {
+			$this->_job_id = wp_generate_password(15, false);
+			$obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
+			$this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
+			$response = $obj->create_job($this->_job_parameters);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						esc_html__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						wp_json_encode($request_data)
+					)
+				);
+			}
+			$success = $this->_job_parameters->save(true);
+			if (! $success) {
+				throw new BatchRequestException(
+					sprintf(
+						esc_html__(
+							'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s',
+							'event_espresso'
+						),
+						$this->_job_id,
+						wp_json_encode($request_data)
+					)
+				);
+			}
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'create_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Retrieves the job's arguments
-     *
-     * @param string $job_id
-     * @param int    $batch_size
-     * @return JobStepResponse
-     */
-    public function continue_job($job_id, $batch_size = 50)
-    {
-        try {
-            $this->_job_id = $job_id;
-            $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size;
-            // get the corresponding WordPress option for the job
-            $this->_job_parameters = JobParameters::load($this->_job_id);
-            $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
-            // continue it
-            $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        esc_html__(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        $this->_job_id
-                    )
-                );
-            }
-            $this->_job_parameters->save();
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'continue_job');
-        }
-        return $response;
-    }
+	/**
+	 * Retrieves the job's arguments
+	 *
+	 * @param string $job_id
+	 * @param int    $batch_size
+	 * @return JobStepResponse
+	 */
+	public function continue_job($job_id, $batch_size = 50)
+	{
+		try {
+			$this->_job_id = $job_id;
+			$batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size;
+			// get the corresponding WordPress option for the job
+			$this->_job_parameters = JobParameters::load($this->_job_id);
+			$handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
+			// continue it
+			$response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						esc_html__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						$this->_job_id
+					)
+				);
+			}
+			$this->_job_parameters->save();
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'continue_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Instantiates an object of type $classname, which implements
-     * JobHandlerInterface
-     *
-     * @param string $classname
-     * @return JobHandlerInterface
-     * @throws BatchRequestException
-     */
-    public function instantiate_batch_job_handler_from_classname($classname)
-    {
-        if (! class_exists($classname)) {
-            throw new BatchRequestException(
-                sprintf(
-                    esc_html__(
-                        'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        $obj = $this->loader->getNew($classname);
-        if (! $obj instanceof JobHandlerInterface) {
-            throw new BatchRequestException(
-                sprintf(
-                    esc_html__(
-                        'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        return $obj;
-    }
+	/**
+	 * Instantiates an object of type $classname, which implements
+	 * JobHandlerInterface
+	 *
+	 * @param string $classname
+	 * @return JobHandlerInterface
+	 * @throws BatchRequestException
+	 */
+	public function instantiate_batch_job_handler_from_classname($classname)
+	{
+		if (! class_exists($classname)) {
+			throw new BatchRequestException(
+				sprintf(
+					esc_html__(
+						'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		$obj = $this->loader->getNew($classname);
+		if (! $obj instanceof JobHandlerInterface) {
+			throw new BatchRequestException(
+				sprintf(
+					esc_html__(
+						'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		return $obj;
+	}
 
 
-    /**
-     * Forces a job to be cleaned up
-     *
-     * @param string $job_id
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job($job_id)
-    {
-        try {
-            $this->_job_id = $job_id;
-            $job_parameters = JobParameters::load($this->_job_id);
-            $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
-            // continue it
-            $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        esc_html__(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        $this->_job_id
-                    )
-                );
-            }
-            $job_parameters->set_status(JobParameters::status_cleaned_up);
-            $job_parameters->delete();
-            return $response;
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'cleanup_job');
-        }
-        return $response;
-    }
+	/**
+	 * Forces a job to be cleaned up
+	 *
+	 * @param string $job_id
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job($job_id)
+	{
+		try {
+			$this->_job_id = $job_id;
+			$job_parameters = JobParameters::load($this->_job_id);
+			$handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
+			// continue it
+			$response = $handler_obj->cleanup_job($job_parameters);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						esc_html__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						$this->_job_id
+					)
+				);
+			}
+			$job_parameters->set_status(JobParameters::status_cleaned_up);
+			$job_parameters->delete();
+			return $response;
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'cleanup_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Creates a valid JobStepResponse object from an exception and method name.
-     *
-     * @param \Exception $exception
-     * @param string     $method_name
-     * @return JobStepResponse
-     */
-    protected function _get_error_response(\Exception $exception, $method_name)
-    {
-        if (! $this->_job_parameters instanceof JobParameters) {
-            $this->_job_parameters = new JobParameters($this->_job_id, esc_html__('__Unknown__', 'event_espresso'), array());
-        }
-        $this->_job_parameters->set_status(JobParameters::status_error);
-        return new JobStepResponse(
-            $this->_job_parameters,
-            sprintf(
-                esc_html__(
-                    'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s',
-                    'event_espresso'
-                ),
-                get_class($exception),
-                'BatchRunner::' . $method_name . '()',
-                $exception->getMessage(),
-                $exception->getTraceAsString()
-            )
-        );
-    }
+	/**
+	 * Creates a valid JobStepResponse object from an exception and method name.
+	 *
+	 * @param \Exception $exception
+	 * @param string     $method_name
+	 * @return JobStepResponse
+	 */
+	protected function _get_error_response(\Exception $exception, $method_name)
+	{
+		if (! $this->_job_parameters instanceof JobParameters) {
+			$this->_job_parameters = new JobParameters($this->_job_id, esc_html__('__Unknown__', 'event_espresso'), array());
+		}
+		$this->_job_parameters->set_status(JobParameters::status_error);
+		return new JobStepResponse(
+			$this->_job_parameters,
+			sprintf(
+				esc_html__(
+					'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s',
+					'event_espresso'
+				),
+				get_class($exception),
+				'BatchRunner::' . $method_name . '()',
+				$exception->getMessage(),
+				$exception->getTraceAsString()
+			)
+		);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -69,7 +69,7 @@ 
             $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
             $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
             $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         esc_html__(
@@ -81,7 +81,7 @@ 
                 );
             }
             $success = $this->_job_parameters->save(true);
-            if (! $success) {
+            if ( ! $success) {
                 throw new BatchRequestException(
                     sprintf(
                         esc_html__(
@@ -117,7 +117,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
             // continue it
             $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         esc_html__(
@@ -146,7 +146,7 @@ 
      */
     public function instantiate_batch_job_handler_from_classname($classname)
     {
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             throw new BatchRequestException(
                 sprintf(
                     esc_html__(
@@ -158,7 +158,7 @@ 
             );
         }
         $obj = $this->loader->getNew($classname);
-        if (! $obj instanceof JobHandlerInterface) {
+        if ( ! $obj instanceof JobHandlerInterface) {
             throw new BatchRequestException(
                 sprintf(
                     esc_html__(
@@ -188,7 +188,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
             // continue it
             $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         esc_html__(
@@ -218,7 +218,7 @@ 
      */
     protected function _get_error_response(\Exception $exception, $method_name)
     {
-        if (! $this->_job_parameters instanceof JobParameters) {
+        if ( ! $this->_job_parameters instanceof JobParameters) {
             $this->_job_parameters = new JobParameters($this->_job_id, esc_html__('__Unknown__', 'event_espresso'), array());
         }
         $this->_job_parameters->set_status(JobParameters::status_error);
@@ -230,7 +230,7 @@ 
                     'event_espresso'
                 ),
                 get_class($exception),
-                'BatchRunner::' . $method_name . '()',
+                'BatchRunner::'.$method_name.'()',
                 $exception->getMessage(),
                 $exception->getTraceAsString()
             )

core/libraries/qtips/EE_Qtip_Config.lib.php

Indentation +225 added lines, -225 removed lines

@@ -15,235 +15,235 @@ 
 abstract class EE_Qtip_Config extends EE_Base
 {
 
-    /**
-     * This will hold the qtips setup array (setup by children)
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_qtipsa;
+	/**
+	 * This will hold the qtips setup array (setup by children)
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_qtipsa;
 
 
-    /**
-     * This holds the constructed EE_Qtip objects
-     *
-     * @access protected
-     * @var EE_Qtip
-     */
-    protected $_qtips;
+	/**
+	 * This holds the constructed EE_Qtip objects
+	 *
+	 * @access protected
+	 * @var EE_Qtip
+	 */
+	protected $_qtips;
 
 
-    /**
-     * an array of default options for instantiated qtip js objects
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_default_options;
+	/**
+	 * an array of default options for instantiated qtip js objects
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_default_options;
 
 
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        $this->_qtipsa = $this->_qtips = array();
-        $this->_set_default_options();
-        $this->_set_tips_array();
-        $this->_construct_tips();
-    }
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		$this->_qtipsa = $this->_qtips = array();
+		$this->_set_default_options();
+		$this->_set_tips_array();
+		$this->_construct_tips();
+	}
 
 
-    /**
-     * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
-     *
-     * $qtipsa = array(
-     *        0 => array(
-     *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
-     *            'content' => 'html/text content for the qtip',
-     *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
-     *            target is for the qTip in the dom (i.e. if class then '.some-class').
-     *            'options' => array() //use this to override any of the default options for this specific qtip.
-     *        )
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tips_array();
+	/**
+	 * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
+	 *
+	 * $qtipsa = array(
+	 *        0 => array(
+	 *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
+	 *            'content' => 'html/text content for the qtip',
+	 *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
+	 *            target is for the qTip in the dom (i.e. if class then '.some-class').
+	 *            'options' => array() //use this to override any of the default options for this specific qtip.
+	 *        )
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tips_array();
 
 
-    /**
-     * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
-     * qtips defined in their config OR just leave it and have the parent default options apply.
-     *
-     * commented out options are there for reference so you know which can be defined by the child.
-     *
-     * Note: children do NOT have to define all these options.  Just define the ones to override.
-     *
-     * @link   http://qtip2.com/options
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_default_options()
-    {
-        $this->_default_options = array(
-            // 'id' => 'unique_id_referncing_qtip_instance',
-            'prerender'      => false,
-            // increases page load if true,
-            'suppress'       => true,
-            // whether default browser tooltips are suppressed.
-            'content'        => array(
-                'button' => false,
-                // what you want for the close button text/link.
-                'title'  => true,
-                // Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
-                'clone'  => true,
-                // Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
-            ),
-            'show_only_once' => false,
-            // this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
-            'position'       => array(
-                'my'        => 'top left',
-                // top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
-                'at'        => 'bottom right',
-                // same options as above.
-                'target'    => 'event',
-                // if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
-                'container' => false,
-                // what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
-                'viewport'  => true,
-                // @link http://qtip2.com/plugins#viewport
-                'adjust'    => array(
-                    'x'      => 0,
-                    // adjust position on x axis by 0 pixels.
-                    'y'      => 0,
-                    // adjust position on y axis by 0 pixels.
-                    'mouse'  => true,
-                    // when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
-                    'resize' => true,
-                    // adjust tooltip position when window is resized.
-                    'scroll' => true,
-                    // position of tooltip adjusted when window (or position.container) is scrolled.
-                    'method' => 'flipinvert',
-                    // @link http://qtip2.com/plugins#viewport
-                ),
-            ),
-            'show'           => array(
-                'event'  => 'mouseenter',
-                // what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
-                'target' => false,
-                // options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
-                'delay'  => 90,
-                // time in millisecons by which to delay showing of tooltip.
-                'solo'   => false,
-                // determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
-                'modal'  => array(
-                    'on'         => false, // does tooltip trigger modal?
-                    'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
-                    'escape'     => true, // hitting escape key hide the tooltip and cancel modal
-                    'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
-                ),
-            ),
-            'hide'           => array(
-                'event'    => 'mouseleave',
-                // similar as what you do for show.event.
-                'target'   => false,
-                // Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
-                'delay'    => 0,
-                // set time in milliseconds for delaying the hide of the tooltip
-                'inactive' => false,
-                // if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
-                'fixed'    => false,
-                // when set to true, the tooltip will not hide if moused over.
-                'leave'    => 'window',
-                // specify whether the tooltip will hide when leaving the window it's conained within.
-                'distance' => false,
-                // if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
-            ),
-            'style'          => array(
-                'classes' => 'qtip-tipsy',
-                // Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
-                'def'     => true,
-                // set to false and the default qtip class does not get applied
-                'widget'  => false,
-                // whether ui-widget classes of the themeroller UI styles are applied to tooltip.
-                'width'   => false,
-                // Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
-                'height'  => false,
-                // same as above except applies to height.
-                'tip'     => array(
-                    'corner' => true,
-                    // where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
-                    'mimic'  => false,
-                    // see documentation @link http://qtip2.com/plugins#tips
-                    'border' => true,
-                    // Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
-                    'width'  => 6,
-                    // width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
-                    'height' => 6,
-                    // works the same as tip.width
-                    'offset' => 0,
-                    // use to set the offset of the tip in relation to its corner position.
-                ),
-            ),
+	/**
+	 * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
+	 * qtips defined in their config OR just leave it and have the parent default options apply.
+	 *
+	 * commented out options are there for reference so you know which can be defined by the child.
+	 *
+	 * Note: children do NOT have to define all these options.  Just define the ones to override.
+	 *
+	 * @link   http://qtip2.com/options
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_default_options()
+	{
+		$this->_default_options = array(
+			// 'id' => 'unique_id_referncing_qtip_instance',
+			'prerender'      => false,
+			// increases page load if true,
+			'suppress'       => true,
+			// whether default browser tooltips are suppressed.
+			'content'        => array(
+				'button' => false,
+				// what you want for the close button text/link.
+				'title'  => true,
+				// Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
+				'clone'  => true,
+				// Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
+			),
+			'show_only_once' => false,
+			// this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
+			'position'       => array(
+				'my'        => 'top left',
+				// top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
+				'at'        => 'bottom right',
+				// same options as above.
+				'target'    => 'event',
+				// if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
+				'container' => false,
+				// what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
+				'viewport'  => true,
+				// @link http://qtip2.com/plugins#viewport
+				'adjust'    => array(
+					'x'      => 0,
+					// adjust position on x axis by 0 pixels.
+					'y'      => 0,
+					// adjust position on y axis by 0 pixels.
+					'mouse'  => true,
+					// when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
+					'resize' => true,
+					// adjust tooltip position when window is resized.
+					'scroll' => true,
+					// position of tooltip adjusted when window (or position.container) is scrolled.
+					'method' => 'flipinvert',
+					// @link http://qtip2.com/plugins#viewport
+				),
+			),
+			'show'           => array(
+				'event'  => 'mouseenter',
+				// what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
+				'target' => false,
+				// options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
+				'delay'  => 90,
+				// time in millisecons by which to delay showing of tooltip.
+				'solo'   => false,
+				// determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
+				'modal'  => array(
+					'on'         => false, // does tooltip trigger modal?
+					'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
+					'escape'     => true, // hitting escape key hide the tooltip and cancel modal
+					'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
+				),
+			),
+			'hide'           => array(
+				'event'    => 'mouseleave',
+				// similar as what you do for show.event.
+				'target'   => false,
+				// Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
+				'delay'    => 0,
+				// set time in milliseconds for delaying the hide of the tooltip
+				'inactive' => false,
+				// if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
+				'fixed'    => false,
+				// when set to true, the tooltip will not hide if moused over.
+				'leave'    => 'window',
+				// specify whether the tooltip will hide when leaving the window it's conained within.
+				'distance' => false,
+				// if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
+			),
+			'style'          => array(
+				'classes' => 'qtip-tipsy',
+				// Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
+				'def'     => true,
+				// set to false and the default qtip class does not get applied
+				'widget'  => false,
+				// whether ui-widget classes of the themeroller UI styles are applied to tooltip.
+				'width'   => false,
+				// Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
+				'height'  => false,
+				// same as above except applies to height.
+				'tip'     => array(
+					'corner' => true,
+					// where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
+					'mimic'  => false,
+					// see documentation @link http://qtip2.com/plugins#tips
+					'border' => true,
+					// Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
+					'width'  => 6,
+					// width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
+					'height' => 6,
+					// works the same as tip.width
+					'offset' => 0,
+					// use to set the offset of the tip in relation to its corner position.
+				),
+			),
 
-        );
-    }
+		);
+	}
 
 
-    /**
-     * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
-     * the $_qtips property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _construct_tips()
-    {
-        foreach ($this->_qtipsa as $qt) {
-            // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        var_export($qt, true)
-                    )
-                );
-            }
+	/**
+	 * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
+	 * the $_qtips property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _construct_tips()
+	{
+		foreach ($this->_qtipsa as $qt) {
+			// make sure we have what we need.
+			if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
+							'event_espresso'
+						),
+						get_class($this),
+						var_export($qt, true)
+					)
+				);
+			}
 
-            // make sure the options include defaults and just override via set config.
-            $options_override = isset($qt['options']) ? (array) $qt['options'] : array();
-            $options = array_merge($this->_default_options, $options_override);
-            $setup = array(
-                'content_id' => $qt['content_id'],
-                'options'    => $options,
-                'target'     => $qt['target'],
-                'content'    => $qt['content'],
-            );
-            $this->_qtips[] = new EE_Qtip($setup);
-        }
-    }
+			// make sure the options include defaults and just override via set config.
+			$options_override = isset($qt['options']) ? (array) $qt['options'] : array();
+			$options = array_merge($this->_default_options, $options_override);
+			$setup = array(
+				'content_id' => $qt['content_id'],
+				'options'    => $options,
+				'target'     => $qt['target'],
+				'content'    => $qt['content'],
+			);
+			$this->_qtips[] = new EE_Qtip($setup);
+		}
+	}
 
 
-    /**
-     * return the _qtips property contents
-     *
-     * @access public
-     * @return EE_Qtip[]
-     */
-    public function get_tips()
-    {
-        return $this->_qtips;
-    }
+	/**
+	 * return the _qtips property contents
+	 *
+	 * @access public
+	 * @return EE_Qtip[]
+	 */
+	public function get_tips()
+	{
+		return $this->_qtips;
+	}
 }
 
 // class names you can use for tooltip styles
@@ -295,17 +295,17 @@ 
  */
 class EE_Qtip extends EE_Base
 {
-    public $content_id;
-    public $options;
-    public $target;
-    public $content;
+	public $content_id;
+	public $options;
+	public $target;
+	public $content;
 
-    public function __construct($setup_array)
-    {
-        foreach ($setup_array as $prop => $value) {
-            if (EEH_Class_Tools::has_property($this, $prop)) {
-                $this->{$prop} = $value;
-            }
-        }
-    }
+	public function __construct($setup_array)
+	{
+		foreach ($setup_array as $prop => $value) {
+			if (EEH_Class_Tools::has_property($this, $prop)) {
+				$this->{$prop} = $value;
+			}
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
     {
         foreach ($this->_qtipsa as $qt) {
             // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+            if ( ! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(

core/libraries/plugin_api/EE_Register_Messages_Template_Variations.lib.php

Indentation +305 added lines, -305 removed lines

@@ -11,332 +11,332 @@
 class EE_Register_Messages_Template_Variations implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered variations
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = [];
+	/**
+	 * Holds values for registered variations
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = [];
 
 
-    /**
-     * Used to register new variations
-     *
-     * Variations are attached to template packs and do not typically change any structural layout but merely tweak the
-     * style of the layout.  The most commonly known variation is css.  CSS does not affect html structure just the
-     * style of existing structure.
-     *
-     * It's important to remember that when variation files are loaded, the file structure looked for is:
-     * '{$messenger}_{$messenger_variation_type}_{$variation_slug}.{$extension}'.
-     *
-     *    - Every variation applies to specific messengers.  That's why the variation file includes the messenger name
-     *    it.   This ensures that if a template pack the variation is registered with supports multiple variations that
-     *    you can have the correct variation loaded.
-     *    - EE_messengers also implicitly define variation "types" which typically are the context in which a specific
-     *    variation is loaded.  For instance the email messenger has: 'inline', which is the css added inline to the
-     *    email templates; 'preview', which is the same css only customized for when emails are previewed; and
-     *    'wpeditor', which is the same css only customized so that it works with the wpeditor fields for templates to
-     *    give a accurate representation of the style in the wysiwyg editor.  This means that for each variation, if
-     *    you want it to be accurately represented in various template contexts you need to have that relevant
-     *    variation file available.
-     *    - $variation_slug  is simply the variation slug for that variation.
-     *    - $extension = whatever the extension is for the variation used for the messenger calling it.  In MOST cases
-     *    messenger variations are .css files. Note: if your file names are not formatted correctly then they will NOT
-     *    be loaded.  The EE messages template pack system will fallback to corresponding default template pack for the
-     *    given messenger or as a last resort (i.e. no default variation for the given messenger) will not load any
-     *    variation (so the template pack would be unstyled)
-     *
-     * @see /core/libraries/messages/defaults/default/variations/* for example variation files for the email and html
-     *      messengers.
-     *
-     * @param string $identifier                      unique reference used to describe this variation registry. If
-     *                                                this ISN'T unique then this method will make it unique (and it
-     *                                                becomes harder to deregister).
-     * @param array  $setup_args                      {
-     *                                                an array of required values for registering the variations.
-     * @type array   $variations                      {
-     *                                                An array indexed by template_pack->dbref. and values are an array
-     *                                                indexed by messenger name and values are an array indexed by
-     *                                                message_type and values are an array indexed by variation_slug
-     *                                                and value  is the localized label for the variation.  Note this
-     *                                                api reserves the "default" variation name for the default
-     *                                                template pack so you can't register a default variation.  Also,
-     *                                                try to use unique variation slugs to reference your variations
-     *                                                because this api checks if any existing variations are in place
-     *                                                with that name.  If there are then subsequent variations for that
-     *                                                template pack with that same name will fail to register with a
-     *                                                persistent notice put up for the user. Required.
-     *                                                'default' => array(
-     *                                                'email' => array(
-     *                                                'registration_approved' => array(
-     *                                                my_ee_addon_blue_lagoon' => esc_html__('Blue Lagoon',
-     *                                                'text_domain'),
-     *                                                'my_ee_addon_red_sunset' => esc_html__('Red Sunset',
-     *                                                'text_domain')
-     *                                                )
-     *                                                )
-     *                                                )
-     *                                                }
-     * @type string  $base_path                       The base path for where all your variations are found.  Although
-     *                                                the full path to your variation files should include
-     *                                                '/variations/' in it, do not include the
-     *                                                'variations/' in this. Required.
-     * @type string  $base_url                        The base url for where all your variations are found. See note
-     *                                                above about the 'variations/' string. Required.
-     *                                                }
-     *                                                }
-     *
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
+	/**
+	 * Used to register new variations
+	 *
+	 * Variations are attached to template packs and do not typically change any structural layout but merely tweak the
+	 * style of the layout.  The most commonly known variation is css.  CSS does not affect html structure just the
+	 * style of existing structure.
+	 *
+	 * It's important to remember that when variation files are loaded, the file structure looked for is:
+	 * '{$messenger}_{$messenger_variation_type}_{$variation_slug}.{$extension}'.
+	 *
+	 *    - Every variation applies to specific messengers.  That's why the variation file includes the messenger name
+	 *    it.   This ensures that if a template pack the variation is registered with supports multiple variations that
+	 *    you can have the correct variation loaded.
+	 *    - EE_messengers also implicitly define variation "types" which typically are the context in which a specific
+	 *    variation is loaded.  For instance the email messenger has: 'inline', which is the css added inline to the
+	 *    email templates; 'preview', which is the same css only customized for when emails are previewed; and
+	 *    'wpeditor', which is the same css only customized so that it works with the wpeditor fields for templates to
+	 *    give a accurate representation of the style in the wysiwyg editor.  This means that for each variation, if
+	 *    you want it to be accurately represented in various template contexts you need to have that relevant
+	 *    variation file available.
+	 *    - $variation_slug  is simply the variation slug for that variation.
+	 *    - $extension = whatever the extension is for the variation used for the messenger calling it.  In MOST cases
+	 *    messenger variations are .css files. Note: if your file names are not formatted correctly then they will NOT
+	 *    be loaded.  The EE messages template pack system will fallback to corresponding default template pack for the
+	 *    given messenger or as a last resort (i.e. no default variation for the given messenger) will not load any
+	 *    variation (so the template pack would be unstyled)
+	 *
+	 * @see /core/libraries/messages/defaults/default/variations/* for example variation files for the email and html
+	 *      messengers.
+	 *
+	 * @param string $identifier                      unique reference used to describe this variation registry. If
+	 *                                                this ISN'T unique then this method will make it unique (and it
+	 *                                                becomes harder to deregister).
+	 * @param array  $setup_args                      {
+	 *                                                an array of required values for registering the variations.
+	 * @type array   $variations                      {
+	 *                                                An array indexed by template_pack->dbref. and values are an array
+	 *                                                indexed by messenger name and values are an array indexed by
+	 *                                                message_type and values are an array indexed by variation_slug
+	 *                                                and value  is the localized label for the variation.  Note this
+	 *                                                api reserves the "default" variation name for the default
+	 *                                                template pack so you can't register a default variation.  Also,
+	 *                                                try to use unique variation slugs to reference your variations
+	 *                                                because this api checks if any existing variations are in place
+	 *                                                with that name.  If there are then subsequent variations for that
+	 *                                                template pack with that same name will fail to register with a
+	 *                                                persistent notice put up for the user. Required.
+	 *                                                'default' => array(
+	 *                                                'email' => array(
+	 *                                                'registration_approved' => array(
+	 *                                                my_ee_addon_blue_lagoon' => esc_html__('Blue Lagoon',
+	 *                                                'text_domain'),
+	 *                                                'my_ee_addon_red_sunset' => esc_html__('Red Sunset',
+	 *                                                'text_domain')
+	 *                                                )
+	 *                                                )
+	 *                                                )
+	 *                                                }
+	 * @type string  $base_path                       The base path for where all your variations are found.  Although
+	 *                                                the full path to your variation files should include
+	 *                                                '/variations/' in it, do not include the
+	 *                                                'variations/' in this. Required.
+	 * @type string  $base_url                        The base url for where all your variations are found. See note
+	 *                                                above about the 'variations/' string. Required.
+	 *                                                }
+	 *                                                }
+	 *
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
 
-        // check for required params
-        if (empty($identifier)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register variations for a EE_Message_Template_Pack, you must include a value to reference the variations being registered',
-                    'event_espresso'
-                )
-            );
-        }
+		// check for required params
+		if (empty($identifier)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register variations for a EE_Message_Template_Pack, you must include a value to reference the variations being registered',
+					'event_espresso'
+				)
+			);
+		}
 
-        if (
-            ! is_array($setup_args)
-            || empty($setup_args['variations'])
-            || empty($setup_args['base_path'])
-            || empty($setup_args['base_url'])
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register variations for a EE_Message_Template_Pack, you must include an array containing the following keys: "variations", "base_path", "base_url", "extension"',
-                    'event_espresso'
-                )
-            );
-        }
+		if (
+			! is_array($setup_args)
+			|| empty($setup_args['variations'])
+			|| empty($setup_args['base_path'])
+			|| empty($setup_args['base_url'])
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register variations for a EE_Message_Template_Pack, you must include an array containing the following keys: "variations", "base_path", "base_url", "extension"',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
 
-        // make sure variation ref is unique.
-        if (isset(self::$_registry[ $identifier ])) {
-            $identifier = uniqid() . '_' . $identifier;
-        }
+		// make sure variation ref is unique.
+		if (isset(self::$_registry[ $identifier ])) {
+			$identifier = uniqid() . '_' . $identifier;
+		}
 
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'Messages Templates Variations given the reference "%s" has been attempted to be registered with the EE Messages Template Pack System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.5.0'
-            );
-        }
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'Messages Templates Variations given the reference "%s" has been attempted to be registered with the EE Messages Template Pack System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.5.0'
+			);
+		}
 
-        // validate/sanitize incoming args.
-        $validated = [
-            'variations' => (array) $setup_args['variations'],
-            'base_path'  => (string) $setup_args['base_path'],
-            'base_url'   => (string) $setup_args['base_url'],
-        ];
+		// validate/sanitize incoming args.
+		$validated = [
+			'variations' => (array) $setup_args['variations'],
+			'base_path'  => (string) $setup_args['base_path'],
+			'base_url'   => (string) $setup_args['base_url'],
+		];
 
 
-        // check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
-        $validated                      = self::_verify_variations($identifier, $validated);
-        self::$_registry[ $identifier ] = $validated;
+		// check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
+		$validated                      = self::_verify_variations($identifier, $validated);
+		self::$_registry[ $identifier ] = $validated;
 
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_variations',
-            ['EE_Register_Messages_Template_Variations', 'get_variations'],
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_variation',
-            ['EE_Register_Messages_Template_Variations', 'get_variation'],
-            10,
-            8
-        );
-    }
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_variations',
+			['EE_Register_Messages_Template_Variations', 'get_variations'],
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_variation',
+			['EE_Register_Messages_Template_Variations', 'get_variation'],
+			10,
+			8
+		);
+	}
 
 
-    /**
-     * Cycles through the variations registered and makes sure there are no reserved variations being registered which
-     * throws an error.  Also checks if there is already a
-     *
-     * @param string $identifier           the reference for the variations being registered
-     * @param array  $validated_variations The variations setup array that's being registered (and verified).
-     * @return array
-     * @throws EE_Error
-     * @since  4.5.0
-     *
-     */
-    private static function _verify_variations($identifier, array $validated_variations)
-    {
-        foreach (self::$_registry as $settings) {
-            foreach ($settings['variations'] as $messenger) {
-                foreach ($messenger as $all_variations) {
-                    if (isset($all_variations['default'])) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    'Variations registered through the EE_Register_Messages_Template_Variations api cannot override the default variation for the default template.  Please check the code registering variations with this reference, "%s" and modify.',
-                                    'event_espresso'
-                                ),
-                                $identifier
-                            )
-                        );
-                    }
-                }
-            }
-        }
+	/**
+	 * Cycles through the variations registered and makes sure there are no reserved variations being registered which
+	 * throws an error.  Also checks if there is already a
+	 *
+	 * @param string $identifier           the reference for the variations being registered
+	 * @param array  $validated_variations The variations setup array that's being registered (and verified).
+	 * @return array
+	 * @throws EE_Error
+	 * @since  4.5.0
+	 *
+	 */
+	private static function _verify_variations($identifier, array $validated_variations)
+	{
+		foreach (self::$_registry as $settings) {
+			foreach ($settings['variations'] as $messenger) {
+				foreach ($messenger as $all_variations) {
+					if (isset($all_variations['default'])) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									'Variations registered through the EE_Register_Messages_Template_Variations api cannot override the default variation for the default template.  Please check the code registering variations with this reference, "%s" and modify.',
+									'event_espresso'
+								),
+								$identifier
+							)
+						);
+					}
+				}
+			}
+		}
 
-        // is there already a variation registered with a given variation slug?
-        foreach ($validated_variations['variations'] as $template_pack => $messenger) {
-            foreach ($messenger as $message_type => $variations) {
-                foreach ($variations as $slug => $label) {
-                    foreach (self::$_registry as $registered_var => $reg_settings) {
-                        if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
-                            unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
-                            EE_Error::add_error(
-                                sprintf(
-                                    esc_html__(
-                                        'Unable to register the %s variation for the %s template pack with the %s messenger and %s message_type because a variation with this slug was already registered for this template pack and messenger and message type by an addon using this key %s.',
-                                        'event_espresso'
-                                    ),
-                                    $label,
-                                    $template_pack,
-                                    $messenger,
-                                    $message_type,
-                                    $registered_var
-                                )
-                            );
-                        }
-                    }
-                }
-            }
-        }
-        return $validated_variations;
-    }
+		// is there already a variation registered with a given variation slug?
+		foreach ($validated_variations['variations'] as $template_pack => $messenger) {
+			foreach ($messenger as $message_type => $variations) {
+				foreach ($variations as $slug => $label) {
+					foreach (self::$_registry as $registered_var => $reg_settings) {
+						if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
+							unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
+							EE_Error::add_error(
+								sprintf(
+									esc_html__(
+										'Unable to register the %s variation for the %s template pack with the %s messenger and %s message_type because a variation with this slug was already registered for this template pack and messenger and message type by an addon using this key %s.',
+										'event_espresso'
+									),
+									$label,
+									$template_pack,
+									$messenger,
+									$message_type,
+									$registered_var
+								)
+							);
+						}
+					}
+				}
+			}
+		}
+		return $validated_variations;
+	}
 
 
-    /**
-     * Callback for the FHEE__EE_Messages_Template_Pack__get_variation filter to ensure registered variations are used.
-     *
-     * @param string                    $variation_path The path generated for the current variation
-     * @param string                    $messenger      The messenger the variation is for
-     * @param string                    $message_type   EE_message_type->name
-     * @param string                    $type           The type of variation being requested
-     * @param string                    $variation      The slug for the variation being requested
-     * @param string                    $file_extension What the file extension is for the variation
-     * @param bool                      $url            Whether url or path is being returned.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string                    The path to the requested variation.
-     * @since 4.5.0
-     *
-     */
-    public static function get_variation(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        // so let's loop through our registered variations and then pull any details matching the request.
-        foreach (self::$_registry as $registry_settings) {
-            $base        = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
-            $file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
-            // see if this file exists
-            if (is_readable($registry_settings['base_path'] . $file_string)) {
-                return $base . $file_string;
-            }
-        }
+	/**
+	 * Callback for the FHEE__EE_Messages_Template_Pack__get_variation filter to ensure registered variations are used.
+	 *
+	 * @param string                    $variation_path The path generated for the current variation
+	 * @param string                    $messenger      The messenger the variation is for
+	 * @param string                    $message_type   EE_message_type->name
+	 * @param string                    $type           The type of variation being requested
+	 * @param string                    $variation      The slug for the variation being requested
+	 * @param string                    $file_extension What the file extension is for the variation
+	 * @param bool                      $url            Whether url or path is being returned.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string                    The path to the requested variation.
+	 * @since 4.5.0
+	 *
+	 */
+	public static function get_variation(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		// so let's loop through our registered variations and then pull any details matching the request.
+		foreach (self::$_registry as $registry_settings) {
+			$base        = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
+			$file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
+			// see if this file exists
+			if (is_readable($registry_settings['base_path'] . $file_string)) {
+				return $base . $file_string;
+			}
+		}
 
-        // no match
-        return $variation_path;
-    }
+		// no match
+		return $variation_path;
+	}
 
 
-    /**
-     * callback for the FHEE__EE_Messages_Template_Pack__get_variations filter.
-     *
-     *
-     * @param array                     $variations The original contents for the template pack variations property.
-     * @param string                    $messenger  The messenger requesting the variations.
-     * @param string                    $message_type
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return array                   new variations array (or existing one if nothing registered)
-     * @since 4.5.0
-     *
-     * @see   $_variation property definition in EE_Messages_Template_Pack
-     */
-    public static function get_variations(
-        array $variations,
-        $messenger,
-        $message_type,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        // first let's check if we even have registered variations and get out early.
-        if (empty(self::$_registry)) {
-            return $variations;
-        }
+	/**
+	 * callback for the FHEE__EE_Messages_Template_Pack__get_variations filter.
+	 *
+	 *
+	 * @param array                     $variations The original contents for the template pack variations property.
+	 * @param string                    $messenger  The messenger requesting the variations.
+	 * @param string                    $message_type
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return array                   new variations array (or existing one if nothing registered)
+	 * @since 4.5.0
+	 *
+	 * @see   $_variation property definition in EE_Messages_Template_Pack
+	 */
+	public static function get_variations(
+		array $variations,
+		$messenger,
+		$message_type,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		// first let's check if we even have registered variations and get out early.
+		if (empty(self::$_registry)) {
+			return $variations;
+		}
 
-        // do we have any new variations for the given messenger, $message_type, and template packs
-        foreach (self::$_registry as $registry_settings) {
-            // allow for different conditions.
-            if (empty($messenger)) {
-                return array_merge($registry_settings['variations'], $variations);
-            }
-            if (empty($message_type)) {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
-                    return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
-                        $variations
-                    );
-                }
-            } else {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
-                    return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
-                        $variations
-                    );
-                }
-            }
-        }
-        return $variations;
-    }
+		// do we have any new variations for the given messenger, $message_type, and template packs
+		foreach (self::$_registry as $registry_settings) {
+			// allow for different conditions.
+			if (empty($messenger)) {
+				return array_merge($registry_settings['variations'], $variations);
+			}
+			if (empty($message_type)) {
+				if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
+					return array_merge(
+						$registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
+						$variations
+					);
+				}
+			} else {
+				if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
+					return array_merge(
+						$registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
+						$variations
+					);
+				}
+			}
+		}
+		return $variations;
+	}
 
 
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @param string $identifier The name for the variation set that was previously registered.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_registry[ $identifier ]);
-    }
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @param string $identifier The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_registry[ $identifier ]);
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -119,13 +119,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
 
         // make sure variation ref is unique.
-        if (isset(self::$_registry[ $identifier ])) {
-            $identifier = uniqid() . '_' . $identifier;
+        if (isset(self::$_registry[$identifier])) {
+            $identifier = uniqid().'_'.$identifier;
         }
 
 
@@ -157,7 +157,7 @@ 
 
         // check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
         $validated                      = self::_verify_variations($identifier, $validated);
-        self::$_registry[ $identifier ] = $validated;
+        self::$_registry[$identifier] = $validated;
 
         add_filter(
             'FHEE__EE_Messages_Template_Pack__get_variations',
@@ -210,8 +210,8 @@ 
             foreach ($messenger as $message_type => $variations) {
                 foreach ($variations as $slug => $label) {
                     foreach (self::$_registry as $registered_var => $reg_settings) {
-                        if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
-                            unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
+                        if (isset($reg_settings['variations'][$template_pack][$messenger][$message_type][$slug])) {
+                            unset($validated_variations['variations'][$template_pack][$messenger][$message_type][$slug]);
                             EE_Error::add_error(
                                 sprintf(
                                     esc_html__(
@@ -263,10 +263,10 @@ 
         // so let's loop through our registered variations and then pull any details matching the request.
         foreach (self::$_registry as $registry_settings) {
             $base        = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
-            $file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
+            $file_string = $messenger.'_'.$type.'_'.$variation.$file_extension;
             // see if this file exists
-            if (is_readable($registry_settings['base_path'] . $file_string)) {
-                return $base . $file_string;
+            if (is_readable($registry_settings['base_path'].$file_string)) {
+                return $base.$file_string;
             }
         }
 
@@ -307,16 +307,16 @@ 
                 return array_merge($registry_settings['variations'], $variations);
             }
             if (empty($message_type)) {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
+                if ( ! empty($registry_settings['variations'][$template_pack->dbref][$messenger])) {
                     return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
+                        $registry_settings['variations'][$template_pack->dbref][$messenger],
                         $variations
                     );
                 }
             } else {
-                if (! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
+                if ( ! empty($registry_settings['variations'][$template_pack->dbref][$messenger][$message_type])) {
                     return array_merge(
-                        $registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
+                        $registry_settings['variations'][$template_pack->dbref][$messenger][$message_type],
                         $variations
                     );
                 }
@@ -337,6 +337,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_registry[ $identifier ]);
+        unset(self::$_registry[$identifier]);
     }
 }

core/libraries/plugin_api/EE_Register_Capabilities.lib.php

Indentation +199 added lines, -199 removed lines

@@ -15,214 +15,214 @@
 class EE_Register_Capabilities implements EEI_Plugin_API
 {
 
-    /**
-     * Holds the settings for a specific registration.
-     *
-     * @var array
-     */
-    protected static $_registry = [];
+	/**
+	 * Holds the settings for a specific registration.
+	 *
+	 * @var array
+	 */
+	protected static $_registry = [];
 
 
-    /**
-     * Used to register capability items with EE core.
-     *
-     * @param string $identifier                                                          usually will be a class name
-     *                                                                                    that references capability
-     *                                                                                    related items setup for
-     *                                                                                    something.
-     * @param array  $setup_args                                                          {
-     *                                                                                    An array of items related to
-     *                                                                                    registering capabilities.
-     * @type array   $capabilities                                                        An array mapping capability
-     *                                                                                    strings to core WP Role.
-     *                                                                                    Something like: array(
-     *                                                                                    'administrator'    => array(
-     *                                                                                    'read_cap', 'edit_cap',
-     *                                                                                    'delete_cap'),
-     *                                                                                    'author'                =>
-     *                                                                                    array( 'read_cap' )
-     *                                                                                    ).
-     * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
-     * @return void
-     * @throws EE_Error
-     * @since 4.5.0
-     * @see   EE_Capabilities.php for php docs on these objects.
-     *                                                                                    Should be indexed by the
-     *                                                                                    classname for the capability
-     *                                                                                    map and values representing
-     *                                                                                    the arguments for the map.
-     *                                                                                    }
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if ($identifier === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
-        // make sure this is not registered too late or too early.
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        '%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.5.0'
-            );
-        }
-        // some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $identifier ] = [
-            'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
-                ? $setup_args['capabilities']
-                : [],
-            'cap_maps' => isset($setup_args['capability_maps']) ? $setup_args['capability_maps'] : [],
-        ];
-        // set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
-        add_filter(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            ['EE_Register_Capabilities', 'register_capabilities']
-        );
-        // add filter for cap maps
-        add_filter(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            ['EE_Register_Capabilities', 'register_cap_maps']
-        );
-    }
+	/**
+	 * Used to register capability items with EE core.
+	 *
+	 * @param string $identifier                                                          usually will be a class name
+	 *                                                                                    that references capability
+	 *                                                                                    related items setup for
+	 *                                                                                    something.
+	 * @param array  $setup_args                                                          {
+	 *                                                                                    An array of items related to
+	 *                                                                                    registering capabilities.
+	 * @type array   $capabilities                                                        An array mapping capability
+	 *                                                                                    strings to core WP Role.
+	 *                                                                                    Something like: array(
+	 *                                                                                    'administrator'    => array(
+	 *                                                                                    'read_cap', 'edit_cap',
+	 *                                                                                    'delete_cap'),
+	 *                                                                                    'author'                =>
+	 *                                                                                    array( 'read_cap' )
+	 *                                                                                    ).
+	 * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 * @see   EE_Capabilities.php for php docs on these objects.
+	 *                                                                                    Should be indexed by the
+	 *                                                                                    classname for the capability
+	 *                                                                                    map and values representing
+	 *                                                                                    the arguments for the map.
+	 *                                                                                    }
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if ($identifier === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
+		// make sure this is not registered too late or too early.
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.5.0'
+			);
+		}
+		// some preliminary sanitization and setting to the $_registry property
+		self::$_registry[ $identifier ] = [
+			'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
+				? $setup_args['capabilities']
+				: [],
+			'cap_maps' => isset($setup_args['capability_maps']) ? $setup_args['capability_maps'] : [],
+		];
+		// set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
+		add_filter(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			['EE_Register_Capabilities', 'register_capabilities']
+		);
+		// add filter for cap maps
+		add_filter(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			['EE_Register_Capabilities', 'register_cap_maps']
+		);
+	}
 
 
-    /**
-     * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
-     * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
-     * registration ensures that new capabilities are added to existing roles.
-     *
-     * @param array $incoming_caps The original caps map.
-     * @return array merged in new caps.
-     */
-    public static function register_capabilities(array $incoming_caps)
-    {
-        foreach (self::$_registry as $caps_and_cap_map) {
-            $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
-        }
-        return $incoming_caps;
-    }
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
+	 * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
+	 * registration ensures that new capabilities are added to existing roles.
+	 *
+	 * @param array $incoming_caps The original caps map.
+	 * @return array merged in new caps.
+	 */
+	public static function register_capabilities(array $incoming_caps)
+	{
+		foreach (self::$_registry as $caps_and_cap_map) {
+			$incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
+		}
+		return $incoming_caps;
+	}
 
 
-    /**
-     * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
-     * capability maps for the WP meta_caps filter called in EE_Capabilities.
-     *
-     * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
-     * @return EE_Meta_Capability_Map[]
-     * @throws EE_Error
-     * @since 4.5.0
-     */
-    public static function register_cap_maps(array $cap_maps)
-    {
-        // loop through and instantiate cap maps.
-        foreach (self::$_registry as $identifier => $setup) {
-            if (! isset($setup['cap_maps'])) {
-                continue;
-            }
-            foreach ($setup['cap_maps'] as $cap_class => $args) {
+	/**
+	 * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
+	 * capability maps for the WP meta_caps filter called in EE_Capabilities.
+	 *
+	 * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
+	 * @return EE_Meta_Capability_Map[]
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 */
+	public static function register_cap_maps(array $cap_maps)
+	{
+		// loop through and instantiate cap maps.
+		foreach (self::$_registry as $identifier => $setup) {
+			if (! isset($setup['cap_maps'])) {
+				continue;
+			}
+			foreach ($setup['cap_maps'] as $cap_class => $args) {
 
-                /**
-                 * account for cases where capability maps may be indexed
-                 * numerically to allow for the same map class to be utilized
-                 * In those cases, maps will be setup in an array like:
-                 * array(
-                 *    0 => array( 'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ) )
-                 *    1 => ...
-                 * )
-                 * instead of:
-                 * array(
-                 *    'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ),
-                 *    ...
-                 * )
-                 */
-                if (is_numeric($cap_class)) {
-                    $cap_class = key($args);
-                    $args      = $args[ $cap_class ];
-                }
+				/**
+				 * account for cases where capability maps may be indexed
+				 * numerically to allow for the same map class to be utilized
+				 * In those cases, maps will be setup in an array like:
+				 * array(
+				 *    0 => array( 'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ) )
+				 *    1 => ...
+				 * )
+				 * instead of:
+				 * array(
+				 *    'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ),
+				 *    ...
+				 * )
+				 */
+				if (is_numeric($cap_class)) {
+					$cap_class = key($args);
+					$args      = $args[ $cap_class ];
+				}
 
-                if (! class_exists($cap_class)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
-                                'event_espresso'
-                            ),
-                            $identifier
-                        )
-                    );
-                }
+				if (! class_exists($cap_class)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
+								'event_espresso'
+							),
+							$identifier
+						)
+					);
+				}
 
-                if (count($args) !== 2) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
-                                'event_espresso'
-                            ),
-                            $identifier
-                        )
-                    );
-                }
-                $cap_maps[] = new $cap_class($args[0], $args[1]);
-            }
-        }
-        return $cap_maps;
-    }
+				if (count($args) !== 2) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
+								'event_espresso'
+							),
+							$identifier
+						)
+					);
+				}
+				$cap_maps[] = new $cap_class($args[0], $args[1]);
+			}
+		}
+		return $cap_maps;
+	}
 
 
-    /**
-     * @param string $identifier
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function deregister($identifier = '')
-    {
-        if (! empty(self::$_registry[ $identifier ])) {
-            if (! empty(self::$_registry[ $identifier ]['caps'])) {
-                // if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $identifier ]['caps'];
-                if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps($caps_to_remove);
-                } else {
-                    add_action(
-                        'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
-                            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                            $capabilities->removeCaps($caps_to_remove);
-                        }
-                    );
-                }
-            }
-        }
-        unset(self::$_registry[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (! empty(self::$_registry[ $identifier ])) {
+			if (! empty(self::$_registry[ $identifier ]['caps'])) {
+				// if it's too early to remove capabilities, wait to do this until core is loaded and ready
+				$caps_to_remove = self::$_registry[ $identifier ]['caps'];
+				if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps($caps_to_remove);
+				} else {
+					add_action(
+						'AHEE__EE_System__core_loaded_and_ready',
+						function () use ($caps_to_remove) {
+							$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+							$capabilities->removeCaps($caps_to_remove);
+						}
+					);
+				}
+			}
+		}
+		unset(self::$_registry[ $identifier ]);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -65,7 +65,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
         // make sure this is not registered too late or too early.
@@ -86,7 +86,7 @@ 
             );
         }
         // some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $identifier ] = [
+        self::$_registry[$identifier] = [
             'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
                 ? $setup_args['capabilities']
                 : [],
@@ -135,7 +135,7 @@ 
     {
         // loop through and instantiate cap maps.
         foreach (self::$_registry as $identifier => $setup) {
-            if (! isset($setup['cap_maps'])) {
+            if ( ! isset($setup['cap_maps'])) {
                 continue;
             }
             foreach ($setup['cap_maps'] as $cap_class => $args) {
@@ -164,10 +164,10 @@ 
                  */
                 if (is_numeric($cap_class)) {
                     $cap_class = key($args);
-                    $args      = $args[ $cap_class ];
+                    $args      = $args[$cap_class];
                 }
 
-                if (! class_exists($cap_class)) {
+                if ( ! class_exists($cap_class)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -205,17 +205,17 @@ 
      */
     public static function deregister($identifier = '')
     {
-        if (! empty(self::$_registry[ $identifier ])) {
-            if (! empty(self::$_registry[ $identifier ]['caps'])) {
+        if ( ! empty(self::$_registry[$identifier])) {
+            if ( ! empty(self::$_registry[$identifier]['caps'])) {
                 // if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $identifier ]['caps'];
+                $caps_to_remove = self::$_registry[$identifier]['caps'];
                 if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps($caps_to_remove);
                 } else {
                     add_action(
                         'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
+                        function() use ($caps_to_remove) {
                             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                             $capabilities->removeCaps($caps_to_remove);
                         }
@@ -223,6 +223,6 @@ 
                 }
             }
         }
-        unset(self::$_registry[ $identifier ]);
+        unset(self::$_registry[$identifier]);
     }
 }

core/libraries/plugin_api/EE_Register_Config.lib.php

Indentation +98 added lines, -98 removed lines

@@ -12,114 +12,114 @@
 class EE_Register_Config implements EEI_Plugin_API
 {
 
-    /**
-     * Holds registered EE_Config items
-     *
-     * @var array
-     */
-    protected static $_ee_config_registry = [];
+	/**
+	 * Holds registered EE_Config items
+	 *
+	 * @var array
+	 */
+	protected static $_ee_config_registry = [];
 
 
-    /**
-     * Handles registering the new config with the EE_Config::instance()->addons property
-     *
-     * @param string $identifier                          The name of the Config class being registered.
-     *                                                    Note this class must extend EE_Config Base and must have
-     *                                                    already been registered with an autoloader.
-     * @param array  $setup_args                          {
-     *
-     * @type  string $config_name                         Optional.  by default the new config will be registered to
-     *        EE_Config::instance()->addons->{config_class}, but supplying a "config_name" will set the property name
-     *        that this variable is accessible by. ie: EE_Config::instance()->addons->{config_name}
-     *                            }
-     * @return void
-     * @throws EE_Error
-     *
-     * @since    4.3.0
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
+	/**
+	 * Handles registering the new config with the EE_Config::instance()->addons property
+	 *
+	 * @param string $identifier                          The name of the Config class being registered.
+	 *                                                    Note this class must extend EE_Config Base and must have
+	 *                                                    already been registered with an autoloader.
+	 * @param array  $setup_args                          {
+	 *
+	 * @type  string $config_name                         Optional.  by default the new config will be registered to
+	 *        EE_Config::instance()->addons->{config_class}, but supplying a "config_name" will set the property name
+	 *        that this variable is accessible by. ie: EE_Config::instance()->addons->{config_name}
+	 *                            }
+	 * @return void
+	 * @throws EE_Error
+	 *
+	 * @since    4.3.0
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
 
-        $setup_args['config_name']    = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
-            ? $setup_args['config_name'] : $identifier;
-        $setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
-            ? $setup_args['config_section'] : 'addons';
+		$setup_args['config_name']    = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
+			? $setup_args['config_name'] : $identifier;
+		$setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
+			? $setup_args['config_section'] : 'addons';
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_config_registry[ $identifier ])) {
+			return;
+		}
 
 
-        // first find out if this happened too late.
-        if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
-                        'event_espresso'
-                    ),
-                    $setup_args['config_name']
-                ),
-                '4.3'
-            );
-        }
-        // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $identifier ] = [
-            'section' => $setup_args['config_section'],
-            'name'    => $setup_args['config_name'],
-        ];
+		// first find out if this happened too late.
+		if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
+						'event_espresso'
+					),
+					$setup_args['config_name']
+				),
+				'4.3'
+			);
+		}
+		// add incoming stuff to our registry property
+		self::$_ee_config_registry[ $identifier ] = [
+			'section' => $setup_args['config_section'],
+			'name'    => $setup_args['config_name'],
+		];
 
-        add_action('AHEE__EE_Config___load_core_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
-        add_action('AHEE__EE_Config__update_espresso_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
-    }
+		add_action('AHEE__EE_Config___load_core_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
+		add_action('AHEE__EE_Config__update_espresso_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
+	}
 
 
-    /**
-     * Callback for the AHEE__EE_Config___load_core_config__end hook.
-     * basically just calls EE_Config->get_config() which will take care of loading or creating our config object for us
-     *
-     * @param EE_Config $EE_Config
-     * @return void
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function set_config(EE_Config $EE_Config)
-    {
-        foreach (self::$_ee_config_registry as $identifier => $settings) {
-            // first some validation of our incoming class_name.  We'll throw an error early if its' not registered correctly
-            if (! class_exists($identifier)) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
-                            'event_espresso'
-                        ),
-                        $identifier
-                    )
-                );
-            }
-            $EE_Config->get_config($settings['section'], $settings['name'], $identifier);
-        }
-    }
+	/**
+	 * Callback for the AHEE__EE_Config___load_core_config__end hook.
+	 * basically just calls EE_Config->get_config() which will take care of loading or creating our config object for us
+	 *
+	 * @param EE_Config $EE_Config
+	 * @return void
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function set_config(EE_Config $EE_Config)
+	{
+		foreach (self::$_ee_config_registry as $identifier => $settings) {
+			// first some validation of our incoming class_name.  We'll throw an error early if its' not registered correctly
+			if (! class_exists($identifier)) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
+							'event_espresso'
+						),
+						$identifier
+					)
+				);
+			}
+			$EE_Config->get_config($settings['section'], $settings['name'], $identifier);
+		}
+	}
 
 
-    /**
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_ee_config_registry[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_ee_config_registry[ $identifier ]);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -56,7 +56,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $identifier ])) {
+        if (isset(self::$_ee_config_registry[$identifier])) {
             return;
         }
 
@@ -76,7 +76,7 @@ 
             );
         }
         // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $identifier ] = [
+        self::$_ee_config_registry[$identifier] = [
             'section' => $setup_args['config_section'],
             'name'    => $setup_args['config_name'],
         ];
@@ -99,7 +99,7 @@ 
     {
         foreach (self::$_ee_config_registry as $identifier => $settings) {
             // first some validation of our incoming class_name.  We'll throw an error early if its' not registered correctly
-            if (! class_exists($identifier)) {
+            if ( ! class_exists($identifier)) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -120,6 +120,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_ee_config_registry[ $identifier ]);
+        unset(self::$_ee_config_registry[$identifier]);
     }
 }