eventespresso / event-espresso-core

core/domain/services/admin/events/data/ConfirmDeletion.php

Indentation +78 added lines, -78 removed lines

@@ -29,89 +29,89 @@
  */
 class ConfirmDeletion
 {
-    /**
-     * @var NodeGroupDao
-     */
-    private $dao;
+	/**
+	 * @var NodeGroupDao
+	 */
+	private $dao;
 
 
-    /**
-     * ConfirmDeletion constructor.
-     *
-     * @param NodeGroupDao $dao
-     */
-    public function __construct(NodeGroupDao $dao)
-    {
-        $this->dao = $dao;
-    }
+	/**
+	 * ConfirmDeletion constructor.
+	 *
+	 * @param NodeGroupDao $dao
+	 */
+	public function __construct(NodeGroupDao $dao)
+	{
+		$this->dao = $dao;
+	}
 
 
-    /**
-     * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
-     * preview page.
-     *
-     * @param $request_data
-     * @param $admin_base_url
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     * @since 4.10.12.p
-     */
-    public function handle($request_data, $admin_base_url)
-    {
-        $deletion_job_code        =
-            isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
-        $models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
-        $form                     = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
-        // Initialize the form from the request, and check if its valid.
-        $form->receive_form_submission($request_data);
-        if ($form->is_valid()) {
-            // Redirect the user to the deletion batch job.
-            EEH_URL::safeRedirectAndExit(
-                EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'page'              => EED_Batch::PAGE_SLUG,
-                        'batch'             => EED_Batch::batch_job,
-                        'deletion_job_code' => $deletion_job_code,
-                        'job_handler'       => urlencode('EventEspresso\core\libraries\batch\JobHandlers\ExecuteBatchDeletion'),
-                        'return_url'        => urlencode(
-                            add_query_arg(
-                                [
-                                    'status' => 'trash',
-                                ],
-                                EVENTS_ADMIN_URL
-                            )
-                        ),
-                    ],
-                    admin_url()
-                )
-            );
-        }
-        // Dont' use $form->submission_error_message() because it adds the form input's label in front
-        // of each validation error which ends up looking quite confusing.
-        $validation_errors = $form->get_validation_errors_accumulated();
-        foreach ($validation_errors as $validation_error) {
-            EE_Error::add_error(
-                $validation_error->getMessage(),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
+	/**
+	 * Redirects to the batch job for deleting events if the form submission is valid, otherwise back to the deletion
+	 * preview page.
+	 *
+	 * @param $request_data
+	 * @param $admin_base_url
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 * @since 4.10.12.p
+	 */
+	public function handle($request_data, $admin_base_url)
+	{
+		$deletion_job_code        =
+			isset($request_data['deletion_job_code']) ? sanitize_key($request_data['deletion_job_code']) : '';
+		$models_and_ids_to_delete = $this->dao->getModelsAndIdsFromGroup($deletion_job_code);
+		$form                     = new ConfirmEventDeletionForm($models_and_ids_to_delete['Event']);
+		// Initialize the form from the request, and check if its valid.
+		$form->receive_form_submission($request_data);
+		if ($form->is_valid()) {
+			// Redirect the user to the deletion batch job.
+			EEH_URL::safeRedirectAndExit(
+				EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'page'              => EED_Batch::PAGE_SLUG,
+						'batch'             => EED_Batch::batch_job,
+						'deletion_job_code' => $deletion_job_code,
+						'job_handler'       => urlencode('EventEspresso\core\libraries\batch\JobHandlers\ExecuteBatchDeletion'),
+						'return_url'        => urlencode(
+							add_query_arg(
+								[
+									'status' => 'trash',
+								],
+								EVENTS_ADMIN_URL
+							)
+						),
+					],
+					admin_url()
+				)
+			);
+		}
+		// Dont' use $form->submission_error_message() because it adds the form input's label in front
+		// of each validation error which ends up looking quite confusing.
+		$validation_errors = $form->get_validation_errors_accumulated();
+		foreach ($validation_errors as $validation_error) {
+			EE_Error::add_error(
+				$validation_error->getMessage(),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
 
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'action'            => 'preview_deletion',
-                    'deletion_job_code' => $deletion_job_code,
-                ],
-                $admin_base_url
-            )
-        );
-    }
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'action'            => 'preview_deletion',
+					'deletion_job_code' => $deletion_job_code,
+				],
+				$admin_base_url
+			)
+		);
+	}
 }
 // End of file ConfirmDeletion.php
 // Location: EventEspresso\core\domain\services\admin\events\data/ConfirmDeletion.php

core/libraries/batch/JobHandlers/AttendeesReport.php

Indentation +131 added lines, -131 removed lines

@@ -27,143 +27,143 @@
  */
 class AttendeesReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        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);
-        // 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
+	/**
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		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);
+		// 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')
+		);
+	}
 
 
-    /**
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        $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 = [
-            '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
-        );
-    }
+	/**
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		$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 = [
+			'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
+		);
+	}
 
 
-    /**
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $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'));
-    }
+	/**
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$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'));
+	}
 
 
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_units_to_process(): int
-    {
-        return EEM_Attendee::instance()->count(['caps' => EEM_Base::caps_read_admin]);
-    }
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_units_to_process(): int
+	{
+		return EEM_Attendee::instance()->count(['caps' => EEM_Base::caps_read_admin]);
+	}
 
 
-    /**
-     * @param $offset
-     * @param $limit
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_csv_data($offset, $limit): array
-    {
-        $attendee_rows = EEM_Attendee::instance()->get_all_wpdb_results(
-            [
-                'limit'      => [$offset, $limit],
-                'force_join' => ['State', 'Country'],
-                'caps'       => EEM_Base::caps_read_admin,
-            ]
-        );
-        $csv_data      = [];
-        foreach ($attendee_rows as $attendee_row) {
-            $csv_row = [];
-            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;
-    }
+	/**
+	 * @param $offset
+	 * @param $limit
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_csv_data($offset, $limit): array
+	{
+		$attendee_rows = EEM_Attendee::instance()->get_all_wpdb_results(
+			[
+				'limit'      => [$offset, $limit],
+				'force_join' => ['State', 'Country'],
+				'caps'       => EEM_Base::caps_read_admin,
+			]
+		);
+		$csv_data      = [];
+		foreach ($attendee_rows as $attendee_row) {
+			$csv_row = [];
+			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 +8 added lines, -8 removed lines

@@ -37,7 +37,7 @@ 
      */
     public function create_job(JobParameters $job_parameters): JobStepResponse
     {
-        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')
             );
@@ -139,23 +139,23 @@ 
                 'caps'       => EEM_Base::caps_read_admin,
             ]
         );
