eventespresso / event-espresso-core

core/data_migration_scripts/4_3_0_stages/EE_DMS_4_3_0_question_option_order.dmsstage.php

Indentation +35 added lines, -35 removed lines

@@ -7,39 +7,39 @@
 
 class EE_DMS_4_3_0_question_option_order extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Question Options", "event_espresso");
-        $this->_old_table = $wpdb->prefix."esp_question_option";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        // foreach question_group_question entry with this QST_ID, we want to set its
-        // QSG_order equal to this question's QST_order
-        global $wpdb;
-        $updated = $wpdb->update(
-            $this->_old_table,
-            array('QSO_order'=>$old_row['QSO_ID']),
-            array('QSO_ID'=>$old_row['QSO_ID']),
-            array('%d',// QSO_order
-                    ),
-            array('%d',// QSO_ID
-                    )
-        );
-        if (false === $updated) {
-            $this->add_error(
-                sprintf(
-                    __(
-                        "Error in updating table %s setting QSO_order = %d where QSO_ID = %d",
-                        'event_espresso'
-                    ),
-                    $this->_old_table,
-                    $old_row['QSO_ID'],
-                    $old_row['QSO_ID']
-                )
-            );
-        }
-    }
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Question Options", "event_espresso");
+		$this->_old_table = $wpdb->prefix."esp_question_option";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		// foreach question_group_question entry with this QST_ID, we want to set its
+		// QSG_order equal to this question's QST_order
+		global $wpdb;
+		$updated = $wpdb->update(
+			$this->_old_table,
+			array('QSO_order'=>$old_row['QSO_ID']),
+			array('QSO_ID'=>$old_row['QSO_ID']),
+			array('%d',// QSO_order
+					),
+			array('%d',// QSO_ID
+					)
+		);
+		if (false === $updated) {
+			$this->add_error(
+				sprintf(
+					__(
+						"Error in updating table %s setting QSO_order = %d where QSO_ID = %d",
+						'event_espresso'
+					),
+					$this->_old_table,
+					$old_row['QSO_ID'],
+					$old_row['QSO_ID']
+				)
+			);
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,9 +23,9 @@
             $this->_old_table,
             array('QSO_order'=>$old_row['QSO_ID']),
             array('QSO_ID'=>$old_row['QSO_ID']),
-            array('%d',// QSO_order
+            array('%d', // QSO_order
                     ),
-            array('%d',// QSO_ID
+            array('%d', // QSO_ID
                     )
         );
         if (false === $updated) {

core/EE_Front_Controller.core.php

Spacing +4 added lines, -4 removed lines

@@ -344,7 +344,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"
         )
         );
 
@@ -360,7 +360,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"
             )
             );
         }
