eventespresso / event-espresso-core

core/libraries/batch/Helpers/JobStepResponse.php

Indentation +99 added lines, -99 removed lines

@@ -14,107 +14,107 @@
 class JobStepResponse
 {
 	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    /**
-     * Description fo what happened during this step
-     *
-     * @var array|string
-     */
-    protected $_update_text;
-
-    /**
-     * @var JobParameters
-     */
-    protected $_job_parameters;
-
-    /**
-     * Extra data to include as part of the response.
-     *
-     * @var array
-     */
-    protected $_extra_data = [];
+	/**
+	 * Description fo what happened during this step
+	 *
+	 * @var array|string
+	 */
+	protected $_update_text;
+
+	/**
+	 * @var JobParameters
+	 */
+	protected $_job_parameters;
+
+	/**
+	 * Extra data to include as part of the response.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data = [];
 
 	// phpcs:enable
 
 	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * @param JobParameters $job_parameters
-     * @param array|string  $update_text
-     * @param array         $extra_data
-     */
-    public function __construct(JobParameters $job_parameters, $update_text = [], array $extra_data = [])
-    {
-        $this->_job_parameters = $job_parameters;
-        $this->_update_text    = (array) $update_text;
-        $this->_extra_data     = $extra_data;
-    }
-
-
-    /**
-     * @return JobParameters
-     */
-    public function job_parameters(): JobParameters
-    {
-        return $this->_job_parameters;
-    }
-
-
-    /**
-     * Gets the update_text of what happened in this job during the current step
-     *
-     * @return string
-     */
-    public function update_text(): string
-    {
-        return implode('', array_filter(array_map('trim', $this->_update_text)));
-    }
-
-
-    /**
-     * @param string $update_text
-     */
-    public function addUpdateText(string $update_text)
-    {
-        $this->_update_text[] = $update_text;
-    }
-
-
-    /**
-     * Returns any extra data we may want to include with this response
-     *
-     * @return array
-     */
-    public function extra_data(): array
-    {
-        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(): array
-    {
-        return apply_filters(
-            'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
-            [
-                '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->extra_data()
-            + $this->job_parameters()->extra_data(),
-            $this
-        );
-    }
+	/**
+	 * @param JobParameters $job_parameters
+	 * @param array|string  $update_text
+	 * @param array         $extra_data
+	 */
+	public function __construct(JobParameters $job_parameters, $update_text = [], array $extra_data = [])
+	{
+		$this->_job_parameters = $job_parameters;
+		$this->_update_text    = (array) $update_text;
+		$this->_extra_data     = $extra_data;
+	}
+
+
+	/**
+	 * @return JobParameters
+	 */
+	public function job_parameters(): JobParameters
+	{
+		return $this->_job_parameters;
+	}
+
+
+	/**
+	 * Gets the update_text of what happened in this job during the current step
+	 *
+	 * @return string
+	 */
+	public function update_text(): string
+	{
+		return implode('', array_filter(array_map('trim', $this->_update_text)));
+	}
+
+
+	/**
+	 * @param string $update_text
+	 */
+	public function addUpdateText(string $update_text)
+	{
+		$this->_update_text[] = $update_text;
+	}
+
+
+	/**
+	 * Returns any extra data we may want to include with this response
+	 *
+	 * @return array
+	 */
+	public function extra_data(): array
+	{
+		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(): array
+	{
+		return apply_filters(
+			'FHEE__EventEspressoBatchRequest\Helpers\JobStepResponse__to_array__return',
+			[
+				'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->extra_data()
+			+ $this->job_parameters()->extra_data(),
+			$this
+		);
+	}
 }

core/libraries/batch/Helpers/JobParametersWordPressOption.php

Indentation +4 added lines, -4 removed lines

@@ -6,8 +6,8 @@
 
 class JobParametersWordPressOption extends WordPressOption
 {
-    public function __construct($option_name)
-    {
-        parent::__construct($option_name, [], false);
-    }
+	public function __construct($option_name)
+	{
+		parent::__construct($option_name, [], false);
+	}
 }

core/libraries/batch/Helpers/JobParameters.php

Indentation +438 added lines, -438 removed lines

@@ -21,442 +21,442 @@
 	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
 
 
-    /**
-     * status indicating the job should advance to a secondary batch job (usually after an assessment phase)
-     */
-    const status_advance = 'advance';
-
-    /**
-     * 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';
-
-    /**
-     * 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 to temporarily stop the current job
-     * so that feedback can be provided to the user and/or to prompt the user for input
-     */
-    const status_pause = 'pause';
-
-    /**
-     * status indicating that the current job needs to redirect to... somewhere else...
-     */
-    const status_redirect = 'redirect';
-
-    /**
-     * string prepended to job ID and used for saving job data to the WP options table
-     */
-    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;
-
-
-    /**
-     * @var JobParametersWordPressOption|null
-     */
-    private $job_record;
-
-    /**
-     * if set to false, then the job parameters record saved to the WordPress options will NOT be deleted
-     *
-     * @var bool
-     */
-    protected $delete_job_record = false;
-
-
-    /**
-     * @param string $job_id
-     * @param string $classname
-     * @param array  $request_data
-     * @param array  $extra_data
-     */
-    public function __construct(string $job_id, string $classname, array $request_data, array $extra_data = [])
-    {
-        $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);
-        $this->job_record = new JobParametersWordPressOption($this->option_name());
-    }
-
-
-    /**
-     * Returns the array of strings of valid stati
-     *
-     * @return array
-     */
-    public static function valid_stati(): array
-    {
-        return [
-            JobParameters::status_complete,
-            JobParameters::status_continue,
-            JobParameters::status_error,
-            JobParameters::status_cleaned_up,
-        ];
-    }
-
-
-    /**
-     * Saves this option to the database (wordpress options table)
-     *
-     * @return bool success
-     */
-    public function save(): bool
-    {
-        $object_vars = get_object_vars($this);
-        unset($object_vars['job_record']);
-        return $this->job_record->updateOption($object_vars);
-    }
-
-
-    /**
-     * Deletes the job from the database if $this->delete_job_record is set to `true`,
-     * although this object is still usable for the rest of the request
-     *
-     * @return bool
-     */
-    public function delete(): bool
-    {
-        return $this->delete_job_record ? $this->job_record->deleteOption() : WordPressOption::UPDATE_NONE;
-    }
-
-
-    /**
-     * Loads the specified job from the database JobParametersWordPressOption
-     *
-     * @param string $job_id
-     * @return JobParameters
-     * @throws BatchRequestException
-     */
-    public static function load(string $job_id): JobParameters
-    {
-        $job_record         = new JobParametersWordPressOption(JobParameters::wp_option_prefix . $job_id);
-        $job_parameter_vars = $job_record->loadOption();
-        if (
-            ! is_array($job_parameter_vars)
-            || ! isset($job_parameter_vars['_classname'])
-            || ! isset($job_parameter_vars['_request_data'])
-        ) {
-            throw new BatchRequestException(
-                sprintf(
-                    esc_html__(
-                        'Could not retrieve valid data for job %1$s from the WordPress options table. The WordPress option was %2$s',
-                        'event_espresso'
-                    ),
-                    $job_id,
-                    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;
-        }
-        $job_parameters->job_record = $job_record;
-        // $job_parameters->save();
-        return $job_parameters;
-    }
-
-
-    /**
-     * Gets the job's unique string
-     *
-     * @return string
-     */
-    public function job_id(): string
-    {
-        return $this->_job_id;
-    }
-
-
-    /**
-     * Gets the classname that should run this job
-     *
-     * @return string
-     */
-    public function classname(): string
-    {
-        return $this->_classname;
-    }
-
-
-    /**
-     * Gets the original array of request data for this job
-     *
-     * @return array
-     */
-    public function request_data(): array
-    {
-        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(string $key, $default = '')
-    {
-        if (isset($this->_request_data[ $key ])) {
-            return $this->_request_data[ $key ];
-        }
-        return $default;
-    }
-
-
-    /**
-     * Gets a single item from the extra data
-     *
-     * @param string       $key
-     * @param string|array $default
-     * @return string|array
-     */
-    public function extra_datum(string $key, $default = '')
-    {
-        if (isset($this->_extra_data[ $key ])) {
-            return $this->_extra_data[ $key ];
-        }
-        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(string $key, $value)
-    {
-        $this->_extra_data[ $key ] = $value;
-    }
-
-
-    /**
-     * Array of any extra data we want to store
-     *
-     * @return array
-     */
-    public function extra_data(): array
-    {
-        return $this->_extra_data;
-    }
-
-
-    /**
-     * Returns the job size, in whatever units you want
-     *
-     * @return int
-     */
-    public function job_size(): int
-    {
-        return $this->_job_size;
-    }
-
-
-    /**
-     * Sets the job size. You decide what units to use
-     *
-     * @param int $size
-     */
-    public function set_job_size(int $size)
-    {
-        $this->_job_size = $size;
-    }
-
-
-    /**
-     * The number of "units" processed, in the same units as the "job size"
-     *
-     * @return int
-     */
-    public function units_processed(): int
-    {
-        return $this->_units_processed;
-    }
-
-
-    /**
-     * Marks more units as processed
-     *
-     * @param int $newly_processed
-     * @return int updated units processed
-     */
-    public function mark_processed(int $newly_processed): int
-    {
-        $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(int $total_units_processed)
-    {
-        $this->_units_processed = $total_units_processed;
-    }
-
-
-    /**
-     * Sets the job's ID
-     *
-     * @param string $job_id
-     */
-    public function set_job_id(string $job_id)
-    {
-        $this->_job_id = $job_id;
-    }
-
-
-    /**
-     * sets the classname
-     *
-     * @param string $classname
-     */
-    public function set_classname(string $classname)
-    {
-        $this->_classname = $classname;
-    }
-
-
-    /**
-     * Sets the request data
-     *
-     * @param array $request_data
-     */
-    public function set_request_data(array $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(array $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(): string
-    {
-        return JobParameters::wp_option_prefix . $this->job_id();
-    }
-
-
-    /**
-     * Gets the job's current status. One of JobParameters::valid_stati();
-     *
-     * @return string
-     */
-    public function status(): string
-    {
-        return $this->_status;
-    }
-
-
-    /**
-     * @param string $status on eof JobParameters::valid_stati()
-     */
-    public function set_status(string $status)
-    {
-        $this->_status = $status;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function deleteJobRecord()
-    {
-        $this->delete_job_record = true;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function dontDeleteJobRecord()
-    {
-        $this->delete_job_record = false;
-    }
+	/**
+	 * status indicating the job should advance to a secondary batch job (usually after an assessment phase)
+	 */
+	const status_advance = 'advance';
+
+	/**
+	 * 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';
+
+	/**
+	 * 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 to temporarily stop the current job
+	 * so that feedback can be provided to the user and/or to prompt the user for input
+	 */
+	const status_pause = 'pause';
+
+	/**
+	 * status indicating that the current job needs to redirect to... somewhere else...
+	 */
+	const status_redirect = 'redirect';
+
+	/**
+	 * string prepended to job ID and used for saving job data to the WP options table
+	 */
+	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;
+
+
+	/**
+	 * @var JobParametersWordPressOption|null
+	 */
+	private $job_record;
+
+	/**
+	 * if set to false, then the job parameters record saved to the WordPress options will NOT be deleted
+	 *
+	 * @var bool
+	 */
+	protected $delete_job_record = false;
+
+
+	/**
+	 * @param string $job_id
+	 * @param string $classname
+	 * @param array  $request_data
+	 * @param array  $extra_data
+	 */
+	public function __construct(string $job_id, string $classname, array $request_data, array $extra_data = [])
+	{
+		$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);
+		$this->job_record = new JobParametersWordPressOption($this->option_name());
+	}
+
+
+	/**
+	 * Returns the array of strings of valid stati
+	 *
+	 * @return array
+	 */
+	public static function valid_stati(): array
+	{
+		return [
+			JobParameters::status_complete,
+			JobParameters::status_continue,
+			JobParameters::status_error,
+			JobParameters::status_cleaned_up,
+		];
+	}
+
+
+	/**
+	 * Saves this option to the database (wordpress options table)
+	 *
+	 * @return bool success
+	 */
+	public function save(): bool
+	{
+		$object_vars = get_object_vars($this);
+		unset($object_vars['job_record']);
+		return $this->job_record->updateOption($object_vars);
+	}
+
+
+	/**
+	 * Deletes the job from the database if $this->delete_job_record is set to `true`,
+	 * although this object is still usable for the rest of the request
+	 *
+	 * @return bool
+	 */
+	public function delete(): bool
+	{
+		return $this->delete_job_record ? $this->job_record->deleteOption() : WordPressOption::UPDATE_NONE;
+	}
+
+
+	/**
+	 * Loads the specified job from the database JobParametersWordPressOption
+	 *
+	 * @param string $job_id
+	 * @return JobParameters
+	 * @throws BatchRequestException
+	 */
+	public static function load(string $job_id): JobParameters
+	{
+		$job_record         = new JobParametersWordPressOption(JobParameters::wp_option_prefix . $job_id);
+		$job_parameter_vars = $job_record->loadOption();
+		if (
+			! is_array($job_parameter_vars)
+			|| ! isset($job_parameter_vars['_classname'])
+			|| ! isset($job_parameter_vars['_request_data'])
+		) {
+			throw new BatchRequestException(
+				sprintf(
+					esc_html__(
+						'Could not retrieve valid data for job %1$s from the WordPress options table. The WordPress option was %2$s',
+						'event_espresso'
+					),
+					$job_id,
+					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;
+		}
+		$job_parameters->job_record = $job_record;
+		// $job_parameters->save();
+		return $job_parameters;
+	}
+
+
+	/**
+	 * Gets the job's unique string
+	 *
+	 * @return string
+	 */
+	public function job_id(): string
+	{
+		return $this->_job_id;
+	}
+
+
+	/**
+	 * Gets the classname that should run this job
+	 *
+	 * @return string
+	 */
+	public function classname(): string
+	{
+		return $this->_classname;
+	}
+
+
+	/**
+	 * Gets the original array of request data for this job
+	 *
+	 * @return array
+	 */
+	public function request_data(): array
+	{
+		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(string $key, $default = '')
+	{
+		if (isset($this->_request_data[ $key ])) {
+			return $this->_request_data[ $key ];
+		}
+		return $default;
+	}
+
+
+	/**
+	 * Gets a single item from the extra data
+	 *
+	 * @param string       $key
+	 * @param string|array $default
+	 * @return string|array
+	 */
+	public function extra_datum(string $key, $default = '')
+	{
+		if (isset($this->_extra_data[ $key ])) {
+			return $this->_extra_data[ $key ];
+		}
+		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(string $key, $value)
+	{
+		$this->_extra_data[ $key ] = $value;
+	}
+
+
+	/**
+	 * Array of any extra data we want to store
+	 *
+	 * @return array
+	 */
+	public function extra_data(): array
+	{
+		return $this->_extra_data;
+	}
+
+
+	/**
+	 * Returns the job size, in whatever units you want
+	 *
+	 * @return int
+	 */
+	public function job_size(): int
+	{
+		return $this->_job_size;
+	}
+
+
+	/**
+	 * Sets the job size. You decide what units to use
+	 *
+	 * @param int $size
+	 */
+	public function set_job_size(int $size)
+	{
+		$this->_job_size = $size;
+	}
+
+
+	/**
+	 * The number of "units" processed, in the same units as the "job size"
+	 *
+	 * @return int
+	 */
+	public function units_processed(): int
+	{
+		return $this->_units_processed;
+	}
+
+
+	/**
+	 * Marks more units as processed
+	 *
+	 * @param int $newly_processed
+	 * @return int updated units processed
+	 */
+	public function mark_processed(int $newly_processed): int
+	{
+		$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(int $total_units_processed)
+	{
+		$this->_units_processed = $total_units_processed;
+	}
+
+
+	/**
+	 * Sets the job's ID
+	 *
+	 * @param string $job_id
+	 */
+	public function set_job_id(string $job_id)
+	{
+		$this->_job_id = $job_id;
+	}
+
+
+	/**
+	 * sets the classname
+	 *
+	 * @param string $classname
+	 */
+	public function set_classname(string $classname)
+	{
+		$this->_classname = $classname;
+	}
+
+
+	/**
+	 * Sets the request data
+	 *
+	 * @param array $request_data
+	 */
+	public function set_request_data(array $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(array $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(): string
+	{
+		return JobParameters::wp_option_prefix . $this->job_id();
+	}
+
+
+	/**
+	 * Gets the job's current status. One of JobParameters::valid_stati();
+	 *
+	 * @return string
+	 */
+	public function status(): string
+	{
+		return $this->_status;
+	}
+
+
+	/**
+	 * @param string $status on eof JobParameters::valid_stati()
+	 */
+	public function set_status(string $status)
+	{
+		$this->_status = $status;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function deleteJobRecord()
+	{
+		$this->delete_job_record = true;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function dontDeleteJobRecord()
+	{
+		$this->delete_job_record = false;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -191,7 +191,7 @@ 
      */
     public static function load(string $job_id): JobParameters
     {
-        $job_record         = new JobParametersWordPressOption(JobParameters::wp_option_prefix . $job_id);
+        $job_record         = new JobParametersWordPressOption(JobParameters::wp_option_prefix.$job_id);
         $job_parameter_vars = $job_record->loadOption();
         if (
             ! is_array($job_parameter_vars)
@@ -205,7 +205,7 @@ 
                         'event_espresso'
                     ),
                     $job_id,
-                    JobParameters::wp_option_prefix . $job_id
+                    JobParameters::wp_option_prefix.$job_id
                 )
             );
         }
@@ -265,8 +265,8 @@ 
      */
     public function request_datum(string $key, $default = '')
     {
-        if (isset($this->_request_data[ $key ])) {
-            return $this->_request_data[ $key ];
+        if (isset($this->_request_data[$key])) {
+            return $this->_request_data[$key];
         }
         return $default;
     }
@@ -281,8 +281,8 @@ 
      */
     public function extra_datum(string $key, $default = '')
     {
-        if (isset($this->_extra_data[ $key ])) {
-            return $this->_extra_data[ $key ];
+        if (isset($this->_extra_data[$key])) {
+            return $this->_extra_data[$key];
         }
         return $default;
     }
@@ -296,7 +296,7 @@ 
      */
     public function add_extra_data(string $key, $value)
     {
-        $this->_extra_data[ $key ] = $value;
+        $this->_extra_data[$key] = $value;
     }
 
 
@@ -419,7 +419,7 @@ 
      */
     public function option_name(): string
     {
-        return JobParameters::wp_option_prefix . $this->job_id();
+        return JobParameters::wp_option_prefix.$this->job_id();
     }
 
 

core/domain/services/admin/notices/status_change/StatusChangeNotice.php

Indentation +96 added lines, -96 removed lines

@@ -16,112 +16,112 @@
  */
 class StatusChangeNotice extends WordPressOption
 {
-    public function __construct()
-    {
-        parent::__construct('ee_hide_status_change_notices_for_users', [], false);
-    }
+	public function __construct()
+	{
+		parent::__construct('ee_hide_status_change_notices_for_users', [], false);
+	}
 
 
-    public static function loadAssets()
-    {
-        wp_enqueue_style(
-            'status_change_notice',
-            EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.css',
-            ['espresso_menu'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script(
-            'status_change_notice',
-            EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'status_change_notice',
-            'eeStatusChangeNotice',
-            [
-                'failed_request_msg' => wp_strip_all_tags(
-                    __(
-                        'Request failed. The server returned status code: ',
-                        'event_espresso'
-                    )
-                ),
-                'unknown_error_msg' => wp_strip_all_tags(
-                    __(
-                        'Oops... an unknown error has occurred on the server and this notice could not be dismissed.',
-                        'event_espresso'
-                    )
-                ),
-            ]
-        );
-    }
+	public static function loadAssets()
+	{
+		wp_enqueue_style(
+			'status_change_notice',
+			EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.css',
+			['espresso_menu'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script(
+			'status_change_notice',
+			EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'status_change_notice',
+			'eeStatusChangeNotice',
+			[
+				'failed_request_msg' => wp_strip_all_tags(
+					__(
+						'Request failed. The server returned status code: ',
+						'event_espresso'
+					)
+				),
+				'unknown_error_msg' => wp_strip_all_tags(
+					__(
+						'Oops... an unknown error has occurred on the server and this notice could not be dismissed.',
+						'event_espresso'
+					)
+				),
+			]
+		);
+	}
 
 
-    public function display(string $context, string $page_slug): string
-    {
-        return $this->isNotDismissed()
-            ? EEH_Template::display_template(
-                __DIR__ . '/status_change_notice.template.php',
-                [
-                    'context'   => $context,
-                    'page_slug' => ! empty($page_slug) ? "$page_slug-page" : '',
-                ],
-                true
-            )
-            : '';
-    }
+	public function display(string $context, string $page_slug): string
+	{
+		return $this->isNotDismissed()
+			? EEH_Template::display_template(
+				__DIR__ . '/status_change_notice.template.php',
+				[
+					'context'   => $context,
+					'page_slug' => ! empty($page_slug) ? "$page_slug-page" : '',
+				],
+				true
+			)
+			: '';
+	}
 
 
-    /**
-     * @return int
-     * @throws RuntimeException
-     */
-    public function dismiss(): int
-    {
-        $user      = $this->getCurrentUser();
-        $dismissed = (array) $this->loadOption();
-        if (! in_array($user, $dismissed)) {
-            $dismissed[] = $user;
-        }
-        return $this->updateOption($dismissed);
-    }
+	/**
+	 * @return int
+	 * @throws RuntimeException
+	 */
+	public function dismiss(): int
+	{
+		$user      = $this->getCurrentUser();
+		$dismissed = (array) $this->loadOption();
+		if (! in_array($user, $dismissed)) {
+			$dismissed[] = $user;
+		}
+		return $this->updateOption($dismissed);
+	}
 
 
-    /**
-     * @return bool
-     * @throws RuntimeException
-     */
-    public function isDismissed(): bool
-    {
-        $user      = $this->getCurrentUser();
-        $dismissed = (array) $this->loadOption();
-        return in_array($user, $dismissed);
-    }
+	/**
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	public function isDismissed(): bool
+	{
+		$user      = $this->getCurrentUser();
+		$dismissed = (array) $this->loadOption();
+		return in_array($user, $dismissed);
+	}
 
 
-    /**
-     * @return bool
-     * @throws RuntimeException
-     */
-    public function isNotDismissed(): bool
-    {
-        return ! $this->isDismissed();
-    }
+	/**
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	public function isNotDismissed(): bool
+	{
+		return ! $this->isDismissed();
+	}
 
 
-    /**
-     * @return string
-     * @throws RuntimeException
-     */
-    private function getCurrentUser(): string
-    {
-        $user = wp_get_current_user();
-        if (! $user instanceof WP_User || ! $user->exists()) {
-            throw new RuntimeException(
-                esc_html__('A valid WP User could not be retrieved.', 'event_espresso')
-            );
-        }
-        return $user->user_login;
-    }
+	/**
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	private function getCurrentUser(): string
+	{
+		$user = wp_get_current_user();
+		if (! $user instanceof WP_User || ! $user->exists()) {
+			throw new RuntimeException(
+				esc_html__('A valid WP User could not be retrieved.', 'event_espresso')
+			);
+		}
+		return $user->user_login;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -26,13 +26,13 @@ 
     {
         wp_enqueue_style(
             'status_change_notice',
-            EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.css',
+            EE_PLUGIN_DIR_URL.'core/domain/services/admin/notices/status_change/status_change_notice.css',
             ['espresso_menu'],
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_script(
             'status_change_notice',
-            EE_PLUGIN_DIR_URL . 'core/domain/services/admin/notices/status_change/status_change_notice.js',
+            EE_PLUGIN_DIR_URL.'core/domain/services/admin/notices/status_change/status_change_notice.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -62,7 +62,7 @@ 
     {
         return $this->isNotDismissed()
             ? EEH_Template::display_template(
-                __DIR__ . '/status_change_notice.template.php',
+                __DIR__.'/status_change_notice.template.php',
                 [
                     'context'   => $context,
                     'page_slug' => ! empty($page_slug) ? "$page_slug-page" : '',
@@ -81,7 +81,7 @@ 
     {
         $user      = $this->getCurrentUser();
         $dismissed = (array) $this->loadOption();
-        if (! in_array($user, $dismissed)) {
+        if ( ! in_array($user, $dismissed)) {
             $dismissed[] = $user;
         }
         return $this->updateOption($dismissed);
@@ -117,7 +117,7 @@ 
     private function getCurrentUser(): string
     {
         $user = wp_get_current_user();
-        if (! $user instanceof WP_User || ! $user->exists()) {
+        if ( ! $user instanceof WP_User || ! $user->exists()) {
             throw new RuntimeException(
                 esc_html__('A valid WP User could not be retrieved.', 'event_espresso')
             );

core/services/json/JsonDataWordpressOption.php

Indentation +93 added lines, -93 removed lines

@@ -15,97 +15,97 @@
  */
 abstract class JsonDataWordpressOption extends WordPressOption
 {
-    /**
-     * @var array|mixed|stdClass
-     */
-    private $options = [];
-
-    /**
-     * @var JsonDataHandler|null
-     */
-    private $json_data_handler;
-
-
-    /**
-     * JsonDataWordpressOption constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param string          $option_name
-     * @param                 $default_value
-     * @param bool            $autoload
-     */
-    public function __construct(
-        JsonDataHandler $json_data_handler,
-        string $option_name,
-        $default_value,
-        bool $autoload = false
-    ) {
-        $this->json_data_handler = $json_data_handler;
-        if (! $this->json_data_handler->dataType()) {
-            $this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
-        }
-        parent::__construct($option_name, $default_value, $autoload);
-    }
-
-
-    /**
-     * @param $value
-     * @return int
-     */
-    public function updateOption($value): int
-    {
-        if (parent::updateOption($this->json_data_handler->encodeData($value))) {
-            $this->options = $value;
-            return WordPressOption::UPDATE_SUCCESS;
-        }
-        return WordPressOption::UPDATE_ERROR;
-    }
-
-
-    /**
-     * @param string $property
-     * @param mixed  $value
-     * @return void
-     */
-    public function addProperty(string $property, $value)
-    {
-        $options = $this->getAll();
-        $options->{$property} = $value;
-        $this->updateOption($options);
-    }
-
-
-    /**
-     * @param string $property
-     * @return mixed
-     */
-    public function getProperty(string $property)
-    {
-        $options = $this->getAll();
-        return property_exists($options, $property) ? $options->{$property} : null;
-    }
-
-
-    /**
-     * @return array|mixed|stdClass
-     */
-    public function getAll()
-    {
-        if (empty($this->options)) {
-            $this->options = $this->json_data_handler->decodeJson($this->loadOption());
-        }
-        return $this->options;
-    }
-
-
-    /**
-     * @param string $property
-     * @return void
-     */
-    public function removeProperty(string $property)
-    {
-        $options = $this->getAll();
-        unset($options->{$property});
-        $this->updateOption($options);
-    }
+	/**
+	 * @var array|mixed|stdClass
+	 */
+	private $options = [];
+
+	/**
+	 * @var JsonDataHandler|null
+	 */
+	private $json_data_handler;
+
+
+	/**
+	 * JsonDataWordpressOption constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param string          $option_name
+	 * @param                 $default_value
+	 * @param bool            $autoload
+	 */
+	public function __construct(
+		JsonDataHandler $json_data_handler,
+		string $option_name,
+		$default_value,
+		bool $autoload = false
+	) {
+		$this->json_data_handler = $json_data_handler;
+		if (! $this->json_data_handler->dataType()) {
+			$this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
+		}
+		parent::__construct($option_name, $default_value, $autoload);
+	}
+
+
+	/**
+	 * @param $value
+	 * @return int
+	 */
+	public function updateOption($value): int
+	{
+		if (parent::updateOption($this->json_data_handler->encodeData($value))) {
+			$this->options = $value;
+			return WordPressOption::UPDATE_SUCCESS;
+		}
+		return WordPressOption::UPDATE_ERROR;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @param mixed  $value
+	 * @return void
+	 */
+	public function addProperty(string $property, $value)
+	{
+		$options = $this->getAll();
+		$options->{$property} = $value;
+		$this->updateOption($options);
+	}
+
+
+	/**
+	 * @param string $property
+	 * @return mixed
+	 */
+	public function getProperty(string $property)
+	{
+		$options = $this->getAll();
+		return property_exists($options, $property) ? $options->{$property} : null;
+	}
+
+
+	/**
+	 * @return array|mixed|stdClass
+	 */
+	public function getAll()
+	{
+		if (empty($this->options)) {
+			$this->options = $this->json_data_handler->decodeJson($this->loadOption());
+		}
+		return $this->options;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @return void
+	 */
+	public function removeProperty(string $property)
+	{
+		$options = $this->getAll();
+		unset($options->{$property});
+		$this->updateOption($options);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
         bool $autoload = false
     ) {
         $this->json_data_handler = $json_data_handler;
-        if (! $this->json_data_handler->dataType()) {
+        if ( ! $this->json_data_handler->dataType()) {
             $this->json_data_handler->configure(JsonDataHandler::DATA_TYPE_OBJECT);
         }
         parent::__construct($option_name, $default_value, $autoload);

core/services/json/JsonDataHandler.php

Indentation +342 added lines, -342 removed lines

@@ -14,346 +14,346 @@
  */
 class JsonDataHandler
 {
-    const DATA_TYPE_ARRAY     = 'array';
-
-    const DATA_TYPE_OBJECT    = 'object';
-
-    const DATA_TYPE_USE_FLAGS = 'flags';
-
-    const NO_ERROR_MSG        = 'No error';
-
-    /**
-     * @var string|null
-     */
-    private $data_type = null;
-
-    /**
-     * @var array|stdClass|null
-     */
-    private $decoded_data = null;
-
-    /**
-     * JSON_BIGINT_AS_STRING,
-     * JSON_INVALID_UTF8_IGNORE,
-     * JSON_INVALID_UTF8_SUBSTITUTE,
-     * JSON_OBJECT_AS_ARRAY,
-     * JSON_THROW_ON_ERROR
-     *
-     * @var int
-     */
-    private $decode_flags = 0;
-
-    /**
-     * @var int
-     */
-    private $depth = 512;
-
-    /**
-     * @var string
-     */
-    private $encoded_data = '';
-
-    /**
-     * JSON_FORCE_OBJECT,
-     * JSON_HEX_QUOT,
-     * JSON_HEX_TAG,
-     * JSON_HEX_AMP,
-     * JSON_HEX_APOS,
-     * JSON_INVALID_UTF8_IGNORE,
-     * JSON_INVALID_UTF8_SUBSTITUTE,
-     * JSON_NUMERIC_CHECK,
-     * JSON_PARTIAL_OUTPUT_ON_ERROR,
-     * JSON_PRESERVE_ZERO_FRACTION,
-     * JSON_PRETTY_PRINT,
-     * JSON_UNESCAPED_LINE_TERMINATORS,
-     * JSON_UNESCAPED_SLASHES,
-     * JSON_UNESCAPED_UNICODE,
-     * JSON_THROW_ON_ERROR.
-     *
-     * @var int
-     */
-    private $encode_flags = 0;
-
-    /**
-     * @var int
-     */
-    private $last_error_code = JSON_ERROR_NONE;
-
-    /**
-     * @var string
-     */
-    private $last_error_msg = JsonDataHandler::NO_ERROR_MSG;
-
-
-    /**
-     * JsonDataHandler constructor.
-     */
-    public function __construct()
-    {
-        if (! defined('JSON_INVALID_UTF8_IGNORE')) {
-            define('JSON_INVALID_UTF8_IGNORE', 1048576);
-        }
-        if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
-            define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
-        }
-        if (! defined('JSON_THROW_ON_ERROR')) {
-            define('JSON_THROW_ON_ERROR', 4194304);
-        }
-    }
-
-
-    /**
-     * set $data_type, $decode_flags, $encode_flags, and depth all in one shot
-     *
-     * @param string $data_type
-     * @param int    $decode_flags
-     * @param int    $encode_flags
-     * @param int    $depth
-     */
-    public function configure(
-        string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS,
-        int $decode_flags = 0,
-        int $encode_flags = 0,
-        int $depth = 512
-    ) {
-        $this->setDataType($data_type);
-        $this->setDecodeFlags($decode_flags);
-        $this->setDepth($depth);
-        $this->setEncodeFlags($encode_flags);
-    }
-
-
-    /**
-     * @param string $data_type
-     */
-    public function setDataType(string $data_type): void
-    {
-        $this->data_type = $data_type === JsonDataHandler::DATA_TYPE_ARRAY
-                           || $data_type === JsonDataHandler::DATA_TYPE_OBJECT
-                           || $data_type === JsonDataHandler::DATA_TYPE_USE_FLAGS
-            ? $data_type
-            : JsonDataHandler::DATA_TYPE_USE_FLAGS;
-    }
-
-
-    /**
-     * One or more Bitmask values:
-     * JSON_BIGINT_AS_STRING,
-     * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
-     * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
-     * JSON_OBJECT_AS_ARRAY,
-     * JSON_THROW_ON_ERROR              PHP >= 7.3
-     *
-     * pass multiple values separated with |
-     * ex: JSON_BIGINT_AS_STRING | JSON_INVALID_UTF8_IGNORE | JSON_OBJECT_AS_ARRAY
-     *
-     * @param int $decode_flags
-     */
-    public function setDecodeFlags(int $decode_flags): void
-    {
-        $this->decode_flags = $decode_flags === JSON_BIGINT_AS_STRING
-                              || $decode_flags === JSON_OBJECT_AS_ARRAY
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
-                              || $decode_flags === JSON_INVALID_UTF8_IGNORE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
-                              || $decode_flags === JSON_INVALID_UTF8_SUBSTITUTE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
-                              || $decode_flags === JSON_THROW_ON_ERROR
-            ? $decode_flags
-            : 0;
-    }
-
-
-    /**
-     * @param int $depth
-     */
-    public function setDepth(int $depth): void
-    {
-        $depth       = absint($depth);
-        $this->depth = $depth ?: 512;
-    }
-
-
-    /**
-     * One or more Bitmask values:
-     * JSON_FORCE_OBJECT,
-     * JSON_HEX_QUOT,
-     * JSON_HEX_TAG,
-     * JSON_HEX_AMP,
-     * JSON_HEX_APOS,
-     * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
-     * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
-     * JSON_NUMERIC_CHECK,
-     * JSON_PARTIAL_OUTPUT_ON_ERROR,
-     * JSON_PRESERVE_ZERO_FRACTION,
-     * JSON_PRETTY_PRINT,
-     * JSON_UNESCAPED_LINE_TERMINATORS,
-     * JSON_UNESCAPED_SLASHES,
-     * JSON_UNESCAPED_UNICODE,
-     * JSON_THROW_ON_ERROR.             PHP >= 7.3
-     *
-     * pass multiple values separated with |
-     * ex: JSON_FORCE_OBJECT | JSON_INVALID_UTF8_IGNORE | JSON_THROW_ON_ERROR
-     *
-     * @param int $encode_flags
-     */
-    public function setEncodeFlags(int $encode_flags): void
-    {
-        $this->encode_flags = $encode_flags === JSON_FORCE_OBJECT
-                              || $encode_flags === JSON_HEX_QUOT
-                              || $encode_flags === JSON_HEX_TAG
-                              || $encode_flags === JSON_HEX_AMP
-                              || $encode_flags === JSON_HEX_APOS
-                              || $encode_flags === JSON_NUMERIC_CHECK
-                              || $encode_flags === JSON_PARTIAL_OUTPUT_ON_ERROR
-                              || $encode_flags === JSON_PRESERVE_ZERO_FRACTION
-                              || $encode_flags === JSON_PRETTY_PRINT
-                              || $encode_flags === JSON_UNESCAPED_LINE_TERMINATORS
-                              || $encode_flags === JSON_UNESCAPED_SLASHES
-                              || $encode_flags === JSON_UNESCAPED_UNICODE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
-                              || $encode_flags === JSON_INVALID_UTF8_IGNORE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
-                              || $encode_flags === JSON_INVALID_UTF8_SUBSTITUTE
-                              // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
-                              || $encode_flags === JSON_THROW_ON_ERROR
-            ? $encode_flags
-            : 0;
-    }
-
-
-    /**
-     * @return string|null
-     */
-    public function dataType(): ?string
-    {
-        return $this->data_type;
-    }
-
-
-    /**
-     * @return bool|null
-     */
-    private function asAssociative(): ?bool
-    {
-        switch ($this->data_type) {
-            case JsonDataHandler::DATA_TYPE_ARRAY:
-                return true;
-            case JsonDataHandler::DATA_TYPE_OBJECT:
-                return false;
-            case JsonDataHandler::DATA_TYPE_USE_FLAGS:
-                return null;
-        }
-        return null;
-    }
-
-
-    /**
-     * @param array|string $json
-     * @return array|mixed|stdClass
-     */
-    public function decodeJson($json)
-    {
-        $this->resetErrors();
-        if ($this->isJson($json)) {
-            $this->decoded_data    = json_decode($json, $this->asAssociative(), $this->depth, $this->decode_flags);
-            $this->last_error_code = json_last_error();
-            $this->last_error_msg  = json_last_error_msg();
-        } else {
-            $this->decoded_data    = $json;
-            $this->last_error_code = JSON_ERROR_NONE;
-            $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-        }
-        return $this->decoded_data;
-    }
-
-
-    /**
-     * @param $data
-     * @return string
-     */
-    public function encodeData($data): string
-    {
-        $this->resetErrors();
-        if ($this->isJson($data)) {
-            $this->encoded_data = $data;
-            $this->last_error_code = JSON_ERROR_NONE;
-            $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-        } else {
-            $this->encoded_data = json_encode($data, $this->encode_flags, $this->depth);
-            $this->last_error_code = json_last_error();
-            $this->last_error_msg  = json_last_error_msg();
-        }
-        return $this->encoded_data ?: '{}';
-    }
-
-
-    /**
-     * @return array|stdClass
-     */
-    public function getDecodedData()
-    {
-        return $this->decoded_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getEncodedData(): string
-    {
-        return $this->encoded_data;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return int
-     */
-    public function getLastErrorCode(bool $reset = false): int
-    {
-        $last_error = $this->last_error_code;
-        if ($reset) {
-            $this->resetErrors();
-        }
-        return $last_error;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function getLastErrorMessage(bool $reset = false): string
-    {
-        $last_error = $this->last_error_msg;
-        if ($reset) {
-            $this->resetErrors();
-        }
-        return $last_error;
-    }
-
-
-    /**
-     * @param array|string $maybe_json
-     * @return bool
-     */
-    public function isJson($maybe_json): bool
-    {
-        if (! is_string($maybe_json)) {
-            return false;
-        }
-        $decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);
-        return json_last_error() === JSON_ERROR_NONE && ! ($decoded === null && ! empty($maybe_json));
-    }
-
-
-    /**
-     * @since $VID:$
-     */
-    public function resetErrors()
-    {
-        $this->last_error_code = JSON_ERROR_NONE;
-        $this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
-    }
+	const DATA_TYPE_ARRAY     = 'array';
+
+	const DATA_TYPE_OBJECT    = 'object';
+
+	const DATA_TYPE_USE_FLAGS = 'flags';
+
+	const NO_ERROR_MSG        = 'No error';
+
+	/**
+	 * @var string|null
+	 */
+	private $data_type = null;
+
+	/**
+	 * @var array|stdClass|null
+	 */
+	private $decoded_data = null;
+
+	/**
+	 * JSON_BIGINT_AS_STRING,
+	 * JSON_INVALID_UTF8_IGNORE,
+	 * JSON_INVALID_UTF8_SUBSTITUTE,
+	 * JSON_OBJECT_AS_ARRAY,
+	 * JSON_THROW_ON_ERROR
+	 *
+	 * @var int
+	 */
+	private $decode_flags = 0;
+
+	/**
+	 * @var int
+	 */
+	private $depth = 512;
+
+	/**
+	 * @var string
+	 */
+	private $encoded_data = '';
+
+	/**
+	 * JSON_FORCE_OBJECT,
+	 * JSON_HEX_QUOT,
+	 * JSON_HEX_TAG,
+	 * JSON_HEX_AMP,
+	 * JSON_HEX_APOS,
+	 * JSON_INVALID_UTF8_IGNORE,
+	 * JSON_INVALID_UTF8_SUBSTITUTE,
+	 * JSON_NUMERIC_CHECK,
+	 * JSON_PARTIAL_OUTPUT_ON_ERROR,
+	 * JSON_PRESERVE_ZERO_FRACTION,
+	 * JSON_PRETTY_PRINT,
+	 * JSON_UNESCAPED_LINE_TERMINATORS,
+	 * JSON_UNESCAPED_SLASHES,
+	 * JSON_UNESCAPED_UNICODE,
+	 * JSON_THROW_ON_ERROR.
+	 *
+	 * @var int
+	 */
+	private $encode_flags = 0;
+
+	/**
+	 * @var int
+	 */
+	private $last_error_code = JSON_ERROR_NONE;
+
+	/**
+	 * @var string
+	 */
+	private $last_error_msg = JsonDataHandler::NO_ERROR_MSG;
+
+
+	/**
+	 * JsonDataHandler constructor.
+	 */
+	public function __construct()
+	{
+		if (! defined('JSON_INVALID_UTF8_IGNORE')) {
+			define('JSON_INVALID_UTF8_IGNORE', 1048576);
+		}
+		if (! defined('JSON_INVALID_UTF8_SUBSTITUTE')) {
+			define('JSON_INVALID_UTF8_SUBSTITUTE', 2097152);
+		}
+		if (! defined('JSON_THROW_ON_ERROR')) {
+			define('JSON_THROW_ON_ERROR', 4194304);
+		}
+	}
+
+
+	/**
+	 * set $data_type, $decode_flags, $encode_flags, and depth all in one shot
+	 *
+	 * @param string $data_type
+	 * @param int    $decode_flags
+	 * @param int    $encode_flags
+	 * @param int    $depth
+	 */
+	public function configure(
+		string $data_type = JsonDataHandler::DATA_TYPE_USE_FLAGS,
+		int $decode_flags = 0,
+		int $encode_flags = 0,
+		int $depth = 512
+	) {
+		$this->setDataType($data_type);
+		$this->setDecodeFlags($decode_flags);
+		$this->setDepth($depth);
+		$this->setEncodeFlags($encode_flags);
+	}
+
+
+	/**
+	 * @param string $data_type
+	 */
+	public function setDataType(string $data_type): void
+	{
+		$this->data_type = $data_type === JsonDataHandler::DATA_TYPE_ARRAY
+						   || $data_type === JsonDataHandler::DATA_TYPE_OBJECT
+						   || $data_type === JsonDataHandler::DATA_TYPE_USE_FLAGS
+			? $data_type
+			: JsonDataHandler::DATA_TYPE_USE_FLAGS;
+	}
+
+
+	/**
+	 * One or more Bitmask values:
+	 * JSON_BIGINT_AS_STRING,
+	 * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
+	 * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
+	 * JSON_OBJECT_AS_ARRAY,
+	 * JSON_THROW_ON_ERROR              PHP >= 7.3
+	 *
+	 * pass multiple values separated with |
+	 * ex: JSON_BIGINT_AS_STRING | JSON_INVALID_UTF8_IGNORE | JSON_OBJECT_AS_ARRAY
+	 *
+	 * @param int $decode_flags
+	 */
+	public function setDecodeFlags(int $decode_flags): void
+	{
+		$this->decode_flags = $decode_flags === JSON_BIGINT_AS_STRING
+							  || $decode_flags === JSON_OBJECT_AS_ARRAY
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
+							  || $decode_flags === JSON_INVALID_UTF8_IGNORE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
+							  || $decode_flags === JSON_INVALID_UTF8_SUBSTITUTE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
+							  || $decode_flags === JSON_THROW_ON_ERROR
+			? $decode_flags
+			: 0;
+	}
+
+
+	/**
+	 * @param int $depth
+	 */
+	public function setDepth(int $depth): void
+	{
+		$depth       = absint($depth);
+		$this->depth = $depth ?: 512;
+	}
+
+
+	/**
+	 * One or more Bitmask values:
+	 * JSON_FORCE_OBJECT,
+	 * JSON_HEX_QUOT,
+	 * JSON_HEX_TAG,
+	 * JSON_HEX_AMP,
+	 * JSON_HEX_APOS,
+	 * JSON_INVALID_UTF8_IGNORE,        PHP >= 7.2
+	 * JSON_INVALID_UTF8_SUBSTITUTE,    PHP >= 7.2
+	 * JSON_NUMERIC_CHECK,
+	 * JSON_PARTIAL_OUTPUT_ON_ERROR,
+	 * JSON_PRESERVE_ZERO_FRACTION,
+	 * JSON_PRETTY_PRINT,
+	 * JSON_UNESCAPED_LINE_TERMINATORS,
+	 * JSON_UNESCAPED_SLASHES,
+	 * JSON_UNESCAPED_UNICODE,
+	 * JSON_THROW_ON_ERROR.             PHP >= 7.3
+	 *
+	 * pass multiple values separated with |
+	 * ex: JSON_FORCE_OBJECT | JSON_INVALID_UTF8_IGNORE | JSON_THROW_ON_ERROR
+	 *
+	 * @param int $encode_flags
+	 */
+	public function setEncodeFlags(int $encode_flags): void
+	{
+		$this->encode_flags = $encode_flags === JSON_FORCE_OBJECT
+							  || $encode_flags === JSON_HEX_QUOT
+							  || $encode_flags === JSON_HEX_TAG
+							  || $encode_flags === JSON_HEX_AMP
+							  || $encode_flags === JSON_HEX_APOS
+							  || $encode_flags === JSON_NUMERIC_CHECK
+							  || $encode_flags === JSON_PARTIAL_OUTPUT_ON_ERROR
+							  || $encode_flags === JSON_PRESERVE_ZERO_FRACTION
+							  || $encode_flags === JSON_PRETTY_PRINT
+							  || $encode_flags === JSON_UNESCAPED_LINE_TERMINATORS
+							  || $encode_flags === JSON_UNESCAPED_SLASHES
+							  || $encode_flags === JSON_UNESCAPED_UNICODE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_ignoreFound
+							  || $encode_flags === JSON_INVALID_UTF8_IGNORE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_invalid_utf8_substituteFound
+							  || $encode_flags === JSON_INVALID_UTF8_SUBSTITUTE
+							  // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_throw_on_errorFound
+							  || $encode_flags === JSON_THROW_ON_ERROR
+			? $encode_flags
+			: 0;
+	}
+
+
+	/**
+	 * @return string|null
+	 */
+	public function dataType(): ?string
+	{
+		return $this->data_type;
+	}
+
+
+	/**
+	 * @return bool|null
+	 */
+	private function asAssociative(): ?bool
+	{
+		switch ($this->data_type) {
+			case JsonDataHandler::DATA_TYPE_ARRAY:
+				return true;
+			case JsonDataHandler::DATA_TYPE_OBJECT:
+				return false;
+			case JsonDataHandler::DATA_TYPE_USE_FLAGS:
+				return null;
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param array|string $json
+	 * @return array|mixed|stdClass
+	 */
+	public function decodeJson($json)
+	{
+		$this->resetErrors();
+		if ($this->isJson($json)) {
+			$this->decoded_data    = json_decode($json, $this->asAssociative(), $this->depth, $this->decode_flags);
+			$this->last_error_code = json_last_error();
+			$this->last_error_msg  = json_last_error_msg();
+		} else {
+			$this->decoded_data    = $json;
+			$this->last_error_code = JSON_ERROR_NONE;
+			$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+		}
+		return $this->decoded_data;
+	}
+
+
+	/**
+	 * @param $data
+	 * @return string
+	 */
+	public function encodeData($data): string
+	{
+		$this->resetErrors();
+		if ($this->isJson($data)) {
+			$this->encoded_data = $data;
+			$this->last_error_code = JSON_ERROR_NONE;
+			$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+		} else {
+			$this->encoded_data = json_encode($data, $this->encode_flags, $this->depth);
+			$this->last_error_code = json_last_error();
+			$this->last_error_msg  = json_last_error_msg();
+		}
+		return $this->encoded_data ?: '{}';
+	}
+
+
+	/**
+	 * @return array|stdClass
+	 */
+	public function getDecodedData()
+	{
+		return $this->decoded_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getEncodedData(): string
+	{
+		return $this->encoded_data;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return int
+	 */
+	public function getLastErrorCode(bool $reset = false): int
+	{
+		$last_error = $this->last_error_code;
+		if ($reset) {
+			$this->resetErrors();
+		}
+		return $last_error;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function getLastErrorMessage(bool $reset = false): string
+	{
+		$last_error = $this->last_error_msg;
+		if ($reset) {
+			$this->resetErrors();
+		}
+		return $last_error;
+	}
+
+
+	/**
+	 * @param array|string $maybe_json
+	 * @return bool
+	 */
+	public function isJson($maybe_json): bool
+	{
+		if (! is_string($maybe_json)) {
+			return false;
+		}
+		$decoded = json_decode($maybe_json, $this->asAssociative(), $this->depth, $this->decode_flags);
+		return json_last_error() === JSON_ERROR_NONE && ! ($decoded === null && ! empty($maybe_json));
+	}
+
+
+	/**
+	 * @since $VID:$
+	 */
+	public function resetErrors()
+	{
+		$this->last_error_code = JSON_ERROR_NONE;
+		$this->last_error_msg  = JsonDataHandler::NO_ERROR_MSG;
+	}
 }

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Indentation +948 added lines, -948 removed lines

@@ -14,952 +14,952 @@
  */
 class Maintenance_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EE_Data_Migration_Manager
-     */
-    protected $migration_manager;
-
-    /**
-     * @var EE_Maintenance_Mode
-     */
-    protected $maintenance_mode;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $datetime_fix_offset_form;
-
-
-    /**
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        $this->migration_manager = EE_Data_Migration_Manager::instance();
-        $this->maintenance_mode  = EE_Maintenance_Mode::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MAINTENANCE_PG_SLUG;
-        $this->page_label       = EE_MAINTENANCE_LABEL;
-        $this->_admin_base_url  = EE_MAINTENANCE_ADMIN_URL;
-        $this->_admin_base_path = EE_MAINTENANCE_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_migration_step', [$this, 'migration_step']);
-        add_action('wp_ajax_add_error_to_migrations_ran', [$this, 'add_error_to_migrations_ran']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EE_MAINTENANCE_LABEL;
-        $this->_labels           = [
-            'buttons' => [
-                'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
-                'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = [
-            'default'                             => [
-                'func'       => '_maintenance',
-                'capability' => 'manage_options',
-            ],
-            'change_maintenance_level'            => [
-                'func'       => '_change_maintenance_level',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'system_status'                       => [
-                'func'       => '_system_status',
-                'capability' => 'manage_options',
-            ],
-            'download_system_status'              => [
-                'func'       => '_download_system_status',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'send_migration_crash_report'         => [
-                'func'       => '_send_migration_crash_report',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'confirm_migration_crash_report_sent' => [
-                'func'       => '_confirm_migration_crash_report_sent',
-                'capability' => 'manage_options',
-            ],
-            'data_reset'                          => [
-                'func'       => '_data_reset_and_delete',
-                'capability' => 'manage_options',
-            ],
-            'reset_db'                            => [
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => ['nuke_old_ee4_data' => true],
-            ],
-            'start_with_fresh_ee4_db'             => [
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => ['nuke_old_ee4_data' => false],
-            ],
-            'delete_db'                           => [
-                'func'       => '_delete_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'rerun_migration_from_ee3'            => [
-                'func'       => '_rerun_migration_from_ee3',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'reset_reservations'                  => [
-                'func'       => '_reset_reservations',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'reset_capabilities'                  => [
-                'func'       => '_reset_capabilities',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'reattempt_migration'                 => [
-                'func'       => '_reattempt_migration',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'datetime_tools'                      => [
-                'func'       => '_datetime_tools',
-                'capability' => 'manage_options',
-            ],
-            'run_datetime_offset_fix'             => [
-                'func'               => '_apply_datetime_offset',
-                'noheader'           => true,
-                'headers_sent_route' => 'datetime_tools',
-                'capability'         => 'manage_options',
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default'        => [
-                'nav'           => [
-                    'label' => esc_html__('Maintenance', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'require_nonce' => false,
-            ],
-            'data_reset'     => [
-                'nav'           => [
-                    'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'require_nonce' => false,
-            ],
-            'datetime_tools' => [
-                'nav'           => [
-                    'label' => esc_html__('Datetime Utilities', 'event_espresso'),
-                    'order' => 25,
-                ],
-                'require_nonce' => false,
-            ],
-            'system_status'  => [
-                'nav'           => [
-                    'label' => esc_html__("System Information", "event_espresso"),
-                    'order' => 30,
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * default maintenance page.
-     * If we're in maintenance mode level 2, then we need to show the migration scripts and all that UI.
-     *
-     * @throws EE_Error
-     */
-    public function _maintenance()
-    {
-        $show_maintenance_switch         = true;
-        $show_backup_db_text             = false;
-        $show_migration_progress         = false;
-        $script_names                    = [];
-        $addons_should_be_upgraded_first = false;
-        // it all depends on if we're in maintenance model level 1 (frontend-only) or
-        // level 2 (everything except maintenance page)
-        try {
-            // get the current maintenance level and check if
-            // we are removed
-            $mMode_level  = $this->maintenance_mode->level();
-            $placed_in_mm = $this->maintenance_mode->set_maintenance_mode_if_db_old();
-            if ($mMode_level == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
-                // we just took the site out of maintenance mode, so notify the user.
-                // unfortunately this message appears to be echoed on the NEXT page load...
-                // oh well, we should really be checking for this on addon deactivation anyways
-                EE_Error::add_attention(
-                    esc_html__(
-                        'Site taken out of maintenance mode because no data migration scripts are required',
-                        'event_espresso'
-                    )
-                );
-                $this->_process_notices(['page' => 'espresso_maintenance_settings']);
-            }
-            // in case an exception is thrown while trying to handle migrations
-            if ($mMode_level === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $show_maintenance_switch = false;
-                $show_migration_progress = true;
-                if (isset($this->_req_data['continue_migration'])) {
-                    $show_backup_db_text = false;
-                } else {
-                    $show_backup_db_text = true;
-                }
-                $scripts_needing_to_run          =
-                    $this->migration_manager->check_for_applicable_data_migration_scripts();
-                $addons_should_be_upgraded_first = $this->migration_manager->addons_need_updating();
-                $script_names                    = [];
-                $current_script                  = null;
-                foreach ($scripts_needing_to_run as $script) {
-                    if ($script instanceof EE_Data_Migration_Script_Base) {
-                        if (! $current_script) {
-                            $current_script = $script;
-                            $current_script->migration_page_hooks();
-                        }
-                        $script_names[] = $script->pretty_name();
-                    }
-                }
-            }
-            $most_recent_migration = $this->migration_manager->get_last_ran_script(true);
-            $exception_thrown      = false;
-        } catch (EE_Error $e) {
-            $this->migration_manager->add_error_to_migrations_ran($e->getMessage());
-            // now, just so we can display the page correctly, make an error migration script stage object
-            // and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-            $exception_thrown = true;
-        }
-        $current_db_state = $this->migration_manager->ensure_current_database_state_is_set();
-        $current_db_state = str_replace('.decaf', '', $current_db_state);
-        if (
-            $exception_thrown
-            || (
-                $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->is_broken()
-            )
-        ) {
-            $this->_template_path                =
-                EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
-            $this->_template_args['support_url'] = 'https://eventespresso.com/support/forums/';
-            $this->_template_args['next_url']    = EEH_URL::add_query_args_and_nonce(
-                [
-                    'action'  => 'confirm_migration_crash_report_sent',
-                    'success' => '0',
-                ],
-                EE_MAINTENANCE_ADMIN_URL
-            );
-        } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
-        } else {
-            if (
-                $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->can_continue()
-            ) {
-                $show_backup_db_text                    = false;
-                $show_continue_current_migration_script = true;
-                $show_most_recent_migration             = true;
-            } elseif (isset($this->_req_data['continue_migration'])) {
-                $show_most_recent_migration             = true;
-                $show_continue_current_migration_script = false;
-            } else {
-                $show_most_recent_migration             = false;
-                $show_continue_current_migration_script = false;
-            }
-            if (isset($current_script)) {
-                $migrates_to          = $current_script->migrates_to_version();
-                $plugin_slug          = $migrates_to['slug'];
-                $new_version          = $migrates_to['version'];
-                $this->_template_args = array_merge(
-                    $this->_template_args,
-                    [
-                        'current_db_state' => sprintf(
-                            esc_html__("EE%s (%s)", "event_espresso"),
-                            isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3,
-                            $plugin_slug
-                        ),
-                        'next_db_state'    => sprintf(
-                            esc_html__("EE%s (%s)", 'event_espresso'),
-                            $new_version,
-                            $plugin_slug
-                        ),
-                    ]
-                );
-            } else {
-                $this->_template_args['current_db_state'] = null;
-                $this->_template_args['next_db_state']    = null;
-            }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
-            $this->_template_args = array_merge(
-                $this->_template_args,
-                [
-                    'show_most_recent_migration'             => $show_most_recent_migration,
-                    // flag for showing the most recent migration's status and/or errors
-                    'show_migration_progress'                => $show_migration_progress,
-                    // flag for showing the option to run migrations and see their progress
-                    'show_backup_db_text'                    => $show_backup_db_text,
-                    // flag for showing text telling the user to back up their DB
-                    'show_maintenance_switch'                => $show_maintenance_switch,
-                    // flag for showing the option to change maintenance mode between levels 0 and 1
-                    'script_names'                           => $script_names,
-                    // array of names of scripts that have run
-                    'show_continue_current_migration_script' => $show_continue_current_migration_script,
-                    // flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
-                    'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => 'reset_db'],
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => 'data_reset'],
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => 'change_maintenance_level'],
-                        EE_MAINTENANCE_ADMIN_URL
-                    ),
-                    'ultimate_db_state'                      => sprintf(
-                        esc_html__("EE%s", 'event_espresso'),
-                        espresso_version()
-                    ),
-                ]
-            );
-        }
-        $this->_template_args['most_recent_migration'] =
-            $most_recent_migration;// the actual most recently ran migration
-        // now render the migration options part, and put it in a variable
-        $migration_options_template_file                = apply_filters(
-            'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
-        );
-        $migration_options_html                         = EEH_Template::display_template(
-            $migration_options_template_file,
-            $this->_template_args,
-            true
-        );
-        $this->_template_args['migration_options_html'] = $migration_options_html;
-        $this->_template_args['admin_page_content']     = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * returns JSON and executes another step of the currently-executing data migration (called via ajax)
-     *
-     * @throws EE_Error
-     */
-    public function migration_step()
-    {
-        $this->_template_args['data'] = $this->migration_manager->response_to_migration_ajax_request();
-        $this->_return_json();
-    }
-
-
-    /**
-     * Can be used by js when it notices a response with HTML in it in order
-     * to log the malformed response
-     *
-     * @throws EE_Error
-     */
-    public function add_error_to_migrations_ran()
-    {
-        $this->migration_manager->add_error_to_migrations_ran($this->_req_data['message']);
-        $this->_template_args['data'] = ['ok' => true];
-        $this->_return_json();
-    }
-
-
-    /**
-     * changes the maintenance level, provided there are still no migration scripts that should run
-     *
-     * @throws EE_Error
-     */
-    public function _change_maintenance_level()
-    {
-        $new_level = absint($this->_req_data['maintenance_mode_level']);
-        if (! $this->migration_manager->check_for_applicable_data_migration_scripts()) {
-            $this->maintenance_mode->set_maintenance_level($new_level);
-            $success = true;
-        } else {
-            $this->maintenance_mode->set_maintenance_mode_if_db_old();
-            $success = false;
-        }
-        $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
-    }
-
-
-    /**
-     * a tab with options for resetting and/or deleting EE data
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function _data_reset_and_delete()
-    {
-        $this->_template_path                              =
-            EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
-        $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
-            'reset_reservations',
-            'reset_reservations',
-            [],
-            'button button--caution ee-confirm'
-        );
-        $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
-            'reset_capabilities',
-            'reset_capabilities',
-            [],
-            'button button--caution ee-confirm'
-        );
-        $this->_template_args['delete_db_url']             = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'delete_db'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_url']              = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'reset_db'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content']        = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _reset_reservations()
-    {
-        if (EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
-            EE_Error::add_success(
-                esc_html__(
-                    'Ticket and datetime reserved counts have been successfully reset.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            EE_Error::add_success(
-                esc_html__(
-                    'Ticket and datetime reserved counts were correct and did not need resetting.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_redirect_after_action(true, '', '', ['action' => 'data_reset'], true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _reset_capabilities()
-    {
-        EE_Registry::instance()->CAP->init_caps(true);
-        EE_Error::add_success(
-            esc_html__(
-                'Default Event Espresso capabilities have been restored for all current roles.',
-                'event_espresso'
-            )
-        );
-        $this->_redirect_after_action(false, '', '', ['action' => 'data_reset'], true);
-    }
-
-
-    /**
-     * resets the DMSs, so we can attempt to continue migrating after a fatal error
-     * (only a good idea when someone has somehow tried ot fix whatever caused
-     * the fatal error in teh first place)
-     *
-     * @throws EE_Error
-     */
-    protected function _reattempt_migration()
-    {
-        $this->migration_manager->reattempt();
-        $this->_redirect_after_action(false, '', '', ['action' => 'default'], true);
-    }
-
-
-    /**
-     * shows the big ol' System Information page
-     *
-     * @throws EE_Error
-     */
-    public function _system_status()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
-        $this->_template_args['system_stati']               = EEM_System_Status::instance()->get_system_stati();
-        $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action' => 'download_system_status',
-            ],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content']         = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * Downloads an HTML file of the system status that can be easily stored or emailed
-     */
-    public function _download_system_status()
-    {
-        $status_info = EEM_System_Status::instance()->get_system_stati();
-        header('Content-Disposition: attachment');
-        header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html");
-        $output = '<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>';
-        $output .= '<h1>' . sprintf(
-            __('System Information for %1$s', 'event_espresso'),
-            esc_url_raw(site_url())
-        ) . '</h1>';
-        $output .= EEH_Template::layout_array_as_table($status_info);
-        echo esc_html($output);
-        die;
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function _send_migration_crash_report()
-    {
-        $from      = $this->_req_data['from'];
-        $from_name = $this->_req_data['from_name'];
-        $body      = $this->_req_data['body'];
-        try {
-            $success = wp_mail(
-                EE_SUPPORT_EMAIL,
-                'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
-                [
-                    "from:$from_name<$from>",
-                ]
-            );
-        } catch (Exception $e) {
-            $success = false;
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__("Migration Crash Report", "event_espresso"),
-            esc_html__("sent", "event_espresso"),
-            ['success' => $success, 'action' => 'confirm_migration_crash_report_sent']
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function _confirm_migration_crash_report_sent()
-    {
-        try {
-            $most_recent_migration = $this->migration_manager->get_last_ran_script(true);
-        } catch (EE_Error $e) {
-            $this->migration_manager->add_error_to_migrations_ran($e->getMessage());
-            // now, just so we can display the page correctly, make an error migration script stage object
-            // and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-        }
-        $success                                       = $this->_req_data['success'] === '1';
-        $this->_template_args['success']               = $success;
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;
-        $this->_template_args['reset_db_action_url']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'reset_db'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_page_url']     = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'data_reset'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reattempt_action_url']  = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'reattempt_migration'],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_path                          =
-            EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Resets the entire EE4 database.
-     * only sets up ee4 database for a fresh install-
-     * doesn't actually clean out the old wp options, or cpts
-     * (although it does erase old ee table data)
-     *
-     * @param boolean $nuke_old_ee4_data controls whether we destroy the old ee4 data,
-     *                                   or just try initializing ee4 default data
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _reset_db($nuke_old_ee4_data = true)
-    {
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        if ($nuke_old_ee4_data) {
-            EEH_Activation::delete_all_espresso_cpt_data();
-            EEH_Activation::delete_all_espresso_tables_and_data(false);
-            EEH_Activation::remove_cron_tasks();
-        }
-        // make sure when we reset the registry's config that it
-        // switches to using the new singleton
-        EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
-        EE_System::instance()->initialize_db_if_no_migrations_required(true);
-        EE_System::instance()->redirect_to_about_ee();
-    }
-
-
-    /**
-     * Deletes ALL EE tables, Records, and Options from the database.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _delete_db()
-    {
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data();
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::deactivate_event_espresso();
-        wp_safe_redirect(admin_url('plugins.php'));
-        exit;
-    }
-
-
-    /**
-     * sets up EE4 to rerun the migrations from ee3 to ee4
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _rerun_migration_from_ee3()
-    {
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data(false);
-        // set the db state to something that will require migrations
-        update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
-        $this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
-        $this->_redirect_after_action(
-            true,
-            esc_html__("Database", 'event_espresso'),
-            esc_html__("reset", 'event_espresso')
-        );
-    }
-
-
-    // none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script(
-            'ee-maintenance',
-            EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style(
-            'espresso_maintenance',
-            EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_maintenance');
-        // localize script stuff
-        wp_localize_script(
-            'ee-maintenance',
-            'ee_maintenance',
-            [
-                'migrating'                        => wp_strip_all_tags(__("Updating Database...", "event_espresso")),
-                'next'                             => wp_strip_all_tags(__("Next", "event_espresso")),
-                'fatal_error'                      => wp_strip_all_tags(__(
-                    "A Fatal Error Has Occurred",
-                    "event_espresso"
-                )),
-                'click_next_when_ready'            => wp_strip_all_tags(
-                    __(
-                        "The current Database Update has ended. Click 'next' when ready to proceed",
-                        "event_espresso"
-                    )
-                ),
-                'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
-                'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
-                'status_completed'                 => EE_Data_Migration_Manager::status_completed,
-                'confirm'                          => wp_strip_all_tags(
-                    __(
-                        'Are you sure you want to do this? It CANNOT be undone!',
-                        'event_espresso'
-                    )
-                ),
-                'confirm_skip_migration'           => wp_strip_all_tags(
-                    __(
-                        'You have chosen to NOT migrate your existing data. Are you sure you want to continue?',
-                        'event_espresso'
-                    )
-                ),
-            ]
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the datetime tools page.
-     */
-    public function load_scripts_styles_datetime_tools()
-    {
-        EE_Datepicker_Input::enqueue_styles_and_scripts();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _datetime_tools()
-    {
-        $form_action                                = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'        => 'run_datetime_offset_fix',
-                'return_action' => $this->_req_action,
-            ],
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $form                                       = $this->_get_datetime_offset_fix_form();
-        $this->_admin_page_title                    = esc_html__('Datetime Utilities', 'event_espresso');
-        $this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
-                                                      . $form->get_html_and_js()
-                                                      . $form->form_close();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _get_datetime_offset_fix_form()
-    {
-        if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
-            $this->datetime_fix_offset_form = new EE_Form_Section_Proper(
-                [
-                    'name'            => 'datetime_offset_fix_option',
-                    'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                    'subsections'     => [
-                        'title'                  => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Datetime Offset Tool', 'event_espresso')
-                            )
-                        ),
-                        'explanation'            => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                esc_html__(
-                                    'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
-                                    'event_espresso'
-                                )
-                            )
-                        ),
-                        'offset_input'           => new EE_Float_Input(
-                            [
-                                'html_name'       => 'offset_for_datetimes',
-                                'html_label_text' => esc_html__(
-                                    'Offset to apply (in hours):',
-                                    'event_espresso'
-                                ),
-                                'min_value'       => '-12',
-                                'max_value'       => '14',
-                                'step_value'      => '.25',
-                                'default'         => DatetimeOffsetFix::getOffset(),
-                            ]
-                        ),
-                        'date_range_explanation' => new EE_Form_Section_HTML(
-                            EEH_HTML::p(
-                                esc_html__(
-                                    'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.',
-                                    'event_espresso'
-                                )
-                            )
-                            . EEH_HTML::p(
-                                EEH_HTML::strong(
-                                    sprintf(
-                                        esc_html__(
-                                            'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).',
-                                            'event_espresso'
-                                        ),
-                                        '<a href="https://www.timeanddate.com/worldclock/converter.html">',
-                                        '</a>'
-                                    )
-                                )
-                            )
-                        ),
-                        'date_range_start_date'  => new EE_Datepicker_Input(
-                            [
-                                'html_name'       => 'offset_date_start_range',
-                                'html_label_text' => esc_html__(
-                                    'Start Date for dates the offset applied to:',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'date_range_end_date'    => new EE_Datepicker_Input(
-                            [
-                                'html_name'       => 'offset_date_end_range',
-                                'html_label_text' => esc_html__(
-                                    'End Date for dates the offset is applied to:',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'submit'                 => new EE_Submit_Input(
-                            [
-                                'html_label_text' => '',
-                                'default'         => esc_html__('Apply Offset', 'event_espresso'),
-                            ]
-                        ),
-                    ],
-                ]
-            );
-        }
-        return $this->datetime_fix_offset_form;
-    }
-
-
-    /**
-     * Callback for the run_datetime_offset_fix route.
-     *
-     * @throws EE_Error
-     */
-    protected function _apply_datetime_offset()
-    {
-        if ($_SERVER['REQUEST_METHOD'] === 'POST') {
-            $form = $this->_get_datetime_offset_fix_form();
-            $form->receive_form_submission($this->_req_data);
-            if ($form->is_valid()) {
-                // save offset data so batch processor can get it.
-                DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
-                $utc_timezone          = new DateTimeZone('UTC');
-                $date_range_start_date = DateTime::createFromFormat(
-                    'm/d/Y H:i:s',
-                    $form->get_input_value('date_range_start_date') . ' 00:00:00',
-                    $utc_timezone
-                );
-                $date_range_end_date   = DateTime::createFromFormat(
-                    'm/d/Y H:i:s',
-                    $form->get_input_value('date_range_end_date') . ' 23:59:59',
-                    $utc_timezone
-                );
-                if ($date_range_start_date instanceof DateTime) {
-                    DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date));
-                }
-                if ($date_range_end_date instanceof DateTime) {
-                    DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date));
-                }
-                // redirect to batch tool
-                wp_redirect(
-                    EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'page'        => EED_Batch::PAGE_SLUG,
-                            'batch'       => EED_Batch::batch_job,
-                            'label'       => esc_html__('Applying Offset', 'event_espresso'),
-                            'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
-                            'return_url'  => urlencode(
-                                add_query_arg(
-                                    [
-                                        'action' => 'datetime_tools',
-                                    ],
-                                    EEH_URL::current_url_without_query_paramaters(
-                                        [
-                                            'return_action',
-                                            'run_datetime_offset_fix_nonce',
-                                            'return',
-                                            'datetime_tools_nonce',
-                                        ]
-                                    )
-                                )
-                            ),
-                        ],
-                        admin_url()
-                    )
-                );
-                exit;
-            }
-        }
-    }
+	/**
+	 * @var EE_Data_Migration_Manager
+	 */
+	protected $migration_manager;
+
+	/**
+	 * @var EE_Maintenance_Mode
+	 */
+	protected $maintenance_mode;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $datetime_fix_offset_form;
+
+
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		$this->migration_manager = EE_Data_Migration_Manager::instance();
+		$this->maintenance_mode  = EE_Maintenance_Mode::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MAINTENANCE_PG_SLUG;
+		$this->page_label       = EE_MAINTENANCE_LABEL;
+		$this->_admin_base_url  = EE_MAINTENANCE_ADMIN_URL;
+		$this->_admin_base_path = EE_MAINTENANCE_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_migration_step', [$this, 'migration_step']);
+		add_action('wp_ajax_add_error_to_migrations_ran', [$this, 'add_error_to_migrations_ran']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
+		$this->_labels           = [
+			'buttons' => [
+				'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
+				'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
+			],
+		];
+	}
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = [
+			'default'                             => [
+				'func'       => '_maintenance',
+				'capability' => 'manage_options',
+			],
+			'change_maintenance_level'            => [
+				'func'       => '_change_maintenance_level',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'system_status'                       => [
+				'func'       => '_system_status',
+				'capability' => 'manage_options',
+			],
+			'download_system_status'              => [
+				'func'       => '_download_system_status',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'send_migration_crash_report'         => [
+				'func'       => '_send_migration_crash_report',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'confirm_migration_crash_report_sent' => [
+				'func'       => '_confirm_migration_crash_report_sent',
+				'capability' => 'manage_options',
+			],
+			'data_reset'                          => [
+				'func'       => '_data_reset_and_delete',
+				'capability' => 'manage_options',
+			],
+			'reset_db'                            => [
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => ['nuke_old_ee4_data' => true],
+			],
+			'start_with_fresh_ee4_db'             => [
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => ['nuke_old_ee4_data' => false],
+			],
+			'delete_db'                           => [
+				'func'       => '_delete_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'rerun_migration_from_ee3'            => [
+				'func'       => '_rerun_migration_from_ee3',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'reset_reservations'                  => [
+				'func'       => '_reset_reservations',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'reset_capabilities'                  => [
+				'func'       => '_reset_capabilities',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'reattempt_migration'                 => [
+				'func'       => '_reattempt_migration',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'datetime_tools'                      => [
+				'func'       => '_datetime_tools',
+				'capability' => 'manage_options',
+			],
+			'run_datetime_offset_fix'             => [
+				'func'               => '_apply_datetime_offset',
+				'noheader'           => true,
+				'headers_sent_route' => 'datetime_tools',
+				'capability'         => 'manage_options',
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default'        => [
+				'nav'           => [
+					'label' => esc_html__('Maintenance', 'event_espresso'),
+					'order' => 10,
+				],
+				'require_nonce' => false,
+			],
+			'data_reset'     => [
+				'nav'           => [
+					'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
+					'order' => 20,
+				],
+				'require_nonce' => false,
+			],
+			'datetime_tools' => [
+				'nav'           => [
+					'label' => esc_html__('Datetime Utilities', 'event_espresso'),
+					'order' => 25,
+				],
+				'require_nonce' => false,
+			],
+			'system_status'  => [
+				'nav'           => [
+					'label' => esc_html__("System Information", "event_espresso"),
+					'order' => 30,
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * default maintenance page.
+	 * If we're in maintenance mode level 2, then we need to show the migration scripts and all that UI.
+	 *
+	 * @throws EE_Error
+	 */
+	public function _maintenance()
+	{
+		$show_maintenance_switch         = true;
+		$show_backup_db_text             = false;
+		$show_migration_progress         = false;
+		$script_names                    = [];
+		$addons_should_be_upgraded_first = false;
+		// it all depends on if we're in maintenance model level 1 (frontend-only) or
+		// level 2 (everything except maintenance page)
+		try {
+			// get the current maintenance level and check if
+			// we are removed
+			$mMode_level  = $this->maintenance_mode->level();
+			$placed_in_mm = $this->maintenance_mode->set_maintenance_mode_if_db_old();
+			if ($mMode_level == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
+				// we just took the site out of maintenance mode, so notify the user.
+				// unfortunately this message appears to be echoed on the NEXT page load...
+				// oh well, we should really be checking for this on addon deactivation anyways
+				EE_Error::add_attention(
+					esc_html__(
+						'Site taken out of maintenance mode because no data migration scripts are required',
+						'event_espresso'
+					)
+				);
+				$this->_process_notices(['page' => 'espresso_maintenance_settings']);
+			}
+			// in case an exception is thrown while trying to handle migrations
+			if ($mMode_level === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$show_maintenance_switch = false;
+				$show_migration_progress = true;
+				if (isset($this->_req_data['continue_migration'])) {
+					$show_backup_db_text = false;
+				} else {
+					$show_backup_db_text = true;
+				}
+				$scripts_needing_to_run          =
+					$this->migration_manager->check_for_applicable_data_migration_scripts();
+				$addons_should_be_upgraded_first = $this->migration_manager->addons_need_updating();
+				$script_names                    = [];
+				$current_script                  = null;
+				foreach ($scripts_needing_to_run as $script) {
+					if ($script instanceof EE_Data_Migration_Script_Base) {
+						if (! $current_script) {
+							$current_script = $script;
+							$current_script->migration_page_hooks();
+						}
+						$script_names[] = $script->pretty_name();
+					}
+				}
+			}
+			$most_recent_migration = $this->migration_manager->get_last_ran_script(true);
+			$exception_thrown      = false;
+		} catch (EE_Error $e) {
+			$this->migration_manager->add_error_to_migrations_ran($e->getMessage());
+			// now, just so we can display the page correctly, make an error migration script stage object
+			// and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+			$exception_thrown = true;
+		}
+		$current_db_state = $this->migration_manager->ensure_current_database_state_is_set();
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
+		if (
+			$exception_thrown
+			|| (
+				$most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->is_broken()
+			)
+		) {
+			$this->_template_path                =
+				EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+			$this->_template_args['support_url'] = 'https://eventespresso.com/support/forums/';
+			$this->_template_args['next_url']    = EEH_URL::add_query_args_and_nonce(
+				[
+					'action'  => 'confirm_migration_crash_report_sent',
+					'success' => '0',
+				],
+				EE_MAINTENANCE_ADMIN_URL
+			);
+		} elseif ($addons_should_be_upgraded_first) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+		} else {
+			if (
+				$most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->can_continue()
+			) {
+				$show_backup_db_text                    = false;
+				$show_continue_current_migration_script = true;
+				$show_most_recent_migration             = true;
+			} elseif (isset($this->_req_data['continue_migration'])) {
+				$show_most_recent_migration             = true;
+				$show_continue_current_migration_script = false;
+			} else {
+				$show_most_recent_migration             = false;
+				$show_continue_current_migration_script = false;
+			}
+			if (isset($current_script)) {
+				$migrates_to          = $current_script->migrates_to_version();
+				$plugin_slug          = $migrates_to['slug'];
+				$new_version          = $migrates_to['version'];
+				$this->_template_args = array_merge(
+					$this->_template_args,
+					[
+						'current_db_state' => sprintf(
+							esc_html__("EE%s (%s)", "event_espresso"),
+							isset($current_db_state[ $plugin_slug ]) ? $current_db_state[ $plugin_slug ] : 3,
+							$plugin_slug
+						),
+						'next_db_state'    => sprintf(
+							esc_html__("EE%s (%s)", 'event_espresso'),
+							$new_version,
+							$plugin_slug
+						),
+					]
+				);
+			} else {
+				$this->_template_args['current_db_state'] = null;
+				$this->_template_args['next_db_state']    = null;
+			}
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+			$this->_template_args = array_merge(
+				$this->_template_args,
+				[
+					'show_most_recent_migration'             => $show_most_recent_migration,
+					// flag for showing the most recent migration's status and/or errors
+					'show_migration_progress'                => $show_migration_progress,
+					// flag for showing the option to run migrations and see their progress
+					'show_backup_db_text'                    => $show_backup_db_text,
+					// flag for showing text telling the user to back up their DB
+					'show_maintenance_switch'                => $show_maintenance_switch,
+					// flag for showing the option to change maintenance mode between levels 0 and 1
+					'script_names'                           => $script_names,
+					// array of names of scripts that have run
+					'show_continue_current_migration_script' => $show_continue_current_migration_script,
+					// flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
+					'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(
+						['action' => 'reset_db'],
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(
+						['action' => 'data_reset'],
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(
+						['action' => 'change_maintenance_level'],
+						EE_MAINTENANCE_ADMIN_URL
+					),
+					'ultimate_db_state'                      => sprintf(
+						esc_html__("EE%s", 'event_espresso'),
+						espresso_version()
+					),
+				]
+			);
+		}
+		$this->_template_args['most_recent_migration'] =
+			$most_recent_migration;// the actual most recently ran migration
+		// now render the migration options part, and put it in a variable
+		$migration_options_template_file                = apply_filters(
+			'FHEE__ee_migration_page__migration_options_template',
+			EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+		);
+		$migration_options_html                         = EEH_Template::display_template(
+			$migration_options_template_file,
+			$this->_template_args,
+			true
+		);
+		$this->_template_args['migration_options_html'] = $migration_options_html;
+		$this->_template_args['admin_page_content']     = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
+	 *
+	 * @throws EE_Error
+	 */
+	public function migration_step()
+	{
+		$this->_template_args['data'] = $this->migration_manager->response_to_migration_ajax_request();
+		$this->_return_json();
+	}
+
+
+	/**
+	 * Can be used by js when it notices a response with HTML in it in order
+	 * to log the malformed response
+	 *
+	 * @throws EE_Error
+	 */
+	public function add_error_to_migrations_ran()
+	{
+		$this->migration_manager->add_error_to_migrations_ran($this->_req_data['message']);
+		$this->_template_args['data'] = ['ok' => true];
+		$this->_return_json();
+	}
+
+
+	/**
+	 * changes the maintenance level, provided there are still no migration scripts that should run
+	 *
+	 * @throws EE_Error
+	 */
+	public function _change_maintenance_level()
+	{
+		$new_level = absint($this->_req_data['maintenance_mode_level']);
+		if (! $this->migration_manager->check_for_applicable_data_migration_scripts()) {
+			$this->maintenance_mode->set_maintenance_level($new_level);
+			$success = true;
+		} else {
+			$this->maintenance_mode->set_maintenance_mode_if_db_old();
+			$success = false;
+		}
+		$this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
+	}
+
+
+	/**
+	 * a tab with options for resetting and/or deleting EE data
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function _data_reset_and_delete()
+	{
+		$this->_template_path                              =
+			EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+		$this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
+			'reset_reservations',
+			'reset_reservations',
+			[],
+			'button button--caution ee-confirm'
+		);
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
+			'reset_capabilities',
+			'reset_capabilities',
+			[],
+			'button button--caution ee-confirm'
+		);
+		$this->_template_args['delete_db_url']             = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'delete_db'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_url']              = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'reset_db'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content']        = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _reset_reservations()
+	{
+		if (EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+			EE_Error::add_success(
+				esc_html__(
+					'Ticket and datetime reserved counts have been successfully reset.',
+					'event_espresso'
+				)
+			);
+		} else {
+			EE_Error::add_success(
+				esc_html__(
+					'Ticket and datetime reserved counts were correct and did not need resetting.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_redirect_after_action(true, '', '', ['action' => 'data_reset'], true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _reset_capabilities()
+	{
+		EE_Registry::instance()->CAP->init_caps(true);
+		EE_Error::add_success(
+			esc_html__(
+				'Default Event Espresso capabilities have been restored for all current roles.',
+				'event_espresso'
+			)
+		);
+		$this->_redirect_after_action(false, '', '', ['action' => 'data_reset'], true);
+	}
+
+
+	/**
+	 * resets the DMSs, so we can attempt to continue migrating after a fatal error
+	 * (only a good idea when someone has somehow tried ot fix whatever caused
+	 * the fatal error in teh first place)
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _reattempt_migration()
+	{
+		$this->migration_manager->reattempt();
+		$this->_redirect_after_action(false, '', '', ['action' => 'default'], true);
+	}
+
+
+	/**
+	 * shows the big ol' System Information page
+	 *
+	 * @throws EE_Error
+	 */
+	public function _system_status()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+		$this->_template_args['system_stati']               = EEM_System_Status::instance()->get_system_stati();
+		$this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action' => 'download_system_status',
+			],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content']         = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * Downloads an HTML file of the system status that can be easily stored or emailed
+	 */
+	public function _download_system_status()
+	{
+		$status_info = EEM_System_Status::instance()->get_system_stati();
+		header('Content-Disposition: attachment');
+		header("Content-Disposition: attachment; filename=system_status_" . sanitize_key(site_url()) . ".html");
+		$output = '<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>';
+		$output .= '<h1>' . sprintf(
+			__('System Information for %1$s', 'event_espresso'),
+			esc_url_raw(site_url())
+		) . '</h1>';
+		$output .= EEH_Template::layout_array_as_table($status_info);
+		echo esc_html($output);
+		die;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function _send_migration_crash_report()
+	{
+		$from      = $this->_req_data['from'];
+		$from_name = $this->_req_data['from_name'];
+		$body      = $this->_req_data['body'];
+		try {
+			$success = wp_mail(
+				EE_SUPPORT_EMAIL,
+				'Migration Crash Report',
+				$body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+				[
+					"from:$from_name<$from>",
+				]
+			);
+		} catch (Exception $e) {
+			$success = false;
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__("Migration Crash Report", "event_espresso"),
+			esc_html__("sent", "event_espresso"),
+			['success' => $success, 'action' => 'confirm_migration_crash_report_sent']
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function _confirm_migration_crash_report_sent()
+	{
+		try {
+			$most_recent_migration = $this->migration_manager->get_last_ran_script(true);
+		} catch (EE_Error $e) {
+			$this->migration_manager->add_error_to_migrations_ran($e->getMessage());
+			// now, just so we can display the page correctly, make an error migration script stage object
+			// and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+		}
+		$success                                       = $this->_req_data['success'] === '1';
+		$this->_template_args['success']               = $success;
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
+		$this->_template_args['reset_db_action_url']   = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'reset_db'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_page_url']     = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'data_reset'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reattempt_action_url']  = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'reattempt_migration'],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_path                          =
+			EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+		$this->_template_args['admin_page_content']    = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Resets the entire EE4 database.
+	 * only sets up ee4 database for a fresh install-
+	 * doesn't actually clean out the old wp options, or cpts
+	 * (although it does erase old ee table data)
+	 *
+	 * @param boolean $nuke_old_ee4_data controls whether we destroy the old ee4 data,
+	 *                                   or just try initializing ee4 default data
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _reset_db($nuke_old_ee4_data = true)
+	{
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		if ($nuke_old_ee4_data) {
+			EEH_Activation::delete_all_espresso_cpt_data();
+			EEH_Activation::delete_all_espresso_tables_and_data(false);
+			EEH_Activation::remove_cron_tasks();
+		}
+		// make sure when we reset the registry's config that it
+		// switches to using the new singleton
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
+		EE_System::instance()->initialize_db_if_no_migrations_required(true);
+		EE_System::instance()->redirect_to_about_ee();
+	}
+
+
+	/**
+	 * Deletes ALL EE tables, Records, and Options from the database.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _delete_db()
+	{
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data();
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::deactivate_event_espresso();
+		wp_safe_redirect(admin_url('plugins.php'));
+		exit;
+	}
+
+
+	/**
+	 * sets up EE4 to rerun the migrations from ee3 to ee4
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _rerun_migration_from_ee3()
+	{
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data(false);
+		// set the db state to something that will require migrations
+		update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
+		$this->maintenance_mode->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
+		$this->_redirect_after_action(
+			true,
+			esc_html__("Database", 'event_espresso'),
+			esc_html__("reset", 'event_espresso')
+		);
+	}
+
+
+	// none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script(
+			'ee-maintenance',
+			EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style(
+			'espresso_maintenance',
+			EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_maintenance');
+		// localize script stuff
+		wp_localize_script(
+			'ee-maintenance',
+			'ee_maintenance',
+			[
+				'migrating'                        => wp_strip_all_tags(__("Updating Database...", "event_espresso")),
+				'next'                             => wp_strip_all_tags(__("Next", "event_espresso")),
+				'fatal_error'                      => wp_strip_all_tags(__(
+					"A Fatal Error Has Occurred",
+					"event_espresso"
+				)),
+				'click_next_when_ready'            => wp_strip_all_tags(
+					__(
+						"The current Database Update has ended. Click 'next' when ready to proceed",
+						"event_espresso"
+					)
+				),
+				'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
+				'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
+				'status_completed'                 => EE_Data_Migration_Manager::status_completed,
+				'confirm'                          => wp_strip_all_tags(
+					__(
+						'Are you sure you want to do this? It CANNOT be undone!',
+						'event_espresso'
+					)
+				),
+				'confirm_skip_migration'           => wp_strip_all_tags(
+					__(
+						'You have chosen to NOT migrate your existing data. Are you sure you want to continue?',
+						'event_espresso'
+					)
+				),
+			]
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the datetime tools page.
+	 */
+	public function load_scripts_styles_datetime_tools()
+	{
+		EE_Datepicker_Input::enqueue_styles_and_scripts();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _datetime_tools()
+	{
+		$form_action                                = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'        => 'run_datetime_offset_fix',
+				'return_action' => $this->_req_action,
+			],
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$form                                       = $this->_get_datetime_offset_fix_form();
+		$this->_admin_page_title                    = esc_html__('Datetime Utilities', 'event_espresso');
+		$this->_template_args['admin_page_content'] = $form->form_open($form_action, 'post')
+													  . $form->get_html_and_js()
+													  . $form->form_close();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime_offset_fix_form()
+	{
+		if (! $this->datetime_fix_offset_form instanceof EE_Form_Section_Proper) {
+			$this->datetime_fix_offset_form = new EE_Form_Section_Proper(
+				[
+					'name'            => 'datetime_offset_fix_option',
+					'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+					'subsections'     => [
+						'title'                  => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Datetime Offset Tool', 'event_espresso')
+							)
+						),
+						'explanation'            => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Use this tool to automatically apply the provided offset to all Event Espresso records in your database that involve dates and times.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								esc_html__(
+									'Note: If you enter 1.25, that will result in the offset of 1 hour 15 minutes being applied.  Decimals represent the fraction of hours, not minutes.',
+									'event_espresso'
+								)
+							)
+						),
+						'offset_input'           => new EE_Float_Input(
+							[
+								'html_name'       => 'offset_for_datetimes',
+								'html_label_text' => esc_html__(
+									'Offset to apply (in hours):',
+									'event_espresso'
+								),
+								'min_value'       => '-12',
+								'max_value'       => '14',
+								'step_value'      => '.25',
+								'default'         => DatetimeOffsetFix::getOffset(),
+							]
+						),
+						'date_range_explanation' => new EE_Form_Section_HTML(
+							EEH_HTML::p(
+								esc_html__(
+									'Leave the following fields blank if you want the offset to be applied to all dates. If however, you want to just apply the offset to a specific range of dates you can restrict the offset application using these fields.',
+									'event_espresso'
+								)
+							)
+							. EEH_HTML::p(
+								EEH_HTML::strong(
+									sprintf(
+										esc_html__(
+											'Note: please enter the dates in UTC (You can use %1$sthis online tool%2$s to assist with conversions).',
+											'event_espresso'
+										),
+										'<a href="https://www.timeanddate.com/worldclock/converter.html">',
+										'</a>'
+									)
+								)
+							)
+						),
+						'date_range_start_date'  => new EE_Datepicker_Input(
+							[
+								'html_name'       => 'offset_date_start_range',
+								'html_label_text' => esc_html__(
+									'Start Date for dates the offset applied to:',
+									'event_espresso'
+								),
+							]
+						),
+						'date_range_end_date'    => new EE_Datepicker_Input(
+							[
+								'html_name'       => 'offset_date_end_range',
+								'html_label_text' => esc_html__(
+									'End Date for dates the offset is applied to:',
+									'event_espresso'
+								),
+							]
+						),
+						'submit'                 => new EE_Submit_Input(
+							[
+								'html_label_text' => '',
+								'default'         => esc_html__('Apply Offset', 'event_espresso'),
+							]
+						),
+					],
+				]
+			);
+		}
+		return $this->datetime_fix_offset_form;
+	}
+
+
+	/**
+	 * Callback for the run_datetime_offset_fix route.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _apply_datetime_offset()
+	{
+		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+			$form = $this->_get_datetime_offset_fix_form();
+			$form->receive_form_submission($this->_req_data);
+			if ($form->is_valid()) {
+				// save offset data so batch processor can get it.
+				DatetimeOffsetFix::updateOffset($form->get_input_value('offset_input'));
+				$utc_timezone          = new DateTimeZone('UTC');
+				$date_range_start_date = DateTime::createFromFormat(
+					'm/d/Y H:i:s',
+					$form->get_input_value('date_range_start_date') . ' 00:00:00',
+					$utc_timezone
+				);
+				$date_range_end_date   = DateTime::createFromFormat(
+					'm/d/Y H:i:s',
+					$form->get_input_value('date_range_end_date') . ' 23:59:59',
+					$utc_timezone
+				);
+				if ($date_range_start_date instanceof DateTime) {
+					DatetimeOffsetFix::updateStartDateRange(DbSafeDateTime::createFromDateTime($date_range_start_date));
+				}
+				if ($date_range_end_date instanceof DateTime) {
+					DatetimeOffsetFix::updateEndDateRange(DbSafeDateTime::createFromDateTime($date_range_end_date));
+				}
+				// redirect to batch tool
+				wp_redirect(
+					EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'page'        => EED_Batch::PAGE_SLUG,
+							'batch'       => EED_Batch::batch_job,
+							'label'       => esc_html__('Applying Offset', 'event_espresso'),
+							'job_handler' => urlencode('EventEspressoBatchRequest\JobHandlers\DatetimeOffsetFix'),
+							'return_url'  => urlencode(
+								add_query_arg(
+									[
+										'action' => 'datetime_tools',
+									],
+									EEH_URL::current_url_without_query_paramaters(
+										[
+											'return_action',
+											'run_datetime_offset_fix_nonce',
+											'return',
+											'datetime_tools_nonce',
+										]
+									)
+								)
+							),
+						],
+						admin_url()
+					)
+				);
+				exit;
+			}
+		}
+	}
 }

modules/batch/templates/batch_runner.template.php

Spacing +1 added lines, -1 removed lines

@@ -4,7 +4,7 @@
 
 <div class="ee-batch-runner__wrapper ee-admin-container">
     <div class="padding">
-        <h1><?php esc_html_e('Running Batch Job...', 'event_espresso');?></h1>
+        <h1><?php esc_html_e('Running Batch Job...', 'event_espresso'); ?></h1>
         <div class="progress-bar-wrapper">
             <div id='batch-progress' class='progress-responsive'></div>
             <label><?php esc_html_e('progress', 'event_espresso'); ?></label>

modules/batch/templates/batch_wrapper.template.php

Indentation +2 added lines, -2 removed lines

@@ -3,7 +3,7 @@
 // just makes the template conditional on the batch request type
 $batch_request_type = EED_Batch::instance()->batch_request_type();
 if ($batch_request_type == EED_Batch::batch_job) {
-    require('batch_runner.template.php');
+	require('batch_runner.template.php');
 } elseif ($batch_request_type == EED_Batch::batch_file_job) {
-    require('batch_file_runner.template.php');
+	require('batch_file_runner.template.php');
 }