eventespresso / event-espresso-core

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_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_CPT_Init.core.php

Indentation +35 added lines, -35 removed lines

@@ -14,43 +14,43 @@
 {
 
 
-    public function do_initial_loads()
-    {
-        // we want to use the corresponding admin page object (but not route it!).  To do this we just set _routing to false.  That way this page object is being loaded on all pages to make sure we hook into admin properly.  But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
-        // This is important because we have hooks that help redirect custom post type saves
-        if (! isset($_REQUEST['page'])
-            || (isset($_REQUEST['page'])
-                && $_REQUEST['page']
-                   != $this->_menu_map->menu_slug)) {
-            $this->_routing = false;
-            $this->_initialize_admin_page();
-        } else {
-            // normal init loads
-            $this->_initialize_admin_page();
-            // added for 4.1 to completely disable autosave for our pages. This can be removed once we fully enable autosave functionality
-            remove_filter('wp_print_scripts', 'wp_just_in_time_script_localization');
-            add_filter('wp_print_scripts', array($this, 'wp_just_in_time_script_localization'), 100);
-            // end removal of autosave functionality.
-        }
-    }
+	public function do_initial_loads()
+	{
+		// we want to use the corresponding admin page object (but not route it!).  To do this we just set _routing to false.  That way this page object is being loaded on all pages to make sure we hook into admin properly.  But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
+		// This is important because we have hooks that help redirect custom post type saves
+		if (! isset($_REQUEST['page'])
+			|| (isset($_REQUEST['page'])
+				&& $_REQUEST['page']
+				   != $this->_menu_map->menu_slug)) {
+			$this->_routing = false;
+			$this->_initialize_admin_page();
+		} else {
+			// normal init loads
+			$this->_initialize_admin_page();
+			// added for 4.1 to completely disable autosave for our pages. This can be removed once we fully enable autosave functionality
+			remove_filter('wp_print_scripts', 'wp_just_in_time_script_localization');
+			add_filter('wp_print_scripts', array($this, 'wp_just_in_time_script_localization'), 100);
+			// end removal of autosave functionality.
+		}
+	}
 
 
-    public function wp_just_in_time_script_localization()
-    {
-        wp_localize_script(
-            'autosave',
-            'autosaveL10n',
-            array(
-                'autosaveInterval' => 172800,
-                'savingText'       => __('Saving Draft…', 'event_espresso'),
-                'saveAlert'        => __('The changes you made will be lost if you navigate away from this page.', 'event_espresso'),
-            )
-        );
-    }
+	public function wp_just_in_time_script_localization()
+	{
+		wp_localize_script(
+			'autosave',
+			'autosaveL10n',
+			array(
+				'autosaveInterval' => 172800,
+				'savingText'       => __('Saving Draft…', 'event_espresso'),
+				'saveAlert'        => __('The changes you made will be lost if you navigate away from this page.', 'event_espresso'),
+			)
+		);
+	}
 
 
-    public function adjust_post_lock_window($interval)
-    {
-        return 172800;
-    }
+	public function adjust_post_lock_window($interval)
+	{
+		return 172800;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
     {
         // we want to use the corresponding admin page object (but not route it!).  To do this we just set _routing to false.  That way this page object is being loaded on all pages to make sure we hook into admin properly.  But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
         // This is important because we have hooks that help redirect custom post type saves
-        if (! isset($_REQUEST['page'])
+        if ( ! isset($_REQUEST['page'])
             || (isset($_REQUEST['page'])
                 && $_REQUEST['page']
                    != $this->_menu_map->menu_slug)) {

core/admin/EE_Help_Tour.core.php

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

Indentation +265 added lines, -265 removed lines

@@ -15,269 +15,269 @@
 abstract class EE_Help_Tour extends EE_Base
 {
 
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = __('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => __('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            // set to false or yoursite.com
-            'cookieDomain'          => false,
-            // Where the tip be attached if not inline
-            // 'tipContainer' => 'body',
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the $_REQUEST object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = __('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => __('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			// set to false or yoursite.com
+			'cookieDomain'          => false,
+			// Where the tip be attached if not inline
+			// 'tipContainer' => 'body',
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }

core/admin/templates/about_admin_wrapper.template.php

Indentation +8 added lines, -8 removed lines

@@ -4,19 +4,19 @@
     <div class="about-text"><?php echo ! empty($admin_page_subtitle) ? $admin_page_subtitle : ''; ?></div>
     <div class="ee-badge"><img class="" src=" <?php echo EE_GLOBAL_ASSETS_URL; ?>images/event-espresso-cup-90x90.png"
                                width="90" height="90" alt="<?php
-                                                        printf(
-                                                            esc_attr__('%s Logo', 'event_espresso'),
-                                                            'Event Espresso'
-                                                        ); ?>"/>
+														printf(
+															esc_attr__('%s Logo', 'event_espresso'),
+															'Event Espresso'
+														); ?>"/>
         <br/><?php printf(__('Version %s', 'event_espresso'), EVENT_ESPRESSO_VERSION); ?></div>
 
     <?php echo $nav_tabs; ?>
 
 
     <?php
-    do_action('AHEE__admin_wrapper__template__before_about_admin_page_content');
-    echo $about_admin_page_content;
-    do_action('AHEE__admin_wrapper__template__after_about_admin_page_content');
-    ?>
+	do_action('AHEE__admin_wrapper__template__before_about_admin_page_content');
+	echo $about_admin_page_content;
+	do_action('AHEE__admin_wrapper__template__after_about_admin_page_content');
+	?>
 
 </div>

core/admin/templates/admin_details_legend.template.php

Indentation +7 added lines, -7 removed lines

@@ -10,17 +10,17 @@ 
     <dl class="alignleft ee-list-table-legend">
         <?php foreach ($items as $item => $details) : ?>
         <?php
-        if ($per_col < $count) : ?>
+		if ($per_col < $count) : ?>
     </dl>
     <dl class="alignleft ee-list-table-legend">
         <?php $count = 1;
-        endif; ?>
+		endif; ?>
         <dt id="ee-legend-item-<?php echo $item; ?>">
             <?php $class = ! empty($details['class']) ? $details['class'] : 'ee-legend-img-container'; ?>
             <?php
-            if (strpos($details['class'], '<span') !== false) {
-                echo $class;
-            } else { ?>
+			if (strpos($details['class'], '<span') !== false) {
+				echo $class;
+			} else { ?>
             <span class="<?php echo $class; ?>">
                 <?php if (! empty($details['icon'])) : ?>
                     <img src="<?php echo $details['icon']; ?>" class="ee-legend-icon"
@@ -28,11 +28,11 @@ 
                 <?php endif; ?>
             </span>
         <?php
-            } ?>
+			} ?>
             <span class="ee-legend-description"><?php echo $details['desc']; ?></span>
         </dt>
         <?php $count++;
-        endforeach; ?>
+		endforeach; ?>
     </dl>
     <div style="clear:both"></div>
 </div>

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
                 echo $class;
             } else { ?>
             <span class="<?php echo $class; ?>">
-                <?php if (! empty($details['icon'])) : ?>
+                <?php if ( ! empty($details['icon'])) : ?>
                     <img src="<?php echo $details['icon']; ?>" class="ee-legend-icon"
                          alt="<?php echo esc_attr($details['desc']); ?>"/>
                 <?php endif; ?>

core/admin/templates/admin_wrapper.template.php

Indentation +6 added lines, -6 removed lines

@@ -7,11 +7,11 @@
     <?php echo $nav_tabs; ?>
 
     <?php
-    do_action('AHEE__admin_wrapper__template__before_admin_page_content');
-    echo $before_admin_page_content;
-    echo $admin_page_content;
-    echo $after_admin_page_content;
-    do_action('AHEE__admin_wrapper__template__after_admin_page_content');
-    ?>
+	do_action('AHEE__admin_wrapper__template__before_admin_page_content');
+	echo $before_admin_page_content;
+	echo $admin_page_content;
+	echo $after_admin_page_content;
+	do_action('AHEE__admin_wrapper__template__after_admin_page_content');
+	?>
 
 </div>