eventespresso / event-espresso-core

core/libraries/batch/JobHandlerBaseClasses/JobHandlerFile.php

Spacing +7 added lines, -7 removed lines

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

Indentation +140 added lines, -140 removed lines

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

core/EE_Front_Controller.core.php

Spacing +5 added lines, -5 removed lines

@@ -98,7 +98,7 @@ 
      */
     public function Request_Handler()
     {
-        if (! $this->Request_Handler instanceof EE_Request_Handler) {
+        if ( ! $this->Request_Handler instanceof EE_Request_Handler) {
             $this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
         }
         return $this->Request_Handler;
@@ -333,7 +333,7 @@ 
         print(
         apply_filters(
             'FHEE__EE_Front_Controller__header_meta_tag',
-            '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
+            '<meta name="generator" content="Event Espresso Version '.EVENT_ESPRESSO_VERSION."\" />\n"
         )
         );
 
@@ -350,7 +350,7 @@ 
             print(
             apply_filters(
                 'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                '<meta name="robots" content="noindex,follow" />' . "\n"
+                '<meta name="robots" content="noindex,follow" />'."\n"
             )
             );
         }
@@ -434,7 +434,7 @@ 
     public function prependNotices($the_content)
     {
         $notices = $this->printNotices();
-        return $notices ? $notices . $the_content : $the_content;
+        return $notices ? $notices.$the_content : $the_content;
     }
 
 
@@ -446,7 +446,7 @@ 
     {
         ob_start();
         echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
-        EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+        EEH_Template::display_template(EE_TEMPLATES.'espresso-ajax-notices.template.php');
         return ob_get_clean();
     }
 

Indentation +511 added lines, -511 removed lines

@@ -19,515 +19,515 @@
  */
 final class EE_Front_Controller
 {
-    /**
-     * @var string
-     */
-    private $_template_path;
-
-    /**
-     * @var string
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-    /**
-     * @type CurrentPage
-     */
-    protected $current_page;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param EE_Registry              $Registry
-     * @param CurrentPage              $EspressoPage
-     * @param EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        CurrentPage $EspressoPage,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->current_page          = $EspressoPage;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // load other resources and begin to actually run shortcodes and modules
-        // analyse the incoming WP request
-        add_action('parse_request', array($this, 'get_request'), 1, 1);
-        // process request with module factory
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
-        // before headers sent
-        add_action('wp', array($this, 'wp'), 5);
-        // primarily used to process any content shortcodes
-        add_action('template_redirect', array($this, 'templateRedirect'), 999);
-        // header
-        add_action('wp_head', array($this, 'header_meta_tag'), 5);
-        add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
-        add_filter('template_include', array($this, 'template_include'), 1);
-        // display errors
-        add_action('loop_start', array($this, 'display_errors'), 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        // exclude our private cpt comments
-        add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
-        // make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     * @deprecated 4.10.14.p
-     */
-    public function Request_Handler()
-    {
-        if (! $this->Request_Handler instanceof EE_Request_Handler) {
-            $this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
-        }
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     * @deprecated 4.10.14.p
-     */
-    public function getLegacyShortcodesManager()
-    {
-        return EE_Config::getLegacyShortcodesManager();
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param  array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $cpts = $custom_post_types->getPrivateCustomPostTypes();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param  string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->current_page->parseQueryVars($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-        remove_action('parse_request', [$this, 'get_request'], 1);
-    }
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
-
-
-
-    /***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks sidebars for EE widgets
-     * loads resources and assets accordingly
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        // if we already know this is an espresso page, then load assets
-        $load_assets = $this->current_page->isEspressoPage();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
-        if ($load_assets) {
-            add_action('wp_enqueue_scripts', array($this, 'enqueueStyle'), 10);
-            add_action('wp_enqueue_scripts', array($this, 'enqueueScripts'), 10);
-        }
-
-        if (is_singular(EspressoPostType::EVENTS)) {
-            new FilterNextPreviousEventPostQuery();
-        }
-    }
-
-
-    /**
-     * builds list of active widgets then scans active sidebars looking for them
-     * returns true is an EE widget is found in an active sidebar
-     * Please Note: this does NOT mean that the sidebar or widget
-     * is actually in use in a given template, as that is unfortunately not known
-     * until a sidebar and it's widgets are actually loaded
-     *
-     * @return boolean
-     */
-    private function espresso_widgets_in_active_sidebars()
-    {
-        $espresso_widgets = array();
-        foreach ($this->Registry->widgets as $widget_class => $widget) {
-            $id_base = EspressoWidget::getIdBase($widget_class);
-            if (is_active_widget(false, false, $id_base)) {
-                $espresso_widgets[] = $id_base;
-            }
-        }
-        $all_sidebar_widgets = wp_get_sidebars_widgets();
-        foreach ($all_sidebar_widgets as $sidebar_widgets) {
-            if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
-                foreach ($sidebar_widgets as $sidebar_widget) {
-                    foreach ($espresso_widgets as $espresso_widget) {
-                        if (strpos($sidebar_widget, $espresso_widget) !== false) {
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-        apply_filters(
-            'FHEE__EE_Front_Controller__header_meta_tag',
-            '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
-        )
-        );
-
-        // let's exclude all event type taxonomy term archive pages from search engine indexing
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        // also exclude all critical pages from indexing
-        if (
-            (
-                is_tax('espresso_event_type')
-                && get_option('blog_public') !== '0'
-            )
-            || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
-        ) {
-            print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                '<meta name="robots" content="noindex,follow" />' . "\n"
-            )
-            );
-        }
-    }
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (
-            isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === EspressoPostType::EVENTS
-            && is_singular()
-        ) {
-            EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-    public function enqueueStyle()
-    {
-        wp_enqueue_style('espresso_default');
-        wp_enqueue_style('espresso_custom_css');
-    }
-
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    public function enqueueScripts()
-    {
-        wp_enqueue_script('espresso_core');
-    }
-
-
-    /**
-     * display_errors
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     */
-    public function display_errors()
-    {
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->current_page->isEspressoPage()
-        ) {
-            $shown_already = true;
-            if (did_action('wp_head')) {
-                echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
-            } else {
-                // block enabled themes run their query loop before headers are sent
-                // so we need to add our notices onto the beginning of the content
-                add_filter('the_content', [$this, 'prependNotices'], 1, 1);
-            }
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-    /**
-     * @param string $the_content
-     * @return string
-     * @since 4.10.30.p
-     */
-    public function prependNotices($the_content)
-    {
-        $notices = $this->printNotices();
-        return $notices ? $notices . $the_content : $the_content;
-    }
-
-
-    /**
-     * @return false|string
-     * @since 4.10.30.p
-     */
-    public function printNotices()
-    {
-        ob_start();
-        echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
-        EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        return ob_get_clean();
-    }
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-
-
-    /**
-     * @param bool|string $template_include_path
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template_include_path = '')
-    {
-        if ($this->current_page->isEspressoPage()) {
-            // despite all helpers having autoloaders set, we need to manually load the template loader
-            // because there are some side effects in that class for triggering template tag functions
-            $this->Registry->load_helper('EEH_Template');
-            $this->_template_path = ! empty($this->_template_path)
-                ? basename($this->_template_path)
-                : basename((string) $template_include_path);
-            $template_path = EEH_Template::locate_template($this->_template_path, [], false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-
-    /**
-     * @param string $shortcode_class
-     * @param WP     $wp
-     * @throws ReflectionException
-     * @deprecated 4.9.26
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.57.p
-     */
-    public function loadPersistentAdminNoticeManager()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.64.p
-     */
-    public function employ_CPT_Strategy()
-    {
-    }
+	/**
+	 * @var string
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+	/**
+	 * @type CurrentPage
+	 */
+	protected $current_page;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param EE_Registry              $Registry
+	 * @param CurrentPage              $EspressoPage
+	 * @param EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		CurrentPage $EspressoPage,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->current_page          = $EspressoPage;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// load other resources and begin to actually run shortcodes and modules
+		// analyse the incoming WP request
+		add_action('parse_request', array($this, 'get_request'), 1, 1);
+		// process request with module factory
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
+		// before headers sent
+		add_action('wp', array($this, 'wp'), 5);
+		// primarily used to process any content shortcodes
+		add_action('template_redirect', array($this, 'templateRedirect'), 999);
+		// header
+		add_action('wp_head', array($this, 'header_meta_tag'), 5);
+		add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
+		add_filter('template_include', array($this, 'template_include'), 1);
+		// display errors
+		add_action('loop_start', array($this, 'display_errors'), 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		// exclude our private cpt comments
+		add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
+		// make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 * @deprecated 4.10.14.p
+	 */
+	public function Request_Handler()
+	{
+		if (! $this->Request_Handler instanceof EE_Request_Handler) {
+			$this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
+		}
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 * @deprecated 4.10.14.p
+	 */
+	public function getLegacyShortcodesManager()
+	{
+		return EE_Config::getLegacyShortcodesManager();
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param  array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$cpts = $custom_post_types->getPrivateCustomPostTypes();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param  string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->current_page->parseQueryVars($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+		remove_action('parse_request', [$this, 'get_request'], 1);
+	}
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
+
+
+
+	/***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks sidebars for EE widgets
+	 * loads resources and assets accordingly
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		// if we already know this is an espresso page, then load assets
+		$load_assets = $this->current_page->isEspressoPage();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
+		if ($load_assets) {
+			add_action('wp_enqueue_scripts', array($this, 'enqueueStyle'), 10);
+			add_action('wp_enqueue_scripts', array($this, 'enqueueScripts'), 10);
+		}
+
+		if (is_singular(EspressoPostType::EVENTS)) {
+			new FilterNextPreviousEventPostQuery();
+		}
+	}
+
+
+	/**
+	 * builds list of active widgets then scans active sidebars looking for them
+	 * returns true is an EE widget is found in an active sidebar
+	 * Please Note: this does NOT mean that the sidebar or widget
+	 * is actually in use in a given template, as that is unfortunately not known
+	 * until a sidebar and it's widgets are actually loaded
+	 *
+	 * @return boolean
+	 */
+	private function espresso_widgets_in_active_sidebars()
+	{
+		$espresso_widgets = array();
+		foreach ($this->Registry->widgets as $widget_class => $widget) {
+			$id_base = EspressoWidget::getIdBase($widget_class);
+			if (is_active_widget(false, false, $id_base)) {
+				$espresso_widgets[] = $id_base;
+			}
+		}
+		$all_sidebar_widgets = wp_get_sidebars_widgets();
+		foreach ($all_sidebar_widgets as $sidebar_widgets) {
+			if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
+				foreach ($sidebar_widgets as $sidebar_widget) {
+					foreach ($espresso_widgets as $espresso_widget) {
+						if (strpos($sidebar_widget, $espresso_widget) !== false) {
+							return true;
+						}
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+		apply_filters(
+			'FHEE__EE_Front_Controller__header_meta_tag',
+			'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
+		)
+		);
+
+		// let's exclude all event type taxonomy term archive pages from search engine indexing
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		// also exclude all critical pages from indexing
+		if (
+			(
+				is_tax('espresso_event_type')
+				&& get_option('blog_public') !== '0'
+			)
+			|| is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
+		) {
+			print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+				'<meta name="robots" content="noindex,follow" />' . "\n"
+			)
+			);
+		}
+	}
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (
+			isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === EspressoPostType::EVENTS
+			&& is_singular()
+		) {
+			EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+	public function enqueueStyle()
+	{
+		wp_enqueue_style('espresso_default');
+		wp_enqueue_style('espresso_custom_css');
+	}
+
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	public function enqueueScripts()
+	{
+		wp_enqueue_script('espresso_core');
+	}
+
+
+	/**
+	 * display_errors
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function display_errors()
+	{
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->current_page->isEspressoPage()
+		) {
+			$shown_already = true;
+			if (did_action('wp_head')) {
+				echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
+			} else {
+				// block enabled themes run their query loop before headers are sent
+				// so we need to add our notices onto the beginning of the content
+				add_filter('the_content', [$this, 'prependNotices'], 1, 1);
+			}
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+	/**
+	 * @param string $the_content
+	 * @return string
+	 * @since 4.10.30.p
+	 */
+	public function prependNotices($the_content)
+	{
+		$notices = $this->printNotices();
+		return $notices ? $notices . $the_content : $the_content;
+	}
+
+
+	/**
+	 * @return false|string
+	 * @since 4.10.30.p
+	 */
+	public function printNotices()
+	{
+		ob_start();
+		echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
+		EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		return ob_get_clean();
+	}
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+
+
+	/**
+	 * @param bool|string $template_include_path
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template_include_path = '')
+	{
+		if ($this->current_page->isEspressoPage()) {
+			// despite all helpers having autoloaders set, we need to manually load the template loader
+			// because there are some side effects in that class for triggering template tag functions
+			$this->Registry->load_helper('EEH_Template');
+			$this->_template_path = ! empty($this->_template_path)
+				? basename($this->_template_path)
+				: basename((string) $template_include_path);
+			$template_path = EEH_Template::locate_template($this->_template_path, [], false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+
+	/**
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 * @throws ReflectionException
+	 * @deprecated 4.9.26
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		$this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.57.p
+	 */
+	public function loadPersistentAdminNoticeManager()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.64.p
+	 */
+	public function employ_CPT_Strategy()
+	{
+	}
 }

core/libraries/form_sections/inputs/EE_Switch_Input.input.php

Indentation +27 added lines, -27 removed lines

@@ -2,34 +2,34 @@
 
 class EE_Switch_Input extends EE_Form_Input_With_Options_Base
 {
-    public const OPTION_ON = 'ON';
+	public const OPTION_ON = 'ON';
 
-    public const OPTION_OFF = 'OFF';
+	public const OPTION_OFF = 'OFF';
 
 
-    /**
-     * @param array $input_settings
-     * @param array $answer_options
-     */
-    public function __construct($input_settings = [], array $answer_options = [])
-    {
-        $this->_set_display_strategy(new EE_Switch_Display_Strategy());
-        $this->_add_validation_strategy(
-            new EE_Many_Valued_Validation_Strategy(
-                [
-                    new EE_Enum_Validation_Strategy(
-                        $input_settings['validation_error_message'] ?? null
-                    ),
-                ]
-            )
-        );
-        if (! is_array($answer_options) || empty($answer_options)) {
-            $answer_options = [
-                EE_Switch_Input::OPTION_ON  => esc_html__('enabled', 'event_espresso'),
-                EE_Switch_Input::OPTION_OFF => esc_html__('disabled', 'event_espresso'),
-            ];
-        }
-        $this->_multiple_selections = false;
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $input_settings
+	 * @param array $answer_options
+	 */
+	public function __construct($input_settings = [], array $answer_options = [])
+	{
+		$this->_set_display_strategy(new EE_Switch_Display_Strategy());
+		$this->_add_validation_strategy(
+			new EE_Many_Valued_Validation_Strategy(
+				[
+					new EE_Enum_Validation_Strategy(
+						$input_settings['validation_error_message'] ?? null
+					),
+				]
+			)
+		);
+		if (! is_array($answer_options) || empty($answer_options)) {
+			$answer_options = [
+				EE_Switch_Input::OPTION_ON  => esc_html__('enabled', 'event_espresso'),
+				EE_Switch_Input::OPTION_OFF => esc_html__('disabled', 'event_espresso'),
+			];
+		}
+		$this->_multiple_selections = false;
+		parent::__construct($answer_options, $input_settings);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
                 ]
             )
         );
-        if (! is_array($answer_options) || empty($answer_options)) {
+        if ( ! is_array($answer_options) || empty($answer_options)) {
             $answer_options = [
                 EE_Switch_Input::OPTION_ON  => esc_html__('enabled', 'event_espresso'),
                 EE_Switch_Input::OPTION_OFF => esc_html__('disabled', 'event_espresso'),

core/libraries/form_sections/inputs/EE_Checkbox_Multi_Input.input.php

Indentation +19 added lines, -19 removed lines

@@ -14,23 +14,23 @@
  */
 class EE_Checkbox_Multi_Input extends EE_Form_Input_With_Options_Base
 {
-    /**
-     * @param array | EE_Question_Option[] $answer_options
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = [])
-    {
-        $this->_set_display_strategy(new EE_Checkbox_Display_Strategy());
-        $this->_add_validation_strategy(
-            new EE_Many_Valued_Validation_Strategy(
-                [
-                    new EE_Enum_Validation_Strategy(
-                        $input_settings['validation_error_message'] ?? null
-                    )
-                ]
-            )
-        );
-        $this->_multiple_selections = true;
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array | EE_Question_Option[] $answer_options
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = [])
+	{
+		$this->_set_display_strategy(new EE_Checkbox_Display_Strategy());
+		$this->_add_validation_strategy(
+			new EE_Many_Valued_Validation_Strategy(
+				[
+					new EE_Enum_Validation_Strategy(
+						$input_settings['validation_error_message'] ?? null
+					)
+				]
+			)
+		);
+		$this->_multiple_selections = true;
+		parent::__construct($answer_options, $input_settings);
+	}
 }

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/domain/services/admin/notices/status_change/StatusChangeNotice.php

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')
             );

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', []);
-    }
+	public function __construct()
+	{
+		parent::__construct('ee_hide_status_change_notices_for_users', []);
+	}
 
 
-    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;
+	}
 }

core/services/json/JsonDataWordpressOption.php

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);

Indentation +90 added lines, -90 removed lines

@@ -15,94 +15,94 @@
  */
 abstract class JsonDataWordpressOption extends WordPressOption
 {
-    private JsonDataHandler $json_data_handler;
-
-    /**
-     * @var array|mixed|stdClass
-     */
-    private $options = [];
-
-
-    /**
-     * 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, bool $force_update = false): int
-    {
-        $update = parent::updateOption($this->json_data_handler->encodeData($value), $force_update);
-        if ($update === WordPressOption::UPDATE_SUCCESS) {
-            $this->options = $value;
-        }
-        return $update;
-    }
-
-
-    /**
-     * @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);
-    }
+	private JsonDataHandler $json_data_handler;
+
+	/**
+	 * @var array|mixed|stdClass
+	 */
+	private $options = [];
+
+
+	/**
+	 * 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, bool $force_update = false): int
+	{
+		$update = parent::updateOption($this->json_data_handler->encodeData($value), $force_update);
+		if ($update === WordPressOption::UPDATE_SUCCESS) {
+			$this->options = $value;
+		}
+		return $update;
+	}
+
+
+	/**
+	 * @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);
+	}
 }

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>