-        $csv_data      = [];
+        $csv_data = [];
         foreach ($attendee_rows as $attendee_row) {
             $csv_row = [];
             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/PreviewEventDeletion.php

Indentation +212 added lines, -212 removed lines

@@ -33,141 +33,141 @@ 
  */
 class PreviewEventDeletion extends JobHandler
 {
-    protected NodeGroupDao $model_obj_node_group_persister;
+	protected NodeGroupDao $model_obj_node_group_persister;
 
-    public function __construct(NodeGroupDao $model_obj_node_group_persister)
-    {
-        $this->model_obj_node_group_persister = $model_obj_node_group_persister;
-    }
+	public function __construct(NodeGroupDao $model_obj_node_group_persister)
+	{
+		$this->model_obj_node_group_persister = $model_obj_node_group_persister;
+	}
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
 
-    /**
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        // Set the "root" model objects we will want to delete (record their ID and model)
-        $event_ids = $job_parameters->request_datum('EVT_IDs', array());
-        // Find all the root nodes to delete (this isn't just events, because there's other data, like related tickets,
-        // prices, message templates, etc, whose model definition doesn't make them dependent on events. But,
-        // we have no UI to access them independent of events, so they may as well get deleted too.)
-        $roots = [];
-        foreach ($event_ids as $event_id) {
-            $roots[] = new ModelObjNode(
-                $event_id,
-                EEM_Event::instance()
-            );
-            // Also, we want to delete their related, non-global, tickets, prices and message templates
-            $related_non_global_tickets = EEM_Ticket::instance()->get_all_deleted_and_undeleted(
-                [
-                    [
-                        'TKT_is_default' => false,
-                        'Datetime.EVT_ID' => $event_id
-                    ]
-                ]
-            );
-            foreach ($related_non_global_tickets as $ticket) {
-                $roots[] = new ModelObjNode(
-                    $ticket->ID(),
-                    $ticket->get_model(),
-                    ['Registration']
-                );
-            }
-            $related_non_global_prices = EEM_Price::instance()->get_all_deleted_and_undeleted(
-                [
-                    [
-                        'PRC_is_default' => false,
-                        'Ticket.Datetime.EVT_ID' => $event_id
-                    ]
-                ]
-            );
-            foreach ($related_non_global_prices as $price) {
-                $roots[] = new ModelObjNode(
-                    $price->ID(),
-                    $price->get_model()
-                );
-            }
-        }
-        $transactions_ids = $this->getTransactionsToDelete($event_ids);
-        foreach ($transactions_ids as $transaction_id) {
-            $roots[] = new ModelObjNode(
-                $transaction_id,
-                EEM_Transaction::instance(),
-                ['Registration']
-            );
-        }
-        $job_parameters->add_extra_data('roots', $roots);
-        // Set an estimate of how long this will take (we're discovering as we go, so it seems impossible to give
-        // an accurate count.)
-        $estimated_work_per_model_obj = 10;
-        $count_regs = EEM_Registration::instance()->count(
-            [
-                [
-                    'EVT_ID' => ['IN', $event_ids]
-                ]
-            ]
-        );
-        $job_parameters->set_job_size((count($roots) + $count_regs) * $estimated_work_per_model_obj);
-        $this->updateTextHeader(esc_html__('Generating preview of data to be deleted...', 'event_espresso'));
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		// Set the "root" model objects we will want to delete (record their ID and model)
+		$event_ids = $job_parameters->request_datum('EVT_IDs', array());
+		// Find all the root nodes to delete (this isn't just events, because there's other data, like related tickets,
+		// prices, message templates, etc, whose model definition doesn't make them dependent on events. But,
+		// we have no UI to access them independent of events, so they may as well get deleted too.)
+		$roots = [];
+		foreach ($event_ids as $event_id) {
+			$roots[] = new ModelObjNode(
+				$event_id,
+				EEM_Event::instance()
+			);
+			// Also, we want to delete their related, non-global, tickets, prices and message templates
+			$related_non_global_tickets = EEM_Ticket::instance()->get_all_deleted_and_undeleted(
+				[
+					[
+						'TKT_is_default' => false,
+						'Datetime.EVT_ID' => $event_id
+					]
+				]
+			);
+			foreach ($related_non_global_tickets as $ticket) {
+				$roots[] = new ModelObjNode(
+					$ticket->ID(),
+					$ticket->get_model(),
+					['Registration']
+				);
+			}
+			$related_non_global_prices = EEM_Price::instance()->get_all_deleted_and_undeleted(
+				[
+					[
+						'PRC_is_default' => false,
+						'Ticket.Datetime.EVT_ID' => $event_id
+					]
+				]
+			);
+			foreach ($related_non_global_prices as $price) {
+				$roots[] = new ModelObjNode(
+					$price->ID(),
+					$price->get_model()
+				);
+			}
+		}
+		$transactions_ids = $this->getTransactionsToDelete($event_ids);
+		foreach ($transactions_ids as $transaction_id) {
+			$roots[] = new ModelObjNode(
+				$transaction_id,
+				EEM_Transaction::instance(),
+				['Registration']
+			);
+		}
+		$job_parameters->add_extra_data('roots', $roots);
+		// Set an estimate of how long this will take (we're discovering as we go, so it seems impossible to give
+		// an accurate count.)
+		$estimated_work_per_model_obj = 10;
+		$count_regs = EEM_Registration::instance()->count(
+			[
+				[
+					'EVT_ID' => ['IN', $event_ids]
+				]
+			]
+		);
+		$job_parameters->set_job_size((count($roots) + $count_regs) * $estimated_work_per_model_obj);
+		$this->updateTextHeader(esc_html__('Generating preview of data to be deleted...', 'event_espresso'));
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 
-    /**
-     * @param EE_Base_Class[] $model_objs
-     * @param array           $dont_traverse_models
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    protected function createModelObjNodes(array $model_objs, array $dont_traverse_models = []): array
-    {
-        $nodes = [];
-        foreach ($model_objs as $model_obj) {
-            $nodes[] = new ModelObjNode(
-                $model_obj->ID(),
-                $model_obj->get_model(),
-                $dont_traverse_models
-            );
-        }
-        return $nodes;
-    }
+	/**
+	 * @param EE_Base_Class[] $model_objs
+	 * @param array           $dont_traverse_models
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	protected function createModelObjNodes(array $model_objs, array $dont_traverse_models = []): array
+	{
+		$nodes = [];
+		foreach ($model_objs as $model_obj) {
+			$nodes[] = new ModelObjNode(
+				$model_obj->ID(),
+				$model_obj->get_model(),
+				$dont_traverse_models
+			);
+		}
+		return $nodes;
+	}
 
-    /**
-     * Gets all the transactions related to these events that aren't related to other events. They'll be deleted too.
-     * (Ones that are related to other events can stay around until those other events are deleted too.)
-     * @since 4.10.12.p
-     * @param array $event_ids
-     * @return array of transaction IDs
-     */
-    protected function getTransactionsToDelete(array $event_ids): array
-    {
-        if (empty($event_ids)) {
-            return [];
-        }
-        global $wpdb;
-        $event_ids = array_map('absint', $event_ids);
-        $imploded_sanitized_event_ids = implode(',', $event_ids);
-        // Select transactions with registrations for the events $event_ids which also don't have registrations
-        // for any events NOT in $event_ids.
-        // Notice the outer query searched for transactions whose registrations ARE in $event_ids,
-        // whereas the inner query checks if the outer query's transaction has any registrations that are
-        // NOT IN $event_ids (ie, don't have registrations for events we're not just about to delete.)
-        return array_map(
-            'absint',
-            $wpdb->get_col(
-                "SELECT
+	/**
+	 * Gets all the transactions related to these events that aren't related to other events. They'll be deleted too.
+	 * (Ones that are related to other events can stay around until those other events are deleted too.)
+	 * @since 4.10.12.p
+	 * @param array $event_ids
+	 * @return array of transaction IDs
+	 */
+	protected function getTransactionsToDelete(array $event_ids): array
+	{
+		if (empty($event_ids)) {
+			return [];
+		}
+		global $wpdb;
+		$event_ids = array_map('absint', $event_ids);
+		$imploded_sanitized_event_ids = implode(',', $event_ids);
+		// Select transactions with registrations for the events $event_ids which also don't have registrations
+		// for any events NOT in $event_ids.
+		// Notice the outer query searched for transactions whose registrations ARE in $event_ids,
+		// whereas the inner query checks if the outer query's transaction has any registrations that are
+		// NOT IN $event_ids (ie, don't have registrations for events we're not just about to delete.)
+		return array_map(
+			'absint',
+			$wpdb->get_col(
+				"SELECT
                       DISTINCT t.TXN_ID
                     FROM
                       {$wpdb->prefix}esp_transaction t INNER JOIN
@@ -185,90 +185,90 @@ 
                            tsub.TXN_ID=t.TXN_ID AND
                            rsub.EVT_ID NOT IN ($imploded_sanitized_event_ids)
                        )"
-            )
-        );
-    }
+			)
+		);
+	}
 
-    /**
-     * Performs another step of the job
-     * @param JobParameters $job_parameters
-     * @param int $batch_size
-     * @return JobStepResponse
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        // Serializing and unserializing is what really makes this drag on (eg on localhost, the ajax requests took
-        // about 4 seconds when the batch size was 250, but 3 seconds when the batch size was 50. So like
-        // 50% of the request is just serializing and unserializing.) So, make the batches much bigger.
-        $batch_size *= 3;
-        $units_processed = 0;
-        foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
-            if ($units_processed >= $batch_size) {
-                break;
-            }
-            if (!$root_node instanceof ModelObjNode) {
-                throw new InvalidClassException('ModelObjNode');
-            }
-            if ($root_node->isComplete()) {
-                continue;
-            }
-            $units_processed += $root_node->visit($batch_size - $units_processed);
-        }
-        $job_parameters->mark_processed($units_processed);
-        // If the most-recently processed root node is complete, we must be all done because we're doing them
-        // sequentially.
-        if (! isset($root_node) || ($root_node instanceof ModelObjNode && $root_node->isComplete())) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            // Show a full progress bar.
-            $job_parameters->set_units_processed($job_parameters->job_size());
-            $deletion_job_code = $job_parameters->request_datum('deletion_job_code');
-            $this->model_obj_node_group_persister->persistModelObjNodesGroup(
-                $job_parameters->extra_datum('roots'),
-                $deletion_job_code
-            );
-            return new JobStepResponse($job_parameters, $this->feedback);
-        }
-        // Because the job size was a guess, it may have likely been proven wrong.
-        // We don't want to show more work done than we originally said there would be.
-        // So adjust the estimate.
-        if (($job_parameters->units_processed() / $job_parameters->job_size()) > .8) {
-            $job_parameters->set_job_size($job_parameters->job_size() * 2);
-        }
-        $this->displayJobStepResults(
-            $units_processed,
-            esc_html__('Identified up to %d potential items for deletion.', 'event_espresso')
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 * Performs another step of the job
+	 * @param JobParameters $job_parameters
+	 * @param int $batch_size
+	 * @return JobStepResponse
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		// Serializing and unserializing is what really makes this drag on (eg on localhost, the ajax requests took
+		// about 4 seconds when the batch size was 250, but 3 seconds when the batch size was 50. So like
+		// 50% of the request is just serializing and unserializing.) So, make the batches much bigger.
+		$batch_size *= 3;
+		$units_processed = 0;
+		foreach ($job_parameters->extra_datum('roots', array()) as $root_node) {
+			if ($units_processed >= $batch_size) {
+				break;
+			}
+			if (!$root_node instanceof ModelObjNode) {
+				throw new InvalidClassException('ModelObjNode');
+			}
+			if ($root_node->isComplete()) {
+				continue;
+			}
+			$units_processed += $root_node->visit($batch_size - $units_processed);
+		}
+		$job_parameters->mark_processed($units_processed);
+		// If the most-recently processed root node is complete, we must be all done because we're doing them
+		// sequentially.
+		if (! isset($root_node) || ($root_node instanceof ModelObjNode && $root_node->isComplete())) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			// Show a full progress bar.
+			$job_parameters->set_units_processed($job_parameters->job_size());
+			$deletion_job_code = $job_parameters->request_datum('deletion_job_code');
+			$this->model_obj_node_group_persister->persistModelObjNodesGroup(
+				$job_parameters->extra_datum('roots'),
+				$deletion_job_code
+			);
+			return new JobStepResponse($job_parameters, $this->feedback);
+		}
+		// Because the job size was a guess, it may have likely been proven wrong.
+		// We don't want to show more work done than we originally said there would be.
+		// So adjust the estimate.
+		if (($job_parameters->units_processed() / $job_parameters->job_size()) > .8) {
+			$job_parameters->set_job_size($job_parameters->job_size() * 2);
+		}
+		$this->displayJobStepResults(
+			$units_processed,
+			esc_html__('Identified up to %d potential items for deletion.', 'event_espresso')
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $this->displayJobFinalResults(
-            $job_parameters,
-            esc_html__('found %d potential items for deletion.', 'event_espresso')
-        );
-        $this->updateText(
-            $this->infoWrapper(
-                sprintf(
-                    esc_html__(
-                        'If not automatically redirected in %1$s seconds, click here to %2$scontinue to the confirmation step%3$s',
-                        'event_espresso'
-                    ),
-                    '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
-                    '</a>'
-                )
-            )
-        );
-        // Nothing much to do.
-        // We can't delete the option with the built tree because we may need it in a moment for the deletion
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$this->displayJobFinalResults(
+			$job_parameters,
+			esc_html__('found %d potential items for deletion.', 'event_espresso')
+		);
+		$this->updateText(
+			$this->infoWrapper(
+				sprintf(
+					esc_html__(
+						'If not automatically redirected in %1$s seconds, click here to %2$scontinue to the confirmation step%3$s',
+						'event_espresso'
+					),
+					'<span id="ee-redirect-timer">10</span>',
+					'<a href="' . $job_parameters->request_datum('return_url') . '">',
+					'</a>'
+				)
+			)
+		);
+		// Nothing much to do.
+		// We can't delete the option with the built tree because we may need it in a moment for the deletion
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspresso\core\libraries\batch\JobHandlers/EventDeletion.php

core/libraries/batch/JobHandlers/DatetimeOffsetFix.php

Indentation +485 added lines, -485 removed lines

@@ -23,489 +23,489 @@
 
 class DatetimeOffsetFix extends JobHandler
 {
-    /**
-     * Key for the option used to track which models have been processed when doing the batches.
-     */
-    const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
-
-
-    const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
-
-    /**
-     * Key for the option used to track what the current offset is that will be applied when this tool is executed.
-     */
-    const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
-
-
-    const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
-
-
-    const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
-
-
-    /**
-     * String labelling the datetime offset fix type for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
-
-
-    /**
-     * String labelling a datetime offset fix error for change-log entries.
-     */
-    const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
-
-    /**
-     * @var EEM_Base[]
-     */
-    protected array $models_with_datetime_fields = [];
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $models_with_datetime_fields = $this->getModelsWithDatetimeFields();
-        // we'll be doing each model as a batch.
-        $job_parameters->set_job_size(count($models_with_datetime_fields));
-        return new JobStepResponse(
-            $job_parameters,
-            esc_html__('Starting Datetime Offset Fix', 'event_espresso')
-        );
-    }
-
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        $models_to_process = $this->getModelsWithDatetimeFields();
-        // let's pop off the a model and do the query to apply the offset.
-        $model_to_process = array_pop($models_to_process);
-        // update our record
-        $this->setModelsToProcess($models_to_process);
-        $this->processModel($model_to_process);
-        $this->updateCountOfModelsProcessed();
-        $job_parameters->set_units_processed($this->getCountOfModelsProcessed());
-        if (count($models_to_process) > 0) {
-            $job_parameters->set_status(JobParameters::status_continue);
-        } else {
-            $job_parameters->set_status(JobParameters::status_complete);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
-                $model_to_process
-            )
-        );
-    }
-
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        // delete important saved options.
-        delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
-        delete_option(self::COUNT_OF_MODELS_PROCESSED);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
-        delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
-        return new JobStepResponse($job_parameters, esc_html__(
-            'Offset has been applied to all affected fields.',
-            'event_espresso'
-        ));
-    }
-
-
-    /**
-     * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
-     *
-     * @param string $model_class_name
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function processModel(string $model_class_name)
-    {
-        global $wpdb;
-        /** @var EEM_Base $model */
-        $model             = $model_class_name::instance();
-        $original_offset   = self::getOffset();
-        $start_date_range  = self::getStartDateRange();
-        $end_date_range    = self::getEndDateRange();
-        $sql_date_function = $original_offset > 0
-            ? 'DATE_ADD'
-            : 'DATE_SUB';
-        $offset            = abs($original_offset) * 60;
-        // since some affected models might have two tables, we have to get our tables and set up a query for each table.
-        foreach ($model->get_tables() as $table) {
-            $query           = 'UPDATE ' . $table->get_table_name();
-            $fields_affected = [];
-            $inner_query     = [];
-            foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
-                if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
-                                                                       . $model_field->get_table_column()
-                                                                       . ", INTERVAL $offset MINUTE)";
-                    $fields_affected[]                               = $model_field;
-                }
-            }
-            if (! $fields_affected) {
-                continue;
-            }
-            // do we do one query per column/field or one query for all fields on the model? It all depends on whether
-            // there is a date range applied or not.
-            if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
-                $result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
-            } else {
-                $result = $this->doQueryForAllFields($query, $inner_query);
-            }
-
-            // record appropriate logs for the query
-            switch (true) {
-                case $result === false:
-                    // record error.
-                    $error_message = $wpdb->last_error;
-                    // handle the edge cases where last_error might be empty.
-                    if (! $error_message) {
-                        $error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
-                    }
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
-                    break;
-                case is_array($result) && ! empty($result):
-                    foreach ($result as $field_name => $error_message) {
-                        $this->recordChangeLog($model, $original_offset, $table, [$field_name], $error_message);
-                    }
-                    break;
-                default:
-                    $this->recordChangeLog($model, $original_offset, $table, $fields_affected);
-            }
-        }
-    }
-
-
-    /**
-     * Does the query on each $inner_query individually.
-     *
-     * @param string              $query
-     * @param array               $inner_query
-     * @param DbSafeDateTime|null $start_date_range
-     * @param DbSafeDateTime|null $end_date_range
-     * @return array  An array of any errors encountered and the fields they were for.
-     */
-    private function doQueryForEachField(
-        string $query,
-        array $inner_query,
-        ?DbSafeDateTime $start_date_range,
-        ?DbSafeDateTime $end_date_range
-    ): array {
-        global $wpdb;
-        $errors = [];
-        foreach ($inner_query as $field_name => $field_query) {
-            $query_to_run     = $query;
-            $where_conditions = [];
-            $query_to_run     .= ' SET ' . $field_query;
-            if ($start_date_range instanceof DbSafeDateTime) {
-                $start_date         = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "$field_name > '$start_date'";
-            }
-            if ($end_date_range instanceof DbSafeDateTime) {
-                $end_date           = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
-                $where_conditions[] = "$field_name < '$end_date'";
-            }
-            if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
-            }
-            $result = $wpdb->query($query_to_run);
-            if ($result === false) {
-                // record error.
-                $error_message = $wpdb->last_error;
-                // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
-                    $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
-                }
-                $errors[ $field_name ] = $error_message;
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * Performs the query for all fields within the inner_query
-     *
-     * @param string $query
-     * @param array  $inner_query
-     * @return false|int
-     */
-    private function doQueryForAllFields(string $query, array $inner_query)
-    {
-        global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * Records a changelog entry using the given information.
-     *
-     * @param EEM_Base              $model
-     * @param int|float             $offset
-     * @param EE_Table_Base         $table
-     * @param EE_Model_Field_Base[] $model_fields_affected
-     * @param string                $error_message If present then there was an error so let's record that instead.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recordChangeLog(
-        EEM_Base $model,
-        $offset,
-        EE_Table_Base $table,
-        array $model_fields_affected,
-        string $error_message = ''
-    ) {
-        // setup $fields list.
-        $fields = [];
-        /** @var EE_Datetime_Field $model_field */
-        foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
-                continue;
-            }
-            $fields[] = $model_field->get_name();
-        }
-        // setup the message for the changelog entry.
-        $message = $error_message
-            ? sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields),
-                $error_message
-            )
-            : sprintf(
-                esc_html__(
-                    'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
-                    'event_espresso'
-                ),
-                $table->get_table_name(),
-                $model->get_this_model_name(),
-                $offset,
-                implode(',', $fields)
-            );
-        // write to the log
-        $changelog = EE_Change_Log::new_instance([
-            'LOG_type'    => $error_message
-                ? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
-                : self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
-            'LOG_message' => $message,
-        ]);
-        $changelog->save();
-    }
-
-
-    /**
-     * Returns an array of models that have datetime fields.
-     * This array is added to a short lived transient cache to keep having to build this list to a minimum.
-     *
-     * @return array an array of model class names.
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    private function getModelsWithDatetimeFields(): array
-    {
-        $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
-            return $this->models_with_datetime_fields;
-        }
-
-        $all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
-        foreach ($all_non_abstract_models as $non_abstract_model) {
-            // get model instance
-            /** @var EEM_Base $non_abstract_model */
-            $non_abstract_model = $non_abstract_model::instance();
-            if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
-                $this->models_with_datetime_fields[] = get_class($non_abstract_model);
-            }
-        }
-        $this->setModelsToProcess($this->models_with_datetime_fields);
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * This simply records the models that have been processed with our tracking option.
-     *
-     * @param array $models_to_set array of model class names.
-     */
-    private function setModelsToProcess(array $models_to_set)
-    {
-        update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
-    }
-
-
-    /**
-     * Used to keep track of how many models have been processed for the batch
-     *
-     * @param int $count
-     */
-    private function updateCountOfModelsProcessed(int $count = 1)
-    {
-        $count = $this->getCountOfModelsProcessed() + $count;
-        update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
-    }
-
-
-    /**
-     * Retrieve the tracked number of models processed between requests.
-     *
-     * @return int
-     */
-    private function getCountOfModelsProcessed(): int
-    {
-        return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
-    }
-
-
-    /**
-     * Returns the models that are left to process.
-     *
-     * @return array  an array of model class names.
-     */
-    private function getModelsToProcess(): array
-    {
-        if (empty($this->models_with_datetime_fields)) {
-            $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, []);
-        }
-        return $this->models_with_datetime_fields;
-    }
-
-
-    /**
-     * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @param float $offset
-     */
-    public static function updateOffset(float $offset)
-    {
-        update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
-    }
-
-
-    /**
-     * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
-     *
-     * @return float
-     */
-    public static function getOffset(): float
-    {
-        return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
-    }
-
-
-    /**
-     * Used to set the saved offset range start date.
-     *
-     * @param DbSafeDateTime|null $start_date
-     */
-    public static function updateStartDateRange(DbSafeDateTime $start_date = null)
-    {
-        $date_to_save = $start_date instanceof DbSafeDateTime
-            ? $start_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range start date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getStartDateRange(): ?DbSafeDateTime
-    {
-        $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        if (! $start_date) {
-            return null;
-        }
-        try {
-            $datetime   = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
-            $start_date = $datetime instanceof DateTime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $start_date = null;
-        }
-        return $start_date;
-    }
-
-
-    /**
-     * Used to set the saved offset range end date.
-     *
-     * @param DbSafeDateTime|null $end_date
-     */
-    public static function updateEndDateRange(DbSafeDateTime $end_date = null)
-    {
-        $date_to_save = $end_date instanceof DbSafeDateTime
-            ? $end_date->format('U')
-            : '';
-        update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
-    }
-
-
-    /**
-     * Used to get the saved offset range end date.
-     *
-     * @return DbSafeDateTime|null
-     */
-    public static function getEndDateRange(): ?DbSafeDateTime
-    {
-        $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        if (! $end_date) {
-            return null;
-        }
-        try {
-            $datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
-            $end_date = $datetime instanceof Datetime
-                ? DbSafeDateTime::createFromDateTime($datetime)
-                : null;
-        } catch (Exception $e) {
-            $end_date = null;
-        }
-        return $end_date;
-    }
+	/**
+	 * Key for the option used to track which models have been processed when doing the batches.
+	 */
+	const MODELS_TO_PROCESS_OPTION_KEY = 'ee_models_processed_for_datetime_offset_fix';
+
+
+	const COUNT_OF_MODELS_PROCESSED = 'ee_count_of_ee_models_processed_for_datetime_offset_fixed';
+
+	/**
+	 * Key for the option used to track what the current offset is that will be applied when this tool is executed.
+	 */
+	const OFFSET_TO_APPLY_OPTION_KEY = 'ee_datetime_offset_fix_offset_to_apply';
+
+
+	const OPTION_KEY_OFFSET_RANGE_START_DATE = 'ee_datetime_offset_start_date_range';
+
+
+	const OPTION_KEY_OFFSET_RANGE_END_DATE = 'ee_datetime_offset_end_date_range';
+
+
+	/**
+	 * String labelling the datetime offset fix type for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_TYPE = 'datetime_offset_fix';
+
+
+	/**
+	 * String labelling a datetime offset fix error for change-log entries.
+	 */
+	const DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE = 'datetime_offset_fix_error';
+
+	/**
+	 * @var EEM_Base[]
+	 */
+	protected array $models_with_datetime_fields = [];
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$models_with_datetime_fields = $this->getModelsWithDatetimeFields();
+		// we'll be doing each model as a batch.
+		$job_parameters->set_job_size(count($models_with_datetime_fields));
+		return new JobStepResponse(
+			$job_parameters,
+			esc_html__('Starting Datetime Offset Fix', 'event_espresso')
+		);
+	}
+
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		$models_to_process = $this->getModelsWithDatetimeFields();
+		// let's pop off the a model and do the query to apply the offset.
+		$model_to_process = array_pop($models_to_process);
+		// update our record
+		$this->setModelsToProcess($models_to_process);
+		$this->processModel($model_to_process);
+		$this->updateCountOfModelsProcessed();
+		$job_parameters->set_units_processed($this->getCountOfModelsProcessed());
+		if (count($models_to_process) > 0) {
+			$job_parameters->set_status(JobParameters::status_continue);
+		} else {
+			$job_parameters->set_status(JobParameters::status_complete);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				esc_html__('Updated the offset for all datetime fields on the %s model.', 'event_espresso'),
+				$model_to_process
+			)
+		);
+	}
+
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		// delete important saved options.
+		delete_option(self::MODELS_TO_PROCESS_OPTION_KEY);
+		delete_option(self::COUNT_OF_MODELS_PROCESSED);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE);
+		delete_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE);
+		return new JobStepResponse($job_parameters, esc_html__(
+			'Offset has been applied to all affected fields.',
+			'event_espresso'
+		));
+	}
+
+
+	/**
+	 * Contains the logic for processing a model and applying the datetime offset to affected fields on that model.
+	 *
+	 * @param string $model_class_name
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function processModel(string $model_class_name)
+	{
+		global $wpdb;
+		/** @var EEM_Base $model */
+		$model             = $model_class_name::instance();
+		$original_offset   = self::getOffset();
+		$start_date_range  = self::getStartDateRange();
+		$end_date_range    = self::getEndDateRange();
+		$sql_date_function = $original_offset > 0
+			? 'DATE_ADD'
+			: 'DATE_SUB';
+		$offset            = abs($original_offset) * 60;
+		// since some affected models might have two tables, we have to get our tables and set up a query for each table.
+		foreach ($model->get_tables() as $table) {
+			$query           = 'UPDATE ' . $table->get_table_name();
+			$fields_affected = [];
+			$inner_query     = [];
+			foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
+				if ($model_field instanceof EE_Datetime_Field) {
+					$inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
+																	   . $sql_date_function . '('
+																	   . $model_field->get_table_column()
+																	   . ", INTERVAL $offset MINUTE)";
+					$fields_affected[]                               = $model_field;
+				}
+			}
+			if (! $fields_affected) {
+				continue;
+			}
+			// do we do one query per column/field or one query for all fields on the model? It all depends on whether
+			// there is a date range applied or not.
+			if ($start_date_range instanceof DbSafeDateTime || $end_date_range instanceof DbSafeDateTime) {
+				$result = $this->doQueryForEachField($query, $inner_query, $start_date_range, $end_date_range);
+			} else {
+				$result = $this->doQueryForAllFields($query, $inner_query);
+			}
+
+			// record appropriate logs for the query
+			switch (true) {
+				case $result === false:
+					// record error.
+					$error_message = $wpdb->last_error;
+					// handle the edge cases where last_error might be empty.
+					if (! $error_message) {
+						$error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
+					}
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
+					break;
+				case is_array($result) && ! empty($result):
+					foreach ($result as $field_name => $error_message) {
+						$this->recordChangeLog($model, $original_offset, $table, [$field_name], $error_message);
+					}
+					break;
+				default:
+					$this->recordChangeLog($model, $original_offset, $table, $fields_affected);
+			}
+		}
+	}
+
+
+	/**
+	 * Does the query on each $inner_query individually.
+	 *
+	 * @param string              $query
+	 * @param array               $inner_query
+	 * @param DbSafeDateTime|null $start_date_range
+	 * @param DbSafeDateTime|null $end_date_range
+	 * @return array  An array of any errors encountered and the fields they were for.
+	 */
+	private function doQueryForEachField(
+		string $query,
+		array $inner_query,
+		?DbSafeDateTime $start_date_range,
+		?DbSafeDateTime $end_date_range
+	): array {
+		global $wpdb;
+		$errors = [];
+		foreach ($inner_query as $field_name => $field_query) {
+			$query_to_run     = $query;
+			$where_conditions = [];
+			$query_to_run     .= ' SET ' . $field_query;
+			if ($start_date_range instanceof DbSafeDateTime) {
+				$start_date         = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "$field_name > '$start_date'";
+			}
+			if ($end_date_range instanceof DbSafeDateTime) {
+				$end_date           = $end_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
+				$where_conditions[] = "$field_name < '$end_date'";
+			}
+			if ($where_conditions) {
+				$query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+			}
+			$result = $wpdb->query($query_to_run);
+			if ($result === false) {
+				// record error.
+				$error_message = $wpdb->last_error;
+				// handle the edgecases where last_error might be empty.
+				if (! $error_message) {
+					$error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
+				}
+				$errors[ $field_name ] = $error_message;
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * Performs the query for all fields within the inner_query
+	 *
+	 * @param string $query
+	 * @param array  $inner_query
+	 * @return false|int
+	 */
+	private function doQueryForAllFields(string $query, array $inner_query)
+	{
+		global $wpdb;
+		$query .= ' SET ' . implode(',', $inner_query);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * Records a changelog entry using the given information.
+	 *
+	 * @param EEM_Base              $model
+	 * @param int|float             $offset
+	 * @param EE_Table_Base         $table
+	 * @param EE_Model_Field_Base[] $model_fields_affected
+	 * @param string                $error_message If present then there was an error so let's record that instead.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recordChangeLog(
+		EEM_Base $model,
+		$offset,
+		EE_Table_Base $table,
+		array $model_fields_affected,
+		string $error_message = ''
+	) {
+		// setup $fields list.
+		$fields = [];
+		/** @var EE_Datetime_Field $model_field */
+		foreach ($model_fields_affected as $model_field) {
+			if (! $model_field instanceof EE_Datetime_Field) {
+				continue;
+			}
+			$fields[] = $model_field->get_name();
+		}
+		// setup the message for the changelog entry.
+		$message = $error_message
+			? sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model did not have the offset of %3$f applied to its fields (%4$s), because of the following error:%5$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields),
+				$error_message
+			)
+			: sprintf(
+				esc_html__(
+					'The %1$s table for the %2$s model has had the offset of %3$f applied to its following fields: %4$s',
+					'event_espresso'
+				),
+				$table->get_table_name(),
+				$model->get_this_model_name(),
+				$offset,
+				implode(',', $fields)
+			);
+		// write to the log
+		$changelog = EE_Change_Log::new_instance([
+			'LOG_type'    => $error_message
+				? self::DATETIME_OFFSET_FIX_CHANGELOG_ERROR_TYPE
+				: self::DATETIME_OFFSET_FIX_CHANGELOG_TYPE,
+			'LOG_message' => $message,
+		]);
+		$changelog->save();
+	}
+
+
+	/**
+	 * Returns an array of models that have datetime fields.
+	 * This array is added to a short lived transient cache to keep having to build this list to a minimum.
+	 *
+	 * @return array an array of model class names.
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	private function getModelsWithDatetimeFields(): array
+	{
+		$this->getModelsToProcess();
+		if (! empty($this->models_with_datetime_fields)) {
+			return $this->models_with_datetime_fields;
+		}
+
+		$all_non_abstract_models = EE_Registry::instance()->non_abstract_db_models;
+		foreach ($all_non_abstract_models as $non_abstract_model) {
+			// get model instance
+			/** @var EEM_Base $non_abstract_model */
+			$non_abstract_model = $non_abstract_model::instance();
+			if ($non_abstract_model->get_a_field_of_type('EE_Datetime_Field') instanceof EE_Datetime_Field) {
+				$this->models_with_datetime_fields[] = get_class($non_abstract_model);
+			}
+		}
+		$this->setModelsToProcess($this->models_with_datetime_fields);
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * This simply records the models that have been processed with our tracking option.
+	 *
+	 * @param array $models_to_set array of model class names.
+	 */
+	private function setModelsToProcess(array $models_to_set)
+	{
+		update_option(self::MODELS_TO_PROCESS_OPTION_KEY, $models_to_set);
+	}
+
+
+	/**
+	 * Used to keep track of how many models have been processed for the batch
+	 *
+	 * @param int $count
+	 */
+	private function updateCountOfModelsProcessed(int $count = 1)
+	{
+		$count = $this->getCountOfModelsProcessed() + $count;
+		update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
+	}
+
+
+	/**
+	 * Retrieve the tracked number of models processed between requests.
+	 *
+	 * @return int
+	 */
+	private function getCountOfModelsProcessed(): int
+	{
+		return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
+	}
+
+
+	/**
+	 * Returns the models that are left to process.
+	 *
+	 * @return array  an array of model class names.
+	 */
+	private function getModelsToProcess(): array
+	{
+		if (empty($this->models_with_datetime_fields)) {
+			$this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, []);
+		}
+		return $this->models_with_datetime_fields;
+	}
+
+
+	/**
+	 * Used to record the offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @param float $offset
+	 */
+	public static function updateOffset(float $offset)
+	{
+		update_option(self::OFFSET_TO_APPLY_OPTION_KEY, $offset);
+	}
+
+
+	/**
+	 * Used to retrieve the saved offset that will be applied to dates and times for EE_Datetime_Field columns.
+	 *
+	 * @return float
+	 */
+	public static function getOffset(): float
+	{
+		return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
+	}
+
+
+	/**
+	 * Used to set the saved offset range start date.
+	 *
+	 * @param DbSafeDateTime|null $start_date
+	 */
+	public static function updateStartDateRange(DbSafeDateTime $start_date = null)
+	{
+		$date_to_save = $start_date instanceof DbSafeDateTime
+			? $start_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range start date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getStartDateRange(): ?DbSafeDateTime
+	{
+		$start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
+		if (! $start_date) {
+			return null;
+		}
+		try {
+			$datetime   = DateTime::createFromFormat('U', $start_date, new DateTimeZone('UTC'));
+			$start_date = $datetime instanceof DateTime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$start_date = null;
+		}
+		return $start_date;
+	}
+
+
+	/**
+	 * Used to set the saved offset range end date.
+	 *
+	 * @param DbSafeDateTime|null $end_date
+	 */
+	public static function updateEndDateRange(DbSafeDateTime $end_date = null)
+	{
+		$date_to_save = $end_date instanceof DbSafeDateTime
+			? $end_date->format('U')
+			: '';
+		update_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, $date_to_save);
+	}
+
+
+	/**
+	 * Used to get the saved offset range end date.
+	 *
+	 * @return DbSafeDateTime|null
+	 */
+	public static function getEndDateRange(): ?DbSafeDateTime
+	{
+		$end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
+		if (! $end_date) {
+			return null;
+		}
+		try {
+			$datetime = DateTime::createFromFormat('U', $end_date, new DateTimeZone('UTC'));
+			$end_date = $datetime instanceof Datetime
+				? DbSafeDateTime::createFromDateTime($datetime)
+				: null;
+		} catch (Exception $e) {
+			$end_date = null;
+		}
+		return $end_date;
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -165,19 +165,19 @@ 
         $offset            = abs($original_offset) * 60;
         // since some affected models might have two tables, we have to get our tables and set up a query for each table.
         foreach ($model->get_tables() as $table) {
-            $query           = 'UPDATE ' . $table->get_table_name();
+            $query           = 'UPDATE '.$table->get_table_name();
             $fields_affected = [];
             $inner_query     = [];
             foreach ($model->_get_fields_for_table($table->get_table_alias()) as $model_field) {
                 if ($model_field instanceof EE_Datetime_Field) {
-                    $inner_query[ $model_field->get_table_column() ] = $model_field->get_table_column() . ' = '
-                                                                       . $sql_date_function . '('
+                    $inner_query[$model_field->get_table_column()] = $model_field->get_table_column().' = '
+                                                                       . $sql_date_function.'('
                                                                        . $model_field->get_table_column()
                                                                        . ", INTERVAL $offset MINUTE)";
-                    $fields_affected[]                               = $model_field;
+                    $fields_affected[] = $model_field;
                 }
             }
-            if (! $fields_affected) {
+            if ( ! $fields_affected) {
                 continue;
             }
             // do we do one query per column/field or one query for all fields on the model? It all depends on whether
@@ -194,7 +194,7 @@ 
                     // record error.
                     $error_message = $wpdb->last_error;
                     // handle the edge cases where last_error might be empty.
-                    if (! $error_message) {
+                    if ( ! $error_message) {
                         $error_message = esc_html__('Unknown mysql error occurred.', 'event_espresso');
                     }
                     $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
@@ -231,7 +231,7 @@ 
         foreach ($inner_query as $field_name => $field_query) {
             $query_to_run     = $query;
             $where_conditions = [];
-            $query_to_run     .= ' SET ' . $field_query;
+            $query_to_run .= ' SET '.$field_query;
             if ($start_date_range instanceof DbSafeDateTime) {
                 $start_date         = $start_date_range->format(EE_Datetime_Field::mysql_timestamp_format);
                 $where_conditions[] = "$field_name > '$start_date'";
@@ -241,17 +241,17 @@ 
                 $where_conditions[] = "$field_name < '$end_date'";
             }
             if ($where_conditions) {
-                $query_to_run .= ' WHERE ' . implode(' AND ', $where_conditions);
+                $query_to_run .= ' WHERE '.implode(' AND ', $where_conditions);
             }
             $result = $wpdb->query($query_to_run);
             if ($result === false) {
                 // record error.
                 $error_message = $wpdb->last_error;
                 // handle the edgecases where last_error might be empty.
-                if (! $error_message) {
+                if ( ! $error_message) {
                     $error_message = esc_html__('Unknown mysql error occured.', 'event_espresso');
                 }
-                $errors[ $field_name ] = $error_message;
+                $errors[$field_name] = $error_message;
             }
         }
         return $errors;
@@ -268,7 +268,7 @@ 
     private function doQueryForAllFields(string $query, array $inner_query)
     {
         global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
+        $query .= ' SET '.implode(',', $inner_query);
         return $wpdb->query($query);
     }
 
@@ -295,7 +295,7 @@ 
         $fields = [];
         /** @var EE_Datetime_Field $model_field */
         foreach ($model_fields_affected as $model_field) {
-            if (! $model_field instanceof EE_Datetime_Field) {
+            if ( ! $model_field instanceof EE_Datetime_Field) {
                 continue;
             }
             $fields[] = $model_field->get_name();
@@ -348,7 +348,7 @@ 
     private function getModelsWithDatetimeFields(): array
     {
         $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
+        if ( ! empty($this->models_with_datetime_fields)) {
             return $this->models_with_datetime_fields;
         }
 
@@ -458,7 +458,7 @@ 
     public static function getStartDateRange(): ?DbSafeDateTime
     {
         $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, null);
-        if (! $start_date) {
+        if ( ! $start_date) {
             return null;
         }
         try {
@@ -495,7 +495,7 @@ 
     public static function getEndDateRange(): ?DbSafeDateTime
     {
         $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, null);
-        if (! $end_date) {
+        if ( ! $end_date) {
             return null;
         }
         try {

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +600 added lines, -600 removed lines

@@ -42,604 +42,604 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
-        $DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
-        if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(
-                esc_html__('You do not have permission to view registrations', 'event_espresso')
-            );
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            $this->get_filename()
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
-        } else {
-            $query_params = [
-                [
-                    'OR'                 => [
-                        // don't include registrations from failed or abandoned transactions...
-                        'Transaction.STS_ID' => [
-                            'NOT IN',
-                            [
-                                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' => ['IN', [true, false]],
-                ],
-                'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
-                'force_join' => ['Transaction', 'Ticket', 'Attendee'],
-                'caps'       => EEM_Base::caps_read_admin,
-            ];
-            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'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
-        }
-
-        $return_url_args = [];
-        parse_str(
-            parse_url(
-                $job_parameters->request_datum('return_url', ''),
-                PHP_URL_QUERY
-            ),
-            $return_url_args
-        );
-
-        if (
-            isset($return_url_args['orderby'], $return_url_args['order'])
-            && $return_url_args['orderby'] === 'ATT_lname'
-        ) {
-            $query_params['order_by'] = [
-                'Attendee.ATT_lname' => $return_url_args['order'],
-                'Attendee.ATT_fname' => $return_url_args['order'],
-                'REG_ID' => $return_url_args['order']
-            ];
-        }
-
-        $query_params = apply_filters(
-            'FHEE__EE_Export__report_registration_for_event',
-            $query_params,
-            $event_id
-        );
-
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size($this->count_units_to_process($query_params));
-        // we need to set the header columns
-        // but to do that we need to process one row so that we can extract ALL of the column headers
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $question_labels,
-            $query_params,
-            $DTT_ID
-        );
-        // but we don't want to write any actual data yet...
-        // so let's blank out all of the values for that first row
-        array_walk(
-            $csv_data_for_row[0],
-            function (&$value) {
-                $value = null;
-            }
-        );
-
-        EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true, true);
-        $this->updateTextHeader(
-            esc_html__('Registrations report started successfully...', 'event_espresso')
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
-
-
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename(): string
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
-            sprintf(
-                'event-espresso-registrations-%s.csv',
-                str_replace([':', ' '], '-', current_time('mysql'))
-            )
-        );
-    }
-
-
-    /**
-     * Gets the questions which are to be used for this report,
-     * so they can be remembered for later
-     *
-     * @param array $registration_query_params
-     * @return array question admin labels to be used for this report
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_labels(array $registration_query_params): array
-    {
-        $where                 = $registration_query_params[0] ?? null;
-        $question_query_params = [];
-        if ($where !== null) {
-            $question_query_params = [
-                $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'] = ['IS_NOT_NULL'];
-        }
-        $question_query_params['order_by'] = ['QST_admin_label' => 'ASC'];
-        $question_query_params['group_by'] = ['QST_ID'];
-        return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
-    }
-
-
-    /**
-     * Takes where params meant for registrations and changes them to work for questions
-     *
-     * @param array $reg_where_params
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _change_registration_where_params_to_question_where_params(array $reg_where_params): array
-    {
-        $question_where_params = [];
-        foreach ($reg_where_params as $key => $val) {
-            if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[ $key ] =
-                    $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
-            }
-        }
-        return $question_where_params;
-    }
-
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                (int) $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params'),
-                (int) $job_parameters->request_datum('DTT_ID', '0')
-            );
-            EEH_Export::write_data_array_to_csv(
-                $job_parameters->extra_datum('filepath'),
-                $csv_data,
-                false
-            );
-            $units_processed = count($csv_data);
-            if ($units_processed) {
-                $job_parameters->mark_processed($units_processed);
-                $this->updateText(
-                    sprintf(
-                        esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
-                        $units_processed
-                    )
-                );
-            }
-        }
-        $extra_response_data = ['file_url' => ''];
-        if ($job_parameters->units_processed() >= $job_parameters->job_size()) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-            $this->displayJobFinalResults($job_parameters);
-        } else {
-            $job_parameters->set_status(JobParameters::status_continue);
-        }
-        return new JobStepResponse($job_parameters, $this->feedback, $extra_response_data);
-    }
-
-
-    /**
-     * Gets the csv data for a batch of registrations
-     *
-     * @param int|null $event_id
-     * @param int      $offset
-     * @param int      $limit
-     * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
-     * @param array    $query_params    for using where querying the model
-     * @param int      $DTT_ID
-     * @return array top-level keys are numeric, next-level keys are column headers
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_csv_data_for(
-        ?int $event_id,
-        int $offset,
-        int $limit,
-        array $question_labels,
-        array $query_params,
-        int $DTT_ID = 0
-    ): array {
-        $reg_fields_to_include = [
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        ];
-        $att_fields_to_include = [
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        ];
-
-        // get models
-        $event_model   = EEM_Event::instance();
-        $date_model    = EEM_Datetime::instance();
-        $ticket_model  = EEM_Ticket::instance();
-        $txn_model     = EEM_Transaction::instance();
-        $reg_model     = EEM_Registration::instance();
-        $pay_model     = EEM_Payment::instance();
-        $status_model  = EEM_Status::instance();
-
-        $registrations_csv_ready_array = [];
-        $query_params['limit']         = [$offset, $limit];
-        $registration_rows             = $reg_model->get_all_wpdb_results($query_params);
-
-        foreach ($registration_rows as $reg_row) {
-            if (! is_array($reg_row)) {
-                continue;
-            }
-            $reg_csv_array = [];
-            // registration ID
-            $reg_id_field = $reg_model->field_settings_for('REG_ID');
-            $reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
-                EEH_Export::prepare_value_from_db_for_display(
-                    $reg_model,
-                    'REG_ID',
-                    $reg_row[ $reg_id_field->get_qualified_column() ]
-                );
-            // ALL registrations, or is list filtered to just one?
-            if (! $event_id) {
-                // ALL registrations, so get each event's name and ID
-                $reg_csv_array[ 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(
-                        $event_model,
-                        'EVT_name',
-                        $reg_row['Event_CPT.post_title']
-                    ),
-                    $reg_row['Event_CPT.ID']
-                );
-            }
-            // add attendee columns
-            $reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
-            // add registration columns
-            $reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_csv_array);
-            // get pretty status
-            $stati = $status_model->localized_status(
-                [
-                    $reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
-                    $reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
-                ],
-                false,
-                'sentence'
-            );
-            $is_primary_reg = $reg_row['Registration.REG_count'] == '1';
-
-            $reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
-                $stati[ $reg_row['Registration.STS_ID'] ];
-            // get pretty transaction status
-            $reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
-                $stati[ $reg_row['TransactionTable.STS_ID'] ];
-            $reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $txn_model,
-                    'TXN_total',
-                    $reg_row['TransactionTable.TXN_total'],
-                    'localized_float'
-                )
-                : '0.00';
-
-            $reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $txn_model,
-                    'TXN_paid',
-                    $reg_row['TransactionTable.TXN_paid'],
-                    'localized_float'
-                )
-                : '0.00';
-
-            $payment_methods                                                                  = [];
-            $gateway_txn_ids_etc                                                              = [];
-            $payment_times                                                                    = [];
-            if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                $payments_info = $pay_model->get_all_wpdb_results(
-                    [
-                        [
-                            'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                            'STS_ID' => EEM_Payment::status_id_approved,
-                        ],
-                        'force_join' => ['Payment_Method'],
-                    ],
-                    ARRAY_A,
-                    'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                );
-                [$payment_methods, $gateway_txn_ids_etc, $payment_times] = PaymentsInfoCSV::extractPaymentInfo(
-                    $payments_info
-                );
-            }
-
-            $reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
-                ',',
-                $payment_times
-            );
-
-            $reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
-                ',',
-                $payment_methods
-            );
-
-            $reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
-                ',',
-                $gateway_txn_ids_etc
-            );
-
-            $ticket_name      = esc_html__('Unknown', 'event_espresso');
-            $datetime_strings = [esc_html__('Unknown', 'event_espresso')];
-            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']
-                );
-                $datetime_strings = [];
-                $datetimes        = $date_model->get_all_wpdb_results(
-                    [
-                        ['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
-                        'order_by'                 => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    $datetime_strings[] = EEH_Export::prepare_value_from_db_for_display(
-                        $date_model,
-                        'DTT_EVT_start',
-                        $datetime['Datetime.DTT_EVT_start']
-                    );
-                }
-            }
-
-            $reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
-
-
-            $reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
-                ', ',
-                $datetime_strings
-            );
-
-            // add answer columns
-            $reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
-            // Include check-in data
-            if ($event_id && $DTT_ID) {
-                // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
-                    $reg_model->count_related(
-                        $reg_row['Registration.REG_ID'],
-                        'Checkin',
-                        [
-                            [
-                                'DTT_ID' => $DTT_ID
-                            ]
-                        ]
-                    );
-                $datetime     = $date_model->get_one_by_ID($DTT_ID);
-                $checkin_rows = EEM_Checkin::instance()->get_all(
-                    [
-                        [
-                            'REG_ID' => $reg_row['Registration.REG_ID'],
-                            'DTT_ID' => $datetime->get('DTT_ID'),
-                        ],
-                    ]
-                );
-                $checkins     = [];
-                foreach ($checkin_rows as $checkin_row) {
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    if ($checkin_value) {
-                        $checkins[] = $checkin_value;
-                    }
-                }
-                $datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
-                $reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
-            } elseif ($event_id) {
-                // get whether or not the user has checked in
-                $reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
-                    $reg_model->count_related(
-                        $reg_row['Registration.REG_ID'],
-                        'Checkin'
-                    );
-
-                $datetimes = $date_model->get_all(
-                    [
-                        [
-                            'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
-                        ],
-                        'order_by'                 => ['DTT_EVT_start' => 'ASC'],
-                        'default_where_conditions' => 'none',
-                    ]
-                );
-                foreach ($datetimes as $datetime) {
-                    if (! $datetime instanceof EE_Datetime) {
-                        continue;
-                    }
-
-                    /** @var EE_Checkin $checkin_row */
-                    $checkin_row = EEM_Checkin::instance()->get_one(
-                        [
-                            [
-                                'REG_ID' => $reg_row['Registration.REG_ID'],
-                                'DTT_ID' => $datetime->get('DTT_ID'),
-                            ],
-                            'limit'    => 1,
-                            'order_by' => [
-                                'CHK_ID' => 'DESC'
-                            ]
-                        ]
-                    );
-
-                    $checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
-                    $datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
-
-                    $reg_csv_array[ $datetime_name ] = $checkin_value;
-                }
-            }
-            /**
-             * Filter to change the contents of each row of the registrations report CSV file.
-             * This can be used to add or remote columns from the CSV file, or change their values.
-             * Note when using: all rows in the CSV should have the same columns.
-             *
-             * @param array $reg_csv_array keys are the column names, values are their cell values
-             * @param array $reg_row       one entry from EEM_Registration::get_all_wpdb_results()
-             */
-            $registrations_csv_ready_array[] = apply_filters(
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-                $reg_csv_array,
-                $reg_row
-            );
-        }
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array               = [];
-            $model_and_fields_to_include = [
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            ];
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field                                                          =
-                        $model->field_settings_for($field_name);
-                    $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
-
-
-    /**
-     * Counts total unit to process
-     *
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function count_units_to_process(array $query_params): int
-    {
-        return EEM_Registration::instance()->count(
-            array_diff_key(
-                $query_params,
-                array_flip(
-                    ['limit']
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $this->updateText(esc_html__('File Generation complete and downloaded', 'event_espresso'));
-
-        $this->_file_helper->delete(
-            EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        $this->updateText(esc_html__('Cleaned up temporary file', 'event_espresso'));
-        $this->updateText(
-            $this->infoWrapper(
-                sprintf(
-                    esc_html__(
-                        'If not automatically redirected in %1$s seconds, click here to return to the %2$sRegistrations List Table%3$s',
-                        'event_espresso'
-                    ),
-                    '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
-                    '</a>'
-                )
-            )
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$event_id = absint($job_parameters->request_datum('EVT_ID', '0'));
+		$DTT_ID   = absint($job_parameters->request_datum('DTT_ID', '0'));
+		if (! EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(
+				esc_html__('You do not have permission to view registrations', 'event_espresso')
+			);
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			$this->get_filename()
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize($job_parameters->request_datum('filters', []));
+		} else {
+			$query_params = [
+				[
+					'OR'                 => [
+						// don't include registrations from failed or abandoned transactions...
+						'Transaction.STS_ID' => [
+							'NOT IN',
+							[
+								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' => ['IN', [true, false]],
+				],
+				'order_by'   => ['Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'],
+				'force_join' => ['Transaction', 'Ticket', 'Attendee'],
+				'caps'       => EEM_Base::caps_read_admin,
+			];
+			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'] = ['Event', 'Transaction', 'Ticket', 'Attendee'];
+		}
+
+		$return_url_args = [];
+		parse_str(
+			parse_url(
+				$job_parameters->request_datum('return_url', ''),
+				PHP_URL_QUERY
+			),
+			$return_url_args
+		);
+
+		if (
+			isset($return_url_args['orderby'], $return_url_args['order'])
+			&& $return_url_args['orderby'] === 'ATT_lname'
+		) {
+			$query_params['order_by'] = [
+				'Attendee.ATT_lname' => $return_url_args['order'],
+				'Attendee.ATT_fname' => $return_url_args['order'],
+				'REG_ID' => $return_url_args['order']
+			];
+		}
+
+		$query_params = apply_filters(
+			'FHEE__EE_Export__report_registration_for_event',
+			$query_params,
+			$event_id
+		);
+
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size($this->count_units_to_process($query_params));
+		// we need to set the header columns
+		// but to do that we need to process one row so that we can extract ALL of the column headers
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$question_labels,
+			$query_params,
+			$DTT_ID
+		);
+		// but we don't want to write any actual data yet...
+		// so let's blank out all of the values for that first row
+		array_walk(
+			$csv_data_for_row[0],
+			function (&$value) {
+				$value = null;
+			}
+		);
+
+		EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true, true);
+		$this->updateTextHeader(
+			esc_html__('Registrations report started successfully...', 'event_espresso')
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
+
+
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename(): string
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__get_filename',
+			sprintf(
+				'event-espresso-registrations-%s.csv',
+				str_replace([':', ' '], '-', current_time('mysql'))
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the questions which are to be used for this report,
+	 * so they can be remembered for later
+	 *
+	 * @param array $registration_query_params
+	 * @return array question admin labels to be used for this report
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_labels(array $registration_query_params): array
+	{
+		$where                 = $registration_query_params[0] ?? null;
+		$question_query_params = [];
+		if ($where !== null) {
+			$question_query_params = [
+				$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'] = ['IS_NOT_NULL'];
+		}
+		$question_query_params['order_by'] = ['QST_admin_label' => 'ASC'];
+		$question_query_params['group_by'] = ['QST_ID'];
+		return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
+	}
+
+
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _change_registration_where_params_to_question_where_params(array $reg_where_params): array
+	{
+		$question_where_params = [];
+		foreach ($reg_where_params as $key => $val) {
+			if (EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[ $key ] =
+					$this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val;
+			}
+		}
+		return $question_where_params;
+	}
+
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				(int) $job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params'),
+				(int) $job_parameters->request_datum('DTT_ID', '0')
+			);
+			EEH_Export::write_data_array_to_csv(
+				$job_parameters->extra_datum('filepath'),
+				$csv_data,
+				false
+			);
+			$units_processed = count($csv_data);
+			if ($units_processed) {
+				$job_parameters->mark_processed($units_processed);
+				$this->updateText(
+					sprintf(
+						esc_html__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+						$units_processed
+					)
+				);
+			}
+		}
+		$extra_response_data = ['file_url' => ''];
+		if ($job_parameters->units_processed() >= $job_parameters->job_size()) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+			$this->displayJobFinalResults($job_parameters);
+		} else {
+			$job_parameters->set_status(JobParameters::status_continue);
+		}
+		return new JobStepResponse($job_parameters, $this->feedback, $extra_response_data);
+	}
+
+
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int      $offset
+	 * @param int      $limit
+	 * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array    $query_params    for using where querying the model
+	 * @param int      $DTT_ID
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_csv_data_for(
+		?int $event_id,
+		int $offset,
+		int $limit,
+		array $question_labels,
+		array $query_params,
+		int $DTT_ID = 0
+	): array {
+		$reg_fields_to_include = [
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		];
+		$att_fields_to_include = [
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		];
+
+		// get models
+		$event_model   = EEM_Event::instance();
+		$date_model    = EEM_Datetime::instance();
+		$ticket_model  = EEM_Ticket::instance();
+		$txn_model     = EEM_Transaction::instance();
+		$reg_model     = EEM_Registration::instance();
+		$pay_model     = EEM_Payment::instance();
+		$status_model  = EEM_Status::instance();
+
+		$registrations_csv_ready_array = [];
+		$query_params['limit']         = [$offset, $limit];
+		$registration_rows             = $reg_model->get_all_wpdb_results($query_params);
+
+		foreach ($registration_rows as $reg_row) {
+			if (! is_array($reg_row)) {
+				continue;
+			}
+			$reg_csv_array = [];
+			// registration ID
+			$reg_id_field = $reg_model->field_settings_for('REG_ID');
+			$reg_csv_array[ EEH_Export::get_column_name_for_field($reg_id_field) ] =
+				EEH_Export::prepare_value_from_db_for_display(
+					$reg_model,
+					'REG_ID',
+					$reg_row[ $reg_id_field->get_qualified_column() ]
+				);
+			// ALL registrations, or is list filtered to just one?
+			if (! $event_id) {
+				// ALL registrations, so get each event's name and ID
+				$reg_csv_array[ 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(
+						$event_model,
+						'EVT_name',
+						$reg_row['Event_CPT.post_title']
+					),
+					$reg_row['Event_CPT.ID']
+				);
+			}
+			// add attendee columns
+			$reg_csv_array = AttendeeCSV::addAttendeeColumns($att_fields_to_include, $reg_row, $reg_csv_array);
+			// add registration columns
+			$reg_csv_array = RegistrationCSV::addRegistrationColumns($reg_fields_to_include, $reg_row, $reg_csv_array);
+			// get pretty status
+			$stati = $status_model->localized_status(
+				[
+					$reg_row['Registration.STS_ID']     => esc_html__('unknown', 'event_espresso'),
+					$reg_row['TransactionTable.STS_ID'] => esc_html__('unknown', 'event_espresso'),
+				],
+				false,
+				'sentence'
+			);
+			$is_primary_reg = $reg_row['Registration.REG_count'] == '1';
+
+			$reg_csv_array[ esc_html__('Registration Status', 'event_espresso') ] =
+				$stati[ $reg_row['Registration.STS_ID'] ];
+			// get pretty transaction status
+			$reg_csv_array[ esc_html__('Transaction Status', 'event_espresso') ]     =
+				$stati[ $reg_row['TransactionTable.STS_ID'] ];
+			$reg_csv_array[ esc_html__('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg
+				? EEH_Export::prepare_value_from_db_for_display(
+					$txn_model,
+					'TXN_total',
+					$reg_row['TransactionTable.TXN_total'],
+					'localized_float'
+				)
+				: '0.00';
+
+			$reg_csv_array[ esc_html__('Amount Paid', 'event_espresso') ]            = $is_primary_reg
+				? EEH_Export::prepare_value_from_db_for_display(
+					$txn_model,
+					'TXN_paid',
+					$reg_row['TransactionTable.TXN_paid'],
+					'localized_float'
+				)
+				: '0.00';
+
+			$payment_methods                                                                  = [];
+			$gateway_txn_ids_etc                                                              = [];
+			$payment_times                                                                    = [];
+			if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+				$payments_info = $pay_model->get_all_wpdb_results(
+					[
+						[
+							'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+							'STS_ID' => EEM_Payment::status_id_approved,
+						],
+						'force_join' => ['Payment_Method'],
+					],
+					ARRAY_A,
+					'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+				);
+				[$payment_methods, $gateway_txn_ids_etc, $payment_times] = PaymentsInfoCSV::extractPaymentInfo(
+					$payments_info
+				);
+			}
+
+			$reg_csv_array[ esc_html__('Payment Date(s)', 'event_espresso') ] = implode(
+				',',
+				$payment_times
+			);
+
+			$reg_csv_array[ esc_html__('Payment Method(s)', 'event_espresso') ] = implode(
+				',',
+				$payment_methods
+			);
+
+			$reg_csv_array[ esc_html__('Gateway Transaction ID(s)', 'event_espresso') ] = implode(
+				',',
+				$gateway_txn_ids_etc
+			);
+
+			$ticket_name      = esc_html__('Unknown', 'event_espresso');
+			$datetime_strings = [esc_html__('Unknown', 'event_espresso')];
+			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']
+				);
+				$datetime_strings = [];
+				$datetimes        = $date_model->get_all_wpdb_results(
+					[
+						['Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']],
+						'order_by'                 => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					$datetime_strings[] = EEH_Export::prepare_value_from_db_for_display(
+						$date_model,
+						'DTT_EVT_start',
+						$datetime['Datetime.DTT_EVT_start']
+					);
+				}
+			}
+
+			$reg_csv_array[ $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name;
+
+
+			$reg_csv_array[ esc_html__('Ticket Datetimes', 'event_espresso') ] = implode(
+				', ',
+				$datetime_strings
+			);
+
+			// add answer columns
+			$reg_csv_array = AnswersCSV::addAnswerColumns($reg_row, $reg_csv_array, $question_labels);
+			// Include check-in data
+			if ($event_id && $DTT_ID) {
+				// get whether or not the user has checked in
+				$reg_csv_array[ esc_html__('Datetime Check-ins #', 'event_espresso') ] =
+					$reg_model->count_related(
+						$reg_row['Registration.REG_ID'],
+						'Checkin',
+						[
+							[
+								'DTT_ID' => $DTT_ID
+							]
+						]
+					);
+				$datetime     = $date_model->get_one_by_ID($DTT_ID);
+				$checkin_rows = EEM_Checkin::instance()->get_all(
+					[
+						[
+							'REG_ID' => $reg_row['Registration.REG_ID'],
+							'DTT_ID' => $datetime->get('DTT_ID'),
+						],
+					]
+				);
+				$checkins     = [];
+				foreach ($checkin_rows as $checkin_row) {
+					/** @var EE_Checkin $checkin_row */
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					if ($checkin_value) {
+						$checkins[] = $checkin_value;
+					}
+				}
+				$datetime_name                   = CheckinsCSV::getDatetimeLabel($datetime);
+				$reg_csv_array[ $datetime_name ] = implode(' --- ', $checkins);
+			} elseif ($event_id) {
+				// get whether or not the user has checked in
+				$reg_csv_array[ esc_html__('Event Check-ins #', 'event_espresso') ] =
+					$reg_model->count_related(
+						$reg_row['Registration.REG_ID'],
+						'Checkin'
+					);
+
+				$datetimes = $date_model->get_all(
+					[
+						[
+							'Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID'],
+						],
+						'order_by'                 => ['DTT_EVT_start' => 'ASC'],
+						'default_where_conditions' => 'none',
+					]
+				);
+				foreach ($datetimes as $datetime) {
+					if (! $datetime instanceof EE_Datetime) {
+						continue;
+					}
+
+					/** @var EE_Checkin $checkin_row */
+					$checkin_row = EEM_Checkin::instance()->get_one(
+						[
+							[
+								'REG_ID' => $reg_row['Registration.REG_ID'],
+								'DTT_ID' => $datetime->get('DTT_ID'),
+							],
+							'limit'    => 1,
+							'order_by' => [
+								'CHK_ID' => 'DESC'
+							]
+						]
+					);
+
+					$checkin_value = CheckinsCSV::getCheckinValue($checkin_row);
+					$datetime_name = CheckinsCSV::getDatetimeLabel($datetime);
+
+					$reg_csv_array[ $datetime_name ] = $checkin_value;
+				}
+			}
+			/**
+			 * Filter to change the contents of each row of the registrations report CSV file.
+			 * This can be used to add or remote columns from the CSV file, or change their values.
+			 * Note when using: all rows in the CSV should have the same columns.
+			 *
+			 * @param array $reg_csv_array keys are the column names, values are their cell values
+			 * @param array $reg_row       one entry from EEM_Registration::get_all_wpdb_results()
+			 */
+			$registrations_csv_ready_array[] = apply_filters(
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+				$reg_csv_array,
+				$reg_row
+			);
+		}
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array               = [];
+			$model_and_fields_to_include = [
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			];
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field                                                          =
+						$model->field_settings_for($field_name);
+					$reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
+
+
+	/**
+	 * Counts total unit to process
+	 *
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function count_units_to_process(array $query_params): int
+	{
+		return EEM_Registration::instance()->count(
+			array_diff_key(
+				$query_params,
+				array_flip(
+					['limit']
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed.
+	 * In this case, we delete the temporary file
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$this->updateText(esc_html__('File Generation complete and downloaded', 'event_espresso'));
+
+		$this->_file_helper->delete(
+			EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		$this->updateText(esc_html__('Cleaned up temporary file', 'event_espresso'));
+		$this->updateText(
+			$this->infoWrapper(
+				sprintf(
+					esc_html__(
+						'If not automatically redirected in %1$s seconds, click here to return to the %2$sRegistrations List Table%3$s',
+						'event_espresso'
+					),
+					'<span id="ee-redirect-timer">10</span>',
+					'<a href="' . $job_parameters->request_datum('return_url') . '">',
+					'</a>'
+				)
+			)
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 }

core/libraries/batch/JobHandlers/ExecuteBatchDeletion.php

Indentation +164 added lines, -164 removed lines

@@ -26,180 +26,180 @@
  */
 class ExecuteBatchDeletion extends JobHandler
 {
-    protected NodeGroupDao $model_obj_node_group_persister;
+	protected NodeGroupDao $model_obj_node_group_persister;
 
 
-    /**
-     * @param NodeGroupDao $model_obj_node_group_persister
-     */
-    public function __construct(NodeGroupDao $model_obj_node_group_persister)
-    {
-        $this->model_obj_node_group_persister = $model_obj_node_group_persister;
-    }
+	/**
+	 * @param NodeGroupDao $model_obj_node_group_persister
+	 */
+	public function __construct(NodeGroupDao $model_obj_node_group_persister)
+	{
+		$this->model_obj_node_group_persister = $model_obj_node_group_persister;
+	}
 
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
 
 
-    /**
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $deletion_job_code = $job_parameters->request_datum('deletion_job_code', null);
-        $roots             = $this->model_obj_node_group_persister->getModelObjNodesInGroup($deletion_job_code);
-        if ($roots === null) {
-            throw new UnexpectedEntityException(
-                $roots,
-                'array',
-                esc_html__(
-                    'The job seems to be stale. Please press the back button in your browser twice.',
-                    'event_espresso'
-                )
-            );
-        }
-        $models_and_ids_to_delete = [];
-        foreach ($roots as $root) {
-            if (! $root instanceof ModelObjNode) {
-                throw new UnexpectedEntityException($root, 'ModelObjNode');
-            }
-            $models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
-        }
-        $job_parameters->set_extra_data(
-            [
-                'models_and_ids_to_delete' => $models_and_ids_to_delete,
-            ]
-        );
-        // Find the job's actual size.
-        $job_size = 0;
-        foreach ($models_and_ids_to_delete as $ids) {
-            $job_size += count($ids);
-        }
-        $job_parameters->set_job_size($job_size);
-        $this->updateTextHeader(esc_html__('Beginning to delete items...', 'event_espresso'));
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$deletion_job_code = $job_parameters->request_datum('deletion_job_code', null);
+		$roots             = $this->model_obj_node_group_persister->getModelObjNodesInGroup($deletion_job_code);
+		if ($roots === null) {
+			throw new UnexpectedEntityException(
+				$roots,
+				'array',
+				esc_html__(
+					'The job seems to be stale. Please press the back button in your browser twice.',
+					'event_espresso'
+				)
+			);
+		}
+		$models_and_ids_to_delete = [];
+		foreach ($roots as $root) {
+			if (! $root instanceof ModelObjNode) {
+				throw new UnexpectedEntityException($root, 'ModelObjNode');
+			}
+			$models_and_ids_to_delete = array_replace_recursive($models_and_ids_to_delete, $root->getIds());
+		}
+		$job_parameters->set_extra_data(
+			[
+				'models_and_ids_to_delete' => $models_and_ids_to_delete,
+			]
+		);
+		// Find the job's actual size.
+		$job_size = 0;
+		foreach ($models_and_ids_to_delete as $ids) {
+			$job_size += count($ids);
+		}
+		$job_parameters->set_job_size($job_size);
+		$this->updateTextHeader(esc_html__('Beginning to delete items...', 'event_espresso'));
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 
 
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        // We already have the items IDs. So deleting is really fast. Let's speed it up.
-        $batch_size               *= 10;
-        $units_processed          = 0;
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        // Build a new list of everything leftover after this request's of deletions.
-        $models_and_ids_remaining = [];
-        foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
-            // don't delete logs
-            if ($model_name === 'Change_Log') {
-                continue;
-            }
-            if ($units_processed < $batch_size) {
-                /** @var EEM_Base $model */
-                $model                    = EE_Registry::instance()->load_model($model_name);
-                $ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
-                if ($model->has_primary_key_field()) {
-                    $where_conditions = [
-                        $model->primary_key_name() => [
-                            'IN',
-                            $ids_to_delete_this_query,
-                        ],
-                    ];
-                } else {
-                    $where_conditions = [
-                        'OR' => [],
-                    ];
-                    foreach ($ids_to_delete_this_query as $index_primary_key_string) {
-                        $keys_n_values                                                =
-                            $model->parse_index_primary_key_string($index_primary_key_string);
-                        $where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
-                    }
-                }
-                // Deleting time!
-                // The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
-                // two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
-                $model->delete_permanently([ $where_conditions ], false);
-                $units_processed += count($ids_to_delete_this_query);
-                $remaining_ids   = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
-                // If there's any more from this model, we'll do them next time.
-                if (count($remaining_ids) > 0) {
-                    $models_and_ids_remaining[ $model_name ] = $remaining_ids;
-                }
-            } else {
-                $models_and_ids_remaining[ $model_name ] = $ids_to_delete;
-            }
-        }
-        $job_parameters->mark_processed($units_processed);
-        // All done deleting for this request. Is there anything to do next time?
-        if (empty($models_and_ids_remaining)) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            return new JobStepResponse($job_parameters, $this->feedback);
-        }
-        $job_parameters->add_extra_data('models_and_ids_to_delete', $models_and_ids_remaining);
-        $this->displayJobStepResults(
-            $units_processed,
-            esc_html__('Deleted %d items.', 'event_espresso')
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		// We already have the items IDs. So deleting is really fast. Let's speed it up.
+		$batch_size               *= 10;
+		$units_processed          = 0;
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		// Build a new list of everything leftover after this request's of deletions.
+		$models_and_ids_remaining = [];
+		foreach ($models_and_ids_to_delete as $model_name => $ids_to_delete) {
+			// don't delete logs
+			if ($model_name === 'Change_Log') {
+				continue;
+			}
+			if ($units_processed < $batch_size) {
+				/** @var EEM_Base $model */
+				$model                    = EE_Registry::instance()->load_model($model_name);
+				$ids_to_delete_this_query = array_slice($ids_to_delete, 0, $batch_size - $units_processed, true);
+				if ($model->has_primary_key_field()) {
+					$where_conditions = [
+						$model->primary_key_name() => [
+							'IN',
+							$ids_to_delete_this_query,
+						],
+					];
+				} else {
+					$where_conditions = [
+						'OR' => [],
+					];
+					foreach ($ids_to_delete_this_query as $index_primary_key_string) {
+						$keys_n_values                                                =
+							$model->parse_index_primary_key_string($index_primary_key_string);
+						$where_conditions['OR'][ 'AND*' . $index_primary_key_string ] = $keys_n_values;
+					}
+				}
+				// Deleting time!
+				// The model's deletion method reports every ROW deleted, and in the case of CPT models that will be
+				// two rows deleted for event CPT item. So don't rely on it for the count of items deleted.
+				$model->delete_permanently([ $where_conditions ], false);
+				$units_processed += count($ids_to_delete_this_query);
+				$remaining_ids   = array_diff_key($ids_to_delete, $ids_to_delete_this_query);
+				// If there's any more from this model, we'll do them next time.
+				if (count($remaining_ids) > 0) {
+					$models_and_ids_remaining[ $model_name ] = $remaining_ids;
+				}
+			} else {
+				$models_and_ids_remaining[ $model_name ] = $ids_to_delete;
+			}
+		}
+		$job_parameters->mark_processed($units_processed);
+		// All done deleting for this request. Is there anything to do next time?
+		if (empty($models_and_ids_remaining)) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			return new JobStepResponse($job_parameters, $this->feedback);
+		}
+		$job_parameters->add_extra_data('models_and_ids_to_delete', $models_and_ids_remaining);
+		$this->displayJobStepResults(
+			$units_processed,
+			esc_html__('Deleted %d items.', 'event_espresso')
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $this->model_obj_node_group_persister->deleteModelObjNodesInGroup(
-            $job_parameters->request_datum('deletion_job_code')
-        );
-        // For backwards compatibility with how we used to delete events, make sure we still trigger the old action.
-        $models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
-        foreach ($models_and_ids_to_delete['Event'] as $event_id) {
-            // TrashLogger hooks into the following to create a log entry
-            // so we know when and who permanently deleted this event.
-            do_action(
-                'AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted',
-                $event_id,
-                'Event',
-                $job_parameters
-            );
-        }
-        $this->displayJobFinalResults(
-            $job_parameters,
-            esc_html__('All Done. Deleted a total of %d items.', 'event_espresso')
-        );
-        $this->updateText(
-            $this->infoWrapper(
-                sprintf(
-                    esc_html__(
-                        'If not automatically redirected in %1$s seconds, click here to return to the %2$sprevious admin screen%3$s',
-                        'event_espresso'
-                    ),
-                    '<span id="ee-redirect-timer">10</span>',
-                    '<a href="' . $job_parameters->request_datum('return_url') . '">',
-                    '</a>'
-                )
-            )
-        );
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$this->model_obj_node_group_persister->deleteModelObjNodesInGroup(
+			$job_parameters->request_datum('deletion_job_code')
+		);
+		// For backwards compatibility with how we used to delete events, make sure we still trigger the old action.
+		$models_and_ids_to_delete = $job_parameters->extra_datum('models_and_ids_to_delete', []);
+		foreach ($models_and_ids_to_delete['Event'] as $event_id) {
+			// TrashLogger hooks into the following to create a log entry
+			// so we know when and who permanently deleted this event.
+			do_action(
+				'AHEE__Events_Admin_Page___permanently_delete_event__after_event_deleted',
+				$event_id,
+				'Event',
+				$job_parameters
+			);
+		}
+		$this->displayJobFinalResults(
+			$job_parameters,
+			esc_html__('All Done. Deleted a total of %d items.', 'event_espresso')
+		);
+		$this->updateText(
+			$this->infoWrapper(
+				sprintf(
+					esc_html__(
+						'If not automatically redirected in %1$s seconds, click here to return to the %2$sprevious admin screen%3$s',
+						'event_espresso'
+					),
+					'<span id="ee-redirect-timer">10</span>',
+					'<a href="' . $job_parameters->request_datum('return_url') . '">',
+					'</a>'
+				)
+			)
+		);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
 }
 // End of file EventDeletion.php
 // Location: EventEspresso\core\libraries\batch\JobHandlers/EventDeletion.php

core/libraries/batch/JobHandlerBaseClasses/JobHandlerInterface.php

Indentation +88 added lines, -88 removed lines

@@ -23,92 +23,92 @@
  */
 interface JobHandlerInterface
 {
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to set up the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function create_job(JobParameters $job_parameters): JobStepResponse;
-
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse;
-
-
-    /**
-     * used to advance from one batch job to another
-     * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
-     * followed by the actual update job.
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function advance_job(JobParameters $job_parameters): JobStepResponse;
-
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters): JobStepResponse;
-
-
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to set up the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function createJob(JobParameters $job_parameters): JobStepResponse;
-
-
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function continueJob(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse;
-
-
-    /**
-     * used to advance from one batch job to another
-     * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
-     * followed by the actual update job.
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function advanceJob(JobParameters $job_parameters): JobStepResponse;
-
-
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanupJob(JobParameters $job_parameters): JobStepResponse;
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to set up the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function create_job(JobParameters $job_parameters): JobStepResponse;
+
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function continue_job(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse;
+
+
+	/**
+	 * used to advance from one batch job to another
+	 * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
+	 * followed by the actual update job.
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function advance_job(JobParameters $job_parameters): JobStepResponse;
+
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters): JobStepResponse;
+
+
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to set up the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function createJob(JobParameters $job_parameters): JobStepResponse;
+
+
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function continueJob(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse;
+
+
+	/**
+	 * used to advance from one batch job to another
+	 * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
+	 * followed by the actual update job.
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function advanceJob(JobParameters $job_parameters): JobStepResponse;
+
+
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanupJob(JobParameters $job_parameters): JobStepResponse;
 }

core/libraries/batch/JobHandlerBaseClasses/JobHandler.php

Indentation +231 added lines, -231 removed lines

@@ -17,264 +17,264 @@
  */
 abstract class JobHandler implements JobHandlerInterface
 {
-    protected array $feedback = [];
-
-    protected array $request_data = [];
-
-    /**
-     * Extra data to include as part of the response, literally gets set as JobStepResponse::$_extra_data
-     *
-     * @var array
-     */
-    protected array $response_data = [];
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @since 5.0.0.p
-     */
-    public function createJob(JobParameters $job_parameters): JobStepResponse
-    {
-        return $this->create_job($job_parameters);
-    }
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @since 5.0.0.p
-     */
-    public function continueJob(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
-    {
-        return $this->continue_job($job_parameters, $batch_size);
-    }
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * used to advance from one batch job to another
-     * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
-     * followed by the actual update job.
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @since 5.0.0.p
-     */
-    public function advanceJob(JobParameters $job_parameters): JobStepResponse
-    {
-        return $this->advance_job($job_parameters);
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * used to advance from one batch job to another
-     * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
-     * followed by the actual update job.
-     * By default, this function won't do anything until overridden in a chile class.
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @since 5.0.0.p
-     */
-    public function advance_job(JobParameters $job_parameters): JobStepResponse
-    {
-        $job_parameters->set_status(JobParameters::status_continue);
-        return new JobStepResponse($job_parameters, $this->feedback);
-    }
-
-
-    /**
-     * utilized in newer batch job implementations, but forwarding to existing methods for now.
-     * Performs any clean-up logic when we know the job is completed
-     *
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     * @since 5.0.0.p
-     */
-    public function cleanupJob(JobParameters $job_parameters): JobStepResponse
-    {
-        return $this->cleanup_job($job_parameters);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function requestData(): array
-    {
-        return $this->request_data;
-    }
-
-
-    /**
-     * @param string|int $key
-     * @return mixed
-     */
-    public function getRequestData($key)
-    {
-        return $this->request_data[ $key ] ?? null;
-    }
-
-
-    /**
-     * @param array $request_data
-     */
-    public function setRequestData(array $request_data): void
-    {
-        $this->request_data = $request_data;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function responseData(): array
-    {
-        return $this->response_data;
-    }
-
-
-    /**
-     * @param array $response_data
-     */
-    public function addResponseData(array $response_data): void
-    {
-        $this->response_data += $response_data;
-    }
-
-
-
-    /**
-     * @param array $response_data
-     */
-    public function setResponseData(array $response_data): void
-    {
-        $this->response_data = $response_data;
-    }
-
-
-
-
-    protected function displayJobStepResults(int $processed, string $custom_message = '')
-    {
-        $this->feedback[] = '
+	protected array $feedback = [];
+
+	protected array $request_data = [];
+
+	/**
+	 * Extra data to include as part of the response, literally gets set as JobStepResponse::$_extra_data
+	 *
+	 * @var array
+	 */
+	protected array $response_data = [];
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @since 5.0.0.p
+	 */
+	public function createJob(JobParameters $job_parameters): JobStepResponse
+	{
+		return $this->create_job($job_parameters);
+	}
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @since 5.0.0.p
+	 */
+	public function continueJob(JobParameters $job_parameters, int $batch_size = 50): JobStepResponse
+	{
+		return $this->continue_job($job_parameters, $batch_size);
+	}
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * used to advance from one batch job to another
+	 * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
+	 * followed by the actual update job.
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @since 5.0.0.p
+	 */
+	public function advanceJob(JobParameters $job_parameters): JobStepResponse
+	{
+		return $this->advance_job($job_parameters);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * used to advance from one batch job to another
+	 * primarily used for executing a job assessment phase where an accurate count of items to update can be made,
+	 * followed by the actual update job.
+	 * By default, this function won't do anything until overridden in a chile class.
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @since 5.0.0.p
+	 */
+	public function advance_job(JobParameters $job_parameters): JobStepResponse
+	{
+		$job_parameters->set_status(JobParameters::status_continue);
+		return new JobStepResponse($job_parameters, $this->feedback);
+	}
+
+
+	/**
+	 * utilized in newer batch job implementations, but forwarding to existing methods for now.
+	 * Performs any clean-up logic when we know the job is completed
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 * @since 5.0.0.p
+	 */
+	public function cleanupJob(JobParameters $job_parameters): JobStepResponse
+	{
+		return $this->cleanup_job($job_parameters);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function requestData(): array
+	{
+		return $this->request_data;
+	}
+
+
+	/**
+	 * @param string|int $key
+	 * @return mixed
+	 */
+	public function getRequestData($key)
+	{
+		return $this->request_data[ $key ] ?? null;
+	}
+
+
+	/**
+	 * @param array $request_data
+	 */
+	public function setRequestData(array $request_data): void
+	{
+		$this->request_data = $request_data;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function responseData(): array
+	{
+		return $this->response_data;
+	}
+
+
+	/**
+	 * @param array $response_data
+	 */
+	public function addResponseData(array $response_data): void
+	{
+		$this->response_data += $response_data;
+	}
+
+
+
+	/**
+	 * @param array $response_data
+	 */
+	public function setResponseData(array $response_data): void
+	{
+		$this->response_data = $response_data;
+	}
+
+
+
+
+	protected function displayJobStepResults(int $processed, string $custom_message = '')
+	{
+		$this->feedback[] = '
 			<div class="ee-batch-job-step-results">
 			' . $this->infoWrapper(
-            sprintf(
-                $custom_message !== ''
-                        ? $custom_message
-                        : esc_html__('processed this batch: %d', 'event_espresso'),
-                $processed
-            )
-        ) . '
+			sprintf(
+				$custom_message !== ''
+						? $custom_message
+						: esc_html__('processed this batch: %d', 'event_espresso'),
+				$processed
+			)
+		) . '
 			</div>';
-    }
+	}
 
 
-    protected function displayJobFinalResults(JobParameters $job_parameters, string $custom_message = '')
-    {
-        if ($job_parameters->status() === JobParameters::status_complete) {
-            $this->feedback[] = '
+	protected function displayJobFinalResults(JobParameters $job_parameters, string $custom_message = '')
+	{
+		if ($job_parameters->status() === JobParameters::status_complete) {
+			$this->feedback[] = '
 			<div class="ee-batch-job-final-results">
 				' . $this->okWrapper(
-                sprintf(
-                    $custom_message !== ''
-                            ? $custom_message
-                            : esc_html__('total units processed: %d', 'event_espresso'),
-                    $job_parameters->units_processed()
-                )
-            ) . '
+				sprintf(
+					$custom_message !== ''
+							? $custom_message
+							: esc_html__('total units processed: %d', 'event_espresso'),
+					$job_parameters->units_processed()
+				)
+			) . '
 				' . $this->jobStatusNotice($job_parameters) . '
 			</div>';
-        }
-    }
+		}
+	}
 
 
-    protected function jobStatusNotice(JobParameters $job_parameters): string
-    {
-        switch ($job_parameters->status()) {
-            case JobParameters::status_cleaned_up:
-            case JobParameters::status_continue:
-            case JobParameters::status_pause:
-                break;
-            case JobParameters::status_complete:
-                return $this->successWrapper('job status: COMPLETE');
-            case JobParameters::status_error:
-                return $this->errorWrapper('job status: ERROR');
-        }
-        return '';
-    }
+	protected function jobStatusNotice(JobParameters $job_parameters): string
+	{
+		switch ($job_parameters->status()) {
+			case JobParameters::status_cleaned_up:
+			case JobParameters::status_continue:
+			case JobParameters::status_pause:
+				break;
+			case JobParameters::status_complete:
+				return $this->successWrapper('job status: COMPLETE');
+			case JobParameters::status_error:
+				return $this->errorWrapper('job status: ERROR');
+		}
+		return '';
+	}
 
 
-    /**
-     * @param string $update_text
-     */
-    protected function updateText(string $update_text)
-    {
-        $this->feedback[] = "<p class='ee-batch-job-update'>$update_text</p>";
-    }
+	/**
+	 * @param string $update_text
+	 */
+	protected function updateText(string $update_text)
+	{
+		$this->feedback[] = "<p class='ee-batch-job-update'>$update_text</p>";
+	}
 
 
-    protected function updateTextHeader(string $update_text)
-    {
-        $this->feedback[] = "<h4 class='ee-batch-job-update-heading'>$update_text</h4>";
-    }
+	protected function updateTextHeader(string $update_text)
+	{
+		$this->feedback[] = "<h4 class='ee-batch-job-update-heading'>$update_text</h4>";
+	}
 
 
-    protected function attentionWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--attention'>$update_text</span>";
-    }
+	protected function attentionWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--attention'>$update_text</span>";
+	}
 
 
-    protected function errorWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--error'>$update_text</span>";
-    }
+	protected function errorWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--error'>$update_text</span>";
+	}
 
 
-    protected function infoWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--info'>$update_text</span>";
-    }
+	protected function infoWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--info'>$update_text</span>";
+	}
 
 
-    protected function okWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--ok'>$update_text</span>";
-    }
+	protected function okWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--ok'>$update_text</span>";
+	}
 
 
-    protected function successWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--success'>$update_text</span>";
-    }
+	protected function successWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--success'>$update_text</span>";
+	}
 
 
-    protected function warningWrapper(string $update_text): string
-    {
-        return "<span class='ee-status-outline ee-status-bg--warning'>$update_text</span>";
-    }
+	protected function warningWrapper(string $update_text): string
+	{
+		return "<span class='ee-status-outline ee-status-bg--warning'>$update_text</span>";
+	}
 
 
-    /**
-     * @return string
-     */
-    protected function spinner(): string
-    {
-        return '<span class="spinner"></span>';
-    }
+	/**
+	 * @return string
+	 */
+	protected function spinner(): string
+	{
+		return '<span class="spinner"></span>';
+	}
 }

