eventespresso / event-espresso-core

core/libraries/rest_api/controllers/rpc/Checkin.php

Indentation +118 added lines, -118 removed lines

@@ -26,124 +26,124 @@
 class Checkin extends Base
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_Error|WP_REST_Response
-     */
-    public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
-    {
-        $controller = new Checkin();
-        return $controller->createCheckinCheckoutObject($request, $version);
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
+	{
+		$controller = new Checkin();
+		return $controller->createCheckinCheckoutObject($request, $version);
+	}
 
 
-    /**
-     * Toggles whether the user is checked in or not.
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_Error|WP_REST_Response
-     */
-    protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
-    {
-        $reg_id = $request->get_param('REG_ID');
-        $dtt_id = $request->get_param('DTT_ID');
-        $force = $request->get_param('force');
-        if ($force == 'true') {
-            $force = true;
-        } else {
-            $force = false;
-        }
-        $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_registration_toggle_checkin_invalid_id',
-                    sprintf(
-                        __(
-                            'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
-                            'event_espresso'
-                        ),
-                        $reg_id
-                    ),
-                    array('status' => 422)
-                )
-            );
-        }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_user_cannot_toggle_checkin',
-                    sprintf(
-                        __('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 403)
-                )
-            );
-        }
-        $success = $reg->toggle_checkin_status($dtt_id, ! $force);
-        if ($success === false) {
-            // check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
-                // rely on EE_Error::add_error messages to have been added to give more data about why it failed
-                return $this->sendResponse(
-                    new WP_Error(
-                        'rest_toggle_checkin_failed',
-                        __(
-                        // @codingStandardsIgnoreStart
-                            'Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_failed_not_forceable',
-                    __('Registration checkin failed. Please see additional error data.', 'event_espresso')
-                )
-            );
-        }
-        $checkin = EEM_Checkin::instance()->get_one(
-            array(
-                array(
-                    'REG_ID' => $reg_id,
-                    'DTT_ID' => $dtt_id,
-                ),
-                'order_by' => array(
-                    'CHK_timestamp' => 'DESC',
-                ),
-            )
-        );
-        if (! $checkin instanceof EE_Checkin) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_error',
-                    sprintf(
-                        __(
-                        // @codingStandardsIgnoreStart
-                            'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $reg_id,
-                        $dtt_id
-                    )
-                )
-            );
-        }
-        $get_request = new WP_REST_Request(
-            'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
-        );
-        $get_request->set_url_params(
-            array(
-                'id' => $checkin->ID(),
-            )
-        );
-        return Read::handleRequestGetOne($get_request, $version, 'Checkin');
-    }
+	/**
+	 * Toggles whether the user is checked in or not.
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
+	{
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
+			$force = true;
+		} else {
+			$force = false;
+		}
+		$reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $reg instanceof EE_Registration) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_registration_toggle_checkin_invalid_id',
+					sprintf(
+						__(
+							'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
+							'event_espresso'
+						),
+						$reg_id
+					),
+					array('status' => 422)
+				)
+			);
+		}
+		if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_user_cannot_toggle_checkin',
+					sprintf(
+						__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
+						$reg_id
+					),
+					array('status' => 403)
+				)
+			);
+		}
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
+			// check if we know they can't check in because they're not approved and we aren't forcing
+			if (! $reg->is_approved() && ! $force) {
+				// rely on EE_Error::add_error messages to have been added to give more data about why it failed
+				return $this->sendResponse(
+					new WP_Error(
+						'rest_toggle_checkin_failed',
+						__(
+						// @codingStandardsIgnoreStart
+							'Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						)
+					)
+				);
+			}
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_failed_not_forceable',
+					__('Registration checkin failed. Please see additional error data.', 'event_espresso')
+				)
+			);
+		}
+		$checkin = EEM_Checkin::instance()->get_one(
+			array(
+				array(
+					'REG_ID' => $reg_id,
+					'DTT_ID' => $dtt_id,
+				),
+				'order_by' => array(
+					'CHK_timestamp' => 'DESC',
+				),
+			)
+		);
+		if (! $checkin instanceof EE_Checkin) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_error',
+					sprintf(
+						__(
+						// @codingStandardsIgnoreStart
+							'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$reg_id,
+						$dtt_id
+					)
+				)
+			);
+		}
+		$get_request = new WP_REST_Request(
+			'GET',
+			'/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+		);
+		$get_request->set_url_params(
+			array(
+				'id' => $checkin->ID(),
+			)
+		);
+		return Read::handleRequestGetOne($get_request, $version, 'Checkin');
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
             $force = false;
         }
         $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_registration_toggle_checkin_invalid_id',
@@ -71,7 +71,7 @@ 
                 )
             );
         }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+        if ( ! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_user_cannot_toggle_checkin',
@@ -86,7 +86,7 @@ 
         $success = $reg->toggle_checkin_status($dtt_id, ! $force);
         if ($success === false) {
             // check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
+            if ( ! $reg->is_approved() && ! $force) {
                 // rely on EE_Error::add_error messages to have been added to give more data about why it failed
                 return $this->sendResponse(
                     new WP_Error(
@@ -118,7 +118,7 @@ 
                 ),
             )
         );
-        if (! $checkin instanceof EE_Checkin) {
+        if ( ! $checkin instanceof EE_Checkin) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_toggle_checkin_error',
@@ -137,7 +137,7 @@ 
         }
         $get_request = new WP_REST_Request(
             'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+            '/'.EED_Core_Rest_Api::ee_api_namespace.'v'.$version.'/checkins/'.$checkin->ID()
         );
         $get_request->set_url_params(
             array(

core/libraries/batch/JobHandlerBaseClasses/JobHandlerFile.php

Indentation +99 added lines, -99 removed lines

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

Spacing +7 added lines, -7 removed lines

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

core/libraries/batch/JobHandlerBaseClasses/JobHandler.php

Indentation +1 added lines, -1 removed lines

@@ -13,5 +13,5 @@
  */
 abstract class JobHandler implements JobHandlerInterface
 {
-    // so far no common methods or properties
+	// so far no common methods or properties
 }

core/libraries/batch/Helpers/BatchRequestException.php

Indentation +1 added lines, -1 removed lines

@@ -14,5 +14,5 @@
  */
 class BatchRequestException extends \Exception
 {
-    // so far the same as exception
+	// so far the same as exception
 }

core/libraries/batch/Helpers/JobParameters.php

Indentation +391 added lines, -391 removed lines

