eventespresso / event-espresso-core

modules/events_archive/EventsArchiveIframe.php

Indentation +58 added lines, -58 removed lines

@@ -21,62 +21,62 @@
  */
 class EventsArchiveIframe extends Iframe
 {
-    /**
-     * EventsArchiveIframe constructor.
-     *
-     * @param EED_Events_Archive $EED_Events_Archive
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($EED_Events_Archive)
-    {
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-        add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
-        $EED_Events_Archive->event_list();
-        /** @var EspressoEvents $event_list */
-        $event_list = EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
-        $shortcode_content = $event_list->processShortcode();
-        if (empty($shortcode_content)) {
-            return;
-        }
-        parent::__construct(
-            esc_html__('Event List', 'event_espresso'),
-            $shortcode_content
-        );
-        $this->addStylesheets(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-                [
-                    'espresso_default' => is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                        ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
-                        : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
-                ],
-                $this
-            )
-        );
-        $this->addScripts(
-            apply_filters(
-                'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-                [
-                    'gmap_api' => sprintf(
-                        'https://maps.googleapis.com/maps/api/js?key=%s',
-                        apply_filters(
-                            'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                            EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                        )
-                    ),
-                    'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
-                ],
-                $this
-            )
-        );
-        $this->addLocalizedVars(
-            [
-                'ee_gmap' => EEH_Maps::$gmap_vars,
-            ],
-            'ee_gmap_vars'
-        );
-    }
+	/**
+	 * EventsArchiveIframe constructor.
+	 *
+	 * @param EED_Events_Archive $EED_Events_Archive
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($EED_Events_Archive)
+	{
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+		add_filter('FHEE__EED_Events_Archive__event_list_iframe', '__return_true');
+		$EED_Events_Archive->event_list();
+		/** @var EspressoEvents $event_list */
+		$event_list = EE_Registry::instance()->create('EventEspresso\core\domain\entities\shortcodes\EspressoEvents');
+		$shortcode_content = $event_list->processShortcode();
+		if (empty($shortcode_content)) {
+			return;
+		}
+		parent::__construct(
+			esc_html__('Event List', 'event_espresso'),
+			$shortcode_content
+		);
+		$this->addStylesheets(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+				[
+					'espresso_default' => is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+						? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION
+						: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css?ver=' . EVENT_ESPRESSO_VERSION,
+				],
+				$this
+			)
+		);
+		$this->addScripts(
+			apply_filters(
+				'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+				[
+					'gmap_api' => sprintf(
+						'https://maps.googleapis.com/maps/api/js?key=%s',
+						apply_filters(
+							'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+							EE_Registry::instance()->CFG->map_settings->google_map_api_key
+						)
+					),
+					'ee_gmap'  => EE_HELPERS_ASSETS . 'ee_gmap.js?ver=1.0',
+				],
+				$this
+			)
+		);
+		$this->addLocalizedVars(
+			[
+				'ee_gmap' => EEH_Maps::$gmap_vars,
+			],
+			'ee_gmap_vars'
+		);
+	}
 }

modules/batch/EED_Batch.module.php

Indentation +434 added lines, -434 removed lines