core/db_classes/EE_Registration.class.php

Indentation +2558 added lines, -2558 removed lines

@@ -17,2562 +17,2562 @@
  */
 class EE_Registration extends EE_Soft_Delete_Base_Class implements EEI_Registration, EEI_Admin_Links
 {
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_never instead
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_in instead
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @deprecated use \EE_Checkin::status_checked_out instead
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object
-            ?: new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db($props_n_values = [], $timezone = '')
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param int $EVT_ID Event ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code':
-                if (! empty($field_value) && ! $this->reg_code()) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string                $new_STS_ID
-     * @param boolean               $use_default
-     * @param ContextInterface|null $context
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_status($new_STS_ID = null, $use_default = false, ContextInterface $context = null)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if (
-            $old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // update internal status first
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            // THEN handle other changes that occur when reg status changes
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->reserveRegistrationSpace();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
-                // OR FROM  approved
-            } elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->releaseRegistrationSpace();
-                do_action(
-                    'AHEE__EE_Registration__set_status__from_approved',
-                    $this,
-                    $old_STS_ID,
-                    $new_STS_ID,
-                    $context
-                );
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, $context);
-            if ($this->statusChangeUpdatesTransaction($context)) {
-                $this->updateTransactionAfterStatusChange();
-            }
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
-            return true;
-        }
-        // even though the old value matches the new value, it's still good to
-        // allow the parent set method to have a say
-        parent::set('STS_ID', $new_STS_ID, $use_default);
-        return true;
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string                $new_STS_ID
-     * @param string                $old_STS_ID
-     * @param ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, ContextInterface $context = null)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        $this->updateIfCanceled(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-        $this->updateIfReinstated(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array                 $closed_reg_statuses
-     * @param string                $new_STS_ID
-     * @param string                $old_STS_ID
-     * @param ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfCanceled(
-        array $closed_reg_statuses,
-        $new_STS_ID,
-        $old_STS_ID,
-        ContextInterface $context = null
-    ) {
-        // true if registration has been cancelled or declined
-        if (
-            in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__canceled_or_declined',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-            return;
-        }
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array                 $closed_reg_statuses
-     * @param string                $new_STS_ID
-     * @param string                $old_STS_ID
-     * @param ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfReinstated(
-        array $closed_reg_statuses,
-        $new_STS_ID,
-        $old_STS_ID,
-        ContextInterface $context = null
-    ) {
-        // true if reinstating cancelled or declined registration
-        if (
-            in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__after_reinstated',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-        }
-    }
-
-
-    /**
-     * @param ContextInterface|null $context
-     * @return bool
-     */
-    private function statusChangeUpdatesTransaction(ContextInterface $context = null)
-    {
-        $contexts_that_do_not_update_transaction = (array) apply_filters(
-            'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
-            ['spco_reg_step_attendee_information_process_registrations'],
-            $context,
-            $this
-        );
-        return ! (
-            $context instanceof ContextInterface
-            && in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateTransactionAfterStatusChange()
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-        $this->transaction()->update_status_based_on_total_paid();
-    }
-
-
-    /**
-     * get Status ID
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = [];
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function event(): EE_Event
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function wp_user(): int
-    {
-        return $this->event()->wp_user();
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    private function reserveRegistrationSpace()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-        $ticket = $this->ticket();
-        $ticket->increaseSold();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    private function releaseRegistrationSpace()
-    {
-        $ticket = $this->ticket();
-        $ticket->decreaseSold();
-        // possibly change event status from sold out back to previous status
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool   $update_ticket if true, will increment ticket and datetime reserved count
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reserve_ticket($update_ticket = false, $source = 'unknown')
-    {
-        // only reserve ticket if space is not currently reserved
-        if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) !== true) {
-            $reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-            if ($reserved && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-                $this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool   $update_ticket if true, will decrement ticket and datetime reserved count
-     * @param string $source
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function release_reserved_ticket($update_ticket = false, $source = 'unknown')
-    {
-        // only release ticket if space is currently reserved
-        if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) === true) {
-            $reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, false);
-            if ($reserved && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-                $this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param int $ATT_ID Attendee ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param int $TXN_ID Transaction ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param string $REG_session PHP Session ID
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param string $REG_url_link Registration URL Link
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param int $REG_count Primary Attendee
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param boolean $REG_group_size Group Registration
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_not_approved;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_pending_payment;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_approved;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_cancelled;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_declined;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() === EEM_Registration::status_id_incomplete;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                                                 Date
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @param float $REG_final_price
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @param float|int|string $REG_paid
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', (float) $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param boolean $REG_att_is_going Attendee Is Going
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee|EE_Base_Class
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     * Gets the name of the attendee.
-     *
-     * @param bool $apply_html_entities set to true if you want to use HTML entities.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function attendeeName($apply_html_entities = false)
-    {
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $attendee_name = $attendee->full_name($apply_html_entities);
-        } else {
-            $attendee_name = esc_html__('Unknown', 'event_espresso');
-        }
-        return $attendee_name;
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Base_Class|EE_Event
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function receipt_url($messenger = 'html')
-    {
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_url_link()
-    {
-        return (string) $this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo esc_url_raw($this->invoice_url($type));
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo esc_url_raw($this->payment_overview_url());
-    }
-
-
-    /**
-     * Gets the URL for the checkout payment options reg step
-     * with this registration's REG_url_link added as a query parameter
-     *
-     * @param bool $clear_session Set to true when you want to clear the session on revisiting the
-     *                            payment overview url.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payment_overview_url($clear_session = false)
-    {
-        return add_query_arg(
-            (array) apply_filters(
-                'FHEE__EE_Registration__payment_overview_url__query_args',
-                [
-                    'e_reg_url_link' => $this->reg_url_link(),
-                    'step'           => 'payment_options',
-                    'revisit'        => true,
-                    'clear_session'  => (bool) $clear_session,
-                ],
-                $this
-            ),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-    }
-
-
-    /**
-     * Gets the URL for the checkout attendee information reg step
-     * with this registration's REG_url_link added as a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(
-            (array) apply_filters(
-                'FHEE__EE_Registration__edit_attendee_information_url__query_args',
-                [
-                    'e_reg_url_link' => $this->reg_url_link(),
-                    'step'           => 'attendee_information',
-                    'revisit'        => true,
-                ],
-                $this
-            ),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * is_primary_registrant?
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function is_primary_registrant()
-    {
-        return (int) $this->get('REG_count') === 1;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        // k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        /** @var EE_Registration $primary_registrant */
-        $primary_registrant = EEM_Registration::instance()->get_one(
-            [
-                [
-                    'TXN_ID'    => $this->transaction_ID(),
-                    'REG_count' => 1,
-                ],
-            ]
-        );
-        return $primary_registrant;
-    }
-
-
-    /**
-     * get  Attendee Number
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     * get Group Size
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     * get Registration Date
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function final_price(): float
-    {
-        return (float) $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function paid(): float
-    {
-        return (float) $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment list of registration statuses that allow a registrant to make a payment
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function owes_monies_and_can_pay($requires_payment = [])
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment)
-            ? $requires_payment
-            : EEM_Registration::reg_statuses_that_allow_payment();
-        if (
-            $this->final_price() !== 0 &&
-            $this->final_price() !== $this->paid() &&
-            in_array($this->status_ID(), $requires_payment)
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$this->status_ID() => esc_html__('unknown', 'event_espresso')],
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[ $this->status_ID() ];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return EE_Answer[]|EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function answers($query_params = [])
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function question_groups()
-    {
-        return EEM_Event::instance()->get_question_groups_for_event($this->event_ID(), $this);
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_question_groups()
-    {
-        return EEM_Event::instance()->count_related(
-            $this->event_ID(),
-            'Question_Group',
-            [
-                [
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext($this->is_primary_registrant()) => true,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Base_Class|EE_Datetime_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Base_Class|EE_Datetime_Ticket
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-
-    /**
-     * Gets deleted
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Base_Class|EE_Status
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', [['CHK_in' => 1]]);
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-        // first check registration status
-        if (! $DTT_ID || ($check_approved && ! $this->is_approved())) {
-            return false;
-        }
-        // is there a datetime ticket that matches this dtt_ID?
-        if (
-            ! (EEM_Datetime_Ticket::instance()->exists(
-                [
-                    [
-                        'TKT_ID' => $this->get('TKT_ID'),
-                        'DTT_ID' => $DTT_ID,
-                    ],
-                ]
-            ))
-        ) {
-            return false;
-        }
-
-        // final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool true means can checkin.  false means cannot checkin.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket
-            ? $this->ticket()->uses()
-            : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
-        // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        // does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        // go ahead and toggle.
-        if (EEM_Checkin::instance()->exists([['REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID]])) {
-            return true;
-        }
-
-        // made it here so the last check is whether the number of checkins per unique datetime on this registration
-        // disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(
-            [
-                [
-                    'REG_ID' => $this->ID(),
-                    'CHK_in' => true,
-                ],
-            ],
-            'DTT_ID',
-            true
-        );
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param int  $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'
-                    ),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $status_paths = [
-            EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
-            EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
-            EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
-        ];
-        // start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-        $status_to  = $status_paths[ $cur_status ];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Checkin::status_checked_in;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(
-            [
-                'REG_ID' => $this->ID(),
-                'DTT_ID' => $DTT_ID,
-                'CHK_in' => $new_status,
-            ]
-        );
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    esc_html__(
-                        'Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = esc_html__(
-                    'Registration check in update failed because of an unknown database error',
-                    'event_espresso'
-                );
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // Fire a checked_in and checkout_out action.
-        $checked_status = $status_to === EE_Checkin::status_checked_in
-            ? 'checked_in'
-            : 'checked_out';
-        do_action("AHEE__EE_Registration__toggle_checkin_status__{$checked_status}", $this, $DTT_ID);
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_latest_related_datetime(): ?EE_Datetime
-    {
-        return EEM_Datetime::instance()->get_one(
-            [
-                [
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ],
-                'order_by' => ['DTT_EVT_start' => 'DESC'],
-            ]
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            [
-                [
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ],
-                'order_by' => ['DTT_EVT_start' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param int|null        $DTT_ID  The ID of the datetime we're checking against
-     *                                 (if empty we'll get the primary datetime for
-     *                                 this registration (via event) and use it's ID);
-     * @param EE_Checkin|null $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                     Integer representing Check-in status.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function check_in_status_for_datetime(?int $DTT_ID = 0, ?EE_Checkin $checkin = null): int
-    {
-        if ($checkin instanceof EE_Checkin) {
-            return $checkin->status();
-        }
-
-        if (! $DTT_ID) {
-            return EE_Checkin::status_invalid;
-        }
-
-        $checkin_query_params = [
-            0          => ['DTT_ID' => $DTT_ID],
-            'order_by' => ['CHK_timestamp' => 'DESC'],
-        ];
-
-        $checkin = $this->get_first_related(
-            'Checkin',
-            $checkin_query_params
-        );
-        return $checkin instanceof EE_Checkin ? $checkin->status() : EE_Checkin::status_checked_never;
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param int|null $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                         then it is assumed Check-in for primary datetime was toggled.
-     * @param bool     $error  This just flags that you want an error message returned. This is put in so that the error
-     *                         message can be customized with the attendee name.
-     * @return string internationalized message
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_checkin_msg(?int $DTT_ID, bool $error = false): string
-    {
-        // let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(
-                    esc_html__("%s's check-in status was not changed.", "event_espresso"),
-                    $attendee->full_name()
-                );
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            // what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Checkin::status_checked_never:
-                    return sprintf(
-                        esc_html__('%s has been removed from Check-in records', 'event_espresso'),
-                        $attendee->full_name()
-                    );
-                case EE_Checkin::status_checked_in:
-                    return sprintf(esc_html__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                case EE_Checkin::status_checked_out:
-                    return sprintf(esc_html__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-            }
-        }
-        return esc_html__('The check-in status could not be determined.', 'event_espresso');
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    public function transaction(): EE_Transaction
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * get Registration Code
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reg_code(): string
-    {
-        return $this->get('REG_code')
-            ?: '';
-    }
-
-
-    /**
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     * Set Registration Code
-     *
-     * @param RegCode|string $REG_code Registration Code
-     * @param boolean        $use_default
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function set_reg_code($REG_code, bool $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(
-                esc_html__('REG_code can not be empty.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @return EE_Registration[] or empty array if this isn't a group registration.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return [];
-        }
-
-        $query[0] = [
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => ['!=', $this->ID()],
-            'TKT_ID' => $this->ticket_ID(),
-        ];
-        /** @var EE_Registration[] $registrations */
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            [
-                'page' => 'espresso_registrations',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function payments($query_params = [])
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return EE_Base_Class[]|EE_Registration_Payment[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function registration_payments($query_params = [])
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment|EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            [$ticket->ID()]
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @param string $source function name that called this method
-     * @return boolean | int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @param string $source function name that called this method
-     * @return bool|int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-    /**
-     * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
-     *
-     * @param boolean $trigger_set_status_logic  EE_Registration::set_status() can trigger additional logic
-     *                                           depending on whether the reg status changes to or from "Approved"
-     * @return boolean whether the Registration status was updated
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
-    {
-        $paid  = $this->paid();
-        $price = $this->final_price();
-        switch (true) {
-            // overpaid or paid
-            case EEH_Money::compare_floats($paid, $price, '>'):
-            case EEH_Money::compare_floats($paid, $price):
-                $new_status = EEM_Registration::status_id_approved;
-                break;
-            //  underpaid
-            case EEH_Money::compare_floats($paid, $price, '<'):
-                $new_status = EEM_Registration::status_id_pending_payment;
-                break;
-            // uhhh Houston...
-            default:
-                throw new RuntimeException(
-                    esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
-                );
-        }
-        if ($new_status !== $this->status_ID()) {
-            if ($trigger_set_status_logic) {
-                return $this->set_status($new_status);
-            }
-            parent::set('STS_ID', $new_status);
-            return true;
-        }
-        return false;
-    }
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Registration::price_paid()',
-            esc_html__(
-                'This method is deprecated, please use EE_Registration::final_price() instead.',
-                'event_espresso'
-            ),
-            '4.7.0'
-        );
-        return $this->final_price();
-    }
-
-
-    /**
-     * @param float $REG_final_price
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws DomainException
-     * @deprecated
-     * @since     4.7.0
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Registration::set_price_paid()',
-            esc_html__(
-                'This method is deprecated, please use EE_Registration::set_final_price() instead.',
-                'event_espresso'
-            ),
-            '4.7.0'
-        );
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     * @since 4.7.0
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Registration::pretty_price_paid()',
-            esc_html__(
-                'This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'
-            ),
-            '4.7.0'
-        );
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated 4.9.17
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
-
-
-    /**
-     * Returns the contact's name (or "Unknown" if there is no contact.)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function name()
-    {
-        return $this->attendeeName();
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wasMoved(): bool
-    {
-        // only need to check 'registration-moved-to' because
-        // the existence of a new REG ID means the registration was moved
-        $reg_moved = $this->get_extra_meta('registration-moved-to', true, []);
-        return isset($reg_moved['NEW_REG_ID']) && $reg_moved['NEW_REG_ID'];
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param float|null $amount
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.8.p
-     */
-    public function applyPayment(EE_Payment $payment, ?float $amount = null): float
-    {
-        // echo "\n\n";
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
-        // \EEH_Debug_Tools::printr($this->ID(), 'REG ID', __FILE__, __LINE__);
-        $payment_amount = $amount ?? $payment->amount();
-        // ensure $payment_amount is NOT negative
-        $payment_amount = (float) abs($payment_amount);
-        // \EEH_Debug_Tools::printr($payment_amount, 'incoming $payment_amount', __FILE__, __LINE__);
-        // \EEH_Debug_Tools::printr($this->final_price(), 'reg final price', __FILE__, __LINE__);
-        // \EEH_Debug_Tools::printr($this->paid(), 'reg paid to date', __FILE__, __LINE__);
-        $payment_amount = $payment->is_a_refund()
-            ? $this->processRefund($payment_amount)
-            : $this->processPayment($payment_amount);
-        // \EEH_Debug_Tools::printr($payment_amount, 'applied payment_amount', __FILE__, __LINE__);
-        if ($payment_amount) {
-            $reg_payment = EEM_Registration_Payment::instance()->get_one(
-                [['REG_ID' => $this->ID(), 'PAY_ID' => $payment->ID()]]
-            );
-            // if existing registration payment exists
-            if ($reg_payment instanceof EE_Registration_Payment) {
-                // echo "\nUPDATE EXISTING REG PAYMENT";
-                // then update that record
-                $reg_payment->set_amount($payment_amount);
-            } else {
-                // echo "\nCREATE NEW REG PAYMENT";
-                // or add new relation between registration and payment and set amount
-                $reg_payment = EE_Registration_Payment::new_instance(
-                    [
-                        'REG_ID'     => $this->ID(),
-                        'PAY_ID'     => $payment->ID(),
-                        'RPY_amount' => $payment_amount,
-                    ]
-                );
-                // $this->_add_relation_to($payment, 'Payment', ['RPY_amount' => $payment_amount]);
-            }
-            $reg_payment->save();
-            // \EEH_Debug_Tools::printr($reg_payment->ID(), '$reg payment ID', __FILE__, __LINE__);
-        }
-        return $payment_amount;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processPayment(float $payment_amount): float
-    {
-        // echo "\n";
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
-        $paid  = $this->paid();
-        $owing = $this->final_price() - $paid;
-        // \EEH_Debug_Tools::printr($owing, '$owing', __FILE__, __LINE__);
-        if ($owing <= 0) {
-            return 0.0;
-        }
-        // don't allow payment amount to exceed the incoming amount, OR the amount owing
-        $payment_amount = min($payment_amount, $owing);
-        $paid           = $paid + $payment_amount;
-        // \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
-        // calculate and set new REG_paid
-        $this->set_paid($paid);
-        // make it stick
-        $this->save();
-        return (float) $payment_amount;
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private function processRefund(float $payment_amount): float
-    {
-        // echo "\n";
-        // \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
-        $paid = $this->paid();
-        if ($paid <= 0) {
-            return 0.0;
-        }
-        // don't allow refund amount to exceed the incoming amount, OR the amount paid
-        $payment_amount = min($payment_amount, $paid);
-        // calculate and set new REG_paid
-        $paid = $paid - $payment_amount;
-        \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
-        $this->set_paid($paid);
-        // make it stick
-        $this->save();
-        // convert payment amount back to a negative value for storage in the db
-        return (float) $payment_amount;
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_never instead
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_in instead
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_out instead
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance($props_n_values = [], $timezone = '', $date_formats = [])
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object
+			?: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db($props_n_values = [], $timezone = '')
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param int $EVT_ID Event ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code':
+				if (! empty($field_value) && ! $this->reg_code()) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string                $new_STS_ID
+	 * @param boolean               $use_default
+	 * @param ContextInterface|null $context
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false, ContextInterface $context = null)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if (
+			$old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// update internal status first
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			// THEN handle other changes that occur when reg status changes
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->reserveRegistrationSpace();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
+				// OR FROM  approved
+			} elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->releaseRegistrationSpace();
+				do_action(
+					'AHEE__EE_Registration__set_status__from_approved',
+					$this,
+					$old_STS_ID,
+					$new_STS_ID,
+					$context
+				);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, $context);
+			if ($this->statusChangeUpdatesTransaction($context)) {
+				$this->updateTransactionAfterStatusChange();
+			}
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
+			return true;
+		}
+		// even though the old value matches the new value, it's still good to
+		// allow the parent set method to have a say
+		parent::set('STS_ID', $new_STS_ID, $use_default);
+		return true;
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string                $new_STS_ID
+	 * @param string                $old_STS_ID
+	 * @param ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, ContextInterface $context = null)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		$this->updateIfCanceled(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+		$this->updateIfReinstated(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array                 $closed_reg_statuses
+	 * @param string                $new_STS_ID
+	 * @param string                $old_STS_ID
+	 * @param ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfCanceled(
+		array $closed_reg_statuses,
+		$new_STS_ID,
+		$old_STS_ID,
+		ContextInterface $context = null
+	) {
+		// true if registration has been cancelled or declined
+		if (
+			in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__canceled_or_declined',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+			return;
+		}
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array                 $closed_reg_statuses
+	 * @param string                $new_STS_ID
+	 * @param string                $old_STS_ID
+	 * @param ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfReinstated(
+		array $closed_reg_statuses,
+		$new_STS_ID,
+		$old_STS_ID,
+		ContextInterface $context = null
+	) {
+		// true if reinstating cancelled or declined registration
+		if (
+			in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__after_reinstated',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+		}
+	}
+
+
+	/**
+	 * @param ContextInterface|null $context
+	 * @return bool
+	 */
+	private function statusChangeUpdatesTransaction(ContextInterface $context = null)
+	{
+		$contexts_that_do_not_update_transaction = (array) apply_filters(
+			'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
+			['spco_reg_step_attendee_information_process_registrations'],
+			$context,
+			$this
+		);
+		return ! (
+			$context instanceof ContextInterface
+			&& in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateTransactionAfterStatusChange()
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+		$this->transaction()->update_status_based_on_total_paid();
+	}
+
+
+	/**
+	 * get Status ID
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = [];
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function event(): EE_Event
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function wp_user(): int
+	{
+		return $this->event()->wp_user();
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	private function reserveRegistrationSpace()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+		$ticket = $this->ticket();
+		$ticket->increaseSold();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	private function releaseRegistrationSpace()
+	{
+		$ticket = $this->ticket();
+		$ticket->decreaseSold();
+		// possibly change event status from sold out back to previous status
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool   $update_ticket if true, will increment ticket and datetime reserved count
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reserve_ticket($update_ticket = false, $source = 'unknown')
+	{
+		// only reserve ticket if space is not currently reserved
+		if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) !== true) {
+			$reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
+			if ($reserved && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+				$this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool   $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @param string $source
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function release_reserved_ticket($update_ticket = false, $source = 'unknown')
+	{
+		// only release ticket if space is currently reserved
+		if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) === true) {
+			$reserved = $this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, false);
+			if ($reserved && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+				$this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param int $ATT_ID Attendee ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param int $TXN_ID Transaction ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param string $REG_session PHP Session ID
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param string $REG_url_link Registration URL Link
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param int $REG_count Primary Attendee
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param boolean $REG_group_size Group Registration
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_not_approved;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_pending_payment;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_approved;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_cancelled;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_declined;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() === EEM_Registration::status_id_incomplete;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                                                 Date
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @param float $REG_final_price
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @param float|int|string $REG_paid
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', (float) $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param boolean $REG_att_is_going Attendee Is Going
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee|EE_Base_Class
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 * Gets the name of the attendee.
+	 *
+	 * @param bool $apply_html_entities set to true if you want to use HTML entities.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	public function attendeeName($apply_html_entities = false)
+	{
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$attendee_name = $attendee->full_name($apply_html_entities);
+		} else {
+			$attendee_name = esc_html__('Unknown', 'event_espresso');
+		}
+		return $attendee_name;
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Base_Class|EE_Event
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_url_link()
+	{
+		return (string) $this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo esc_url_raw($this->invoice_url($type));
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo esc_url_raw($this->payment_overview_url());
+	}
+
+
+	/**
+	 * Gets the URL for the checkout payment options reg step
+	 * with this registration's REG_url_link added as a query parameter
+	 *
+	 * @param bool $clear_session Set to true when you want to clear the session on revisiting the
+	 *                            payment overview url.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payment_overview_url($clear_session = false)
+	{
+		return add_query_arg(
+			(array) apply_filters(
+				'FHEE__EE_Registration__payment_overview_url__query_args',
+				[
+					'e_reg_url_link' => $this->reg_url_link(),
+					'step'           => 'payment_options',
+					'revisit'        => true,
+					'clear_session'  => (bool) $clear_session,
+				],
+				$this
+			),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+	}
+
+
+	/**
+	 * Gets the URL for the checkout attendee information reg step
+	 * with this registration's REG_url_link added as a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(
+			(array) apply_filters(
+				'FHEE__EE_Registration__edit_attendee_information_url__query_args',
+				[
+					'e_reg_url_link' => $this->reg_url_link(),
+					'step'           => 'attendee_information',
+					'revisit'        => true,
+				],
+				$this
+			),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * is_primary_registrant?
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function is_primary_registrant()
+	{
+		return (int) $this->get('REG_count') === 1;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		// k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		/** @var EE_Registration $primary_registrant */
+		$primary_registrant = EEM_Registration::instance()->get_one(
+			[
+				[
+					'TXN_ID'    => $this->transaction_ID(),
+					'REG_count' => 1,
+				],
+			]
+		);
+		return $primary_registrant;
+	}
+
+
+	/**
+	 * get  Attendee Number
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 * get Group Size
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 * get Registration Date
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function final_price(): float
+	{
+		return (float) $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function paid(): float
+	{
+		return (float) $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment list of registration statuses that allow a registrant to make a payment
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function owes_monies_and_can_pay($requires_payment = [])
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment)
+			? $requires_payment
+			: EEM_Registration::reg_statuses_that_allow_payment();
+		if (
+			$this->final_price() !== 0 &&
+			$this->final_price() !== $this->paid() &&
+			in_array($this->status_ID(), $requires_payment)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo wp_kses($this->pretty_status($show_icons), AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$this->status_ID() => esc_html__('unknown', 'event_espresso')],
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[ $this->status_ID() ];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return EE_Answer[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function answers($query_params = [])
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function question_groups()
+	{
+		return EEM_Event::instance()->get_question_groups_for_event($this->event_ID(), $this);
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_question_groups()
+	{
+		return EEM_Event::instance()->count_related(
+			$this->event_ID(),
+			'Question_Group',
+			[
+				[
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext($this->is_primary_registrant()) => true,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Base_Class|EE_Datetime_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Base_Class|EE_Datetime_Ticket
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Base_Class|EE_Status
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', [['CHK_in' => 1]]);
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+		// first check registration status
+		if (! $DTT_ID || ($check_approved && ! $this->is_approved())) {
+			return false;
+		}
+		// is there a datetime ticket that matches this dtt_ID?
+		if (
+			! (EEM_Datetime_Ticket::instance()->exists(
+				[
+					[
+						'TKT_ID' => $this->get('TKT_ID'),
+						'DTT_ID' => $DTT_ID,
+					],
+				]
+			))
+		) {
+			return false;
+		}
+
+		// final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool true means can checkin.  false means cannot checkin.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket
+			? $this->ticket()->uses()
+			: EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can
+		// check-in or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		// does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		// go ahead and toggle.
+		if (EEM_Checkin::instance()->exists([['REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID]])) {
+			return true;
+		}
+
+		// made it here so the last check is whether the number of checkins per unique datetime on this registration
+		// disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(
+			[
+				[
+					'REG_ID' => $this->ID(),
+					'CHK_in' => true,
+				],
+			],
+			'DTT_ID',
+			true
+		);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(
+				esc_html__(
+					'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param int  $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'
+					),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$status_paths = [
+			EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
+			EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
+			EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
+		];
+		// start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+		$status_to  = $status_paths[ $cur_status ];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Checkin::status_checked_in;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(
+			[
+				'REG_ID' => $this->ID(),
+				'DTT_ID' => $DTT_ID,
+				'CHK_in' => $new_status,
+			]
+		);
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					esc_html__(
+						'Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = esc_html__(
+					'Registration check in update failed because of an unknown database error',
+					'event_espresso'
+				);
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// Fire a checked_in and checkout_out action.
+		$checked_status = $status_to === EE_Checkin::status_checked_in
+			? 'checked_in'
+			: 'checked_out';
+		do_action("AHEE__EE_Registration__toggle_checkin_status__{$checked_status}", $this, $DTT_ID);
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_latest_related_datetime(): ?EE_Datetime
+	{
+		return EEM_Datetime::instance()->get_one(
+			[
+				[
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				],
+				'order_by' => ['DTT_EVT_start' => 'DESC'],
+			]
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			[
+				[
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				],
+				'order_by' => ['DTT_EVT_start' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param int|null        $DTT_ID  The ID of the datetime we're checking against
+	 *                                 (if empty we'll get the primary datetime for
+	 *                                 this registration (via event) and use it's ID);
+	 * @param EE_Checkin|null $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                     Integer representing Check-in status.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function check_in_status_for_datetime(?int $DTT_ID = 0, ?EE_Checkin $checkin = null): int
+	{
+		if ($checkin instanceof EE_Checkin) {
+			return $checkin->status();
+		}
+
+		if (! $DTT_ID) {
+			return EE_Checkin::status_invalid;
+		}
+
+		$checkin_query_params = [
+			0          => ['DTT_ID' => $DTT_ID],
+			'order_by' => ['CHK_timestamp' => 'DESC'],
+		];
+
+		$checkin = $this->get_first_related(
+			'Checkin',
+			$checkin_query_params
+		);
+		return $checkin instanceof EE_Checkin ? $checkin->status() : EE_Checkin::status_checked_never;
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param int|null $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                         then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool     $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                         message can be customized with the attendee name.
+	 * @return string internationalized message
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_checkin_msg(?int $DTT_ID, bool $error = false): string
+	{
+		// let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(
+					esc_html__("%s's check-in status was not changed.", "event_espresso"),
+					$attendee->full_name()
+				);
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			// what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Checkin::status_checked_never:
+					return sprintf(
+						esc_html__('%s has been removed from Check-in records', 'event_espresso'),
+						$attendee->full_name()
+					);
+				case EE_Checkin::status_checked_in:
+					return sprintf(esc_html__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+				case EE_Checkin::status_checked_out:
+					return sprintf(esc_html__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+			}
+		}
+		return esc_html__('The check-in status could not be determined.', 'event_espresso');
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	public function transaction(): EE_Transaction
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * get Registration Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reg_code(): string
+	{
+		return $this->get('REG_code')
+			?: '';
+	}
+
+
+	/**
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 * Set Registration Code
+	 *
+	 * @param RegCode|string $REG_code Registration Code
+	 * @param boolean        $use_default
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function set_reg_code($REG_code, bool $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(
+				esc_html__('REG_code can not be empty.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @return EE_Registration[] or empty array if this isn't a group registration.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return [];
+		}
+
+		$query[0] = [
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => ['!=', $this->ID()],
+			'TKT_ID' => $this->ticket_ID(),
+		];
+		/** @var EE_Registration[] $registrations */
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			[
+				'page' => 'espresso_registrations',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function payments($query_params = [])
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return EE_Base_Class[]|EE_Registration_Payment[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function registration_payments($query_params = [])
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment|EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			[$ticket->ID()]
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @param string $source function name that called this method
+	 * @return boolean | int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @param string $source function name that called this method
+	 * @return bool|int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+	/**
+	 * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
+	 *
+	 * @param boolean $trigger_set_status_logic  EE_Registration::set_status() can trigger additional logic
+	 *                                           depending on whether the reg status changes to or from "Approved"
+	 * @return boolean whether the Registration status was updated
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
+	{
+		$paid  = $this->paid();
+		$price = $this->final_price();
+		switch (true) {
+			// overpaid or paid
+			case EEH_Money::compare_floats($paid, $price, '>'):
+			case EEH_Money::compare_floats($paid, $price):
+				$new_status = EEM_Registration::status_id_approved;
+				break;
+			//  underpaid
+			case EEH_Money::compare_floats($paid, $price, '<'):
+				$new_status = EEM_Registration::status_id_pending_payment;
+				break;
+			// uhhh Houston...
+			default:
+				throw new RuntimeException(
+					esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
+				);
+		}
+		if ($new_status !== $this->status_ID()) {
+			if ($trigger_set_status_logic) {
+				return $this->set_status($new_status);
+			}
+			parent::set('STS_ID', $new_status);
+			return true;
+		}
+		return false;
+	}
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Registration::price_paid()',
+			esc_html__(
+				'This method is deprecated, please use EE_Registration::final_price() instead.',
+				'event_espresso'
+			),
+			'4.7.0'
+		);
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @param float $REG_final_price
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws DomainException
+	 * @deprecated
+	 * @since     4.7.0
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Registration::set_price_paid()',
+			esc_html__(
+				'This method is deprecated, please use EE_Registration::set_final_price() instead.',
+				'event_espresso'
+			),
+			'4.7.0'
+		);
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 * @since 4.7.0
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Registration::pretty_price_paid()',
+			esc_html__(
+				'This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'
+			),
+			'4.7.0'
+		);
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated 4.9.17
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
+
+
+	/**
+	 * Returns the contact's name (or "Unknown" if there is no contact.)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	public function name()
+	{
+		return $this->attendeeName();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wasMoved(): bool
+	{
+		// only need to check 'registration-moved-to' because
+		// the existence of a new REG ID means the registration was moved
+		$reg_moved = $this->get_extra_meta('registration-moved-to', true, []);
+		return isset($reg_moved['NEW_REG_ID']) && $reg_moved['NEW_REG_ID'];
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param float|null $amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.8.p
+	 */
+	public function applyPayment(EE_Payment $payment, ?float $amount = null): float
+	{
+		// echo "\n\n";
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
+		// \EEH_Debug_Tools::printr($this->ID(), 'REG ID', __FILE__, __LINE__);
+		$payment_amount = $amount ?? $payment->amount();
+		// ensure $payment_amount is NOT negative
+		$payment_amount = (float) abs($payment_amount);
+		// \EEH_Debug_Tools::printr($payment_amount, 'incoming $payment_amount', __FILE__, __LINE__);
+		// \EEH_Debug_Tools::printr($this->final_price(), 'reg final price', __FILE__, __LINE__);
+		// \EEH_Debug_Tools::printr($this->paid(), 'reg paid to date', __FILE__, __LINE__);
+		$payment_amount = $payment->is_a_refund()
+			? $this->processRefund($payment_amount)
+			: $this->processPayment($payment_amount);
+		// \EEH_Debug_Tools::printr($payment_amount, 'applied payment_amount', __FILE__, __LINE__);
+		if ($payment_amount) {
+			$reg_payment = EEM_Registration_Payment::instance()->get_one(
+				[['REG_ID' => $this->ID(), 'PAY_ID' => $payment->ID()]]
+			);
+			// if existing registration payment exists
+			if ($reg_payment instanceof EE_Registration_Payment) {
+				// echo "\nUPDATE EXISTING REG PAYMENT";
+				// then update that record
+				$reg_payment->set_amount($payment_amount);
+			} else {
+				// echo "\nCREATE NEW REG PAYMENT";
+				// or add new relation between registration and payment and set amount
+				$reg_payment = EE_Registration_Payment::new_instance(
+					[
+						'REG_ID'     => $this->ID(),
+						'PAY_ID'     => $payment->ID(),
+						'RPY_amount' => $payment_amount,
+					]
+				);
+				// $this->_add_relation_to($payment, 'Payment', ['RPY_amount' => $payment_amount]);
+			}
+			$reg_payment->save();
+			// \EEH_Debug_Tools::printr($reg_payment->ID(), '$reg payment ID', __FILE__, __LINE__);
+		}
+		return $payment_amount;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processPayment(float $payment_amount): float
+	{
+		// echo "\n";
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
+		$paid  = $this->paid();
+		$owing = $this->final_price() - $paid;
+		// \EEH_Debug_Tools::printr($owing, '$owing', __FILE__, __LINE__);
+		if ($owing <= 0) {
+			return 0.0;
+		}
+		// don't allow payment amount to exceed the incoming amount, OR the amount owing
+		$payment_amount = min($payment_amount, $owing);
+		$paid           = $paid + $payment_amount;
+		// \EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
+		// calculate and set new REG_paid
+		$this->set_paid($paid);
+		// make it stick
+		$this->save();
+		return (float) $payment_amount;
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private function processRefund(float $payment_amount): float
+	{
+		// echo "\n";
+		// \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 3);
+		$paid = $this->paid();
+		if ($paid <= 0) {
+			return 0.0;
+		}
+		// don't allow refund amount to exceed the incoming amount, OR the amount paid
+		$payment_amount = min($payment_amount, $paid);
+		// calculate and set new REG_paid
+		$paid = $paid - $payment_amount;
+		\EEH_Debug_Tools::printr($paid, 'NEW REG PAID AMOUNT', __FILE__, __LINE__);
+		$this->set_paid($paid);
+		// make it stick
+		$this->save();
+		// convert payment amount back to a negative value for storage in the db
+		return (float) $payment_amount;
+	}
 }