@@ -413,7 +413,7 @@ 
     {
         static $shown_already = false;
         do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (! $shown_already
+        if ( ! $shown_already
             && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
             && is_main_query()
             && ! is_feed()
@@ -422,7 +422,7 @@ 
         ) {
             echo EE_Error::get_notices();
             $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+            EEH_Template::display_template(EE_TEMPLATES.'espresso-ajax-notices.template.php');
         }
         do_action('AHEE__EE_Front_Controller__display_errors__end');
     }

Indentation +463 added lines, -463 removed lines

@@ -26,467 +26,467 @@
 final class EE_Front_Controller
 {
 
-    /**
-     * @var string $_template_path
-     */
-    private $_template_path;
-
-    /**
-     * @var string $_template
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry $Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler $Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router $Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-
-    /**
-     *    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 \EE_Request_Handler       $Request_Handler
-     * @param \EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        EE_Request_Handler $Request_Handler,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry = $Registry;
-        $this->Request_Handler = $Request_Handler;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // load other resources and begin to actually run shortcodes and modules
-        add_action('wp_loaded', array($this, 'wp_loaded'), 5);
-        // 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
-     */
-    public function Request_Handler()
-    {
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    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->Request_Handler->parse_request($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-    }
-
-
-    /**
-     *    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
-     */
-    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->Request_Handler->is_espresso_page();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $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_print_footer_scripts', array($this, 'enqueueScripts'), 10);
-        }
-    }
-
-
-    /**
-     * 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_name => $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
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === 'espresso_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()
-            && did_action('wp_head')
-            && $this->Request_Handler->is_espresso_page()
-        ) {
-            echo EE_Error::get_notices();
-            $shown_already = true;
-            EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param   string $template_include_path
-     * @return    string
-     */
-    public function template_include($template_include_path = null)
-    {
-        if ($this->Request_Handler->is_espresso_page()) {
-            $this->_template_path = ! empty($this->_template_path)
-                ? basename($this->_template_path)
-                : basename(
-                    $template_include_path
-                );
-            $template_path = EEH_Template::locate_template($this->_template_path, array(), 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;
-    }
-
-
-    /**
-     *    get_selected_template
-     *
-     * @access    public
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-
-    /**
-     * @deprecated 4.9.26
-     * @param string $shortcode_class
-     * @param \WP    $wp
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                '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 $_template_path
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string $_template
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry $Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler $Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router $Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+
+	/**
+	 *    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 \EE_Request_Handler       $Request_Handler
+	 * @param \EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		EE_Request_Handler $Request_Handler,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry = $Registry;
+		$this->Request_Handler = $Request_Handler;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// load other resources and begin to actually run shortcodes and modules
+		add_action('wp_loaded', array($this, 'wp_loaded'), 5);
+		// 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
+	 */
+	public function Request_Handler()
+	{
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	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->Request_Handler->parse_request($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+	}
+
+
+	/**
+	 *    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
+	 */
+	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->Request_Handler->is_espresso_page();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $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_print_footer_scripts', array($this, 'enqueueScripts'), 10);
+		}
+	}
+
+
+	/**
+	 * 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_name => $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
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === 'espresso_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()
+			&& did_action('wp_head')
+			&& $this->Request_Handler->is_espresso_page()
+		) {
+			echo EE_Error::get_notices();
+			$shown_already = true;
+			EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param   string $template_include_path
+	 * @return    string
+	 */
+	public function template_include($template_include_path = null)
+	{
+		if ($this->Request_Handler->is_espresso_page()) {
+			$this->_template_path = ! empty($this->_template_path)
+				? basename($this->_template_path)
+				: basename(
+					$template_include_path
+				);
+			$template_path = EEH_Template::locate_template($this->_template_path, array(), 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;
+	}
+
+
+	/**
+	 *    get_selected_template
+	 *
+	 * @access    public
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+
+	/**
+	 * @deprecated 4.9.26
+	 * @param string $shortcode_class
+	 * @param \WP    $wp
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'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/EE_Psr4AutoloaderInit.core.php

Indentation +34 added lines, -34 removed lines

@@ -17,38 +17,38 @@
 {
 
 
-    /**
-     * @type \EventEspresso\core\Psr4Autoloader
-     */
-    protected static $psr4_loader;
-
-
-    /**
-     * @return \EventEspresso\core\Psr4Autoloader
-     */
-    public function initializeAutoloader()
-    {
-        static $initialized = false;
-        if (! $initialized) {
-            // instantiate PSR4 autoloader
-            espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
-            EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
-            // register the autoloader
-            EE_Psr4AutoloaderInit::$psr4_loader->register();
-            // register the base directories for the namespace prefix
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
-            $initialized = true;
-        }
-    }
-
-
-    /**
-     * @return \EventEspresso\core\Psr4Autoloader
-     */
-    public static function psr4_loader()
-    {
-        return self::$psr4_loader;
-    }
+	/**
+	 * @type \EventEspresso\core\Psr4Autoloader
+	 */
+	protected static $psr4_loader;
+
+
+	/**
+	 * @return \EventEspresso\core\Psr4Autoloader
+	 */
+	public function initializeAutoloader()
+	{
+		static $initialized = false;
+		if (! $initialized) {
+			// instantiate PSR4 autoloader
+			espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
+			EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
+			// register the autoloader
+			EE_Psr4AutoloaderInit::$psr4_loader->register();
+			// register the base directories for the namespace prefix
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
+			$initialized = true;
+		}
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\Psr4Autoloader
+	 */
+	public static function psr4_loader()
+	{
+		return self::$psr4_loader;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -29,15 +29,15 @@
     public function initializeAutoloader()
     {
         static $initialized = false;
-        if (! $initialized) {
+        if ( ! $initialized) {
             // instantiate PSR4 autoloader
-            espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
+            espresso_load_required('Psr4Autoloader', EE_CORE.'Psr4Autoloader.php');
             EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
             // register the autoloader
             EE_Psr4AutoloaderInit::$psr4_loader->register();
             // register the base directories for the namespace prefix
             EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES.'batch');
             EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
             $initialized = true;
         }

core/EE_Object_Repository.core.php

Indentation +86 added lines, -86 removed lines

@@ -16,98 +16,98 @@
 abstract class EE_Object_Repository extends EE_Object_Collection implements EEI_Repository
 {
 
-    /**
-     * default persist method called on repository objects if none supplied
-     *
-     * @type string $persist_method
-     */
-    protected $persist_method;
+	/**
+	 * default persist method called on repository objects if none supplied
+	 *
+	 * @type string $persist_method
+	 */
+	protected $persist_method;
 
 
-    /**
-     * _call_user_func_array_on_current
-     *
-     * calls the supplied callback method name on the current repository object,
-     * an array of arguments can also be supplied that will be passed along to the callback method,
-     * where each element of the $arguments array corresponds to a parameter for the callback method
-     * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
-     * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
-     *
-     * @access public
-     * @param string $callback  name of method found on object to be called.
-     * @param array  $arguments arrays of arguments that will be passed to the object's callback method
-     * @return bool | int
-     */
-    protected function _call_user_func_array_on_current($callback = '', $arguments = array())
-    {
-        if ($callback !== '' && method_exists($this->current(), $callback)) {
-            return call_user_func_array(array($this->current(), $callback), $arguments);
-        }
-        return false;
-    }
+	/**
+	 * _call_user_func_array_on_current
+	 *
+	 * calls the supplied callback method name on the current repository object,
+	 * an array of arguments can also be supplied that will be passed along to the callback method,
+	 * where each element of the $arguments array corresponds to a parameter for the callback method
+	 * PLZ NOTE: if the first argument of the callback requires an array, for example array( 'key' => 'value' )
+	 * then $arguments needs to be a DOUBLE array ie: array( array( 'key' => 'value' ) )
+	 *
+	 * @access public
+	 * @param string $callback  name of method found on object to be called.
+	 * @param array  $arguments arrays of arguments that will be passed to the object's callback method
+	 * @return bool | int
+	 */
+	protected function _call_user_func_array_on_current($callback = '', $arguments = array())
+	{
+		if ($callback !== '' && method_exists($this->current(), $callback)) {
+			return call_user_func_array(array($this->current(), $callback), $arguments);
+		}
+		return false;
+	}
 
 
-    /**
-     * _call_user_func_on_all
-     *
-     * calls the supplied callback method name on ALL repository objects,
-     *
-     * @access public
-     * @param string $callback name of method found on repository objects to be called
-     * @return bool | int
-     */
-    protected function _call_user_func_on_all($callback = '')
-    {
-        $success = true;
-        if ($this->valid()) {
-            $this->rewind();
-            while ($this->valid()) {
-                // any negative result will toggle success to false
-                $success = $this->_call_user_func_array_on_current($callback) ? $success : false;
-                $this->next();
-            }
-            $this->rewind();
-        }
-        return $success;
-    }
+	/**
+	 * _call_user_func_on_all
+	 *
+	 * calls the supplied callback method name on ALL repository objects,
+	 *
+	 * @access public
+	 * @param string $callback name of method found on repository objects to be called
+	 * @return bool | int
+	 */
+	protected function _call_user_func_on_all($callback = '')
+	{
+		$success = true;
+		if ($this->valid()) {
+			$this->rewind();
+			while ($this->valid()) {
+				// any negative result will toggle success to false
+				$success = $this->_call_user_func_array_on_current($callback) ? $success : false;
+				$this->next();
+			}
+			$this->rewind();
+		}
+		return $success;
+	}
 
 
-    /**
-     * persist
-     *
-     * primarily used for saving EE_Base_Class classes to the database,
-     * but can be supplied with a "persistence callback" that can be used for classes that are not instances of
-     * EE_Base_Class, or for providing alternate ways to persist an object such as session caching, etc... an array of
-     * arguments can also be supplied that will be passed along to the object's persistence method
-     *
-     * @access public
-     * @param string $persistence_callback                                    name of method found on object that can
-     *                                                                        be used for persisting the object
-     *                                                                        defaults to
-     *                                                                        EE_Object_Repository::$persist_method
-     * @param array  $persistence_arguments                                   arrays of arguments that will be passed
-     *                                                                        to the object's persistence method
-     * @return bool | int
-     */
-    public function persist($persistence_callback = '', $persistence_arguments = array())
-    {
-        $persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
-        return $this->_call_user_func_array_on_current($persistence_callback, $persistence_arguments);
-    }
+	/**
+	 * persist
+	 *
+	 * primarily used for saving EE_Base_Class classes to the database,
+	 * but can be supplied with a "persistence callback" that can be used for classes that are not instances of
+	 * EE_Base_Class, or for providing alternate ways to persist an object such as session caching, etc... an array of
+	 * arguments can also be supplied that will be passed along to the object's persistence method
+	 *
+	 * @access public
+	 * @param string $persistence_callback                                    name of method found on object that can
+	 *                                                                        be used for persisting the object
+	 *                                                                        defaults to
+	 *                                                                        EE_Object_Repository::$persist_method
+	 * @param array  $persistence_arguments                                   arrays of arguments that will be passed
+	 *                                                                        to the object's persistence method
+	 * @return bool | int
+	 */
+	public function persist($persistence_callback = '', $persistence_arguments = array())
+	{
+		$persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
+		return $this->_call_user_func_array_on_current($persistence_callback, $persistence_arguments);
+	}
 
 
-    /**
-     * persist_all
-     *
-     * calls \EE_Object_Repository::persist() on all objects within the repository
-     *
-     * @access public
-     * @param string $persistence_callback name of method found on object that can be used for persisting the object
-     * @return bool | int
-     */
-    public function persist_all($persistence_callback = '')
-    {
-        $persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
-        return $this->_call_user_func_on_all($persistence_callback);
-    }
+	/**
+	 * persist_all
+	 *
+	 * calls \EE_Object_Repository::persist() on all objects within the repository
+	 *
+	 * @access public
+	 * @param string $persistence_callback name of method found on object that can be used for persisting the object
+	 * @return bool | int
+	 */
+	public function persist_all($persistence_callback = '')
+	{
+		$persistence_callback = ! empty($persistence_callback) ? $persistence_callback : $this->persist_method;
+		return $this->_call_user_func_on_all($persistence_callback);
+	}
 }

core/EED_Module.module.php

Indentation +106 added lines, -106 removed lines

@@ -12,110 +12,110 @@
 abstract class EED_Module extends EE_Configurable implements ResettableInterface
 {
 
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var    string $output
-     */
-    protected $output = '';
-
-    /**
-     * the current active espresso template theme
-     *
-     * @var    string $theme
-     */
-    protected $theme = '';
-
-
-    /**
-     * @return void
-     */
-    public static function reset()
-    {
-        $module_name = get_called_class();
-        new $module_name();
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @access    public
-     * @var            WP $WP
-     * @return    void
-     */
-    abstract public function run($WP);
-
-
-    /**
-     * EED_Module constructor.
-     */
-    final public function __construct()
-    {
-        $this->theme = EE_Config::get_current_theme();
-        $module_name = $this->module_name();
-        EE_Registry::instance()->modules->{$module_name} = $this;
-    }
-
-
-    /**
-     * @param $module_name
-     * @return EED_Module
-     */
-    protected static function get_instance($module_name = '')
-    {
-        $module_name = ! empty($module_name)
-            ? $module_name
-            : get_called_class();
-        if (! isset(EE_Registry::instance()->modules->{$module_name})
-            || ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
-        ) {
-            EE_Registry::instance()->add_module($module_name);
-        }
-        return EE_Registry::instance()->get_module($module_name);
-    }
-
-
-    /**
-     *    module_name
-     *
-     * @access    public
-     * @return    string
-     */
-    public function module_name()
-    {
-        return get_class($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function theme()
-    {
-        return $this->theme;
-    }
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var    string $output
+	 */
+	protected $output = '';
+
+	/**
+	 * the current active espresso template theme
+	 *
+	 * @var    string $theme
+	 */
+	protected $theme = '';
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset()
+	{
+		$module_name = get_called_class();
+		new $module_name();
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @access    public
+	 * @var            WP $WP
+	 * @return    void
+	 */
+	abstract public function run($WP);
+
+
+	/**
+	 * EED_Module constructor.
+	 */
+	final public function __construct()
+	{
+		$this->theme = EE_Config::get_current_theme();
+		$module_name = $this->module_name();
+		EE_Registry::instance()->modules->{$module_name} = $this;
+	}
+
+
+	/**
+	 * @param $module_name
+	 * @return EED_Module
+	 */
+	protected static function get_instance($module_name = '')
+	{
+		$module_name = ! empty($module_name)
+			? $module_name
+			: get_called_class();
+		if (! isset(EE_Registry::instance()->modules->{$module_name})
+			|| ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
+		) {
+			EE_Registry::instance()->add_module($module_name);
+		}
+		return EE_Registry::instance()->get_module($module_name);
+	}
+
+
+	/**
+	 *    module_name
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function module_name()
+	{
+		return get_class($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function theme()
+	{
+		return $this->theme;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
         $module_name = ! empty($module_name)
             ? $module_name
             : get_called_class();
-        if (! isset(EE_Registry::instance()->modules->{$module_name})
+        if ( ! isset(EE_Registry::instance()->modules->{$module_name})
             || ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
         ) {
             EE_Registry::instance()->add_module($module_name);

core/EE_Base.core.php

Indentation +32 added lines, -32 removed lines

@@ -11,42 +11,42 @@
 class EE_Base
 {
 
-    /**
-     *        @ override magic methods
-     *        @ return void
-     */
-    public function __get($a)
-    {
-        return false;
-    }
+	/**
+	 *        @ override magic methods
+	 *        @ return void
+	 */
+	public function __get($a)
+	{
+		return false;
+	}
 
-    public function __set($a, $b)
-    {
-        return false;
-    }
+	public function __set($a, $b)
+	{
+		return false;
+	}
 
-    public function __isset($a)
-    {
-        return false;
-    }
+	public function __isset($a)
+	{
+		return false;
+	}
 
-    public function __unset($a)
-    {
-        return false;
-    }
+	public function __unset($a)
+	{
+		return false;
+	}
 
-    public function __clone()
-    {
-        return false;
-    }
+	public function __clone()
+	{
+		return false;
+	}
 
-    public function __wakeup()
-    {
-        return false;
-    }
+	public function __wakeup()
+	{
+		return false;
+	}
 
-    public function __destruct()
-    {
-        return false;
-    }
+	public function __destruct()
+	{
+		return false;
+	}
 }

core/EE_Request_Handler.core.php

Indentation +365 added lines, -365 removed lines

@@ -12,369 +12,369 @@
 final class EE_Request_Handler implements InterminableInterface
 {
 
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var array $_notice
-     */
-    private $_notice = array();
-
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var string $_output
-     */
-    private $_output = '';
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean $ajax
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean $front_ajax
-     */
-    public $front_ajax = false;
-
-
-    /**
-     * @param  EE_Request $request
-     */
-    public function __construct(EE_Request $request)
-    {
-        $this->request = $request;
-        $this->ajax = $this->request->ajax;
-        $this->front_ajax = $this->request->front_ajax;
-        do_action('AHEE__EE_Request_Handler__construct__complete');
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function parse_request($wp = null)
-    {
-        // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $this->set_request_vars($wp);
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_request_vars($wp = null)
-    {
-        if (! is_admin()) {
-            // set request post_id
-            $this->request->set('post_id', $this->get_post_id_from_request($wp));
-            // set request post name
-            $this->request->set('post_name', $this->get_post_name_from_request($wp));
-            // set request post_type
-            $this->request->set('post_type', $this->get_post_type_from_request($wp));
-            // true or false ? is this page being used by EE ?
-            $this->set_espresso_page();
-        }
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return int
-     */
-    public function get_post_id_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $post_id = null;
-        if (isset($wp->query_vars['p'])) {
-            $post_id = $wp->query_vars['p'];
-        }
-        if (! $post_id && isset($wp->query_vars['page_id'])) {
-            $post_id = $wp->query_vars['page_id'];
-        }
-        if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
-            $post_id = basename($wp->request);
-        }
-        return $post_id;
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return string
-     */
-    public function get_post_name_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        $post_name = null;
-        if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
-            $post_name = $wp->query_vars['name'];
-        }
-        if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
-            $post_name = $wp->query_vars['pagename'];
-        }
-        if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
-            $possible_post_name = basename($wp->request);
-            if (! is_numeric($possible_post_name)) {
-                /** @type WPDB $wpdb */
-                global $wpdb;
-                $SQL =
-                    "SELECT ID from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s";
-                $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
-                if ($possible_post_name) {
-                    $post_name = $possible_post_name;
-                }
-            }
-        }
-        if (! $post_name && $this->get('post_id')) {
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            $SQL =
-                "SELECT post_name from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d";
-            $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->get('post_id')));
-            if ($possible_post_name) {
-                $post_name = $possible_post_name;
-            }
-        }
-        return $post_name;
-    }
-
-
-    /**
-     * @param WP $wp
-     * @return mixed
-     */
-    public function get_post_type_from_request($wp = null)
-    {
-        if (! $wp instanceof WP) {
-            global $wp;
-        }
-        return isset($wp->query_vars['post_type'])
-            ? $wp->query_vars['post_type']
-            : null;
-    }
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param  WP $wp
-     * @return string
-     */
-    public function get_current_page_permalink($wp = null)
-    {
-        $post_id = $this->get_post_id_from_request($wp);
-        if ($post_id) {
-            $current_page_permalink = get_permalink($post_id);
-        } else {
-            if (! $wp instanceof WP) {
-                global $wp;
-            }
-            if ($wp->request) {
-                $current_page_permalink = site_url($wp->request);
-            } else {
-                $current_page_permalink = esc_url(site_url($_SERVER['REQUEST_URI']));
-            }
-        }
-        return $current_page_permalink;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function test_for_espresso_page()
-    {
-        global $wp;
-        /** @type EE_CPT_Strategy $EE_CPT_Strategy */
-        $EE_CPT_Strategy = EE_Registry::instance()->load_core('CPT_Strategy');
-        $espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
-        if (is_array($espresso_CPT_taxonomies)) {
-            foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($wp->query_vars, $wp->query_vars[ $espresso_CPT_taxonomy ])) {
-                    return true;
-                }
-            }
-        }
-        // load espresso CPT endpoints
-        $espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
-        $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        $post_types = (array) $this->get('post_type');
-        foreach ($post_types as $post_type) {
-            // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
-                // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->get('post_name')) {
-                    // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    $post_name = isset($post_type_CPT_endpoints[ $this->get('post_type') ])
-                        ? $post_type_CPT_endpoints[ $this->get('post_type') ]
-                        : '';
-                    // if the post type matches on of our then set the endpoint
-                    if ($post_name) {
-                        $this->set('post_name', $post_name);
-                    }
-                }
-                return true;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function set_notice($key, $value)
-    {
-        $this->_notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function get_notice($key)
-    {
-        return isset($this->_notice[ $key ])
-            ? $this->_notice[ $key ]
-            : null;
-    }
-
-
-    /**
-     * @param $string
-     * @return void
-     */
-    public function add_output($string)
-    {
-        $this->_output .= $string;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_output()
-    {
-        return $this->_output;
-    }
-
-
-    /**
-     * @param $item
-     * @param $key
-     */
-    public function sanitize_text_field_for_array_walk(&$item, &$key)
-    {
-        $item = strpos($item, 'email') !== false
-            ? sanitize_email($item)
-            : sanitize_text_field($item);
-    }
-
-
-    /**
-     * @param null|bool $value
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_espresso_page($value = null)
-    {
-        $this->request->set(
-            'is_espresso_page',
-            ! empty($value)
-                ? $value
-                : $this->test_for_espresso_page()
-        );
-    }
-
-
-    /**
-     * @return    mixed
-     */
-    public function is_espresso_page()
-    {
-        return $this->request->is_set('is_espresso_page');
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params()
-    {
-        return $this->request->params();
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        $this->request->set($key, $value, $override_ee);
-    }
-
-
-    /**
-     * @param      $key
-     * @param null $default
-     * @return    mixed
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request->get($key, $default);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param $key
-     * @return    boolean
-     */
-    public function is_set($key)
-    {
-        return $this->request->is_set($key);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param $key
-     * @return    void
-     */
-    public function un_set($key)
-    {
-        $this->request->un_set($key);
-    }
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var array $_notice
+	 */
+	private $_notice = array();
+
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var string $_output
+	 */
+	private $_output = '';
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean $ajax
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean $front_ajax
+	 */
+	public $front_ajax = false;
+
+
+	/**
+	 * @param  EE_Request $request
+	 */
+	public function __construct(EE_Request $request)
+	{
+		$this->request = $request;
+		$this->ajax = $this->request->ajax;
+		$this->front_ajax = $this->request->front_ajax;
+		do_action('AHEE__EE_Request_Handler__construct__complete');
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function parse_request($wp = null)
+	{
+		// if somebody forgot to provide us with WP, that's ok because its global
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$this->set_request_vars($wp);
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_request_vars($wp = null)
+	{
+		if (! is_admin()) {
+			// set request post_id
+			$this->request->set('post_id', $this->get_post_id_from_request($wp));
+			// set request post name
+			$this->request->set('post_name', $this->get_post_name_from_request($wp));
+			// set request post_type
+			$this->request->set('post_type', $this->get_post_type_from_request($wp));
+			// true or false ? is this page being used by EE ?
+			$this->set_espresso_page();
+		}
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return int
+	 */
+	public function get_post_id_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$post_id = null;
+		if (isset($wp->query_vars['p'])) {
+			$post_id = $wp->query_vars['p'];
+		}
+		if (! $post_id && isset($wp->query_vars['page_id'])) {
+			$post_id = $wp->query_vars['page_id'];
+		}
+		if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
+			$post_id = basename($wp->request);
+		}
+		return $post_id;
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return string
+	 */
+	public function get_post_name_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		$post_name = null;
+		if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
+			$post_name = $wp->query_vars['name'];
+		}
+		if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
+			$post_name = $wp->query_vars['pagename'];
+		}
+		if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
+			$possible_post_name = basename($wp->request);
+			if (! is_numeric($possible_post_name)) {
+				/** @type WPDB $wpdb */
+				global $wpdb;
+				$SQL =
+					"SELECT ID from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s";
+				$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
+				if ($possible_post_name) {
+					$post_name = $possible_post_name;
+				}
+			}
+		}
+		if (! $post_name && $this->get('post_id')) {
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			$SQL =
+				"SELECT post_name from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d";
+			$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->get('post_id')));
+			if ($possible_post_name) {
+				$post_name = $possible_post_name;
+			}
+		}
+		return $post_name;
+	}
+
+
+	/**
+	 * @param WP $wp
+	 * @return mixed
+	 */
+	public function get_post_type_from_request($wp = null)
+	{
+		if (! $wp instanceof WP) {
+			global $wp;
+		}
+		return isset($wp->query_vars['post_type'])
+			? $wp->query_vars['post_type']
+			: null;
+	}
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param  WP $wp
+	 * @return string
+	 */
+	public function get_current_page_permalink($wp = null)
+	{
+		$post_id = $this->get_post_id_from_request($wp);
+		if ($post_id) {
+			$current_page_permalink = get_permalink($post_id);
+		} else {
+			if (! $wp instanceof WP) {
+				global $wp;
+			}
+			if ($wp->request) {
+				$current_page_permalink = site_url($wp->request);
+			} else {
+				$current_page_permalink = esc_url(site_url($_SERVER['REQUEST_URI']));
+			}
+		}
+		return $current_page_permalink;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function test_for_espresso_page()
+	{
+		global $wp;
+		/** @type EE_CPT_Strategy $EE_CPT_Strategy */
+		$EE_CPT_Strategy = EE_Registry::instance()->load_core('CPT_Strategy');
+		$espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
+		if (is_array($espresso_CPT_taxonomies)) {
+			foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
+				if (isset($wp->query_vars, $wp->query_vars[ $espresso_CPT_taxonomy ])) {
+					return true;
+				}
+			}
+		}
+		// load espresso CPT endpoints
+		$espresso_CPT_endpoints = $EE_CPT_Strategy->get_CPT_endpoints();
+		$post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
+		$post_types = (array) $this->get('post_type');
+		foreach ($post_types as $post_type) {
+			// was a post name passed ?
+			if (isset($post_type_CPT_endpoints[ $post_type ])) {
+				// kk we know this is an espresso page, but is it a specific post ?
+				if (! $this->get('post_name')) {
+					// there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
+					$post_name = isset($post_type_CPT_endpoints[ $this->get('post_type') ])
+						? $post_type_CPT_endpoints[ $this->get('post_type') ]
+						: '';
+					// if the post type matches on of our then set the endpoint
+					if ($post_name) {
+						$this->set('post_name', $post_name);
+					}
+				}
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function set_notice($key, $value)
+	{
+		$this->_notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function get_notice($key)
+	{
+		return isset($this->_notice[ $key ])
+			? $this->_notice[ $key ]
+			: null;
+	}
+
+
+	/**
+	 * @param $string
+	 * @return void
+	 */
+	public function add_output($string)
+	{
+		$this->_output .= $string;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_output()
+	{
+		return $this->_output;
+	}
+
+
+	/**
+	 * @param $item
+	 * @param $key
+	 */
+	public function sanitize_text_field_for_array_walk(&$item, &$key)
+	{
+		$item = strpos($item, 'email') !== false
+			? sanitize_email($item)
+			: sanitize_text_field($item);
+	}
+
+
+	/**
+	 * @param null|bool $value
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_espresso_page($value = null)
+	{
+		$this->request->set(
+			'is_espresso_page',
+			! empty($value)
+				? $value
+				: $this->test_for_espresso_page()
+		);
+	}
+
+
+	/**
+	 * @return    mixed
+	 */
+	public function is_espresso_page()
+	{
+		return $this->request->is_set('is_espresso_page');
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params()
+	{
+		return $this->request->params();
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		$this->request->set($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param null $default
+	 * @return    mixed
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request->get($key, $default);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param $key
+	 * @return    boolean
+	 */
+	public function is_set($key)
+	{
+		return $this->request->is_set($key);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param $key
+	 * @return    void
+	 */
+	public function un_set($key)
+	{
+		$this->request->un_set($key);
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -65,7 +65,7 @@ 
     public function parse_request($wp = null)
     {
         // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $this->set_request_vars($wp);
@@ -80,7 +80,7 @@ 
      */
     public function set_request_vars($wp = null)
     {
-        if (! is_admin()) {
+        if ( ! is_admin()) {
             // set request post_id
             $this->request->set('post_id', $this->get_post_id_from_request($wp));
             // set request post name
@@ -99,17 +99,17 @@ 
      */
     public function get_post_id_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $post_id = null;
         if (isset($wp->query_vars['p'])) {
             $post_id = $wp->query_vars['p'];
         }
-        if (! $post_id && isset($wp->query_vars['page_id'])) {
+        if ( ! $post_id && isset($wp->query_vars['page_id'])) {
             $post_id = $wp->query_vars['page_id'];
         }
-        if (! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
+        if ( ! $post_id && $wp->request !== null && is_numeric(basename($wp->request))) {
             $post_id = basename($wp->request);
         }
         return $post_id;
@@ -122,19 +122,19 @@ 
      */
     public function get_post_name_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         $post_name = null;
         if (isset($wp->query_vars['name']) && ! empty($wp->query_vars['name'])) {
             $post_name = $wp->query_vars['name'];
         }
-        if (! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
+        if ( ! $post_name && isset($wp->query_vars['pagename']) && ! empty($wp->query_vars['pagename'])) {
             $post_name = $wp->query_vars['pagename'];
         }
-        if (! $post_name && $wp->request !== null && ! empty($wp->request)) {
+        if ( ! $post_name && $wp->request !== null && ! empty($wp->request)) {
             $possible_post_name = basename($wp->request);
-            if (! is_numeric($possible_post_name)) {
+            if ( ! is_numeric($possible_post_name)) {
                 /** @type WPDB $wpdb */
                 global $wpdb;
                 $SQL =
@@ -145,7 +145,7 @@ 
                 }
             }
         }
-        if (! $post_name && $this->get('post_id')) {
+        if ( ! $post_name && $this->get('post_id')) {
             /** @type WPDB $wpdb */
             global $wpdb;
             $SQL =
@@ -165,7 +165,7 @@ 
      */
     public function get_post_type_from_request($wp = null)
     {
-        if (! $wp instanceof WP) {
+        if ( ! $wp instanceof WP) {
             global $wp;
         }
         return isset($wp->query_vars['post_type'])
@@ -186,7 +186,7 @@ 
         if ($post_id) {
             $current_page_permalink = get_permalink($post_id);
         } else {
-            if (! $wp instanceof WP) {
+            if ( ! $wp instanceof WP) {
                 global $wp;
             }
             if ($wp->request) {
@@ -212,7 +212,7 @@ 
         $espresso_CPT_taxonomies = $EE_CPT_Strategy->get_CPT_taxonomies();
         if (is_array($espresso_CPT_taxonomies)) {
             foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($wp->query_vars, $wp->query_vars[ $espresso_CPT_taxonomy ])) {
+                if (isset($wp->query_vars, $wp->query_vars[$espresso_CPT_taxonomy])) {
                     return true;
                 }
             }
@@ -223,12 +223,12 @@ 
         $post_types = (array) $this->get('post_type');
         foreach ($post_types as $post_type) {
             // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
+            if (isset($post_type_CPT_endpoints[$post_type])) {
                 // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->get('post_name')) {
+                if ( ! $this->get('post_name')) {
                     // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    $post_name = isset($post_type_CPT_endpoints[ $this->get('post_type') ])
-                        ? $post_type_CPT_endpoints[ $this->get('post_type') ]
+                    $post_name = isset($post_type_CPT_endpoints[$this->get('post_type')])
+                        ? $post_type_CPT_endpoints[$this->get('post_type')]
                         : '';
                     // if the post type matches on of our then set the endpoint
                     if ($post_name) {
@@ -248,7 +248,7 @@ 
      */
     public function set_notice($key, $value)
     {
-        $this->_notice[ $key ] = $value;
+        $this->_notice[$key] = $value;
     }
 
 
@@ -258,8 +258,8 @@ 
      */
     public function get_notice($key)
     {
-        return isset($this->_notice[ $key ])
-            ? $this->_notice[ $key ]
+        return isset($this->_notice[$key])
+            ? $this->_notice[$key]
             : null;
     }
 

core/EE_Maintenance_Mode.core.php

Indentation +327 added lines, -327 removed lines

@@ -14,333 +14,333 @@
 class EE_Maintenance_Mode implements ResettableInterface
 {
 
-    /**
-     * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
-     * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
-     */
-    const level_0_not_in_maintenance = 0;
-
-    /**
-     * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
-     * but the admin backend should be running as normal. Maybe an admin can view the frontend though
-     */
-    const level_1_frontend_only_maintenance = 1;
-
-    /**
-     * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
-     * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
-     * migration scripts before taking the site out of maintenance mode
-     */
-    const level_2_complete_maintenance = 2;
-
-    /**
-     * the name of the option which stores the current level of maintenance mode
-     */
-    const option_name_maintenance_mode = 'ee_maintenance_mode';
-
-
-    /**
-     * @var EE_Maintenance_Mode $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $EE
-     */
-    protected $EE;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Maintenance_Mode
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets maintenance mode (mostly just re-checks whether or not we should be in maintenance mode)
-     *
-     * @return EE_Maintenance_Mode
-     */
-    public static function reset()
-    {
-        self::instance()->set_maintenance_mode_if_db_old();
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     */
-    private function __construct()
-    {
-        // if M-Mode level 2 is engaged, we still need basic assets loaded
-        add_action('wp_enqueue_scripts', array($this, 'load_assets_required_for_m_mode'));
-        // shut 'er down down for maintenance ?
-        add_filter('the_content', array($this, 'the_content'), 2);
-        // add powered by EE msg
-        add_action('shutdown', array($this, 'display_maintenance_mode_notice'), 10);
-    }
-
-
-    /**
-     * retrieves the maintenance mode option value from the db
-     *
-     * @return int
-     */
-    public function real_level()
-    {
-        return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
-    }
-
-
-    /**
-     * Returns whether or not the models reportedly are able to run queries or not
-     * (ie, if the system thinks their tables are present and up-to-date).
-     *
-     * @return boolean
-     */
-    public function models_can_query()
-    {
-        return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-
-    /**
-     * Determines whether or not we're in maintenance mode and what level. However, while the site
-     * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
-     * to them as if teh site isn't in maintenance mode.
-     * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
-     * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
-     * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
-     *
-     * @return int
-     */
-    public function level()
-    {
-        $maintenance_mode_level = $this->real_level();
-        // if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
-        if ($maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
-            && ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
-            && current_user_can('administrator') // when the user is an admin
-        ) {
-            $maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
-        }
-        return $maintenance_mode_level;
-    }
-
-
-    /**
-     * Determines if we need to put EE in maintenance mode because the database needs updating
-     *
-     * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
-     */
-    public function set_maintenance_mode_if_db_old()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
-            return true;
-        }
-        if ($this->level() === self::level_2_complete_maintenance) {
-            // we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
-            // then we shouldn't be in mm2. (Maybe an addon got deactivated?)
-            update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
-            return false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the maintenance level on the site
-     *
-     * @param int $level
-     * @return void
-     */
-    public function set_maintenance_level($level)
-    {
-        do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
-        update_option(self::option_name_maintenance_mode, (int) $level);
-    }
-
-
-    /**
-     * returns TRUE if M-Mode is engaged and the current request is not for the admin
-     *
-     * @return    string
-     */
-    public static function disable_frontend_for_maintenance()
-    {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_assets_required_for_m_mode()
-    {
-        if ($this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
-            && ! wp_script_is('espresso_core')
-        ) {
-            wp_register_style(
-                'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                array('dashicons'),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('espresso_default');
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                array('jquery'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-    /**
-     * replacement EE CPT template that displays message notifying site visitors
-     * that EE has been temporarily placed into maintenance mode
-     * does NOT get called on non-EE-CPT requests
-     *
-     * @return    string
-     */
-    public static function template_include()
-    {
-        // shut 'er down down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
-    }
-
-
-    /**
-     * displays message notifying site visitors that EE has been temporarily
-     * placed into maintenance mode when post_type != EE CPT
-     *
-     * @param string $the_content
-     * @return string
-     */
-    public function the_content($the_content)
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
-            // this can eventually be moved to a template, or edited via admin. But for now...
-            $the_content = sprintf(
-                esc_html__(
-                    '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '</h3><p>',
-                '</p>'
-            );
-        }
-        return $the_content;
-    }
-
-
-    /**
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
-     */
-    public function display_maintenance_mode_notice()
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if (! (defined('DOING_AJAX') && DOING_AJAX)
-            && $this->real_level()
-            && ! is_admin()
-            && current_user_can('administrator')
-            && EE_Registry::instance()->REQ->is_espresso_page()
-        ) {
-            printf(
-                esc_html__(
-                    '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
-                    'event_espresso'
-                ),
-                '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
-                '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
-                    array('page' => 'espresso_maintenance_settings'),
-                    admin_url('admin.php')
-                ) . '">',
-                '</a></p></div>'
-            );
-        }
-    }
-    // espresso-notices important-notice ee-attention
-
-
-    /**
-     * override magic methods
-     */
-    final public function __destruct()
-    {
-    }
-
-
-    final public function __call($a, $b)
-    {
-    }
-
-
-    final public function __get($a)
-    {
-    }
-
-
-    final public function __set($a, $b)
-    {
-    }
-
-
-    final public function __isset($a)
-    {
-    }
-
-
-    final public function __unset($a)
-    {
-    }
-
-
-    final public function __sleep()
-    {
-        return array();
-    }
-
-
-    final public function __wakeup()
-    {
-    }
-
-
-    final public function __invoke()
-    {
-    }
-
-
-    final public static function __set_state($a = null)
-    {
-        return EE_Maintenance_Mode::instance();
-    }
-
-
-    final public function __clone()
-    {
-    }
+	/**
+	 * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
+	 * level_0_not_in_maintenance means the site is NOT in maintenance mode (so everything's normal)
+	 */
+	const level_0_not_in_maintenance = 0;
+
+	/**
+	 * level_1_frontend_only_maintenance means that the site's frontend EE code should be completely disabled
+	 * but the admin backend should be running as normal. Maybe an admin can view the frontend though
+	 */
+	const level_1_frontend_only_maintenance = 1;
+
+	/**
+	 * level_2_complete_maintenance means the frontend AND EE backend code are disabled. The only system running
+	 * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
+	 * migration scripts before taking the site out of maintenance mode
+	 */
+	const level_2_complete_maintenance = 2;
+
+	/**
+	 * the name of the option which stores the current level of maintenance mode
+	 */
+	const option_name_maintenance_mode = 'ee_maintenance_mode';
+
+
+	/**
+	 * @var EE_Maintenance_Mode $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $EE
+	 */
+	protected $EE;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Maintenance_Mode
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Maintenance_Mode) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets maintenance mode (mostly just re-checks whether or not we should be in maintenance mode)
+	 *
+	 * @return EE_Maintenance_Mode
+	 */
+	public static function reset()
+	{
+		self::instance()->set_maintenance_mode_if_db_old();
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 */
+	private function __construct()
+	{
+		// if M-Mode level 2 is engaged, we still need basic assets loaded
+		add_action('wp_enqueue_scripts', array($this, 'load_assets_required_for_m_mode'));
+		// shut 'er down down for maintenance ?
+		add_filter('the_content', array($this, 'the_content'), 2);
+		// add powered by EE msg
+		add_action('shutdown', array($this, 'display_maintenance_mode_notice'), 10);
+	}
+
+
+	/**
+	 * retrieves the maintenance mode option value from the db
+	 *
+	 * @return int
+	 */
+	public function real_level()
+	{
+		return (int) get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance);
+	}
+
+
+	/**
+	 * Returns whether or not the models reportedly are able to run queries or not
+	 * (ie, if the system thinks their tables are present and up-to-date).
+	 *
+	 * @return boolean
+	 */
+	public function models_can_query()
+	{
+		return $this->real_level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+
+	/**
+	 * Determines whether or not we're in maintenance mode and what level. However, while the site
+	 * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
+	 * to them as if teh site isn't in maintenance mode.
+	 * EE_Maintenance_Mode::level_0_not_in_maintenance => not in maintenance mode (in normal mode)
+	 * EE_Maintenance_Mode::level_1_frontend_only_maintenance=> frontend-only maintenance mode
+	 * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode
+	 *
+	 * @return int
+	 */
+	public function level()
+	{
+		$maintenance_mode_level = $this->real_level();
+		// if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend
+		if ($maintenance_mode_level === EE_Maintenance_Mode::level_1_frontend_only_maintenance// we're in level 1
+			&& ((defined('DOING_AJAX') && DOING_AJAX) || ! is_admin()) // on non-ajax frontend requests
+			&& current_user_can('administrator') // when the user is an admin
+		) {
+			$maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance;
+		}
+		return $maintenance_mode_level;
+	}
+
+
+	/**
+	 * Determines if we need to put EE in maintenance mode because the database needs updating
+	 *
+	 * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
+	 */
+	public function set_maintenance_mode_if_db_old()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance);
+			return true;
+		}
+		if ($this->level() === self::level_2_complete_maintenance) {
+			// we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
+			// then we shouldn't be in mm2. (Maybe an addon got deactivated?)
+			update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance);
+			return false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the maintenance level on the site
+	 *
+	 * @param int $level
+	 * @return void
+	 */
+	public function set_maintenance_level($level)
+	{
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level);
+		update_option(self::option_name_maintenance_mode, (int) $level);
+	}
+
+
+	/**
+	 * returns TRUE if M-Mode is engaged and the current request is not for the admin
+	 *
+	 * @return    string
+	 */
+	public static function disable_frontend_for_maintenance()
+	{
+		return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_assets_required_for_m_mode()
+	{
+		if ($this->real_level() === EE_Maintenance_Mode::level_2_complete_maintenance
+			&& ! wp_script_is('espresso_core')
+		) {
+			wp_register_style(
+				'espresso_default',
+				EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				array('dashicons'),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('espresso_default');
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				array('jquery'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+	/**
+	 * replacement EE CPT template that displays message notifying site visitors
+	 * that EE has been temporarily placed into maintenance mode
+	 * does NOT get called on non-EE-CPT requests
+	 *
+	 * @return    string
+	 */
+	public static function template_include()
+	{
+		// shut 'er down down for maintenance ? then don't use any of our templates for our endpoints
+		return get_template_directory() . '/index.php';
+	}
+
+
+	/**
+	 * displays message notifying site visitors that EE has been temporarily
+	 * placed into maintenance mode when post_type != EE CPT
+	 *
+	 * @param string $the_content
+	 * @return string
+	 */
+	public function the_content($the_content)
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if ($this->level() && strpos($the_content, '[ESPRESSO_') !== false) {
+			// this can eventually be moved to a template, or edited via admin. But for now...
+			$the_content = sprintf(
+				esc_html__(
+					'%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'</h3><p>',
+				'</p>'
+			);
+		}
+		return $the_content;
+	}
+
+
+	/**
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
+	 */
+	public function display_maintenance_mode_notice()
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if (! (defined('DOING_AJAX') && DOING_AJAX)
+			&& $this->real_level()
+			&& ! is_admin()
+			&& current_user_can('administrator')
+			&& EE_Registry::instance()->REQ->is_espresso_page()
+		) {
+			printf(
+				esc_html__(
+					'%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
+					'event_espresso'
+				),
+				'<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
+				'"><span class="dashicons dashicons-no"></span></a><p>',
+				' &raquo; <a href="' . add_query_arg(
+					array('page' => 'espresso_maintenance_settings'),
+					admin_url('admin.php')
+				) . '">',
+				'</a></p></div>'
+			);
+		}
+	}
+	// espresso-notices important-notice ee-attention
+
+
+	/**
+	 * override magic methods
+	 */
+	final public function __destruct()
+	{
+	}
+
+
+	final public function __call($a, $b)
+	{
+	}
+
+
+	final public function __get($a)
+	{
+	}
+
+
+	final public function __set($a, $b)
+	{
+	}
+
+
+	final public function __isset($a)
+	{
+	}
+
+
+	final public function __unset($a)
+	{
+	}
+
+
+	final public function __sleep()
+	{
+		return array();
+	}
+
+
+	final public function __wakeup()
+	{
+	}
+
+
+	final public function __invoke()
+	{
+	}
+
+
+	final public static function __set_state($a = null)
+	{
+		return EE_Maintenance_Mode::instance();
+	}
+
+
+	final public function __clone()
+	{
+	}
 
 
-    final public static function __callStatic($a, $b)
-    {
-    }
+	final public static function __callStatic($a, $b)
+	{
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -57,7 +57,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
+        if ( ! self::$_instance instanceof EE_Maintenance_Mode) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -179,7 +179,7 @@ 
      */
     public static function disable_frontend_for_maintenance()
     {
-        return (! is_admin() && EE_Maintenance_Mode::instance()->level());
+        return ( ! is_admin() && EE_Maintenance_Mode::instance()->level());
     }
 
 
@@ -193,14 +193,14 @@ 
         ) {
             wp_register_style(
                 'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+                EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
                 array('dashicons'),
                 EVENT_ESPRESSO_VERSION
             );
             wp_enqueue_style('espresso_default');
             wp_register_script(
                 'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+                EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
                 array('jquery'),
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -220,7 +220,7 @@ 
     public static function template_include()
     {
         // shut 'er down down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
+        return get_template_directory().'/index.php';
     }
 
 
@@ -256,7 +256,7 @@ 
     public function display_maintenance_mode_notice()
     {
         // check if M-mode is engaged and for EE shortcode
-        if (! (defined('DOING_AJAX') && DOING_AJAX)
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)
             && $this->real_level()
             && ! is_admin()
             && current_user_can('administrator')
@@ -269,10 +269,10 @@ 
                 ),
                 '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
                 '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
+                ' &raquo; <a href="'.add_query_arg(
                     array('page' => 'espresso_maintenance_settings'),
                     admin_url('admin.php')
-                ) . '">',
+                ).'">',
                 '</a></p></div>'
             );
         }

core/admin/EE_Admin_Page_Menu_Map.core.php

Indentation +357 added lines, -357 removed lines

@@ -11,257 +11,257 @@ 
 {
 
 
-    /**
-     * The title for the menu page. (the page the menu links to)
-     *
-     * @since  4.4.0
-     * @var string
-     */
-    public $title;
-
-
-    /**
-     * The label for the menu item. (What shows up in the actual menu).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_label;
-
-
-    /**
-     * What menu item is the parent of this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $parent_slug;
-
-
-    /**
-     * What capability is required to access this page.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $capability = 'administrator';
-
-
-    /**
-     * What slug should be used to reference this menu item.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_slug;
-
-
-    /**
-     * The callback for displaying the page that the menu references.
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_callback;
-
-
-    /**
-     * The EE_Admin_Page_Init attached to this map.
-     *
-     * @var EE_Admin_Page_Init
-     */
-    public $admin_init_page;
-
-
-    /**
-     * The EE specific group this menu item belongs in (group slug).
-     *
-     * @since 4.4.0
-     * @var string
-     */
-    public $menu_group;
-
-
-    /**
-     * What order this item should be in the menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $menu_order;
-
-
-    const NONE = 0;
-    const BLOG_ADMIN_ONLY = 1;
-    const BLOG_AND_NETWORK_ADMIN = 2;
-    const NETWORK_ADMIN_ONLY = 3;
-
-
-    /**
-     * Whether this item is displayed in the menu or not.
-     * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
-     * admin menu.
-     *
-     * @since 4.4.0
-     * @var int
-     */
-    public $show_on_menu = self::BLOG_ADMIN_ONLY;
-
-
-    /**
-     * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
-     * EE_Maintenance_Mode::level_2_complete_maintenance is active.
-     *
-     * @var bool
-     */
-    public $maintenance_mode_parent = '';
-
-
-    /**
-     * Constructor.
-     *
-     * @since 4.4.0
-     *
-     * @param  array $menu_args           An array of arguments used to setup the menu
-     *                                    properties on construct.
-     * @param  array $required            An array of keys that should be in the $menu_args, this
-     *                                    is used to validate that the items that should be defined
-     *                                    are present.
-     * @return void
-     */
-    public function __construct($menu_args, $required)
-    {
-        // filter all args before processing so plugins can manipulate various settings for menus.
-        $menu_args = apply_filters(
-            'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
-            $menu_args,
-            $required,
-            get_class($this)
-        );
-
-
-        // verify that required keys are present in the incoming array.
-        $missing = array_diff((array) $required, array_keys((array) $menu_args));
-
-        if (! empty($missing)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%s is missing some expected keys in the argument array.  The following keys are missing: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    implode(', ', $missing)
-                )
-            );
-        }
-
-        // made it here okay, so let's set the properties!
-        foreach ($menu_args as $prop => $value) {
-            switch ($prop) {
-                case 'show_on_menu':
-                    $value = (int) $value;
-                    break;
-                case 'admin_init_page':
-                    if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
-                        throw new EE_Error(
-                            sprintf(
-                                __(
-                                    'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
-                                    'event_espresso'
-                                ),
-                                print_r($value, true)
-                            )
-                        );
-                    }
-                    break;
-                case 'menu_callback':
-                    break;
-
-                default:
-                    $value = (string) $value;
-                    break;
-            }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        $prop
-                    )
-                );
-            }
-            $this->{$prop} = $value;
-        }
-
-        // filter capabilities (both static and dynamic)
-        $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
-
-        // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
-            && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-        ) {
-            $this->parent_slug = $this->maintenance_mode_parent;
-        }
-
-        // if empty menu_callback let's set default (but only if we have admin page init object)
-        if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            $this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
-        }
-    }
-
-
-    /**
-     * This method should define how the menu page gets added for this particular item
-     * and go ahead and define it.  Note that child classes MUST also return the result of
-     * the function used to register the WordPress admin page (the wp_page_slug string)
-     *
-     * @since  4.4.0
-     * @return string wp_page_slug.
-     */
-    abstract protected function _add_menu_page();
-
-
-    /**
-     * Called by client code to use this menu map for registering a WordPress admin page
-     *
-     * @param boolean $network_admin whether this is being added to the network admin page or not
-     * @since  4.4.0
-     */
-    public function add_menu_page($network_admin = false)
-    {
-
-        $show_on_menu_int = (int) $this->show_on_menu;
-        if (($network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
-                 true
-             ))
-            ||
-            (! $network_admin
-             && in_array(
-                 $show_on_menu_int,
-                 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
-                 true
-             ))) {
-            $wp_page_slug = $this->_add_menu_page();
-        } else {
-            $wp_page_slug = '';
-        }
-
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
-            try {
-                $this->admin_init_page->set_page_dependencies($wp_page_slug);
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-    }
+	/**
+	 * The title for the menu page. (the page the menu links to)
+	 *
+	 * @since  4.4.0
+	 * @var string
+	 */
+	public $title;
+
+
+	/**
+	 * The label for the menu item. (What shows up in the actual menu).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_label;
+
+
+	/**
+	 * What menu item is the parent of this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $parent_slug;
+
+
+	/**
+	 * What capability is required to access this page.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $capability = 'administrator';
+
+
+	/**
+	 * What slug should be used to reference this menu item.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_slug;
+
+
+	/**
+	 * The callback for displaying the page that the menu references.
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_callback;
+
+
+	/**
+	 * The EE_Admin_Page_Init attached to this map.
+	 *
+	 * @var EE_Admin_Page_Init
+	 */
+	public $admin_init_page;
+
+
+	/**
+	 * The EE specific group this menu item belongs in (group slug).
+	 *
+	 * @since 4.4.0
+	 * @var string
+	 */
+	public $menu_group;
+
+
+	/**
+	 * What order this item should be in the menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $menu_order;
+
+
+	const NONE = 0;
+	const BLOG_ADMIN_ONLY = 1;
+	const BLOG_AND_NETWORK_ADMIN = 2;
+	const NETWORK_ADMIN_ONLY = 3;
+
+
+	/**
+	 * Whether this item is displayed in the menu or not.
+	 * Sometimes an EE Admin Page needs to register itself but is not accessible via the WordPress
+	 * admin menu.
+	 *
+	 * @since 4.4.0
+	 * @var int
+	 */
+	public $show_on_menu = self::BLOG_ADMIN_ONLY;
+
+
+	/**
+	 * Menu maps can define a parent slug that gets used instead of the main parent slug for the menu when
+	 * EE_Maintenance_Mode::level_2_complete_maintenance is active.
+	 *
+	 * @var bool
+	 */
+	public $maintenance_mode_parent = '';
+
+
+	/**
+	 * Constructor.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @param  array $menu_args           An array of arguments used to setup the menu
+	 *                                    properties on construct.
+	 * @param  array $required            An array of keys that should be in the $menu_args, this
+	 *                                    is used to validate that the items that should be defined
+	 *                                    are present.
+	 * @return void
+	 */
+	public function __construct($menu_args, $required)
+	{
+		// filter all args before processing so plugins can manipulate various settings for menus.
+		$menu_args = apply_filters(
+			'FHEE__EE_Admin_Page_Menu_Map__construct__menu_args',
+			$menu_args,
+			$required,
+			get_class($this)
+		);
+
+
+		// verify that required keys are present in the incoming array.
+		$missing = array_diff((array) $required, array_keys((array) $menu_args));
+
+		if (! empty($missing)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%s is missing some expected keys in the argument array.  The following keys are missing: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					implode(', ', $missing)
+				)
+			);
+		}
+
+		// made it here okay, so let's set the properties!
+		foreach ($menu_args as $prop => $value) {
+			switch ($prop) {
+				case 'show_on_menu':
+					$value = (int) $value;
+					break;
+				case 'admin_init_page':
+					if (in_array('admin_init_page', $required) && ! $value instanceof EE_Admin_Page_Init) {
+						throw new EE_Error(
+							sprintf(
+								__(
+									'The value for the "admin_init_page" argument must be an instance of an EE_Admin_Page_Init object.  Instead %s was given as the value.',
+									'event_espresso'
+								),
+								print_r($value, true)
+							)
+						);
+					}
+					break;
+				case 'menu_callback':
+					break;
+
+				default:
+					$value = (string) $value;
+					break;
+			}
+			if (! EEH_Class_Tools::has_property($this, $prop)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The $menu_args coming into %s has a index key (%s) representing a property that is not defined by the class.  Perhaps there is a typo?',
+							'event_espresso'
+						),
+						get_class($this),
+						$prop
+					)
+				);
+			}
+			$this->{$prop} = $value;
+		}
+
+		// filter capabilities (both static and dynamic)
+		$this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
+		$this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+
+		// Might need to change parent slug depending on maintenance mode.
+		if (! empty($this->maintenance_mode_parent)
+			&& EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+		) {
+			$this->parent_slug = $this->maintenance_mode_parent;
+		}
+
+		// if empty menu_callback let's set default (but only if we have admin page init object)
+		if (empty($this->menu_callback) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			$this->menu_callback = array($this->admin_init_page, 'initialize_admin_page');
+		}
+	}
+
+
+	/**
+	 * This method should define how the menu page gets added for this particular item
+	 * and go ahead and define it.  Note that child classes MUST also return the result of
+	 * the function used to register the WordPress admin page (the wp_page_slug string)
+	 *
+	 * @since  4.4.0
+	 * @return string wp_page_slug.
+	 */
+	abstract protected function _add_menu_page();
+
+
+	/**
+	 * Called by client code to use this menu map for registering a WordPress admin page
+	 *
+	 * @param boolean $network_admin whether this is being added to the network admin page or not
+	 * @since  4.4.0
+	 */
+	public function add_menu_page($network_admin = false)
+	{
+
+		$show_on_menu_int = (int) $this->show_on_menu;
+		if (($network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::NETWORK_ADMIN_ONLY),
+				 true
+			 ))
+			||
+			(! $network_admin
+			 && in_array(
+				 $show_on_menu_int,
+				 array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
+				 true
+			 ))) {
+			$wp_page_slug = $this->_add_menu_page();
+		} else {
+			$wp_page_slug = '';
+		}
+
+		if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+			try {
+				$this->admin_init_page->set_page_dependencies($wp_page_slug);
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+	}
 }
 
 
@@ -275,75 +275,75 @@ 
 class EE_Admin_Page_Main_Menu extends EE_Admin_Page_Menu_Map
 {
 
-    /**
-     * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
-     * subtitle than the main menu item.
-     *
-     * @since 4.4.0
-     *
-     * @var string
-     */
-    public $subtitle;
-
-    /**
-     * The page to a icon used for this menu.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var string
-     */
-    public $icon_url;
-
-
-    /**
-     * What position in the main menu order for the WP admin menu this menu item
-     * should show.
-     *
-     * @since  4.4.0
-     * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
-     *        for what can be set for this property.
-     * @var integer
-     */
-    public $position;
-
-
-    public function __construct($menu_args)
-    {
-        $required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
-
-        parent::__construct($menu_args, $required);
-
-        $this->position = ! empty($this->position) ? (int) $this->position : $this->position;
-    }
-
-
-    /**
-     * Uses the proper WP utility for registering a menu page for the main WP pages.
-     */
-    protected function _add_menu_page()
-    {
-        $main = add_menu_page(
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->parent_slug,
-            $this->menu_callback,
-            $this->icon_url,
-            $this->position
-        );
-        if (! empty($this->subtitle)) {
-            add_submenu_page(
-                $this->parent_slug,
-                $this->subtitle,
-                $this->subtitle,
-                $this->capability,
-                $this->menu_slug,
-                $this->menu_callback
-            );
-        }
-        return $main;
-    }
+	/**
+	 * If included int incoming params, then this class will also register a Sub Menue Admin page with a different
+	 * subtitle than the main menu item.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @var string
+	 */
+	public $subtitle;
+
+	/**
+	 * The page to a icon used for this menu.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var string
+	 */
+	public $icon_url;
+
+
+	/**
+	 * What position in the main menu order for the WP admin menu this menu item
+	 * should show.
+	 *
+	 * @since  4.4.0
+	 * @see    http://codex.wordpress.org/Function_Reference/add_menu_page#Parameters
+	 *        for what can be set for this property.
+	 * @var integer
+	 */
+	public $position;
+
+
+	public function __construct($menu_args)
+	{
+		$required = array('menu_label', 'parent_slug', 'menu_slug', 'menu_group', 'menu_order', 'admin_init_page');
+
+		parent::__construct($menu_args, $required);
+
+		$this->position = ! empty($this->position) ? (int) $this->position : $this->position;
+	}
+
+
+	/**
+	 * Uses the proper WP utility for registering a menu page for the main WP pages.
+	 */
+	protected function _add_menu_page()
+	{
+		$main = add_menu_page(
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->parent_slug,
+			$this->menu_callback,
+			$this->icon_url,
+			$this->position
+		);
+		if (! empty($this->subtitle)) {
+			add_submenu_page(
+				$this->parent_slug,
+				$this->subtitle,
+				$this->subtitle,
+				$this->capability,
+				$this->menu_slug,
+				$this->menu_callback
+			);
+		}
+		return $main;
+	}
 } //end EE_Admin_Page_Main_Menu
 
 
@@ -357,23 +357,23 @@ 
 class EE_Admin_Page_Sub_Menu extends EE_Admin_Page_Main_Menu
 {
 
-    public function __construct($menu_args)
-    {
-        parent::__construct($menu_args);
-    }
-
-
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->title,
-            $this->menu_label,
-            $this->capability,
-            $this->menu_slug,
-            $this->menu_callback
-        );
-    }
+	public function __construct($menu_args)
+	{
+		parent::__construct($menu_args);
+	}
+
+
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->title,
+			$this->menu_label,
+			$this->capability,
+			$this->menu_slug,
+			$this->menu_callback
+		);
+	}
 }
 
 
@@ -392,28 +392,28 @@ 
 {
 
 
-    public function __construct($menu_args = array())
-    {
-        $required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
-        parent::__construct($menu_args, $required);
-    }
+	public function __construct($menu_args = array())
+	{
+		$required = array('menu_label', 'menu_slug', 'menu_order', 'parent_slug');
+		parent::__construct($menu_args, $required);
+	}
 
 
-    protected function _add_menu_page()
-    {
-        return add_submenu_page(
-            $this->parent_slug,
-            $this->menu_label,
-            $this->_group_link(),
-            $this->capability,
-            $this->menu_slug,
-            '__return_false'
-        );
-    }
+	protected function _add_menu_page()
+	{
+		return add_submenu_page(
+			$this->parent_slug,
+			$this->menu_label,
+			$this->_group_link(),
+			$this->capability,
+			$this->menu_slug,
+			'__return_false'
+		);
+	}
 
 
-    private function _group_link()
-    {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
-    }
+	private function _group_link()
+	{
+		return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -143,7 +143,7 @@ 
         // verify that required keys are present in the incoming array.
         $missing = array_diff((array) $required, array_keys((array) $menu_args));
 
-        if (! empty($missing)) {
+        if ( ! empty($missing)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -182,7 +182,7 @@ 
                     $value = (string) $value;
                     break;
             }
-            if (! EEH_Class_Tools::has_property($this, $prop)) {
+            if ( ! EEH_Class_Tools::has_property($this, $prop)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -199,10 +199,10 @@ 
 
         // filter capabilities (both static and dynamic)
         $this->capability = apply_filters('FHEE_management_capability', $this->capability, null);
-        $this->capability = apply_filters('FHEE_' . $this->menu_slug . '_capability', $this->capability, null);
+        $this->capability = apply_filters('FHEE_'.$this->menu_slug.'_capability', $this->capability, null);
 
         // Might need to change parent slug depending on maintenance mode.
-        if (! empty($this->maintenance_mode_parent)
+        if ( ! empty($this->maintenance_mode_parent)
             && EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
         ) {
             $this->parent_slug = $this->maintenance_mode_parent;
@@ -243,7 +243,7 @@ 
                  true
              ))
             ||
-            (! $network_admin
+            ( ! $network_admin
              && in_array(
                  $show_on_menu_int,
                  array(self::BLOG_AND_NETWORK_ADMIN, self::BLOG_ADMIN_ONLY),
@@ -254,7 +254,7 @@ 
             $wp_page_slug = '';
         }
 
-        if (! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
+        if ( ! empty($wp_page_slug) && $this->admin_init_page instanceof EE_Admin_Page_Init) {
             try {
                 $this->admin_init_page->set_page_dependencies($wp_page_slug);
             } catch (EE_Error $e) {
@@ -332,7 +332,7 @@ 
             $this->icon_url,
             $this->position
         );
-        if (! empty($this->subtitle)) {
+        if ( ! empty($this->subtitle)) {
             add_submenu_page(
                 $this->parent_slug,
                 $this->subtitle,
@@ -414,6 +414,6 @@ 
 
     private function _group_link()
     {
-        return '<span class="ee_menu_group"  onclick="return false;">' . $this->menu_label . '</span>';
+        return '<span class="ee_menu_group"  onclick="return false;">'.$this->menu_label.'</span>';
     }
 }