@@ -29,438 +29,438 @@
  */
 class EED_Batch extends EED_Module
 {
-    public const PAGE_SLUG = 'espresso_batch';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * processes data only
-     */
-    const batch_job = 'job';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * produces a file for download
-     */
-    const batch_file_job = 'file';
-
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
-     * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
-     * at all
-     */
-    const batch_not_job = 'none';
-
-    /**
-     *
-     * @var string 'file', or 'job', or false to indicate its not a batch request at all
-     */
-    protected $_batch_request_type = '';
-
-    /**
-     * Because we want to use the response in both the localized JS and in the body
-     * we need to make this response available between method calls
-     *
-     * @var JobStepResponse|null
-     */
-    protected $_job_step_response = null;
-
-    /**
-     * @var LoaderInterface|null
-     */
-    protected $loader = null;
-
-
-    /**
-     * Gets the batch instance
-     *
-     * @return  EED_Module|EED_Batch
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Batch
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Sets hooks to enable batch jobs on the frontend. Disabled by default
-     * because it's an attack vector and there are currently no implementations
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks()
-    {
-        // because this is a possible attack vector, let's have this disabled until
-        // we at least have a real use for it on the frontend
-        if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
-            add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-            add_filter('template_include', [self::instance(), 'override_template'], 99);
-        }
-    }
-
-
-    /**
-     * Initializes some hooks for the admin in order to run batch jobs
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('admin_menu', [self::instance(), 'register_admin_pages']);
-        add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
-
-        // ajax
-        add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
-        add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
-    }
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Enqueues batch scripts on the frontend or admin, and creates a job
-     */
-    public function enqueue_scripts()
-    {
-        $request = EED_Batch::getRequest();
-        if (
-            $request->getRequestParam(EED_Batch::PAGE_SLUG)
-            || $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
-        ) {
-            if (
-                ! $request->requestParamIsSet('default_nonce')
-                || ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
-            ) {
-                wp_die(
-                    esc_html__(
-                        'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
-                        'event_espresso'
-                    )
-                );
-            }
-            switch ($this->batch_request_type()) {
-                case self::batch_job:
-                    $this->enqueue_scripts_styles_batch_create();
-                    break;
-                case self::batch_file_job:
-                    $this->enqueue_scripts_styles_batch_file_create();
-                    break;
-            }
-        }
-    }
-
-
-    /**
-     * Create a batch job, enqueues a script to run it, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_create()
-    {
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
-        if ($return_url) {
-            wp_localize_script(
-                'batch_runner_init',
-                'ee_job_i18n',
-                [
-                    'return_url'                => $return_url,
-                    'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
-                        'auto_redirect_on_complete'
-                    ),
-                    'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                        ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_file_create()
-    {
-        // creates a job based on the request variable
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
-            ['batch_runner'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
-
-        $return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
-        if ($return_url) {
-            wp_localize_script(
-                'batch_file_runner_init',
-                'ee_job_i18n',
-                ['return_url' => $return_url]
-            );
-        }
-    }
-
-
-    /**
-     * Enqueues scripts and styles common to any batch job, and creates
-     * a job from the request data, and stores the response in the
-     * $this->_job_step_response property
-     *
-     * @return JobStepResponse
-     */
-    protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
-    {
-        // just copy the bits of EE admin's eei18n that we need in the JS
-        EE_Registry::$i18n_js_strings['batchJobError'] = __(
-            'An error occurred and the job has been stopped. Please refresh the page to try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
-        wp_enqueue_style(
-            EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
-            ['espresso_admin_base'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style(
-            'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
-            [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-            date('Y-m-d-H:i', time())
-        );
-        wp_register_script(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
-            ['jquery'],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        wp_enqueue_style(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
-            [],
-            date('Y-m-d-H:i', time())
-        );
-        wp_enqueue_script(
-            'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
-            ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
-            date('Y-m-d-H:i', time()),
-            true
-        );
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
-        // remember the response for later. We need it to display the page body
-        $this->_job_step_response = $batch_runner->createJob();
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
-     *
-     * @param string $template
-     * @return string
-     */
-    public function override_template(string $template): string
-    {
-        $request = EED_Batch::getRequest();
-        if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
-        }
-        return $template;
-    }
-
-
-    /**
-     * Adds an admin page which doesn't appear in the admin menu
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function register_admin_pages()
-    {
-        add_submenu_page(
-            '',
-            // parent slug. we don't want this to actually appear in the menu
-            esc_html__('Batch Job', 'event_espresso'),
-            // page title
-            'n/a',
-            // menu title
-            'read',
-            // we want this page to actually be accessible to anyone,
-            EED_Batch::PAGE_SLUG,
-            // menu slug
-            [self::instance(), 'show_admin_page']
-        );
-    }
-
-
-    /**
-     * Renders the admin page, after most of the work was already done during enqueuing scripts
-     * of creating the job and localizing some data
-     */
-    public function show_admin_page()
-    {
-        echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
-            [
-                'batch_request_type'        => $this->batch_request_type(),
-                'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
-                'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
-                    ?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
-            ]
-        );
-    }
-
-
-    private function runBatchRunnerJob(string $job)
-    {
-        $job_id = EED_Batch::getRequest()->getRequestParam('job_id');
-        /** @var BatchRequestProcessor $batch_runner */
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $job_response = $batch_runner->{$job}($job_id);
-        $this->_return_json($job_response->to_array());
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function continueBatchJob()
-    {
-        $this->runBatchRunnerJob('continueJob');
-    }
-
-
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function advanceBatchJob()
-    {
-        $this->runBatchRunnerJob('advanceJob');
-    }
-
-
-    /**
-     * Receives the ajax call to cleanup a job
-     *
-     * @return void
-     */
-    public function cleanupBatchJob()
-    {
-        $this->runBatchRunnerJob('cleanupJob');
-    }
-
-
-    /**
-     * Returns a json response
-     *
-     * @param array $data The data we want to send echo via in the JSON response's "data" element
-     *
-     * The returned json object is created from an array in the following format:
-     * array(
-     *    'notices' => '', // - contains any EE_Error formatted notices
-     *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *    We're also going to include the template args with every package (so js can pick out any specific template
-     *    args that might be included in here)
-     *    'isEEajax' => true,//indicates this is a response from EE
-     * )
-     */
-    protected function _return_json(array $data)
-    {
-        $json = [
-            'data'     => $data,
-            'isEEajax' => true,
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        ];
-
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (error_get_last() === null || ! headers_sent()) {
-            $notices = EE_Error::get_notices(false);
-            header('Content-Type: application/json; charset=UTF-8');
-            echo wp_json_encode($json + $notices);
-            exit();
-        }
-    }
-
-
-    /**
-     * Gets the job step response which was done during the enqueuing of scripts
-     *
-     * @return JobStepResponse
-     */
-    public function job_step_response(): JobStepResponse
-    {
-        return $this->_job_step_response;
-    }
-
-
-    /**
-     * Gets the batch request type indicated in the current request
-     *
-     * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
-     */
-    public function batch_request_type(): string
-    {
-        if (! $this->_batch_request_type) {
-            $request = EED_Batch::getRequest();
-            $batch   = $request->getRequestParam('batch');
-            switch ($batch) {
-                case self::batch_job:
-                    $this->_batch_request_type = self::batch_job;
-                    break;
-                case self::batch_file_job:
-                    $this->_batch_request_type = self::batch_file_job;
-                    break;
-                default:
-                    // if we didn't find that it was a batch request, indicate it wasn't
-                    $this->_batch_request_type = self::batch_not_job;
-            }
-        }
-        return $this->_batch_request_type;
-    }
-
-
-    /**
-     * Unnecessary
-     *
-     * @param WP $WP
-     */
-    public function run($WP)
-    {
-    }
+	public const PAGE_SLUG = 'espresso_batch';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * processes data only
+	 */
+	const batch_job = 'job';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * produces a file for download
+	 */
+	const batch_file_job = 'file';
+
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
+	 * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
+	 * at all
+	 */
+	const batch_not_job = 'none';
+
+	/**
+	 *
+	 * @var string 'file', or 'job', or false to indicate its not a batch request at all
+	 */
+	protected $_batch_request_type = '';
+
+	/**
+	 * Because we want to use the response in both the localized JS and in the body
+	 * we need to make this response available between method calls
+	 *
+	 * @var JobStepResponse|null
+	 */
+	protected $_job_step_response = null;
+
+	/**
+	 * @var LoaderInterface|null
+	 */
+	protected $loader = null;
+
+
+	/**
+	 * Gets the batch instance
+	 *
+	 * @return  EED_Module|EED_Batch
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Batch
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Sets hooks to enable batch jobs on the frontend. Disabled by default
+	 * because it's an attack vector and there are currently no implementations
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks()
+	{
+		// because this is a possible attack vector, let's have this disabled until
+		// we at least have a real use for it on the frontend
+		if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
+			add_action('wp_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+			add_filter('template_include', [self::instance(), 'override_template'], 99);
+		}
+	}
+
+
+	/**
+	 * Initializes some hooks for the admin in order to run batch jobs
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('admin_menu', [self::instance(), 'register_admin_pages']);
+		add_action('admin_enqueue_scripts', [self::instance(), 'enqueue_scripts']);
+
+		// ajax
+		add_action('wp_ajax_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_continue', [self::instance(), 'continueBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_advance', [self::instance(), 'advanceBatchJob']);
+		add_action('wp_ajax_nopriv_espresso_batch_cleanup', [self::instance(), 'cleanupBatchJob']);
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Enqueues batch scripts on the frontend or admin, and creates a job
+	 */
+	public function enqueue_scripts()
+	{
+		$request = EED_Batch::getRequest();
+		if (
+			$request->getRequestParam(EED_Batch::PAGE_SLUG)
+			|| $request->getRequestParam('page') === EED_Batch::PAGE_SLUG
+		) {
+			if (
+				! $request->requestParamIsSet('default_nonce')
+				|| ! wp_verify_nonce($request->getRequestParam('default_nonce'), 'default_nonce')
+			) {
+				wp_die(
+					esc_html__(
+						'The link you clicked to start the batch job has expired. Please go back and refresh the previous page.',
+						'event_espresso'
+					)
+				);
+			}
+			switch ($this->batch_request_type()) {
+				case self::batch_job:
+					$this->enqueue_scripts_styles_batch_create();
+					break;
+				case self::batch_file_job:
+					$this->enqueue_scripts_styles_batch_file_create();
+					break;
+			}
+		}
+	}
+
+
+	/**
+	 * Create a batch job, enqueues a script to run it, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_create()
+	{
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_runner_init',
+			BATCH_URL . 'assets/batch_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
+		if ($return_url) {
+			wp_localize_script(
+				'batch_runner_init',
+				'ee_job_i18n',
+				[
+					'return_url'                => $return_url,
+					'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam(
+						'auto_redirect_on_complete'
+					),
+					'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+						?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_file_create()
+	{
+		// creates a job based on the request variable
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_file_runner_init',
+			BATCH_URL . 'assets/batch_file_runner_init.js',
+			['batch_runner'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script('batch_file_runner_init', 'eei18n', EE_Registry::$i18n_js_strings);
+
+		$return_url = EED_Batch::getRequest()->getRequestParam('return_url', '', DataType::URL);
+		if ($return_url) {
+			wp_localize_script(
+				'batch_file_runner_init',
+				'ee_job_i18n',
+				['return_url' => $return_url]
+			);
+		}
+	}
+
+
+	/**
+	 * Enqueues scripts and styles common to any batch job, and creates
+	 * a job from the request data, and stores the response in the
+	 * $this->_job_step_response property
+	 *
+	 * @return JobStepResponse
+	 */
+	protected function _enqueue_batch_job_scripts_and_styles_and_start_job(): JobStepResponse
+	{
+		// just copy the bits of EE admin's eei18n that we need in the JS
+		EE_Registry::$i18n_js_strings['batchJobError'] = __(
+			'An error occurred and the job has been stopped. Please refresh the page to try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+		wp_enqueue_style(
+			EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
+			EE_ADMIN_URL . 'assets/ee-admin-page.css',
+			['espresso_admin_base'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style(
+			'batch_runner',
+			BATCH_URL . 'assets/batch_runner.css',
+			[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+			date('Y-m-d-H:i', time())
+		);
+		wp_register_script(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+			['jquery'],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		wp_enqueue_style(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+			[],
+			date('Y-m-d-H:i', time())
+		);
+		wp_enqueue_script(
+			'batch_runner',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+			['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
+			date('Y-m-d-H:i', time()),
+			true
+		);
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		// eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
+		// remember the response for later. We need it to display the page body
+		$this->_job_step_response = $batch_runner->createJob();
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
+	 *
+	 * @param string $template
+	 * @return string
+	 */
+	public function override_template(string $template): string
+	{
+		$request = EED_Batch::getRequest();
+		if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
+			return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+		}
+		return $template;
+	}
+
+
+	/**
+	 * Adds an admin page which doesn't appear in the admin menu
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function register_admin_pages()
+	{
+		add_submenu_page(
+			'',
+			// parent slug. we don't want this to actually appear in the menu
+			esc_html__('Batch Job', 'event_espresso'),
+			// page title
+			'n/a',
+			// menu title
+			'read',
+			// we want this page to actually be accessible to anyone,
+			EED_Batch::PAGE_SLUG,
+			// menu slug
+			[self::instance(), 'show_admin_page']
+		);
+	}
+
+
+	/**
+	 * Renders the admin page, after most of the work was already done during enqueuing scripts
+	 * of creating the job and localizing some data
+	 */
+	public function show_admin_page()
+	{
+		echo EEH_Template::locate_template(
+			EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+			[
+				'batch_request_type'        => $this->batch_request_type(),
+				'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
+				'user_message'              => EED_Batch::getRequest()->getRequestParam('assessment_notice')
+					?: EED_Batch::getRequest()->getRequestParam('job_start_notice'),
+			]
+		);
+	}
+
+
+	private function runBatchRunnerJob(string $job)
+	{
+		$job_id = EED_Batch::getRequest()->getRequestParam('job_id');
+		/** @var BatchRequestProcessor $batch_runner */
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$job_response = $batch_runner->{$job}($job_id);
+		$this->_return_json($job_response->to_array());
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function continueBatchJob()
+	{
+		$this->runBatchRunnerJob('continueJob');
+	}
+
+
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function advanceBatchJob()
+	{
+		$this->runBatchRunnerJob('advanceJob');
+	}
+
+
+	/**
+	 * Receives the ajax call to cleanup a job
+	 *
+	 * @return void
+	 */
+	public function cleanupBatchJob()
+	{
+		$this->runBatchRunnerJob('cleanupJob');
+	}
+
+
+	/**
+	 * Returns a json response
+	 *
+	 * @param array $data The data we want to send echo via in the JSON response's "data" element
+	 *
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *    'notices' => '', // - contains any EE_Error formatted notices
+	 *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *    We're also going to include the template args with every package (so js can pick out any specific template
+	 *    args that might be included in here)
+	 *    'isEEajax' => true,//indicates this is a response from EE
+	 * )
+	 */
+	protected function _return_json(array $data)
+	{
+		$json = [
+			'data'     => $data,
+			'isEEajax' => true,
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		];
+
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (error_get_last() === null || ! headers_sent()) {
+			$notices = EE_Error::get_notices(false);
+			header('Content-Type: application/json; charset=UTF-8');
+			echo wp_json_encode($json + $notices);
+			exit();
+		}
+	}
+
+
+	/**
+	 * Gets the job step response which was done during the enqueuing of scripts
+	 *
+	 * @return JobStepResponse
+	 */
+	public function job_step_response(): JobStepResponse
+	{
+		return $this->_job_step_response;
+	}
+
+
+	/**
+	 * Gets the batch request type indicated in the current request
+	 *
+	 * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
+	 */
+	public function batch_request_type(): string
+	{
+		if (! $this->_batch_request_type) {
+			$request = EED_Batch::getRequest();
+			$batch   = $request->getRequestParam('batch');
+			switch ($batch) {
+				case self::batch_job:
+					$this->_batch_request_type = self::batch_job;
+					break;
+				case self::batch_file_job:
+					$this->_batch_request_type = self::batch_file_job;
+					break;
+				default:
+					// if we didn't find that it was a batch request, indicate it wasn't
+					$this->_batch_request_type = self::batch_not_job;
+			}
+		}
+		return $this->_batch_request_type;
+	}
+
+
+	/**
+	 * Unnecessary
+	 *
+	 * @param WP $WP
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -131,7 +131,7 @@ 
      */
     protected function getLoader(): LoaderInterface
     {
-        if (! $this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -179,7 +179,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
+            BATCH_URL.'assets/batch_runner_init.js',
             ['batch_runner'],
             date('Y-m-d-H:i', time()),
             true
@@ -214,7 +214,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
+            BATCH_URL.'assets/batch_file_runner_init.js',
             ['batch_runner'],
             date('Y-m-d-H:i', time()),
             true
@@ -247,35 +247,35 @@ 
             'An error occurred and the job has been stopped. Please refresh the page to try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['is_admin']      = is_admin();
+        EE_Registry::$i18n_js_strings['is_admin'] = is_admin();
         wp_enqueue_style(
             EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN,
-            EE_ADMIN_URL . 'assets/ee-admin-page.css',
+            EE_ADMIN_URL.'assets/ee-admin-page.css',
             ['espresso_admin_base'],
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style(
             'batch_runner',
-            BATCH_URL . 'assets/batch_runner.css',
+            BATCH_URL.'assets/batch_runner.css',
             [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
             date('Y-m-d-H:i', time())
         );
         wp_register_script(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.js',
             ['jquery'],
             date('Y-m-d-H:i', time()),
             true
         );
         wp_enqueue_style(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.css',
             [],
             date('Y-m-d-H:i', time())
         );
         wp_enqueue_script(
             'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/batch_runner.js',
             ['progress_bar', CoreAssetManager::JS_HANDLE_CORE],
             date('Y-m-d-H:i', time()),
             true
@@ -299,7 +299,7 @@ 
     {
         $request = EED_Batch::getRequest();
         if ($request->requestParamIsSet('batch') && $request->requestParamIsSet(EED_Batch::PAGE_SLUG)) {
-            return EE_MODULES . 'batch/templates/batch_frontend_wrapper.template.php';
+            return EE_MODULES.'batch/templates/batch_frontend_wrapper.template.php';
         }
         return $template;
     }
@@ -336,7 +336,7 @@ 
     public function show_admin_page()
     {
         echo EEH_Template::locate_template(
-            EE_MODULES . 'batch/templates/batch_wrapper.template.php',
+            EE_MODULES.'batch/templates/batch_wrapper.template.php',
             [
                 'batch_request_type'        => $this->batch_request_type(),
                 'auto_redirect_on_complete' => EED_Batch::getRequest()->getRequestParam('auto_redirect_on_complete'),
@@ -436,7 +436,7 @@ 
      */
     public function batch_request_type(): string
     {
-        if (! $this->_batch_request_type) {
+        if ( ! $this->_batch_request_type) {
             $request = EED_Batch::getRequest();
             $batch   = $request->getRequestParam('batch');
             switch ($batch) {