@@ -14,395 +14,395 @@
  */
 class JobParameters
 {
-    // phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * status indicating the job should continue
-     */
-    const status_continue = 'continue';
-
-    /**
-     * status indicated the job has been completed successfully and should be cleaned up next
-     */
-    const status_complete = 'complete';
-
-    /**
-     * status indicating there was an error and the job should be cleaned up
-     */
-    const status_error = 'error';
-
-    /**
-     * status indicating the job has been cleaned up, and so this is probably the last
-     * time you'll see this job
-     */
-    const status_cleaned_up = 'cleaned_up';
-
-    const wp_option_prefix = 'ee_job_parameters_';
-
-
-    /**
-     * String uniquely identifying the job
-     *
-     * @var string
-     */
-    protected $_job_id;
-
-    /**
-     * @var string
-     */
-    protected $_classname;
-
-    /**
-     * @var array
-     */
-    protected $_request_data;
-
-    /**
-     * Array of any extra data we want to remember about this request, that
-     * wasn't necessarily past in with the request data
-     *
-     * @var array
-     */
-    protected $_extra_data;
-
-    /**
-     * Estimate of how many units HAVE been processed
-     *
-     * @var int
-     */
-    protected $_units_processed = 0;
-
-    /**
-     * @var string
-     */
-    protected $_status;
-
-    /**
-     * The size of the total job in whatever units you want.
-     * If you can't provide an estimate leave as 0.
-     * Once _units_processed equals _job_size, we should be done
-     *
-     * @var int
-     */
-    protected $_job_size = 0;
-
-
-    /**
-     * @param string $job_id
-     * @param string $classname
-     * @param array  $request_data
-     * @param array  $extra_data
-     */
-    public function __construct($job_id, $classname, $request_data, $extra_data = array())
-    {
-        $this->set_job_id($job_id);
-        $this->set_classname($classname);
-        $this->set_request_data($request_data);
-        $this->set_extra_data($extra_data);
-        $this->set_status(JobParameters::status_continue);
-    }
-
-
-    /**
-     * Returns the array of strings of valid stati
-     *
-     * @return array
-     */
-    public static function valid_stati()
-    {
-        return array(
-            JobParameters::status_complete,
-            JobParameters::status_continue,
-            JobParameters::status_error,
-            JobParameters::status_cleaned_up,
-        );
-    }
-
-
-    /**
-     * Saves this option to the database (wordpress options table)
-     *
-     * @param boolean $first
-     * @return boolean success
-     */
-    public function save($first = false)
-    {
-        $object_vars = get_object_vars($this);
-        if ($first) {
-            return add_option($this->option_name(), $object_vars, null, 'no');
-        } else {
-            return update_option($this->option_name(), $object_vars);
-        }
-    }
-
-
-    /**
-     * Deletes the job from teh database, although this object is still usable
-     * for the rest of the request
-     *
-     * @return boolean
-     */
-    public function delete()
-    {
-        return delete_option($this->option_name());
-    }
-
-
-    /**
-     * Loads the specified job from the database
-     *
-     * @param string $job_id
-     * @return JobParameters
-     * @throws BatchRequestException
-     */
-    public static function load($job_id)
-    {
-        $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
-        if (! is_array($job_parameter_vars) ||
-            ! isset($job_parameter_vars['_classname']) ||
-            ! isset($job_parameter_vars['_request_data'])
-        ) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s',
-                        'event_espresso'
-                    ),
-                    $job_id,
-                    get_option(JobParameters::wp_option_prefix . $job_id)
-                )
-            );
-        }
-        $job_parameters = new JobParameters(
-            $job_id,
-            $job_parameter_vars['_classname'],
-            $job_parameter_vars['_request_data']
-        );
-        foreach ($job_parameter_vars as $key => $value) {
-            $job_parameters->{$key} = $value;
-        }
-        return $job_parameters;
-    }
-
-
-    /**
-     * Gets the job's unique string
-     *
-     * @return string
-     */
-    public function job_id()
-    {
-        return $this->_job_id;
-    }
-
-
-    /**
-     * Gets the classname that should run this job
-     *
-     * @return string
-     */
-    public function classname()
-    {
-        return $this->_classname;
-    }
-
-
-    /**
-     * Gets the original array of $_REQUEST data for this job
-     *
-     * @return array
-     */
-    public function request_data()
-    {
-        return $this->_request_data;
-    }
-
-
-    /**
-     * Gets a single item from the request data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function request_datum($key, $default = '')
-    {
-        if (isset($this->_request_data[$key])) {
-            return $this->_request_data[$key];
-        } else {
-            return $default;
-        }
-    }
-
-
-    /**
-     * Gets a single item from the extra data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function extra_datum($key, $default = '')
-    {
-        if (isset($this->_extra_data[$key])) {
-            return $this->_extra_data[$key];
-        } else {
-            return $default;
-        }
-    }
-
-
-    /**
-     * Adds an extra piece of extra data that we're going to want later during the job
-     *
-     * @param string                $key
-     * @param string|int|array|null $value almost any extra data you want to store
-     */
-    public function add_extra_data($key, $value)
-    {
-        $this->_extra_data[$key] = $value;
-    }
-
-
-    /**
-     * Array of any extra data we want to store
-     *
-     * @return array
-     */
-    public function extra_data()
-    {
-        return $this->_extra_data;
-    }
-
-
-    /**
-     * Returns the job size, in whatever units you want
-     *
-     * @return int
-     */
-    public function job_size()
-    {
-        return $this->_job_size;
-    }
-
-
-    /**
-     * Sets the job size. You decide what units to use
-     *
-     * @param int $size
-     */
-    public function set_job_size($size)
-    {
-        $this->_job_size = $size;
-    }
-
-
-    /**
-     * The number of "units" processed, in the same units as the "job size"
-     *
-     * @return int
-     */
-    public function units_processed()
-    {
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Marks more units as processed
-     *
-     * @param int $newly_processed
-     * @return int updated units processed
-     */
-    public function mark_processed($newly_processed)
-    {
-        $this->_units_processed += $newly_processed;
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Sets the total count of units processed. You might prefer to use mark_processed
-     *
-     * @param int $total_units_processed
-     */
-    public function set_units_processed($total_units_processed)
-    {
-        $this->_units_processed = $total_units_processed;
-    }
-
-
-    /**
-     * Sets the job's ID
-     *
-     * @param string $job_id
-     */
-    public function set_job_id($job_id)
-    {
-        $this->_job_id = $job_id;
-    }
-
-
-    /**
-     * sets the classname
-     *
-     * @param string $classname
-     */
-    public function set_classname($classname)
-    {
-        $this->_classname = $classname;
-    }
-
-
-    /**
-     * Sets the request data
-     *
-     * @param array $request_data
-     */
-    public function set_request_data($request_data)
-    {
-        $this->_request_data = $request_data;
-    }
-
-
-    /**
-     * Sets the array of extra data we want to store on this request
-     *
-     * @param array $extra_data
-     */
-    public function set_extra_data($extra_data)
-    {
-        $this->_extra_data = $extra_data;
-    }
-
-
-    /**
-     * Gets the name of the wordpress option that should store these job parameters
-     *
-     * @return string
-     */
-    public function option_name()
-    {
-        return JobParameters::wp_option_prefix . $this->job_id();
-    }
-
-
-    /**
-     * Gets the job\s current status. One of JobParameters::valid_stati();
-     *
-     * @return string
-     */
-    public function status()
-    {
-        return $this->_status;
-    }
-
-
-    /**
-     * @param string $status on eof JobParameters::valid_stati()
-     */
-    public function set_status($status)
-    {
-        $this->_status = $status;
-    }
+	// phpcs:disable Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * status indicating the job should continue
+	 */
+	const status_continue = 'continue';
+
+	/**
+	 * status indicated the job has been completed successfully and should be cleaned up next
+	 */
+	const status_complete = 'complete';
+
+	/**
+	 * status indicating there was an error and the job should be cleaned up
+	 */
+	const status_error = 'error';
+
+	/**
+	 * status indicating the job has been cleaned up, and so this is probably the last
+	 * time you'll see this job
+	 */
+	const status_cleaned_up = 'cleaned_up';
+
+	const wp_option_prefix = 'ee_job_parameters_';
+
+
+	/**
+	 * String uniquely identifying the job
+	 *
+	 * @var string
+	 */
+	protected $_job_id;
+
+	/**
+	 * @var string
+	 */
+	protected $_classname;
+
+	/**
+	 * @var array
+	 */
+	protected $_request_data;
+
+	/**
+	 * Array of any extra data we want to remember about this request, that
+	 * wasn't necessarily past in with the request data
+	 *
+	 * @var array
+	 */
+	protected $_extra_data;
+
+	/**
+	 * Estimate of how many units HAVE been processed
+	 *
+	 * @var int
+	 */
+	protected $_units_processed = 0;
+
+	/**
+	 * @var string
+	 */
+	protected $_status;
+
+	/**
+	 * The size of the total job in whatever units you want.
+	 * If you can't provide an estimate leave as 0.
+	 * Once _units_processed equals _job_size, we should be done
+	 *
+	 * @var int
+	 */
+	protected $_job_size = 0;
+
+
+	/**
+	 * @param string $job_id
+	 * @param string $classname
+	 * @param array  $request_data
+	 * @param array  $extra_data
+	 */
+	public function __construct($job_id, $classname, $request_data, $extra_data = array())
+	{
+		$this->set_job_id($job_id);
+		$this->set_classname($classname);
+		$this->set_request_data($request_data);
+		$this->set_extra_data($extra_data);
+		$this->set_status(JobParameters::status_continue);
+	}
+
+
+	/**
+	 * Returns the array of strings of valid stati
+	 *
+	 * @return array
+	 */
+	public static function valid_stati()
+	{
+		return array(
+			JobParameters::status_complete,
+			JobParameters::status_continue,
+			JobParameters::status_error,
+			JobParameters::status_cleaned_up,
+		);
+	}
+
+
+	/**
+	 * Saves this option to the database (wordpress options table)
+	 *
+	 * @param boolean $first
+	 * @return boolean success
+	 */
+	public function save($first = false)
+	{
+		$object_vars = get_object_vars($this);
+		if ($first) {
+			return add_option($this->option_name(), $object_vars, null, 'no');
+		} else {
+			return update_option($this->option_name(), $object_vars);
+		}
+	}
+
+
+	/**
+	 * Deletes the job from teh database, although this object is still usable
+	 * for the rest of the request
+	 *
+	 * @return boolean
+	 */
+	public function delete()
+	{
+		return delete_option($this->option_name());
+	}
+
+
+	/**
+	 * Loads the specified job from the database
+	 *
+	 * @param string $job_id
+	 * @return JobParameters
+	 * @throws BatchRequestException
+	 */
+	public static function load($job_id)
+	{
+		$job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
+		if (! is_array($job_parameter_vars) ||
+			! isset($job_parameter_vars['_classname']) ||
+			! isset($job_parameter_vars['_request_data'])
+		) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'Could not retrieve job %1$s from the Wordpress options table, and so the job could not continue. The wordpress option was %2$s',
+						'event_espresso'
+					),
+					$job_id,
+					get_option(JobParameters::wp_option_prefix . $job_id)
+				)
+			);
+		}
+		$job_parameters = new JobParameters(
+			$job_id,
+			$job_parameter_vars['_classname'],
+			$job_parameter_vars['_request_data']
+		);
+		foreach ($job_parameter_vars as $key => $value) {
+			$job_parameters->{$key} = $value;
+		}
+		return $job_parameters;
+	}
+
+
+	/**
+	 * Gets the job's unique string
+	 *
+	 * @return string
+	 */
+	public function job_id()
+	{
+		return $this->_job_id;
+	}
+
+
+	/**
+	 * Gets the classname that should run this job
+	 *
+	 * @return string
+	 */
+	public function classname()
+	{
+		return $this->_classname;
+	}
+
+
+	/**
+	 * Gets the original array of $_REQUEST data for this job
+	 *
+	 * @return array
+	 */
+	public function request_data()
+	{
+		return $this->_request_data;
+	}
+
+
+	/**
+	 * Gets a single item from the request data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function request_datum($key, $default = '')
+	{
+		if (isset($this->_request_data[$key])) {
+			return $this->_request_data[$key];
+		} else {
+			return $default;
+		}
+	}
+
+
+	/**
+	 * Gets a single item from the extra data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function extra_datum($key, $default = '')
+	{
+		if (isset($this->_extra_data[$key])) {
+			return $this->_extra_data[$key];
+		} else {
+			return $default;
+		}
+	}
+
+
+	/**
+	 * Adds an extra piece of extra data that we're going to want later during the job
+	 *
+	 * @param string                $key
+	 * @param string|int|array|null $value almost any extra data you want to store
+	 */
+	public function add_extra_data($key, $value)
+	{
+		$this->_extra_data[$key] = $value;
+	}
+
+
+	/**
+	 * Array of any extra data we want to store
+	 *
+	 * @return array
+	 */
+	public function extra_data()
+	{
+		return $this->_extra_data;
+	}
+
+
+	/**
+	 * Returns the job size, in whatever units you want
+	 *
+	 * @return int
+	 */
+	public function job_size()
+	{
+		return $this->_job_size;
+	}
+
+
+	/**
+	 * Sets the job size. You decide what units to use
+	 *
+	 * @param int $size
+	 */
+	public function set_job_size($size)
+	{
+		$this->_job_size = $size;
+	}
+
+
+	/**
+	 * The number of "units" processed, in the same units as the "job size"
+	 *
+	 * @return int
+	 */
+	public function units_processed()
+	{
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Marks more units as processed
+	 *
+	 * @param int $newly_processed
+	 * @return int updated units processed
+	 */
+	public function mark_processed($newly_processed)
+	{
+		$this->_units_processed += $newly_processed;
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Sets the total count of units processed. You might prefer to use mark_processed
+	 *
+	 * @param int $total_units_processed
+	 */
+	public function set_units_processed($total_units_processed)
+	{
+		$this->_units_processed = $total_units_processed;
+	}
+
+
+	/**
+	 * Sets the job's ID
+	 *
+	 * @param string $job_id
+	 */
+	public function set_job_id($job_id)
+	{
+		$this->_job_id = $job_id;
+	}
+
+
+	/**
+	 * sets the classname
+	 *
+	 * @param string $classname
+	 */
+	public function set_classname($classname)
+	{
+		$this->_classname = $classname;
+	}
+
+
+	/**
+	 * Sets the request data
+	 *
+	 * @param array $request_data
+	 */
+	public function set_request_data($request_data)
+	{
+		$this->_request_data = $request_data;
+	}
+
+
+	/**
+	 * Sets the array of extra data we want to store on this request
+	 *
+	 * @param array $extra_data
+	 */
+	public function set_extra_data($extra_data)
+	{
+		$this->_extra_data = $extra_data;
+	}
+
+
+	/**
+	 * Gets the name of the wordpress option that should store these job parameters
+	 *
+	 * @return string
+	 */
+	public function option_name()
+	{
+		return JobParameters::wp_option_prefix . $this->job_id();
+	}
+
+
+	/**
+	 * Gets the job\s current status. One of JobParameters::valid_stati();
+	 *
+	 * @return string
+	 */
+	public function status()
+	{
+		return $this->_status;
+	}
+
+
+	/**
+	 * @param string $status on eof JobParameters::valid_stati()
+	 */
+	public function set_status($status)
+	{
+		$this->_status = $status;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -157,8 +157,8 @@ 
      */
     public static function load($job_id)
     {
-        $job_parameter_vars = get_option(JobParameters::wp_option_prefix . $job_id);
-        if (! is_array($job_parameter_vars) ||
+        $job_parameter_vars = get_option(JobParameters::wp_option_prefix.$job_id);
+        if ( ! is_array($job_parameter_vars) ||
             ! isset($job_parameter_vars['_classname']) ||
             ! isset($job_parameter_vars['_request_data'])
         ) {
@@ -169,7 +169,7 @@ 
                         'event_espresso'
                     ),
                     $job_id,
-                    get_option(JobParameters::wp_option_prefix . $job_id)
+                    get_option(JobParameters::wp_option_prefix.$job_id)
                 )
             );
         }
@@ -383,7 +383,7 @@ 
      */
     public function option_name()
     {
-        return JobParameters::wp_option_prefix . $this->job_id();
+        return JobParameters::wp_option_prefix.$this->job_id();
     }
 
 

core/libraries/batch/Helpers/JobStepResponse.php

Indentation +82 added lines, -82 removed lines

@@ -14,97 +14,97 @@
 class JobStepResponse
 {
 
-    /**
-     * Description fo what happened during this step
-     *
-     * @var string
-     */
-    protected $_update_text;
+	/**
+	 * Description fo what happened during this step
+	 *
+	 * @var string
+	 */
+	protected $_update_text;
 
-    /**
-     * @var JobParameters
-     */
-    protected $_job_parameters;
+	/**
+	 * @var JobParameters
+	 */
+	protected $_job_parameters;
 
-    /**
-     * Extra data to include as part of the response.
-     *
-     * @var array
-     */
-    protected $_extra_data = array();
+	/**
+	 * Extra data to include as part of the response.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data = array();
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters
-     * @param string                                           $update_text
-     * @param array                                            $extra_data
-     */
-    public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array())
-    {
-        $this->_job_parameters = $job_parameters;
-        $this->_update_text = $update_text;
-        $this->_extra_data = (array)$extra_data;
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * @param \EventEspressoBatchRequest\Helpers\JobParameters $job_parameters
+	 * @param string                                           $update_text
+	 * @param array                                            $extra_data
+	 */
+	public function __construct(JobParameters $job_parameters, $update_text, $extra_data = array())
+	{
+		$this->_job_parameters = $job_parameters;
+		$this->_update_text = $update_text;
+		$this->_extra_data = (array)$extra_data;
+	}
 
 
-    /**
-     * @return JobParameters
-     */
-    public function job_parameters()
-    {
-        return $this->_job_parameters;
-    }
+	/**
+	 * @return JobParameters
+	 */
+	public function job_parameters()
+	{
+		return $this->_job_parameters;
+	}
 
 
-    /**
-     * Gets the update_text of what happened in this job during the current step
-     *
-     * @return string
-     */
-    public function update_text()
-    {
-        return $this->_update_text;
-    }
+	/**
+	 * Gets the update_text of what happened in this job during the current step
+	 *
+	 * @return string
+	 */
+	public function update_text()
+	{
+		return $this->_update_text;
+	}
 
 
-    /**
-     * Returns any extra data we may want to include with this response
-     *
-     * @return array
-     */
-    public function extra_data()
-    {
-        return $this->_extra_data;
-    }
+	/**
+	 * Returns any extra data we may want to include with this response
+	 *
+	 * @return array
+	 */
+	public function extra_data()
+	{
+		return $this->_extra_data;
+	}
 
 
-    /**
-     * Converts this response into an array that can be easily serialized.
-     * This is most useful for serializing or json encoding
-     *
-     * @return array {
-     * @type string $status          , one of JobParameters::valid_stati()
-     * @type int    $units_processed count of units processed
-     * @type int    $job_size        total number of units TO process
-     * @type string $job_id          unique string identifying the job
-     * @type string $update_text     string describing what happened during this step
-     * } and any other items from $this->extra_data()
-     */
-    public function to_array()
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
-            array_merge(
-                $this->extra_data(),
-                array(
-                    'status'          => $this->job_parameters()->status(),
-                    'units_processed' => $this->job_parameters()->units_processed(),
-                    'job_size'        => $this->job_parameters()->job_size(),
-                    'job_id'          => $this->job_parameters()->job_id(),
-                    'update_text'     => $this->update_text(),
-                )
-            ),
-            $this
-        );
-    }
+	/**
+	 * Converts this response into an array that can be easily serialized.
+	 * This is most useful for serializing or json encoding
+	 *
+	 * @return array {
+	 * @type string $status          , one of JobParameters::valid_stati()
+	 * @type int    $units_processed count of units processed
+	 * @type int    $job_size        total number of units TO process
+	 * @type string $job_id          unique string identifying the job
+	 * @type string $update_text     string describing what happened during this step
+	 * } and any other items from $this->extra_data()
+	 */
+	public function to_array()
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
+			array_merge(
+				$this->extra_data(),
+				array(
+					'status'          => $this->job_parameters()->status(),
+					'units_processed' => $this->job_parameters()->units_processed(),
+					'job_size'        => $this->job_parameters()->job_size(),
+					'job_id'          => $this->job_parameters()->job_id(),
+					'update_text'     => $this->update_text(),
+				)
+			),
+			$this
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
     {
         $this->_job_parameters = $job_parameters;
         $this->_update_text = $update_text;
-        $this->_extra_data = (array)$extra_data;
+        $this->_extra_data = (array) $extra_data;
     }
 
 

core/libraries/batch/BatchRequestProcessor.php

Indentation +187 added lines, -187 removed lines

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

Spacing +8 added lines, -8 removed lines

@@ -54,7 +54,7 @@ 
             $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
             $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
             $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -66,7 +66,7 @@ 
                 );
             }
             $success = $this->_job_parameters->save(true);
-            if (! $success) {
+            if ( ! $success) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -102,7 +102,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
             // continue it
             $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -131,7 +131,7 @@ 
      */
     public function instantiate_batch_job_handler_from_classname($classname)
     {
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             throw new BatchRequestException(
                 sprintf(
                     __(
@@ -143,7 +143,7 @@ 
             );
         }
         $obj = new $classname;
-        if (! $obj instanceof JobHandlerInterface) {
+        if ( ! $obj instanceof JobHandlerInterface) {
             throw new BatchRequestException(
                 sprintf(
                     __(
@@ -173,7 +173,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
             // continue it
             $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -203,7 +203,7 @@ 
      */
     protected function _get_error_response(\Exception $exception, $method_name)
     {
-        if (! $this->_job_parameters instanceof JobParameters) {
+        if ( ! $this->_job_parameters instanceof JobParameters) {
             $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
         }
         $this->_job_parameters->set_status(JobParameters::status_error);
@@ -215,7 +215,7 @@ 
                     'event_espresso'
                 ),
                 get_class($exception),
-                'BatchRunner::' . $method_name . '()',
+                'BatchRunner::'.$method_name.'()',
                 $exception->getMessage(),
                 $exception->getTraceAsString()
             )

core/libraries/batch/JobHandlers/RegistrationsReport.php

Indentation +496 added lines, -496 removed lines

@@ -19,515 +19,515 @@
  */
 class RegistrationsReport extends JobHandlerFile
 {
-    // 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
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
-            throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            $this->get_filename($event_id)
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        if ($job_parameters->request_datum('use_filters', false)) {
-            $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
-        } else {
-            $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
-                array(
-                    'OR'                 => array(
-                        // don't include registrations from failed or abandoned transactions...
-                        'Transaction.STS_ID' => array(
-                            'NOT IN',
-                            array(
-                                \EEM_Transaction::failed_status_code,
-                                \EEM_Transaction::abandoned_status_code,
-                            ),
-                        ),
-                        // unless the registration is approved, in which case include it regardless of transaction status
-                        'STS_ID'             => \EEM_Registration::status_id_approved,
-                    ),
-                    'Ticket.TKT_deleted' => array('IN', array(true, false)),
-                ),
-                'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
-                'force_join' => array('Transaction', 'Ticket', 'Attendee'),
-                'caps'       => \EEM_Base::caps_read_admin,
-            ), $event_id);
-            if ($event_id) {
-                $query_params[0]['EVT_ID'] = $event_id;
-            } else {
-                $query_params['force_join'][] = 'Event';
-            }
-        }
-        if (! isset($query_params['force_join'])) {
-            $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
-        }
-        $job_parameters->add_extra_data('query_params', $query_params);
-        $question_labels = $this->_get_question_labels($query_params);
-        $job_parameters->add_extra_data('question_labels', $question_labels);
-        $job_parameters->set_job_size(
-            \EEM_Registration::instance()->count(
-                array_diff_key(
-                    $query_params,
-                    array_flip(
-                        array('limit')
-                    )
-                )
-            )
-        );
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data_for(
-            $event_id,
-            0,
-            1,
-            $job_parameters->extra_datum('question_labels'),
-            $job_parameters->extra_datum('query_params')
-        );
-        \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
-        // if we actually processed a row there, record it
-        if ($job_parameters->job_size()) {
-            $job_parameters->mark_processed(1);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            __('Registrations report started successfully...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 *
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+			throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			$this->get_filename($event_id)
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		if ($job_parameters->request_datum('use_filters', false)) {
+			$query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array())));
+		} else {
+			$query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(
+				array(
+					'OR'                 => array(
+						// don't include registrations from failed or abandoned transactions...
+						'Transaction.STS_ID' => array(
+							'NOT IN',
+							array(
+								\EEM_Transaction::failed_status_code,
+								\EEM_Transaction::abandoned_status_code,
+							),
+						),
+						// unless the registration is approved, in which case include it regardless of transaction status
+						'STS_ID'             => \EEM_Registration::status_id_approved,
+					),
+					'Ticket.TKT_deleted' => array('IN', array(true, false)),
+				),
+				'order_by'   => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'),
+				'force_join' => array('Transaction', 'Ticket', 'Attendee'),
+				'caps'       => \EEM_Base::caps_read_admin,
+			), $event_id);
+			if ($event_id) {
+				$query_params[0]['EVT_ID'] = $event_id;
+			} else {
+				$query_params['force_join'][] = 'Event';
+			}
+		}
+		if (! isset($query_params['force_join'])) {
+			$query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
+		}
+		$job_parameters->add_extra_data('query_params', $query_params);
+		$question_labels = $this->_get_question_labels($query_params);
+		$job_parameters->add_extra_data('question_labels', $question_labels);
+		$job_parameters->set_job_size(
+			\EEM_Registration::instance()->count(
+				array_diff_key(
+					$query_params,
+					array_flip(
+						array('limit')
+					)
+				)
+			)
+		);
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data_for(
+			$event_id,
+			0,
+			1,
+			$job_parameters->extra_datum('question_labels'),
+			$job_parameters->extra_datum('query_params')
+		);
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
+		// if we actually processed a row there, record it
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			__('Registrations report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    /**
-     * Gets the filename
-     *
-     * @return string
-     */
-    protected function get_filename()
-    {
-        return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql')));
-    }
+	/**
+	 * Gets the filename
+	 *
+	 * @return string
+	 */
+	protected function get_filename()
+	{
+		return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql')));
+	}
 
 
-    /**
-     * Gets the questions which are to be used for this report, so they
-     * can be remembered for later
-     *
-     * @param array $registration_query_params
-     * @return array question admin labels to be used for this report
-     */
-    protected function _get_question_labels($registration_query_params)
-    {
-        $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null;
-        $question_query_params = array();
-        if ($where !== null) {
-            $question_query_params = array(
-                $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
-            );
-        }
-        $question_query_params[0]['QST_system'] = array(
-            'NOT_IN',
-            array_keys(\EEM_Attendee::instance()->system_question_to_attendee_field_mapping()),
-        );
-        if (apply_filters(
-            'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
-            false,
-            $registration_query_params
-        )) {
-            $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL');
-        }
-        $question_query_params['group_by'] = array('QST_ID');
-        return array_unique(\EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
-    }
+	/**
+	 * Gets the questions which are to be used for this report, so they
+	 * can be remembered for later
+	 *
+	 * @param array $registration_query_params
+	 * @return array question admin labels to be used for this report
+	 */
+	protected function _get_question_labels($registration_query_params)
+	{
+		$where = isset($registration_query_params[0]) ? $registration_query_params[0] : null;
+		$question_query_params = array();
+		if ($where !== null) {
+			$question_query_params = array(
+				$this->_change_registration_where_params_to_question_where_params($registration_query_params[0]),
+			);
+		}
+		$question_query_params[0]['QST_system'] = array(
+			'NOT_IN',
+			array_keys(\EEM_Attendee::instance()->system_question_to_attendee_field_mapping()),
+		);
+		if (apply_filters(
+			'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions',
+			false,
+			$registration_query_params
+		)) {
+			$question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL');
+		}
+		$question_query_params['group_by'] = array('QST_ID');
+		return array_unique(\EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label'));
+	}
 
 
-    /**
-     * Takes where params meant for registrations and changes them to work for questions
-     *
-     * @param array $reg_where_params
-     * @return array
-     */
-    protected function _change_registration_where_params_to_question_where_params($reg_where_params)
-    {
-        $question_where_params = array();
-        foreach ($reg_where_params as $key => $val) {
-            if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
-                $question_where_params[$key] = $this->_change_registration_where_params_to_question_where_params($val);
-            } else {
-                // it's a normal where condition
-                $question_where_params['Question_Group.Event.Registration.' . $key] = $val;
-            }
-        }
-        return $question_where_params;
-    }
+	/**
+	 * Takes where params meant for registrations and changes them to work for questions
+	 *
+	 * @param array $reg_where_params
+	 * @return array
+	 */
+	protected function _change_registration_where_params_to_question_where_params($reg_where_params)
+	{
+		$question_where_params = array();
+		foreach ($reg_where_params as $key => $val) {
+			if (\EEM_Registration::instance()->is_logic_query_param_key($key)) {
+				$question_where_params[$key] = $this->_change_registration_where_params_to_question_where_params($val);
+			} else {
+				// it's a normal where condition
+				$question_where_params['Question_Group.Event.Registration.' . $key] = $val;
+			}
+		}
+		return $question_where_params;
+	}
 
 
-    /**
-     * Performs another step of the job
-     *
-     * @param JobParameters $job_parameters
-     * @param int           $batch_size
-     * @return JobStepResponse
-     * @throws \EE_Error
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        if ($job_parameters->units_processed() < $job_parameters->job_size()) {
-            $csv_data = $this->get_csv_data_for(
-                $job_parameters->request_datum('EVT_ID', '0'),
-                $job_parameters->units_processed(),
-                $batch_size,
-                $job_parameters->extra_datum('question_labels'),
-                $job_parameters->extra_datum('query_params')
-            );
-            \EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
-            $units_processed = count($csv_data);
-        } else {
-            $units_processed = 0;
-        }
-        $job_parameters->mark_processed($units_processed);
-        $extra_response_data = array(
-            'file_url' => '',
-        );
-        if ($units_processed < $batch_size) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-        }
+	/**
+	 * Performs another step of the job
+	 *
+	 * @param JobParameters $job_parameters
+	 * @param int           $batch_size
+	 * @return JobStepResponse
+	 * @throws \EE_Error
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		if ($job_parameters->units_processed() < $job_parameters->job_size()) {
+			$csv_data = $this->get_csv_data_for(
+				$job_parameters->request_datum('EVT_ID', '0'),
+				$job_parameters->units_processed(),
+				$batch_size,
+				$job_parameters->extra_datum('question_labels'),
+				$job_parameters->extra_datum('query_params')
+			);
+			\EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false);
+			$units_processed = count($csv_data);
+		} else {
+			$units_processed = 0;
+		}
+		$job_parameters->mark_processed($units_processed);
+		$extra_response_data = array(
+			'file_url' => '',
+		);
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+		}
 
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count($csv_data)),
-            $extra_response_data
-        );
-    }
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count($csv_data)),
+			$extra_response_data
+		);
+	}
 
 
-    /**
-     * Gets the csv data for a batch of registrations
-     *
-     * @param int|null $event_id
-     * @param int      $offset
-     * @param int      $limit
-     * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
-     * @param array    $query_params    for using where querying the model
-     * @return array top-level keys are numeric, next-level keys are column headers
-     */
-    public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
-    {
-        $reg_fields_to_include = array(
-            'TXN_ID',
-            'ATT_ID',
-            'REG_ID',
-            'REG_date',
-            'REG_code',
-            'REG_count',
-            'REG_final_price',
-        );
-        $att_fields_to_include = array(
-            'ATT_fname',
-            'ATT_lname',
-            'ATT_email',
-            'ATT_address',
-            'ATT_address2',
-            'ATT_city',
-            'STA_ID',
-            'CNT_ISO',
-            'ATT_zip',
-            'ATT_phone',
-        );
-        $registrations_csv_ready_array = array();
-        $reg_model = \EE_Registry::instance()->load_model('Registration');
-        $query_params['limit'] = array($offset, $limit);
-        $registration_rows = $reg_model->get_all_wpdb_results($query_params);
-        $registration_ids = array();
-        foreach ($registration_rows as $reg_row) {
-            $registration_ids[] = intval($reg_row['Registration.REG_ID']);
-        }
-        foreach ($registration_rows as $reg_row) {
-            if (is_array($reg_row)) {
-                $reg_csv_array = array();
-                if (! $event_id) {
-                    // get the event's name and Id
-                    $reg_csv_array[__('Event', 'event_espresso')] = sprintf(
-                        __('%1$s (%2$s)', 'event_espresso'),
-                        \EEH_Export::prepare_value_from_db_for_display(
-                            \EEM_Event::instance(),
-                            'EVT_name',
-                            $reg_row['Event_CPT.post_title']
-                        ),
-                        $reg_row['Event_CPT.ID']
-                    );
-                }
-                $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
-                /*@var $reg_row EE_Registration */
-                foreach ($reg_fields_to_include as $field_name) {
-                    $field = $reg_model->field_settings_for($field_name);
-                    if ($field_name == 'REG_final_price') {
-                        $value = \EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_final_price'],
-                            'localized_float'
-                        );
-                    } elseif ($field_name == 'REG_count') {
-                        $value = sprintf(
-                            __('%1$s of %2$s', 'event_espresso'),
-                            \EEH_Export::prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_count',
-                                $reg_row['Registration.REG_count']
-                            ),
-                            \EEH_Export::prepare_value_from_db_for_display(
-                                $reg_model,
-                                'REG_group_size',
-                                $reg_row['Registration.REG_group_size']
-                            )
-                        );
-                    } elseif ($field_name == 'REG_date') {
-                        $value = \EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row['Registration.REG_date'],
-                            'no_html'
-                        );
-                    } else {
-                        $value = \EEH_Export::prepare_value_from_db_for_display(
-                            $reg_model,
-                            $field_name,
-                            $reg_row[$field->get_qualified_column()]
-                        );
-                    }
-                    $reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = $value;
-                    if ($field_name == 'REG_final_price') {
-                        // add a column named Currency after the final price
-                        $reg_csv_array[__("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
-                    }
-                }
-                // get pretty status
-                $stati = \EEM_Status::instance()->localized_status(array(
-                    $reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
-                    $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
-                ), false, 'sentence');
-                $reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
-                // get pretty transaction status
-                $reg_csv_array[__("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
-                $reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
-                    ? \EEH_Export::prepare_value_from_db_for_display(
-                        \EEM_Transaction::instance(),
-                        'TXN_total',
-                        $reg_row['TransactionTable.TXN_total'],
-                        'localized_float'
-                    ) : '0.00';
-                $reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg
-                    ? \EEH_Export::prepare_value_from_db_for_display(
-                        \EEM_Transaction::instance(),
-                        'TXN_paid',
-                        $reg_row['TransactionTable.TXN_paid'],
-                        'localized_float'
-                    ) : '0.00';
-                $payment_methods = array();
-                $gateway_txn_ids_etc = array();
-                $payment_times = array();
-                if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
-                    $payments_info = \EEM_Payment::instance()->get_all_wpdb_results(
-                        array(
-                            array(
-                                'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
-                                'STS_ID' => \EEM_Payment::status_id_approved,
-                            ),
-                            'force_join' => array('Payment_Method'),
-                        ),
-                        ARRAY_A,
-                        'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
-                    );
-                    foreach ($payments_info as $payment_method_and_gateway_txn_id) {
-                        $payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
-                            ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
-                        $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
-                            ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
-                        $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
-                            ? $payment_method_and_gateway_txn_id['payment_time'] : '';
-                    }
-                }
-                $reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
-                $reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
-                $reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(',', $gateway_txn_ids_etc);
-                // get whether or not the user has checked in
-                $reg_csv_array[__("Check-Ins", "event_espresso")] = $reg_model->count_related(
-                    $reg_row['Registration.REG_ID'],
-                    'Checkin'
-                );
-                // get ticket of registration and its price
-                $ticket_model = \EE_Registry::instance()->load_model('Ticket');
-                if ($reg_row['Ticket.TKT_ID']) {
-                    $ticket_name = \EEH_Export::prepare_value_from_db_for_display(
-                        $ticket_model,
-                        'TKT_name',
-                        $reg_row['Ticket.TKT_name']
-                    );
-                    $datetimes_strings = array();
-                    foreach (\EEM_Datetime::instance()->get_all_wpdb_results(
-                        array(
-                            array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
-                            'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                            'default_where_conditions' => 'none',
-                        )
-                    ) as $datetime) {
-                        $datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display(
-                            \EEM_Datetime::instance(),
-                            'DTT_EVT_start',
-                            $datetime['Datetime.DTT_EVT_start']
-                        );
-                    }
-                } else {
-                    $ticket_name = __('Unknown', 'event_espresso');
-                    $datetimes_strings = array(__('Unknown', 'event_espresso'));
-                }
-                $reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
-                $reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
-                // get datetime(s) of registration
-                // add attendee columns
-                foreach ($att_fields_to_include as $att_field_name) {
-                    $field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name);
-                    if ($reg_row['Attendee_CPT.ID']) {
-                        if ($att_field_name == 'STA_ID') {
-                            $value = \EEM_State::instance()->get_var(
-                                array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
-                                'STA_name'
-                            );
-                        } elseif ($att_field_name == 'CNT_ISO') {
-                            $value = \EEM_Country::instance()->get_var(
-                                array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
-                                'CNT_name'
-                            );
-                        } else {
-                            $value = \EEH_Export::prepare_value_from_db_for_display(
-                                \EEM_Attendee::instance(),
-                                $att_field_name,
-                                $reg_row[$field_obj->get_qualified_column()]
-                            );
-                        }
-                    } else {
-                        $value = '';
-                    }
-                    $reg_csv_array[\EEH_Export::get_column_name_for_field($field_obj)] = $value;
-                }
-                // make sure each registration has the same questions in the same order
-                foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[$question_label])) {
-                        $reg_csv_array[$question_label] = null;
-                    }
-                }
-                $answers = \EEM_Answer::instance()->get_all_wpdb_results(array(
-                    array('REG_ID' => $reg_row['Registration.REG_ID']),
-                    'force_join' => array('Question'),
-                ));
-                // now fill out the questions THEY answered
-                foreach ($answers as $answer_row) {
-                    if ($answer_row['Question.QST_ID']) {
-                        $question_label = \EEH_Export::prepare_value_from_db_for_display(
-                            \EEM_Question::instance(),
-                            'QST_admin_label',
-                            $answer_row['Question.QST_admin_label']
-                        );
-                    } else {
-                        $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
-                    }
-                    if (isset($answer_row['Question.QST_type'])
-                        && $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state
-                    ) {
-                        $reg_csv_array[$question_label] = \EEM_State::instance()->get_state_name_by_ID(
-                            $answer_row['Answer.ANS_value']
-                        );
-                    } else {
-                        // this isn't for html, so don't show html entities
-                        $reg_csv_array[$question_label] = html_entity_decode(
-                            \EEH_Export::prepare_value_from_db_for_display(
-                                \EEM_Answer::instance(),
-                                'ANS_value',
-                                $answer_row['Answer.ANS_value']
-                            )
-                        );
-                    }
-                }
-                /**
-                 * Filter to change the contents of each row of the registrations report CSV file.
-                 * This can be used to add or remote columns from the CSV file, or change their values.                 *
-                 * Note: it has this name because originally that's where this filter resided,
-                 * and we've left its name as-is for backward compatibility.
-                 * Note when using: all rows in the CSV should have the same columns.
-                 *
-                 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
-                 *                             in this row
-                 * @param array $reg_row       is the row from the database's wp_esp_registration table
-                 */
-                $registrations_csv_ready_array[] = apply_filters(
-                    'FHEE__EE_Export__report_registrations__reg_csv_array',
-                    $reg_csv_array,
-                    $reg_row
-                );
-            }
-        }
-        // if we couldn't export anything, we want to at least show the column headers
-        if (empty($registrations_csv_ready_array)) {
-            $reg_csv_array = array();
-            $model_and_fields_to_include = array(
-                'Registration' => $reg_fields_to_include,
-                'Attendee'     => $att_fields_to_include,
-            );
-            foreach ($model_and_fields_to_include as $model_name => $field_list) {
-                $model = \EE_Registry::instance()->load_model($model_name);
-                foreach ($field_list as $field_name) {
-                    $field = $model->field_settings_for($field_name);
-                    $reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = null;
-                }
-            }
-            $registrations_csv_ready_array[] = $reg_csv_array;
-        }
-        return $registrations_csv_ready_array;
-    }
+	/**
+	 * Gets the csv data for a batch of registrations
+	 *
+	 * @param int|null $event_id
+	 * @param int      $offset
+	 * @param int      $limit
+	 * @param array    $question_labels the IDs for all the questions which were answered by someone in this selection
+	 * @param array    $query_params    for using where querying the model
+	 * @return array top-level keys are numeric, next-level keys are column headers
+	 */
+	public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params)
+	{
+		$reg_fields_to_include = array(
+			'TXN_ID',
+			'ATT_ID',
+			'REG_ID',
+			'REG_date',
+			'REG_code',
+			'REG_count',
+			'REG_final_price',
+		);
+		$att_fields_to_include = array(
+			'ATT_fname',
+			'ATT_lname',
+			'ATT_email',
+			'ATT_address',
+			'ATT_address2',
+			'ATT_city',
+			'STA_ID',
+			'CNT_ISO',
+			'ATT_zip',
+			'ATT_phone',
+		);
+		$registrations_csv_ready_array = array();
+		$reg_model = \EE_Registry::instance()->load_model('Registration');
+		$query_params['limit'] = array($offset, $limit);
+		$registration_rows = $reg_model->get_all_wpdb_results($query_params);
+		$registration_ids = array();
+		foreach ($registration_rows as $reg_row) {
+			$registration_ids[] = intval($reg_row['Registration.REG_ID']);
+		}
+		foreach ($registration_rows as $reg_row) {
+			if (is_array($reg_row)) {
+				$reg_csv_array = array();
+				if (! $event_id) {
+					// get the event's name and Id
+					$reg_csv_array[__('Event', 'event_espresso')] = sprintf(
+						__('%1$s (%2$s)', 'event_espresso'),
+						\EEH_Export::prepare_value_from_db_for_display(
+							\EEM_Event::instance(),
+							'EVT_name',
+							$reg_row['Event_CPT.post_title']
+						),
+						$reg_row['Event_CPT.ID']
+					);
+				}
+				$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
+				/*@var $reg_row EE_Registration */
+				foreach ($reg_fields_to_include as $field_name) {
+					$field = $reg_model->field_settings_for($field_name);
+					if ($field_name == 'REG_final_price') {
+						$value = \EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_final_price'],
+							'localized_float'
+						);
+					} elseif ($field_name == 'REG_count') {
+						$value = sprintf(
+							__('%1$s of %2$s', 'event_espresso'),
+							\EEH_Export::prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_count',
+								$reg_row['Registration.REG_count']
+							),
+							\EEH_Export::prepare_value_from_db_for_display(
+								$reg_model,
+								'REG_group_size',
+								$reg_row['Registration.REG_group_size']
+							)
+						);
+					} elseif ($field_name == 'REG_date') {
+						$value = \EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row['Registration.REG_date'],
+							'no_html'
+						);
+					} else {
+						$value = \EEH_Export::prepare_value_from_db_for_display(
+							$reg_model,
+							$field_name,
+							$reg_row[$field->get_qualified_column()]
+						);
+					}
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = $value;
+					if ($field_name == 'REG_final_price') {
+						// add a column named Currency after the final price
+						$reg_csv_array[__("Currency", "event_espresso")] = \EE_Config::instance()->currency->code;
+					}
+				}
+				// get pretty status
+				$stati = \EEM_Status::instance()->localized_status(array(
+					$reg_row['Registration.STS_ID']     => __('unknown', 'event_espresso'),
+					$reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'),
+				), false, 'sentence');
+				$reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
+				// get pretty transaction status
+				$reg_csv_array[__("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
+				$reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg
+					? \EEH_Export::prepare_value_from_db_for_display(
+						\EEM_Transaction::instance(),
+						'TXN_total',
+						$reg_row['TransactionTable.TXN_total'],
+						'localized_float'
+					) : '0.00';
+				$reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg
+					? \EEH_Export::prepare_value_from_db_for_display(
+						\EEM_Transaction::instance(),
+						'TXN_paid',
+						$reg_row['TransactionTable.TXN_paid'],
+						'localized_float'
+					) : '0.00';
+				$payment_methods = array();
+				$gateway_txn_ids_etc = array();
+				$payment_times = array();
+				if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
+					$payments_info = \EEM_Payment::instance()->get_all_wpdb_results(
+						array(
+							array(
+								'TXN_ID' => $reg_row['TransactionTable.TXN_ID'],
+								'STS_ID' => \EEM_Payment::status_id_approved,
+							),
+							'force_join' => array('Payment_Method'),
+						),
+						ARRAY_A,
+						'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time'
+					);
+					foreach ($payments_info as $payment_method_and_gateway_txn_id) {
+						$payment_methods[] = isset($payment_method_and_gateway_txn_id['name'])
+							? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
+						$gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id'])
+							? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
+						$payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time'])
+							? $payment_method_and_gateway_txn_id['payment_time'] : '';
+					}
+				}
+				$reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
+				$reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
+				$reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(',', $gateway_txn_ids_etc);
+				// get whether or not the user has checked in
+				$reg_csv_array[__("Check-Ins", "event_espresso")] = $reg_model->count_related(
+					$reg_row['Registration.REG_ID'],
+					'Checkin'
+				);
+				// get ticket of registration and its price
+				$ticket_model = \EE_Registry::instance()->load_model('Ticket');
+				if ($reg_row['Ticket.TKT_ID']) {
+					$ticket_name = \EEH_Export::prepare_value_from_db_for_display(
+						$ticket_model,
+						'TKT_name',
+						$reg_row['Ticket.TKT_name']
+					);
+					$datetimes_strings = array();
+					foreach (\EEM_Datetime::instance()->get_all_wpdb_results(
+						array(
+							array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']),
+							'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+							'default_where_conditions' => 'none',
+						)
+					) as $datetime) {
+						$datetimes_strings[] = \EEH_Export::prepare_value_from_db_for_display(
+							\EEM_Datetime::instance(),
+							'DTT_EVT_start',
+							$datetime['Datetime.DTT_EVT_start']
+						);
+					}
+				} else {
+					$ticket_name = __('Unknown', 'event_espresso');
+					$datetimes_strings = array(__('Unknown', 'event_espresso'));
+				}
+				$reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
+				$reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
+				// get datetime(s) of registration
+				// add attendee columns
+				foreach ($att_fields_to_include as $att_field_name) {
+					$field_obj = \EEM_Attendee::instance()->field_settings_for($att_field_name);
+					if ($reg_row['Attendee_CPT.ID']) {
+						if ($att_field_name == 'STA_ID') {
+							$value = \EEM_State::instance()->get_var(
+								array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])),
+								'STA_name'
+							);
+						} elseif ($att_field_name == 'CNT_ISO') {
+							$value = \EEM_Country::instance()->get_var(
+								array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])),
+								'CNT_name'
+							);
+						} else {
+							$value = \EEH_Export::prepare_value_from_db_for_display(
+								\EEM_Attendee::instance(),
+								$att_field_name,
+								$reg_row[$field_obj->get_qualified_column()]
+							);
+						}
+					} else {
+						$value = '';
+					}
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field_obj)] = $value;
+				}
+				// make sure each registration has the same questions in the same order
+				foreach ($question_labels as $question_label) {
+					if (! isset($reg_csv_array[$question_label])) {
+						$reg_csv_array[$question_label] = null;
+					}
+				}
+				$answers = \EEM_Answer::instance()->get_all_wpdb_results(array(
+					array('REG_ID' => $reg_row['Registration.REG_ID']),
+					'force_join' => array('Question'),
+				));
+				// now fill out the questions THEY answered
+				foreach ($answers as $answer_row) {
+					if ($answer_row['Question.QST_ID']) {
+						$question_label = \EEH_Export::prepare_value_from_db_for_display(
+							\EEM_Question::instance(),
+							'QST_admin_label',
+							$answer_row['Question.QST_admin_label']
+						);
+					} else {
+						$question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
+					}
+					if (isset($answer_row['Question.QST_type'])
+						&& $answer_row['Question.QST_type'] == \EEM_Question::QST_type_state
+					) {
+						$reg_csv_array[$question_label] = \EEM_State::instance()->get_state_name_by_ID(
+							$answer_row['Answer.ANS_value']
+						);
+					} else {
+						// this isn't for html, so don't show html entities
+						$reg_csv_array[$question_label] = html_entity_decode(
+							\EEH_Export::prepare_value_from_db_for_display(
+								\EEM_Answer::instance(),
+								'ANS_value',
+								$answer_row['Answer.ANS_value']
+							)
+						);
+					}
+				}
+				/**
+				 * Filter to change the contents of each row of the registrations report CSV file.
+				 * This can be used to add or remote columns from the CSV file, or change their values.                 *
+				 * Note: it has this name because originally that's where this filter resided,
+				 * and we've left its name as-is for backward compatibility.
+				 * Note when using: all rows in the CSV should have the same columns.
+				 *
+				 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
+				 *                             in this row
+				 * @param array $reg_row       is the row from the database's wp_esp_registration table
+				 */
+				$registrations_csv_ready_array[] = apply_filters(
+					'FHEE__EE_Export__report_registrations__reg_csv_array',
+					$reg_csv_array,
+					$reg_row
+				);
+			}
+		}
+		// if we couldn't export anything, we want to at least show the column headers
+		if (empty($registrations_csv_ready_array)) {
+			$reg_csv_array = array();
+			$model_and_fields_to_include = array(
+				'Registration' => $reg_fields_to_include,
+				'Attendee'     => $att_fields_to_include,
+			);
+			foreach ($model_and_fields_to_include as $model_name => $field_list) {
+				$model = \EE_Registry::instance()->load_model($model_name);
+				foreach ($field_list as $field_name) {
+					$field = $model->field_settings_for($field_name);
+					$reg_csv_array[\EEH_Export::get_column_name_for_field($field)] = null;
+				}
+			}
+			$registrations_csv_ready_array[] = $reg_csv_array;
+		}
+		return $registrations_csv_ready_array;
+	}
 
 
-    /**
-     * Counts total unit to process
-     *
-     * @deprecated since 4.9.19
-     * @param int|array $event_id
-     * @return int
-     */
-    public function count_units_to_process($event_id)
-    {
-        // use the legacy filter
-        if ($event_id) {
-            $query_params[0]['EVT_ID'] = $event_id;
-        } else {
-            $query_params['force_join'][] = 'Event';
-        }
-        return \EEM_Registration::instance()->count($query_params);
-    }
+	/**
+	 * Counts total unit to process
+	 *
+	 * @deprecated since 4.9.19
+	 * @param int|array $event_id
+	 * @return int
+	 */
+	public function count_units_to_process($event_id)
+	{
+		// use the legacy filter
+		if ($event_id) {
+			$query_params[0]['EVT_ID'] = $event_id;
+		} else {
+			$query_params['force_join'][] = 'Event';
+		}
+		return \EEM_Registration::instance()->count($query_params);
+	}
 
 
-    /**
-     * Performs any clean-up logic when we know the job is completed.
-     * In this case, we delete the temporary file
-     *
-     * @param JobParameters $job_parameters
-     * @return boolean
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->_file_helper->delete(
-            \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
-    }
+	/**
+	 * Performs any clean-up logic when we know the job is completed.
+	 * In this case, we delete the temporary file
+	 *
+	 * @param JobParameters $job_parameters
+	 * @return boolean
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->_file_helper->delete(
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -32,7 +32,7 @@ 
     public function create_job(JobParameters $job_parameters)
     {
         $event_id = intval($job_parameters->request_datum('EVT_ID', '0'));
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
+        if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) {
             throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso'));
         }
         $filepath = $this->create_file_from_job_with_name(
@@ -69,7 +69,7 @@ 
                 $query_params['force_join'][] = 'Event';
             }
         }
-        if (! isset($query_params['force_join'])) {
+        if ( ! isset($query_params['force_join'])) {
             $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee');
         }
         $job_parameters->add_extra_data('query_params', $query_params);
@@ -162,7 +162,7 @@ 
                 $question_where_params[$key] = $this->_change_registration_where_params_to_question_where_params($val);
             } else {
                 // it's a normal where condition
-                $question_where_params['Question_Group.Event.Registration.' . $key] = $val;
+                $question_where_params['Question_Group.Event.Registration.'.$key] = $val;
             }
         }
         return $question_where_params;
@@ -253,7 +253,7 @@ 
         foreach ($registration_rows as $reg_row) {
             if (is_array($reg_row)) {
                 $reg_csv_array = array();
-                if (! $event_id) {
+                if ( ! $event_id) {
                     // get the event's name and Id
                     $reg_csv_array[__('Event', 'event_espresso')] = sprintf(
                         __('%1$s (%2$s)', 'event_espresso'),
@@ -421,7 +421,7 @@ 
                 }
                 // make sure each registration has the same questions in the same order
                 foreach ($question_labels as $question_label) {
-                    if (! isset($reg_csv_array[$question_label])) {
+                    if ( ! isset($reg_csv_array[$question_label])) {
                         $reg_csv_array[$question_label] = null;
                     }
                 }

core/libraries/batch/JobHandlers/DatetimeOffsetFix.php

Indentation +466 added lines, -466 removed lines

@@ -24,470 +24,470 @@
 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 $models_with_datetime_fields = array();
-
-    // 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
-     */
-    public function create_job(JobParameters $job_parameters)
-    {
-        $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
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $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
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        // 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
-     */
-    protected function processModel($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;
-        $date_ranges = array();
-        // 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 = array();
-            $inner_query = array();
-            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 edgecases where last_error might be empty.
-                    if (! $error_message) {
-                        $error_message = esc_html__('Unknown mysql error occured.', '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, array($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($query, array $inner_query, $start_date_range, $end_date_range)
-    {
-        global $wpdb;
-        $errors = array();
-        foreach ($inner_query as $field_name => $field_query) {
-            $query_to_run = $query;
-            $where_conditions = array();
-            $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($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 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
-     */
-    private function recordChangeLog(
-        EEM_Base $model,
-        $offset,
-        EE_Table_Base $table,
-        $model_fields_affected,
-        $error_message = ''
-    ) {
-        // setup $fields list.
-        $fields = array();
-        /** @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(array(
-            '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
-     */
-    private function getModelsWithDatetimeFields()
-    {
-        $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($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 $count
-     */
-    private function updateCountOfModelsProcessed($count = 1)
-    {
-        $count = $this->getCountOfModelsProcessed() + (int)$count;
-        update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
-    }
-
-
-    /**
-     * Retrieve the tracked number of models processed between requests.
-     *
-     * @return int
-     */
-    private function getCountOfModelsProcessed()
-    {
-        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()
-    {
-        if (empty($this->models_with_datetime_fields)) {
-            $this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
-        }
-        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($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()
-    {
-        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()
-    {
-        $start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, 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()
-    {
-        $end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, 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 $models_with_datetime_fields = array();
+
+	// 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
+	 */
+	public function create_job(JobParameters $job_parameters)
+	{
+		$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
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$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
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		// 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
+	 */
+	protected function processModel($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;
+		$date_ranges = array();
+		// 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 = array();
+			$inner_query = array();
+			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 edgecases where last_error might be empty.
+					if (! $error_message) {
+						$error_message = esc_html__('Unknown mysql error occured.', '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, array($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($query, array $inner_query, $start_date_range, $end_date_range)
+	{
+		global $wpdb;
+		$errors = array();
+		foreach ($inner_query as $field_name => $field_query) {
+			$query_to_run = $query;
+			$where_conditions = array();
+			$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($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 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
+	 */
+	private function recordChangeLog(
+		EEM_Base $model,
+		$offset,
+		EE_Table_Base $table,
+		$model_fields_affected,
+		$error_message = ''
+	) {
+		// setup $fields list.
+		$fields = array();
+		/** @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(array(
+			'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
+	 */
+	private function getModelsWithDatetimeFields()
+	{
+		$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($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 $count
+	 */
+	private function updateCountOfModelsProcessed($count = 1)
+	{
+		$count = $this->getCountOfModelsProcessed() + (int)$count;
+		update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
+	}
+
+
+	/**
+	 * Retrieve the tracked number of models processed between requests.
+	 *
+	 * @return int
+	 */
+	private function getCountOfModelsProcessed()
+	{
+		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()
+	{
+		if (empty($this->models_with_datetime_fields)) {
+			$this->models_with_datetime_fields = get_option(self::MODELS_TO_PROCESS_OPTION_KEY, array());
+		}
+		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($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()
+	{
+		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()
+	{
+		$start_date = get_option(self::OPTION_KEY_OFFSET_RANGE_START_DATE, 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()
+	{
+		$end_date = get_option(self::OPTION_KEY_OFFSET_RANGE_END_DATE, 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 +14 added lines, -14 removed lines

@@ -159,19 +159,19 @@ 
         $date_ranges = array();
         // 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 = array();
             $inner_query = array();
             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;
                 }
             }
-            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
@@ -188,7 +188,7 @@ 
                     // 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');
                     }
                     $this->recordChangeLog($model, $original_offset, $table, $fields_affected, $error_message);
@@ -221,7 +221,7 @@ 
         foreach ($inner_query as $field_name => $field_query) {
             $query_to_run = $query;
             $where_conditions = array();
-            $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}'";
@@ -231,14 +231,14 @@ 
                 $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;
@@ -258,7 +258,7 @@ 
     private function doQueryForAllFields($query, array $inner_query)
     {
         global $wpdb;
-        $query .= ' SET ' . implode(',', $inner_query);
+        $query .= ' SET '.implode(',', $inner_query);
         return $wpdb->query($query);
     }
 
@@ -284,7 +284,7 @@ 
         $fields = array();
         /** @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();
@@ -336,7 +336,7 @@ 
     private function getModelsWithDatetimeFields()
     {
         $this->getModelsToProcess();
-        if (! empty($this->models_with_datetime_fields)) {
+        if ( ! empty($this->models_with_datetime_fields)) {
             return $this->models_with_datetime_fields;
         }
 
@@ -372,7 +372,7 @@ 
      */
     private function updateCountOfModelsProcessed($count = 1)
     {
-        $count = $this->getCountOfModelsProcessed() + (int)$count;
+        $count = $this->getCountOfModelsProcessed() + (int) $count;
         update_option(self::COUNT_OF_MODELS_PROCESSED, $count);
     }
 
@@ -384,7 +384,7 @@ 
      */
     private function getCountOfModelsProcessed()
     {
-        return (int)get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
+        return (int) get_option(self::COUNT_OF_MODELS_PROCESSED, 0);
     }
 
 
@@ -420,7 +420,7 @@ 
      */
     public static function getOffset()
     {
-        return (float)get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
+        return (float) get_option(self::OFFSET_TO_APPLY_OPTION_KEY, 0);
     }