eventespresso / event-espresso-core

core/EE_System.core.php

Indentation +1407 added lines, -1407 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\services\shortcodes\ShortcodesManager;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -19,1412 +19,1412 @@ 
 {
 
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @type  EE_Registry $Registry
-     * @access    protected
-     */
-    protected $registry;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Registry $Registry
-     * @return \EE_System
-     */
-    public static function instance(EE_Registry $Registry = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($Registry);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        //make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        //we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-
-    /**
-     *    sets hooks for running rest of system
-     *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     *    starting EE Addons from any other point may lead to problems
-     *
-     * @access private
-     * @param  \EE_Registry $Registry
-     */
-    private function __construct(EE_Registry $Registry)
-    {
-        $this->registry = $Registry;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
-            3);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
-        // load EE_Config, EE_Textdomain, etc
-        add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'), 7);
-        // you wanna get going? I wanna get going... let's get going!
-        add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
-        //other housekeeping
-        //exclude EE critical pages from wp_list_pages
-        add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        //load and setup EE_Capabilities
-        $this->registry->load_core('Capabilities');
-        //caps need to be initialized on every request so that capability maps are set.
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-        do_action('AHEE__EE_System__load_espresso_addons');
-        //if the WP API basic auth plugin isn't already loaded, load it now.
-        //We want it for mobile apps. Just include the entire plugin
-        //also, don't load the basic auth when a plugin is getting activated, because
-        //it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        //and causes a fatal error
-        if ( ! function_exists('json_basic_auth_handler')
-             && ! function_exists('json_basic_auth_error')
-             && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'))
-            )
-             && ! (
-                isset($_GET['activate'])
-                && $_GET['activate'] === 'true'
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        //first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            //detect teh request type for that addon
-            $addon->detect_activation_or_upgrade();
-        }
-    }
-
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // load M-Mode class
-        $this->registry->load_core('Maintenance_Mode');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        //EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                //migrations may be required now that we've upgraded
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                //				echo "done upgrade";die;
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                //its possible migrations are no longer required
-                EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                //				$this->_maybe_redirect_to_ee_about();
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    protected function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        //get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required'));
-    }
-
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param null $espresso_db_update
-     * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
-     *           from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if ( ! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if ( ! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            //if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    //the key is an int, and the value IS NOT an array
-                    //so it must be numerically-indexed, where values are versions installed...
-                    //fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[$version_string] = array('unknown-date');
-                } else {
-                    //ok it checks out
-                    $corrected_db_update[$should_be_version_string] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        //only initialize system if we're not in maintenance mode.
-        if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
-            update_option('ee_flush_rewrite_rules', true);
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-
-    /**
-     * Initializes the db for all registered addons
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            $addon->initialize_db_if_no_migrations_required();
-        }
-    }
-
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if ( ! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add == null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
-                'ee_espresso_activation', espresso_version());
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-        }
-        return $this->_req_type;
-    }
-
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    protected function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            //it exists, so this isn't a completely new install
-            //check if this version already in that list of previously installed versions
-            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
-                //it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    //we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        //we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {//$version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            //brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        //find the most recently-activated version
-        $most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    protected static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                //check there is a record of when this version was activated. Otherwise,
-                //mark it as unknown
-                if ( ! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation == 'unknown-date'
-                            ? '1970-01-01 00:00:00' : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        //if current user is an admin and it's not an ajax or rest request
-        if (
-            ! (defined('DOING_AJAX') && DOING_AJAX)
-            && ! (defined('REST_REQUEST') && REST_REQUEST)
-            && ! isset($notices['errors'])
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->registry->load_core('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $this->registry->load_core('Config');
-        $this->registry->load_core('Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($this->registry->CFG->admin->use_full_logging) {
-            $this->registry->load_core('Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        //load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     */
-    private function _parse_model_names()
-    {
-        //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[$short_name] = $classname;
-            }
-            $model_names[$short_name] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models);
-    }
-
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     */
-    private function _maybe_brew_regular()
-    {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        try {
-            // load, register, and add shortcodes the new way
-            new ShortcodesManager(
-            // and the old way, but we'll put it under control of the new system
-                EE_Config::getLegacyShortcodesManager()
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hookpoint
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
-        if ( ! empty($class_names)) {
-            $msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso');
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso');
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->registry->load_core('PUE');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-    }
-
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if ( ! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        //first check if we had previously attempted to setup EE's directories but failed
-        if (EEH_Activation::upload_directories_incomplete()) {
-            EEH_Activation::create_upload_directories();
-        }
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-
-    /**
-     *    load_CPTs_and_session
-     *
-     * @access public
-     * @return    void
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        // register Custom Post Types
-        $this->registry->load_core('Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->registry->load_core('Front_Controller');
-        } else if ( ! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            EE_Registry::instance()->load_core('Admin');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->registry->load_core('Session');
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
-        }
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-        $this->registry->create('EventEspresso\core\services\assets\Registry');
-        wp_enqueue_script('espresso_core');
-    }
-
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-    }
-
-
-
-    /**
-     * set_hooks_for_shortcodes_modules_and_addons
-     * this is the best place for other systems to set callbacks for hooking into other parts of EE
-     * this happens at the very beginning of the wp_loaded hookpoint
-     *
-     * @access public
-     * @return void
-     */
-    public function set_hooks_for_shortcodes_modules_and_addons()
-    {
-        //		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
-    }
-
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if ( ! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if ( ! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if ( ! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-
-    /**
-     *    espresso_toolbar_items
-     *
-     * @access public
-     * @param  WP_Admin_Bar $admin_bar
-     * @return void
-     */
-    public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
-    {
-        // if in full M-Mode, or its an AJAX request, or user is NOT an admin
-        if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
-            || defined('DOING_AJAX')
-            || ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
-        ) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $menu_class = 'espresso_menu_item_class';
-        //we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
-        //because they're only defined in each of their respective constructors
-        //and this might be a frontend request, in which case they aren't available
-        $events_admin_url = admin_url("admin.php?page=espresso_events");
-        $reg_admin_url = admin_url("admin.php?page=espresso_registrations");
-        $extensions_admin_url = admin_url("admin.php?page=espresso_packages");
-        //Top Level
-        $admin_bar->add_menu(array(
-            'id'    => 'espresso-toolbar',
-            'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
-                       . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
-                       . '</span>',
-            'href'  => $events_admin_url,
-            'meta'  => array(
-                'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
-            ),
-        ));
-        //Events
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Events', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('Events', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
-            //Events Add New
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-new',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('Add New', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Add New', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if (is_single() && (get_post_type() == 'espresso_events')) {
-            //Current post
-            global $post;
-            if ($this->registry->CAP->current_user_can('ee_edit_event',
-                'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
-            ) {
-                //Events Edit Current Event
-                $admin_bar->add_menu(array(
-                    'id'     => 'espresso-toolbar-events-edit',
-                    'parent' => 'espresso-toolbar-events',
-                    'title'  => __('Edit Event', 'event_espresso'),
-                    'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
-                        $events_admin_url),
-                    'meta'   => array(
-                        'title'  => __('Edit Event', 'event_espresso'),
-                        'target' => '',
-                        'class'  => $menu_class,
-                    ),
-                ));
-            }
-        }
-        //Events View
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-view')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-view',
-                'parent' => 'espresso-toolbar-events',
-                'title'  => __('View', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('View', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
-            //Events View All
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-all',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('All', 'event_espresso'),
-                'href'   => $events_admin_url,
-                'meta'   => array(
-                    'title'  => __('All', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-today')
-        ) {
-            //Events View Today
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-today',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        if ($this->registry->CAP->current_user_can('ee_read_events',
-            'ee_admin_bar_menu_espresso-toolbar-events-month')
-        ) {
-            //Events View This Month
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-events-month',
-                'parent' => 'espresso-toolbar-events-view',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $events_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Registrations', 'event_espresso'),
-                'href'   => $reg_admin_url,
-                'meta'   => array(
-                    'title'  => __('Registrations', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('Today', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Today', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Completed
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Pending\
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-pending',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'     => 'default',
-                    'status'     => 'today',
-                    'reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending Payment', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-not-approved',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview Today Incomplete
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-today-cancelled',
-                'parent' => 'espresso-toolbar-registrations-today',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'today',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month',
-                'parent' => 'espresso-toolbar-registrations',
-                'title'  => __('This Month', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
-                    $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('This Month', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Pending
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-pending',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Pending', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Pending', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Not Approved
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-not-approved',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Not Approved', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Not Approved', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Registration Overview This Month Cancelled
-        if ($this->registry->CAP->current_user_can('ee_read_registrations',
-            'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-registrations-month-cancelled',
-                'parent' => 'espresso-toolbar-registrations-month',
-                'title'  => __('Cancelled', 'event_espresso'),
-                'href'   => EEH_URL::add_query_args_and_nonce(array(
-                    'action'      => 'default',
-                    'status'      => 'month',
-                    '_reg_status' => EEM_Registration::status_id_cancelled,
-                ), $reg_admin_url),
-                'meta'   => array(
-                    'title'  => __('Cancelled', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-        //Extensions & Services
-        if ($this->registry->CAP->current_user_can('ee_read_ee',
-            'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
-        ) {
-            $admin_bar->add_menu(array(
-                'id'     => 'espresso-toolbar-extensions-and-services',
-                'parent' => 'espresso-toolbar',
-                'title'  => __('Extensions & Services', 'event_espresso'),
-                'href'   => $extensions_admin_url,
-                'meta'   => array(
-                    'title'  => __('Extensions & Services', 'event_espresso'),
-                    'target' => '',
-                    'class'  => $menu_class,
-                ),
-            ));
-        }
-    }
-
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @type  EE_Registry $Registry
+	 * @access    protected
+	 */
+	protected $registry;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Registry $Registry
+	 * @return \EE_System
+	 */
+	public static function instance(EE_Registry $Registry = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($Registry);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		//make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		//we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+
+	/**
+	 *    sets hooks for running rest of system
+	 *    provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 *    starting EE Addons from any other point may lead to problems
+	 *
+	 * @access private
+	 * @param  \EE_Registry $Registry
+	 */
+	private function __construct(EE_Registry $Registry)
+	{
+		$this->registry = $Registry;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action('AHEE__EE_Bootstrap__load_espresso_addons', array($this, 'load_espresso_addons'));
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades', array($this, 'detect_activations_or_upgrades'),
+			3);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__load_core_configuration', array($this, 'load_core_configuration'), 5);
+		// load EE_Config, EE_Textdomain, etc
+		add_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'), 7);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action('AHEE__EE_Bootstrap__brew_espresso', array($this, 'brew_espresso'), 9);
+		//other housekeeping
+		//exclude EE critical pages from wp_list_pages
+		add_filter('wp_list_pages_excludes', array($this, 'remove_pages_from_wp_list_pages'), 10);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		//load and setup EE_Capabilities
+		$this->registry->load_core('Capabilities');
+		//caps need to be initialized on every request so that capability maps are set.
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+		do_action('AHEE__EE_System__load_espresso_addons');
+		//if the WP API basic auth plugin isn't already loaded, load it now.
+		//We want it for mobile apps. Just include the entire plugin
+		//also, don't load the basic auth when a plugin is getting activated, because
+		//it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		//and causes a fatal error
+		if ( ! function_exists('json_basic_auth_handler')
+			 && ! function_exists('json_basic_auth_error')
+			 && ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'))
+			)
+			 && ! (
+				isset($_GET['activate'])
+				&& $_GET['activate'] === 'true'
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		//first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			//detect teh request type for that addon
+			$addon->detect_activation_or_upgrade();
+		}
+	}
+
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// load M-Mode class
+		$this->registry->load_core('Maintenance_Mode');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		//EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				//migrations may be required now that we've upgraded
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				//				echo "done upgrade";die;
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				//its possible migrations are no longer required
+				EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				//				$this->_maybe_redirect_to_ee_about();
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	protected function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		//get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required'));
+	}
+
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param null $espresso_db_update
+	 * @internal param array $espresso_db_update_value the value of the WordPress option. If not supplied, fetches it
+	 *           from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if ( ! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if ( ! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			//if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					//the key is an int, and the value IS NOT an array
+					//so it must be numerically-indexed, where values are versions installed...
+					//fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[$version_string] = array('unknown-date');
+				} else {
+					//ok it checks out
+					$corrected_db_update[$should_be_version_string] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		//only initialize system if we're not in maintenance mode.
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			update_option('ee_flush_rewrite_rules', true);
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			$addon->initialize_db_if_no_migrations_required();
+		}
+	}
+
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if ( ! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add == null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update) ? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = $this->detect_req_type_given_activation_history($espresso_db_update,
+				'ee_espresso_activation', espresso_version());
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+		}
+		return $this->_req_type;
+	}
+
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	protected function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the wordpress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the wordpress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			//it exists, so this isn't a completely new install
+			//check if this version already in that list of previously installed versions
+			if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
+				//it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					//we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						//we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {//$version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			//brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	protected static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		//find the most recently-activated version
+		$most_recently_active_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	protected static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				//check there is a record of when this version was activated. Otherwise,
+				//mark it as unknown
+				if ( ! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if ($an_activation != 'unknown-date' && $an_activation > $most_recently_active_version_activation) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation == 'unknown-date'
+							? '1970-01-01 00:00:00' : $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		//if current user is an admin and it's not an ajax or rest request
+		if (
+			! (defined('DOING_AJAX') && DOING_AJAX)
+			&& ! (defined('REST_REQUEST') && REST_REQUEST)
+			&& ! isset($notices['errors'])
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->registry->CAP->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() == EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->registry->load_core('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$this->registry->load_core('Config');
+		$this->registry->load_core('Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($this->registry->CFG->admin->use_full_logging) {
+			$this->registry->load_core('Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		//load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 */
+	private function _parse_model_names()
+	{
+		//get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[$short_name] = $classname;
+			}
+			$model_names[$short_name] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters('FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 */
+	private function _maybe_brew_regular()
+	{
+		if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		try {
+			// load, register, and add shortcodes the new way
+			new ShortcodesManager(
+			// and the old way, but we'll put it under control of the new system
+				EE_Config::getLegacyShortcodesManager()
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hookpoint
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook('AHEE__EE_System__register_shortcodes_modules_and_addons');
+		if ( ! empty($class_names)) {
+			$msg = __('The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso');
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+						$class_name) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso');
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hookpoint
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		add_action('admin_bar_menu', array($this, 'espresso_toolbar_items'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->registry->load_core('PUE');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+	}
+
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if ( ! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		//first check if we had previously attempted to setup EE's directories but failed
+		if (EEH_Activation::upload_directories_incomplete()) {
+			EEH_Activation::create_upload_directories();
+		}
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+
+	/**
+	 *    load_CPTs_and_session
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		// register Custom Post Types
+		$this->registry->load_core('Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if ( ! is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->registry->load_core('Front_Controller');
+		} else if ( ! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			EE_Registry::instance()->load_core('Admin');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->registry->load_core('Session');
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// load_espresso_template_tags
+		if (is_readable(EE_PUBLIC . 'template_tags.php')) {
+			require_once(EE_PUBLIC . 'template_tags.php');
+		}
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+		$this->registry->create('EventEspresso\core\services\assets\Registry');
+		wp_enqueue_script('espresso_core');
+	}
+
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hookpoint, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+	}
+
+
+
+	/**
+	 * set_hooks_for_shortcodes_modules_and_addons
+	 * this is the best place for other systems to set callbacks for hooking into other parts of EE
+	 * this happens at the very beginning of the wp_loaded hookpoint
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function set_hooks_for_shortcodes_modules_and_addons()
+	{
+		//		do_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons' );
+	}
+
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if ( ! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if ( ! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if ( ! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+
+	/**
+	 *    espresso_toolbar_items
+	 *
+	 * @access public
+	 * @param  WP_Admin_Bar $admin_bar
+	 * @return void
+	 */
+	public function espresso_toolbar_items(WP_Admin_Bar $admin_bar)
+	{
+		// if in full M-Mode, or its an AJAX request, or user is NOT an admin
+		if (EE_Maintenance_Mode::instance()->level() == EE_Maintenance_Mode::level_2_complete_maintenance
+			|| defined('DOING_AJAX')
+			|| ! $this->registry->CAP->current_user_can('ee_read_ee', 'ee_admin_bar_menu_top_level')
+		) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$menu_class = 'espresso_menu_item_class';
+		//we don't use the constants EVENTS_ADMIN_URL or REG_ADMIN_URL
+		//because they're only defined in each of their respective constructors
+		//and this might be a frontend request, in which case they aren't available
+		$events_admin_url = admin_url("admin.php?page=espresso_events");
+		$reg_admin_url = admin_url("admin.php?page=espresso_registrations");
+		$extensions_admin_url = admin_url("admin.php?page=espresso_packages");
+		//Top Level
+		$admin_bar->add_menu(array(
+			'id'    => 'espresso-toolbar',
+			'title' => '<span class="ee-icon ee-icon-ee-cup-thick ee-icon-size-20"></span><span class="ab-label">'
+					   . _x('Event Espresso', 'admin bar menu group label', 'event_espresso')
+					   . '</span>',
+			'href'  => $events_admin_url,
+			'meta'  => array(
+				'title' => __('Event Espresso', 'event_espresso'),
+				'class' => $menu_class . 'first',
+			),
+		));
+		//Events
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events')) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Events', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('Events', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_edit_events', 'ee_admin_bar_menu_espresso-toolbar-events-new')) {
+			//Events Add New
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-new',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('Add New', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'create_new'), $events_admin_url),
+				'meta'   => array(
+					'title'  => __('Add New', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if (is_single() && (get_post_type() == 'espresso_events')) {
+			//Current post
+			global $post;
+			if ($this->registry->CAP->current_user_can('ee_edit_event',
+				'ee_admin_bar_menu_espresso-toolbar-events-edit', $post->ID)
+			) {
+				//Events Edit Current Event
+				$admin_bar->add_menu(array(
+					'id'     => 'espresso-toolbar-events-edit',
+					'parent' => 'espresso-toolbar-events',
+					'title'  => __('Edit Event', 'event_espresso'),
+					'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'edit', 'post' => $post->ID),
+						$events_admin_url),
+					'meta'   => array(
+						'title'  => __('Edit Event', 'event_espresso'),
+						'target' => '',
+						'class'  => $menu_class,
+					),
+				));
+			}
+		}
+		//Events View
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-view')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-view',
+				'parent' => 'espresso-toolbar-events',
+				'title'  => __('View', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('View', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events', 'ee_admin_bar_menu_espresso-toolbar-events-all')) {
+			//Events View All
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-all',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('All', 'event_espresso'),
+				'href'   => $events_admin_url,
+				'meta'   => array(
+					'title'  => __('All', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-today')
+		) {
+			//Events View Today
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-today',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		if ($this->registry->CAP->current_user_can('ee_read_events',
+			'ee_admin_bar_menu_espresso-toolbar-events-month')
+		) {
+			//Events View This Month
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-events-month',
+				'parent' => 'espresso-toolbar-events-view',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$events_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Registrations', 'event_espresso'),
+				'href'   => $reg_admin_url,
+				'meta'   => array(
+					'title'  => __('Registrations', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('Today', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'today'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Today', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Completed
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Pending\
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-pending',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'     => 'default',
+					'status'     => 'today',
+					'reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending Payment', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-not-approved',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview Today Incomplete
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-today-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-today-cancelled',
+				'parent' => 'espresso-toolbar-registrations-today',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'today',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month',
+				'parent' => 'espresso-toolbar-registrations',
+				'title'  => __('This Month', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array('action' => 'default', 'status' => 'month'),
+					$reg_admin_url),
+				'meta'   => array(
+					'title'  => __('This Month', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Pending
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-pending')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-pending',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Pending', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Pending', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Not Approved
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-not-approved')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-not-approved',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Not Approved', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Not Approved', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Registration Overview This Month Cancelled
+		if ($this->registry->CAP->current_user_can('ee_read_registrations',
+			'ee_admin_bar_menu_espresso-toolbar-registrations-month-cancelled')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-registrations-month-cancelled',
+				'parent' => 'espresso-toolbar-registrations-month',
+				'title'  => __('Cancelled', 'event_espresso'),
+				'href'   => EEH_URL::add_query_args_and_nonce(array(
+					'action'      => 'default',
+					'status'      => 'month',
+					'_reg_status' => EEM_Registration::status_id_cancelled,
+				), $reg_admin_url),
+				'meta'   => array(
+					'title'  => __('Cancelled', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+		//Extensions & Services
+		if ($this->registry->CAP->current_user_can('ee_read_ee',
+			'ee_admin_bar_menu_espresso-toolbar-extensions-and-services')
+		) {
+			$admin_bar->add_menu(array(
+				'id'     => 'espresso-toolbar-extensions-and-services',
+				'parent' => 'espresso-toolbar',
+				'title'  => __('Extensions & Services', 'event_espresso'),
+				'href'   => $extensions_admin_url,
+				'meta'   => array(
+					'title'  => __('Extensions & Services', 'event_espresso'),
+					'target' => '',
+					'class'  => $menu_class,
+				),
+			));
+		}
+	}
+
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 
 
 

Spacing +10 added lines, -10 removed lines

@@ -185,7 +185,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
         //load and setup EE_Capabilities
         $this->registry->load_core('Capabilities');
         //caps need to be initialized on every request so that capability maps are set.
@@ -208,7 +208,7 @@ 
                 && $_GET['activate'] === 'true'
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth'.DS.'basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -690,7 +690,7 @@ 
     private function _parse_model_names()
     {
         //get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -718,8 +718,8 @@ 
      */
     private function _maybe_brew_regular()
     {
-        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH . 'brewing_regular.php')) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+        if (( ! defined('EE_DECAF') || EE_DECAF !== true) && is_readable(EE_CAFF_PATH.'brewing_regular.php')) {
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -769,8 +769,8 @@ 
                 'event_espresso');
             $msg .= '<ul>';
             foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - ' . str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
-                        $class_name) . '</b></li>';
+                $msg .= '<li><b>Event Espresso - '.str_replace(array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
+                        $class_name).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __('Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
@@ -921,8 +921,8 @@ 
         $this->registry->load_core('Session');
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // load_espresso_template_tags
-        if (is_readable(EE_PUBLIC . 'template_tags.php')) {
-            require_once(EE_PUBLIC . 'template_tags.php');
+        if (is_readable(EE_PUBLIC.'template_tags.php')) {
+            require_once(EE_PUBLIC.'template_tags.php');
         }
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
         $this->registry->create('EventEspresso\core\services\assets\Registry');
@@ -1068,7 +1068,7 @@ 
             'href'  => $events_admin_url,
             'meta'  => array(
                 'title' => __('Event Espresso', 'event_espresso'),
-                'class' => $menu_class . 'first',
+                'class' => $menu_class.'first',
             ),
         ));
         //Events

core/EE_Session.core.php

Spacing +148 added lines, -148 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\InvalidSessionDataException;
 use EventEspresso\core\services\cache\CacheStorageInterface;
 
-if (!defined( 'EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed');}
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed'); }
 /**
  *
  * EE_Session class
@@ -108,7 +108,7 @@ 
 	  * array for defining default session vars
 	  * @var array
 	  */
-	 private $_default_session_vars = array (
+	 private $_default_session_vars = array(
         'id'            => null,
         'user_id'       => null,
         'ip_address'    => null,
@@ -136,8 +136,8 @@ 
 		// check if class object is instantiated
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
 		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! self::$_instance instanceof EE_Session && apply_filters( 'FHEE_load_EE_Session', true ) ) {
-			self::$_instance = new self($cache_storage, $encryption );
+		if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self($cache_storage, $encryption);
 		}
 		return self::$_instance;
 	}
@@ -152,15 +152,15 @@ 
 	  * @throws \EE_Error
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  */
-	 protected function __construct(CacheStorageInterface $cache_storage, EE_Encryption $encryption = null ) {
+	 protected function __construct(CacheStorageInterface $cache_storage, EE_Encryption $encryption = null) {
 
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! apply_filters( 'FHEE_load_EE_Session', true ) ) {
+		if ( ! apply_filters('FHEE_load_EE_Session', true)) {
 			return;
 		}
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		if ( ! defined( 'ESPRESSO_SESSION' ) ) {
-			define( 'ESPRESSO_SESSION', true );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
 		}
 		// default session lifespan in seconds
 		$this->_lifespan = apply_filters(
@@ -174,12 +174,12 @@ 
 		 * 		}
 		 */
 		// retrieve session options from db
-		$session_settings = (array) get_option( 'ee_session_settings', array() );
-		if ( ! empty( $session_settings )) {
+		$session_settings = (array) get_option('ee_session_settings', array());
+		if ( ! empty($session_settings)) {
 			// cycle though existing session options
-			foreach ( $session_settings as $var_name => $session_setting ) {
+			foreach ($session_settings as $var_name => $session_setting) {
 				// set values for class properties
-				$var_name = '_' . $var_name;
+				$var_name = '_'.$var_name;
 				$this->{$var_name} = $session_setting;
 			}
 		}
@@ -190,15 +190,15 @@ 
         // encrypt data via: $this->encryption->encrypt();
         $this->encryption = $encryption;
 		// filter hook allows outside functions/classes/plugins to change default empty cart
-		$extra_default_session_vars = apply_filters( 'FHEE__EE_Session__construct__extra_default_session_vars', array() );
-		array_merge( $this->_default_session_vars, $extra_default_session_vars );
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
 		// apply default session vars
 		$this->_set_defaults();
          add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
          // check request for 'clear_session' param
-		add_action( 'AHEE__EE_Request_Handler__construct__complete', array( $this, 'wp_loaded' ));
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
 		// once everything is all said and done,
-		add_action( 'shutdown', array( $this, 'update' ), 100 );
+		add_action('shutdown', array($this, 'update'), 100);
          $this->configure_garbage_collection_filters();
 	}
 
@@ -286,11 +286,11 @@ 
 	 */
 	private function _set_defaults() {
 		// set some defaults
-		foreach ( $this->_default_session_vars as $key => $default_var ) {
-			if ( is_array( $default_var )) {
-				$this->_session_data[ $key ] = array();
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[$key] = array();
 			} else {
-				$this->_session_data[ $key ] = '';
+				$this->_session_data[$key] = '';
 			}
 		}
 	}
@@ -345,7 +345,7 @@ 
 	  * @param \EE_Checkout $checkout
 	  * @return bool
 	  */
-	 public function set_checkout( EE_Checkout $checkout ) {
+	 public function set_checkout(EE_Checkout $checkout) {
 		 $this->_session_data['checkout'] = $checkout;
 		 return TRUE;
 	 }
@@ -378,9 +378,9 @@ 
 	  * @return bool
 	  * @throws \EE_Error
 	  */
-	 public function set_transaction( EE_Transaction $transaction ) {
+	 public function set_transaction(EE_Transaction $transaction) {
 		 // first remove the session from the transaction before we save the transaction in the session
-		 $transaction->set_txn_session_data( NULL );
+		 $transaction->set_txn_session_data(NULL);
 		 $this->_session_data['transaction'] = $transaction;
 		 return TRUE;
 	 }
@@ -416,15 +416,15 @@ 
 	  * @param bool $reset_cache
 	  * @return    array
 	  */
-	public function get_session_data( $key = NULL, $reset_cache = FALSE ) {
-		if ( $reset_cache ) {
+	public function get_session_data($key = NULL, $reset_cache = FALSE) {
+		if ($reset_cache) {
 			$this->reset_cart();
 			$this->reset_checkout();
 			$this->reset_transaction();
 		}
-		 if ( ! empty( $key ))  {
-			return  isset( $this->_session_data[ $key ] ) ? $this->_session_data[ $key ] : NULL;
-		}  else  {
+		 if ( ! empty($key)) {
+			return  isset($this->_session_data[$key]) ? $this->_session_data[$key] : NULL;
+		} else {
 			return $this->_session_data;
 		}
 	}
@@ -437,20 +437,20 @@ 
 	  * @param 	array $data
 	  * @return 	TRUE on success, FALSE on fail
 	  */
-	public function set_session_data( $data ) {
+	public function set_session_data($data) {
 
 		// nothing ??? bad data ??? go home!
-		if ( empty( $data ) || ! is_array( $data )) {
-			EE_Error::add_error( __( 'No session data or invalid session data was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(__('No session data or invalid session data was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 
-		foreach ( $data as $key =>$value ) {
-			if ( isset( $this->_default_session_vars[ $key ] )) {
-				EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $key ), __FILE__, __FUNCTION__, __LINE__ );
+		foreach ($data as $key =>$value) {
+			if (isset($this->_default_session_vars[$key])) {
+				EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $key), __FILE__, __FUNCTION__, __LINE__);
 				return FALSE;
 			} else {
-				$this->_session_data[ $key ] = $value;
+				$this->_session_data[$key] = $value;
 			}
 		}
 
@@ -468,9 +468,9 @@ 
 	  * @throws \EE_Error
 	  */
 	private function _espresso_session() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		// check that session has started
-		if ( session_id() === '' ) {
+		if (session_id() === '') {
 			//starts a new session if one doesn't already exist, or re-initiates an existing one
 			session_start();
 		}
@@ -479,39 +479,39 @@ 
 		// and the visitors IP
 		$this->_ip_address = $this->_visitor_ip();
 		// set the "user agent"
-		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr( $_SERVER['HTTP_USER_AGENT'] ) : FALSE;
+		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr($_SERVER['HTTP_USER_AGENT']) : FALSE;
 		// now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
-			$this->_time = isset( $this->_time ) ? $this->_time : time();
+			$this->_time = isset($this->_time) ? $this->_time : time();
 			// and reset the session expiration
-			$this->_expiration = isset( $session_data['expiration'] )
+			$this->_expiration = isset($session_data['expiration'])
 				? $session_data['expiration']
 				: $this->_time + $this->_lifespan;
 		} else {
             // set initial site access time and the session expiration
 			$this->_set_init_access_and_expiration();
 			// set referer
-			$this->_session_data[ 'pages_visited' ][ $this->_session_data['init_access'] ] = isset( $_SERVER['HTTP_REFERER'] )
-				? esc_attr( $_SERVER['HTTP_REFERER'] )
+			$this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
 				: '';
 			// no previous session = go back and create one (on top of the data above)
 			return FALSE;
 		}
         // now the user agent
-		if ( $session_data['user_agent'] !== $this->_user_agent ) {
+		if ($session_data['user_agent'] !== $this->_user_agent) {
 			return FALSE;
 		}
 		// wait a minute... how old are you?
-		if ( $this->_time > $this->_expiration ) {
+		if ($this->_time > $this->_expiration) {
 			// yer too old fer me!
             $this->_expired = true;
 			// wipe out everything that isn't a default session datum
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 		// make event espresso session data available to plugin
-		$this->_session_data = array_merge( $this->_session_data, $session_data );
+		$this->_session_data = array_merge($this->_session_data, $session_data);
 		return TRUE;
 
 	}
@@ -527,7 +527,7 @@ 
       */
      protected function _retrieve_session_data()
      {
-         $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+         $ssn_key = EE_Session::session_id_prefix.$this->_sid;
          try {
              // we're using WP's Transient API to store session data using the PHP session ID as the option name
              $session_data = $this->cache_storage->get($ssn_key, false);
@@ -536,7 +536,7 @@ 
              }
              if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                  $hash_check = $this->cache_storage->get(
-                     EE_Session::hash_check_prefix . $this->_sid,
+                     EE_Session::hash_check_prefix.$this->_sid,
                      false
                  );
                  if ($hash_check && $hash_check !== md5($session_data)) {
@@ -546,7 +546,7 @@ 
                                  'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                  'event_espresso'
                              ),
-                             EE_Session::session_id_prefix . $this->_sid
+                             EE_Session::session_id_prefix.$this->_sid
                          ),
                          __FILE__, __FUNCTION__, __LINE__
                      );
@@ -558,17 +558,17 @@ 
              $row = $wpdb->get_row(
                  $wpdb->prepare(
                      "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                     '_transient_' . $ssn_key
+                     '_transient_'.$ssn_key
                  )
              );
              $session_data = is_object($row) ? $row->option_value : null;
              if ($session_data) {
                  $session_data = preg_replace_callback(
                      '!s:(d+):"(.*?)";!',
-                     function ($match) {
+                     function($match) {
                          return $match[1] === strlen($match[2])
                              ? $match[0]
-                             : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                             : 's:'.strlen($match[2]).':"'.$match[2].'";';
                      },
                      $session_data
                  );
@@ -589,7 +589,7 @@ 
                      'event_espresso'
                  );
                  $msg .= WP_DEBUG
-                     ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                     ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                      : '';
                  throw new InvalidSessionDataException($msg, 0, $e);
              }
@@ -602,11 +602,11 @@ 
                  'event_espresso'
              );
              $msg .= WP_DEBUG
-                 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                 ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                  : '';
 	         throw new InvalidSessionDataException($msg);
          }
-	     if ( isset($session_data['transaction'] ) && absint($session_data['transaction'] ) !== 0 ) {
+	     if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
              $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
                  $session_data['transaction']
 	         );
@@ -627,12 +627,12 @@ 
 	  */
 	protected function _generate_session_id() {
 		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-		if ( isset( $_REQUEST[ 'EESID' ] ) ) {
-			$session_id = sanitize_text_field( $_REQUEST[ 'EESID' ] );
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
 		} else {
-			$session_id = md5( session_id() . get_current_blog_id() . $this->_get_sid_salt() );
+			$session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
 		}
-		return apply_filters( 'FHEE__EE_Session___generate_session_id__session_id', $session_id );
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
 	}
 
 
@@ -644,20 +644,20 @@ 
 	  */
 	protected function _get_sid_salt() {
 		// was session id salt already saved to db ?
-		if ( empty( $this->_sid_salt ) ) {
+		if (empty($this->_sid_salt)) {
 			// no?  then maybe use WP defined constant
-			if ( defined( 'AUTH_SALT' ) ) {
+			if (defined('AUTH_SALT')) {
 				$this->_sid_salt = AUTH_SALT;
 			}
 			// if salt doesn't exist or is too short
-			if ( strlen( $this->_sid_salt ) < 32 ) {
+			if (strlen($this->_sid_salt) < 32) {
 				// create a new one
-				$this->_sid_salt = wp_generate_password( 64 );
+				$this->_sid_salt = wp_generate_password(64);
 			}
 			// and save it as a permanent session setting
-			$session_settings = get_option( 'ee_session_settings' );
-			$session_settings[ 'sid_salt' ] = $this->_sid_salt;
-			update_option( 'ee_session_settings', $session_settings );
+			$session_settings = get_option('ee_session_settings');
+			$session_settings['sid_salt'] = $this->_sid_salt;
+			update_option('ee_session_settings', $session_settings);
 		}
 		return $this->_sid_salt;
 	}
@@ -686,19 +686,19 @@ 
       * @return TRUE on success, FALSE on fail
       * @throws \EE_Error
       */
-	public function update( $new_session = FALSE ) {
-		$this->_session_data = isset( $this->_session_data )
-			&& is_array( $this->_session_data )
-			&& isset( $this->_session_data['id'])
+	public function update($new_session = FALSE) {
+		$this->_session_data = isset($this->_session_data)
+			&& is_array($this->_session_data)
+			&& isset($this->_session_data['id'])
 			? $this->_session_data
 			: array();
-		if ( empty( $this->_session_data )) {
+		if (empty($this->_session_data)) {
 			$this->_set_defaults();
 		}
 		$session_data = array();
-		foreach ( $this->_session_data as $key => $value ) {
+		foreach ($this->_session_data as $key => $value) {
 
-			switch( $key ) {
+			switch ($key) {
 
 				case 'id' :
 					// session ID
@@ -716,7 +716,7 @@ 
 				break;
 
 				case 'init_access' :
-					$session_data['init_access'] = absint( $value );
+					$session_data['init_access'] = absint($value);
 				break;
 
 				case 'last_access' :
@@ -726,7 +726,7 @@ 
 
 				case 'expiration' :
 					// when the session expires
-					$session_data['expiration'] = ! empty( $this->_expiration )
+					$session_data['expiration'] = ! empty($this->_expiration)
 						? $this->_expiration
 						: $session_data['init_access'] + $this->_lifespan;
 				break;
@@ -738,11 +738,11 @@ 
 
 				case 'pages_visited' :
 					$page_visit = $this->_get_page_visit();
-					if ( $page_visit ) {
+					if ($page_visit) {
 						// set pages visited where the first will be the http referrer
-						$this->_session_data[ 'pages_visited' ][ $this->_time ] = $page_visit;
+						$this->_session_data['pages_visited'][$this->_time] = $page_visit;
 						// we'll only save the last 10 page visits.
-						$session_data[ 'pages_visited' ] = array_slice( $this->_session_data['pages_visited'], -10 );
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
 					}
 				break;
 
@@ -756,9 +756,9 @@ 
 
 		$this->_session_data = $session_data;
 		// creating a new session does not require saving to the db just yet
-		if ( ! $new_session ) {
+		if ( ! $new_session) {
 			// ready? let's save
-			if ( $this->_save_session_to_db() ) {
+			if ($this->_save_session_to_db()) {
 				return TRUE;
 			} else {
 				return FALSE;
@@ -778,9 +778,9 @@ 
       * @throws \EE_Error
       */
 	private function _create_espresso_session( ) {
-		do_action( 'AHEE_log', __CLASS__, __FUNCTION__, '' );
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
 		// use the update function for now with $new_session arg set to TRUE
-		return  $this->update( TRUE ) ? TRUE : FALSE;
+		return  $this->update(TRUE) ? TRUE : FALSE;
 	}
 
 
@@ -800,7 +800,7 @@ 
                 EE_Registry::instance()->REQ->front_ajax
                 || (
                     // OR an admin request that is NOT AJAX
-					! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+					! (defined('DOING_AJAX') && DOING_AJAX)
                     && is_admin()
 				)
                 || (
@@ -813,8 +813,8 @@ 
 			return false;
 		}
 		$transaction = $this->transaction();
-		if ( $transaction instanceof EE_Transaction ) {
-			if ( ! $transaction->ID() ) {
+		if ($transaction instanceof EE_Transaction) {
+			if ( ! $transaction->ID()) {
 				$transaction->save();
 			}
 			$this->_session_data['transaction'] = $transaction->ID();
@@ -823,19 +823,19 @@ 
 		$session_data = serialize($this->_session_data);
 		// do we need to also encode it to avoid corrupted data when saved to the db?
 		$session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode( $session_data )
+            ? $this->encryption->base64_string_encode($session_data)
             : $session_data;
 		// maybe save hash check
-		if ( apply_filters( 'FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG ) ) {
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->_lifespan
             );
         }
         // we're using the Transient API for storing session data,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->_lifespan
         );
@@ -864,10 +864,10 @@ 
 			'HTTP_FORWARDED',
 			'REMOTE_ADDR'
 		);
-		foreach ( $server_keys as $key ){
-			if ( isset( $_SERVER[ $key ] )) {
-				foreach ( array_map( 'trim', explode( ',', $_SERVER[ $key ] )) as $ip ) {
-					if ( $ip === '127.0.0.1' || filter_var( $ip, FILTER_VALIDATE_IP ) !== FALSE ) {
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== FALSE) {
 						$visitor_ip = $ip;
 					}
 				}
@@ -886,32 +886,32 @@ 
 	 *			@return string
 	 */
 	public function _get_page_visit() {
-		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		$page_visit = home_url('/').'wp-admin/admin-ajax.php';
 		// check for request url
-		if ( isset( $_SERVER['REQUEST_URI'] )) {
+		if (isset($_SERVER['REQUEST_URI'])) {
 			$http_host = '';
 			$page_id = '?';
 			$e_reg = '';
-			$request_uri = esc_url( $_SERVER['REQUEST_URI'] );
-			$ru_bits = explode( '?', $request_uri );
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
 			$request_uri = $ru_bits[0];
 			// check for and grab host as well
-			if ( isset( $_SERVER['HTTP_HOST'] )) {
-				$http_host = esc_url( $_SERVER['HTTP_HOST'] );
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
 			}
 			// check for page_id in SERVER REQUEST
-			if ( isset( $_REQUEST['page_id'] )) {
+			if (isset($_REQUEST['page_id'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$page_id = '?page_id=' . esc_attr( $_REQUEST['page_id'] ) . '&amp;';
+				$page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
 			}
 			// check for $e_reg in SERVER REQUEST
-			if ( isset( $_REQUEST['ee'] )) {
+			if (isset($_REQUEST['ee'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$e_reg = 'ee=' . esc_attr( $_REQUEST['ee'] );
+				$e_reg = 'ee='.esc_attr($_REQUEST['ee']);
 			}
-			$page_visit = rtrim( $http_host . $request_uri . $page_id . $e_reg, '?' );
+			$page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
 		}
-		return $page_visit !== home_url( '/wp-admin/admin-ajax.php' ) ? $page_visit : '';
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
 
 	}
 
@@ -941,14 +941,14 @@ 
       * @return void
       * @throws \EE_Error
       */
-	public function clear_session( $class = '', $function = '' ) {
+	public function clear_session($class = '', $function = '') {
 		//echo '<h3 style="color:#999;line-height:.9em;"><span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/><span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b></h3>';
-        do_action( 'AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' .  $function . '()' );
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
 		$this->reset_cart();
 		$this->reset_checkout();
 		$this->reset_transaction();
 		// wipe out everything that isn't a default session datum
-		$this->reset_data( array_keys( $this->_session_data ));
+		$this->reset_data(array_keys($this->_session_data));
 		// reset initial site access time and the session expiration
 		$this->_set_init_access_and_expiration();
 		$this->_save_session_to_db();
@@ -963,42 +963,42 @@ 
 	  * @param bool  $show_all_notices
 	  * @return TRUE on success, FALSE on fail
 	  */
-	public function reset_data( $data_to_reset = array(), $show_all_notices = FALSE ) {
+	public function reset_data($data_to_reset = array(), $show_all_notices = FALSE) {
 		// if $data_to_reset is not in an array, then put it in one
-		if ( ! is_array( $data_to_reset ) ) {
-			$data_to_reset = array ( $data_to_reset );
+		if ( ! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
 		}
 		// nothing ??? go home!
-		if ( empty( $data_to_reset )) {
-			EE_Error::add_error( __( 'No session data could be reset, because no session var name was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(__('No session data could be reset, because no session var name was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		$return_value = TRUE;
 		// since $data_to_reset is an array, cycle through the values
-		foreach ( $data_to_reset as $reset ) {
+		foreach ($data_to_reset as $reset) {
 
 			// first check to make sure it is a valid session var
-			if ( isset( $this->_session_data[ $reset ] )) {
+			if (isset($this->_session_data[$reset])) {
 				// then check to make sure it is not a default var
-				if ( ! array_key_exists( $reset, $this->_default_session_vars )) {
+				if ( ! array_key_exists($reset, $this->_default_session_vars)) {
 					// remove session var
-					unset( $this->_session_data[ $reset ] );
-					if ( $show_all_notices ) {
-						EE_Error::add_success( sprintf( __( 'The session variable %s was removed.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					unset($this->_session_data[$reset]);
+					if ($show_all_notices) {
+						EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
-					$return_value = !isset($return_value) ? TRUE : $return_value;
+					$return_value = ! isset($return_value) ? TRUE : $return_value;
 
 				} else {
 					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
-					if ( $show_all_notices ) {
-						EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					if ($show_all_notices) {
+						EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
 					$return_value = FALSE;
 				}
 
-			} else if ( $show_all_notices ) {
+			} else if ($show_all_notices) {
 				// oops! that session var does not exist!
-				EE_Error::add_error( sprintf( __( 'The session item provided, %s, is invalid or does not exist.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 				$return_value = FALSE;
 			}
 
@@ -1017,8 +1017,8 @@ 
       * @throws \EE_Error
       */
 	public function wp_loaded() {
-		if ( isset(  EE_Registry::instance()->REQ ) && EE_Registry::instance()->REQ->is_set( 'clear_session' )) {
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+		if (isset(EE_Registry::instance()->REQ) && EE_Registry::instance()->REQ->is_set('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 	}
 
@@ -1054,7 +1054,7 @@ 
              // or use that for the new transient cleanup query limit
              add_filter(
                  'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                 function () use ($expired_session_transient_delete_query_limit) {
+                 function() use ($expired_session_transient_delete_query_limit) {
                      return $expired_session_transient_delete_query_limit;
                  }
              );
@@ -1068,34 +1068,34 @@ 
 	  * @param $data1
 	  * @return string
 	  */
-	 private function find_serialize_error( $data1 ) {
+	 private function find_serialize_error($data1) {
 		$error = '<pre>';
 		 $data2 = preg_replace_callback(
 			 '!s:(\d+):"(.*?)";!',
-			 function ( $match ) {
-				 return ( $match[1] === strlen( $match[2] ) )
+			 function($match) {
+				 return ($match[1] === strlen($match[2]))
 					 ? $match[0]
 					 : 's:'
-					   . strlen( $match[2] )
+					   . strlen($match[2])
 					   . ':"'
 					   . $match[2]
 					   . '";';
 			 },
 			 $data1
 		 );
-		$max = ( strlen( $data1 ) > strlen( $data2 ) ) ? strlen( $data1 ) : strlen( $data2 );
-		$error .= $data1 . PHP_EOL;
-		$error .= $data2 . PHP_EOL;
-		for ( $i = 0; $i < $max; $i++ ) {
-			if ( @$data1[ $i ] !== @$data2[ $i ] ) {
-				$error .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-				$error .= "\t-> ORD number " . ord( @$data1[ $i ] ) . ' != ' . ord( @$data2[ $i ] ) . PHP_EOL;
-				$error .= "\t-> Line Number = $i" . PHP_EOL;
-				$start = ( $i - 20 );
-				$start = ( $start < 0 ) ? 0 : $start;
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1.PHP_EOL;
+		$error .= $data2.PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[$i] !== @$data2[$i]) {
+				$error .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+				$error .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+				$error .= "\t-> Line Number = $i".PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
 				$length = 40;
 				$point = $max - $i;
-				if ( $point < 20 ) {
+				if ($point < 20) {
 					$rlength = 1;
 					$rpoint = -$point;
 				} else {
@@ -1104,16 +1104,16 @@ 
 				}
 				$error .= "\t-> Section Data1  = ";
 				$error .= substr_replace(
-					substr( $data1, $start, $length ),
-					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[$i]}</b>",
 					$rpoint,
 					$rlength
 				);
 				$error .= PHP_EOL;
 				$error .= "\t-> Section Data2  = ";
 				$error .= substr_replace(
-					substr( $data2, $start, $length ),
-					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[$i]}</b>",
 					$rpoint,
 					$rlength
 				);

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +76 added lines, -76 removed lines

@@ -24,82 +24,82 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return MINUTE_IN_SECONDS;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract($attributes, EXTR_OVERWRITE);
-        $event_id = isset($event_id) ? $event_id : 0;
-        $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
-            new ExceptionStackTraceDisplay(
-                new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that it\'s value corresponds to a valid Event ID.',
-                            'event_espresso'
-                        ),
-                        $this->getTag(),
-                        $event_id,
-                        'event_id',
-                        '<br />'
-                    )
-                )
-            );
-            return '';
-        }
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return MINUTE_IN_SECONDS;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract($attributes, EXTR_OVERWRITE);
+		$event_id = isset($event_id) ? $event_id : 0;
+		$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
+		if (! $event instanceof EE_Event) {
+			new ExceptionStackTraceDisplay(
+				new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that it\'s value corresponds to a valid Event ID.',
+							'event_espresso'
+						),
+						$this->getTag(),
+						$event_id,
+						'event_id',
+						'<br />'
+					)
+				)
+			);
+			return '';
+		}
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();
+	}
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
         extract($attributes, EXTR_OVERWRITE);
         $event_id = isset($event_id) ? $event_id : 0;
         $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             new ExceptionStackTraceDisplay(
                 new InvalidArgumentException(
                     sprintf(

core/domain/services/session/SessionIdentifierInterface.php

Indentation +4 added lines, -4 removed lines

@@ -5,9 +5,9 @@
 interface SessionIdentifierInterface
 {
 
-    /**
-     * @return    string
-     */
-    public function id();
+	/**
+	 * @return    string
+	 */
+	public function id();
 
 }
\ No newline at end of file

core/services/collections/CollectionLoader.php

Indentation +37 added lines, -37 removed lines

@@ -199,13 +199,13 @@ 
 			);
 			return CollectionLoader::ENTITY_ADDED;
 		}
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
 	}
 
 
@@ -220,37 +220,37 @@ 
 	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
 	 */
 	protected function setIdentifier( $entity, $identifier ) {
-	    switch($this->collection_details->identifierType()) {
-	        // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH :
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME :
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD :
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if ( ! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+		switch($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH :
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME :
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD :
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if ( ! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-
-        }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+
+		}
 		return apply_filters(
 			'FHEE__CollectionLoader__addEntityToCollection__identifier',
 			$identifier,

core/services/cache/BasicCacheManager.php

Spacing +4 added lines, -4 removed lines

@@ -140,7 +140,7 @@ 
         // with these parameters
         $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
         // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+        return substr($this->cachePrefix().$id_prefix.'-'.md5($cache_id), 0, 182);
     }
 
 
@@ -170,9 +170,9 @@ 
         return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
-        <b>' . $type . '</b><span style="color:#999"> : </span>
-        <span>' . $cache_id . '</span>
-        <span style="margin-left:2em;">' . __FILE__ . '</span>
+        <b>' . $type.'</b><span style="color:#999"> : </span>
+        <span>' . $cache_id.'</span>
+        <span style="margin-left:2em;">' . __FILE__.'</span>
     </p>
 </div>';
     }

Indentation +135 added lines, -135 removed lines

@@ -19,140 +19,140 @@ 
 class BasicCacheManager implements CacheManagerInterface
 {
 
-    /**
-     * @type string
-     */
-    const CACHE_PREFIX = 'ee_cache_';
-
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    private $cache_storage;
-
-
-
-    /**
-     * BasicCacheManager constructor.
-     *
-     * @param CacheStorageInterface      $cache_storage [required]
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        $this->cache_storage = $cache_storage;
-    }
-
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return BasicCacheManager::CACHE_PREFIX;
-    }
-
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
-    {
-        $content = '';
-        $expiration = absint(
-            apply_filters(
-                'FHEE__CacheManager__get__cache_expiration',
-                $expiration,
-                $id_prefix,
-                $cache_id
-            )
-        );
-        $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
-        // is caching enabled for this content ?
-        if ($expiration) {
-            $content = $this->cache_storage->get($cache_id);
-        }
-        // any existing content ?
-        if (empty($content)) {
-            // nope! let's generate some new stuff
-            $content = $callback();
-            // save the new content if caching is enabled
-            if ($expiration) {
-                $this->cache_storage->add($cache_id, $content, $expiration);
-                if (EE_DEBUG) {
-                    $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
-                }
-            }
-        } else {
-            if (EE_DEBUG) {
-                $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
-            }
-        }
-        return $content;
-    }
-
-
-
-    /**
-     * Generates a unique identifier string for the cache
-     *
-     * @param string $id_prefix  [required] see BasicCacheManager::get()
-     * @param string $cache_id   [required] see BasicCacheManager::get()
-     * @return string
-     */
-    private function generateCacheIdentifier($id_prefix, $cache_id)
-    {
-        // let's make the cached content unique for this "page"
-        $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
-        // with these parameters
-        $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
-        // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
-    }
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id)
-    {
-        // ensure incoming arg is in an array
-        $cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
-        // delete corresponding transients for the supplied id prefix
-        $this->cache_storage->deleteMany($cache_id);
-    }
-
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @param string       $type
-     * @return string
-     */
-    private function displayCacheNotice($cache_id, $type) {
-        return '
+	/**
+	 * @type string
+	 */
+	const CACHE_PREFIX = 'ee_cache_';
+
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	private $cache_storage;
+
+
+
+	/**
+	 * BasicCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface      $cache_storage [required]
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		$this->cache_storage = $cache_storage;
+	}
+
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return BasicCacheManager::CACHE_PREFIX;
+	}
+
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
+	{
+		$content = '';
+		$expiration = absint(
+			apply_filters(
+				'FHEE__CacheManager__get__cache_expiration',
+				$expiration,
+				$id_prefix,
+				$cache_id
+			)
+		);
+		$cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
+		// is caching enabled for this content ?
+		if ($expiration) {
+			$content = $this->cache_storage->get($cache_id);
+		}
+		// any existing content ?
+		if (empty($content)) {
+			// nope! let's generate some new stuff
+			$content = $callback();
+			// save the new content if caching is enabled
+			if ($expiration) {
+				$this->cache_storage->add($cache_id, $content, $expiration);
+				if (EE_DEBUG) {
+					$content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
+				}
+			}
+		} else {
+			if (EE_DEBUG) {
+				$content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
+			}
+		}
+		return $content;
+	}
+
+
+
+	/**
+	 * Generates a unique identifier string for the cache
+	 *
+	 * @param string $id_prefix  [required] see BasicCacheManager::get()
+	 * @param string $cache_id   [required] see BasicCacheManager::get()
+	 * @return string
+	 */
+	private function generateCacheIdentifier($id_prefix, $cache_id)
+	{
+		// let's make the cached content unique for this "page"
+		$cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
+		// with these parameters
+		$cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
+		// then md5 the above to control it's length, add all of our prefixes, and truncate
+		return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+	}
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id)
+	{
+		// ensure incoming arg is in an array
+		$cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
+		// delete corresponding transients for the supplied id prefix
+		$this->cache_storage->deleteMany($cache_id);
+	}
+
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @param string       $type
+	 * @return string
+	 */
+	private function displayCacheNotice($cache_id, $type) {
+		return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
         <b>' . $type . '</b><span style="color:#999"> : </span>
@@ -160,7 +160,7 @@ 
         <span style="margin-left:2em;">' . __FILE__ . '</span>
     </p>
 </div>';
-    }
+	}
 
 }
 // End of file BasicCacheManager.php

core/services/cache/PostRelatedCacheManager.php

Indentation +87 added lines, -87 removed lines

@@ -18,93 +18,93 @@
 class PostRelatedCacheManager extends BasicCacheManager
 {
 
-    /**
-     * @type string
-     */
-    const POST_CACHE_PREFIX = 'ee_cache_post_';
-
-    /**
-     * wp-option option_name for tracking post related cache
-     *
-     * @type string
-     */
-    const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
-
-
-
-    /**
-     * PostRelatedCacheManager constructor.
-     *
-     * @param CacheStorageInterface      $cache_storage
-     * @param SessionIdentifierInterface $session
-     */
-    public function __construct(CacheStorageInterface $cache_storage, SessionIdentifierInterface $session)
-    {
-        parent::__construct($cache_storage, $session);
-        add_action('save_post', array($this, 'clearPostRelatedCache'));
-    }
-
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return PostRelatedCacheManager::POST_CACHE_PREFIX;
-    }
-
-
-
-    /**
-     * If you are caching content that pertains to a Post of any type,
-     * then it is recommended to pass the post id and cache id prefix to this method
-     * so that it can be added to the post related cache tracking.
-     * Then, whenever that post is updated, the cache will automatically be deleted,
-     * which helps to ensure that outdated cache content will not be served
-     *
-     * @param int    $post_ID    [required]
-     * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     */
-    public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not already being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            // add array to add cache ids to
-            $post_related_cache[$post_ID] = array();
-        }
-        // add cache id to be tracked
-        $post_related_cache[$post_ID][] = $id_prefix;
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
-
-
-
-    /**
-     * callback hooked into the WordPress "save_post" action
-     * deletes any cache content associated with the post
-     *
-     * @param int $post_ID [required]
-     */
-    public function clearPostRelatedCache($post_ID)
-    {
-        $post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // if post is not being tracked
-        if ( ! isset($post_related_cache[$post_ID])) {
-            return;
-        }
-        // get cache id prefixes for post, and delete their corresponding transients
-        $this->clear($post_related_cache[$post_ID]);
-        unset($post_related_cache[$post_ID]);
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
+	/**
+	 * @type string
+	 */
+	const POST_CACHE_PREFIX = 'ee_cache_post_';
+
+	/**
+	 * wp-option option_name for tracking post related cache
+	 *
+	 * @type string
+	 */
+	const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
+
+
+
+	/**
+	 * PostRelatedCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface      $cache_storage
+	 * @param SessionIdentifierInterface $session
+	 */
+	public function __construct(CacheStorageInterface $cache_storage, SessionIdentifierInterface $session)
+	{
+		parent::__construct($cache_storage, $session);
+		add_action('save_post', array($this, 'clearPostRelatedCache'));
+	}
+
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return PostRelatedCacheManager::POST_CACHE_PREFIX;
+	}
+
+
+
+	/**
+	 * If you are caching content that pertains to a Post of any type,
+	 * then it is recommended to pass the post id and cache id prefix to this method
+	 * so that it can be added to the post related cache tracking.
+	 * Then, whenever that post is updated, the cache will automatically be deleted,
+	 * which helps to ensure that outdated cache content will not be served
+	 *
+	 * @param int    $post_ID    [required]
+	 * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 */
+	public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not already being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			// add array to add cache ids to
+			$post_related_cache[$post_ID] = array();
+		}
+		// add cache id to be tracked
+		$post_related_cache[$post_ID][] = $id_prefix;
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
+
+
+
+	/**
+	 * callback hooked into the WordPress "save_post" action
+	 * deletes any cache content associated with the post
+	 *
+	 * @param int $post_ID [required]
+	 */
+	public function clearPostRelatedCache($post_ID)
+	{
+		$post_related_cache = (array)get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// if post is not being tracked
+		if ( ! isset($post_related_cache[$post_ID])) {
+			return;
+		}
+		// get cache id prefixes for post, and delete their corresponding transients
+		$this->clear($post_related_cache[$post_ID]);
+		unset($post_related_cache[$post_ID]);
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
 
 
 }

core/services/shortcodes/ShortcodesManager.php

Indentation +205 added lines, -205 removed lines

@@ -32,211 +32,211 @@
 class ShortcodesManager
 {
 
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * @var ShortcodeInterface[] $shortcodes
-     */
-    private $shortcodes;
-
-
-
-    /**
-     * ShortcodesManager constructor
-     *
-     * @param LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) {
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        // assemble a list of installed and active shortcodes
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'registerShortcodes'),
-            999
-        );
-        //  call add_shortcode() for all installed shortcodes
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes'));
-        // check content for shortcodes the old way
-        add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5);
-        // check content for shortcodes the NEW more efficient way
-        add_action('wp_head', array($this, 'wpHead'), 0);
-    }
-
-
-
-    /**
-     * @return CollectionInterface|ShortcodeInterface[]
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    public function getShortcodes()
-    {
-        if ( ! $this->shortcodes instanceof CollectionInterface) {
-            $this->shortcodes = $this->loadShortcodesCollection();
-        }
-        return $this->shortcodes;
-    }
-
-
-
-    /**
-     * @return CollectionInterface|ShortcodeInterface[]
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function loadShortcodesCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-            // collection name
-                'shortcodes',
-                // collection interface
-                'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-                // FQCNs for classes to add (all classes within that namespace will be loaded)
-                array('EventEspresso\core\domain\entities\shortcodes'),
-                // filepaths to classes to add
-                array(),
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            )
-        );
-        return $loader->getCollection();
-    }
-
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidInterfaceException
-     * @throws InvalidIdentifierException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    public function registerShortcodes()
-    {
-        try {
-            $this->shortcodes = apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-                $this->getShortcodes()
-            );
-            if (! $this->shortcodes instanceof CollectionInterface) {
-                throw new InvalidEntityException(
-                    $this->shortcodes,
-                    'CollectionInterface',
-                    sprintf(
-                        esc_html__(
-                            'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.',
-                            'event_espresso'
-                        ),
-                        is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes)
-                    )
-                );
-            }
-            $this->legacy_shortcodes_manager->registerShortcodes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        try {
-            // cycle thru shortcode folders
-            foreach ($this->shortcodes as $shortcode) {
-                /** @var ShortcodeInterface $shortcode */
-                if ( $shortcode instanceof EnqueueAssetsInterface) {
-                    add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10);
-                    add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11);
-                }
-                // add_shortcode() if it has not already been added
-                if ( ! shortcode_exists($shortcode->getTag())) {
-                    add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback'));
-                }
-            }
-            $this->legacy_shortcodes_manager->addShortcodes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-
-    /**
-     * callback for the "wp_head" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @return void
-     */
-    public function wpHead()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        $load_assets = false;
-        // array of posts displayed in current request
-        $posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts);
-        foreach ($posts as $post) {
-            // now check post content and excerpt for EE shortcodes
-            $load_assets = $this->parseContentForShortcodes($post->post_content)
-                ? true
-                : $load_assets;
-        }
-        if ($load_assets) {
-            $this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-    }
-
-
-
-    /**
-     * checks supplied content against list of shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @return bool
-     */
-    public function parseContentForShortcodes($content)
-    {
-        $has_shortcode = false;
-        if(empty($this->shortcodes)){
-            return $has_shortcode;
-        }
-        foreach ($this->shortcodes as $shortcode) {
-            /** @var ShortcodeInterface $shortcode */
-            if (has_shortcode($content, $shortcode->getTag())) {
-                $shortcode->initializeShortcode();
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * @var ShortcodeInterface[] $shortcodes
+	 */
+	private $shortcodes;
+
+
+
+	/**
+	 * ShortcodesManager constructor
+	 *
+	 * @param LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	public function __construct(LegacyShortcodesManager $legacy_shortcodes_manager) {
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		// assemble a list of installed and active shortcodes
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'registerShortcodes'),
+			999
+		);
+		//  call add_shortcode() for all installed shortcodes
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'addShortcodes'));
+		// check content for shortcodes the old way
+		add_action('parse_query', array($this->legacy_shortcodes_manager, 'initializeShortcodes'), 5);
+		// check content for shortcodes the NEW more efficient way
+		add_action('wp_head', array($this, 'wpHead'), 0);
+	}
+
+
+
+	/**
+	 * @return CollectionInterface|ShortcodeInterface[]
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	public function getShortcodes()
+	{
+		if ( ! $this->shortcodes instanceof CollectionInterface) {
+			$this->shortcodes = $this->loadShortcodesCollection();
+		}
+		return $this->shortcodes;
+	}
+
+
+
+	/**
+	 * @return CollectionInterface|ShortcodeInterface[]
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function loadShortcodesCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+			// collection name
+				'shortcodes',
+				// collection interface
+				'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+				// FQCNs for classes to add (all classes within that namespace will be loaded)
+				array('EventEspresso\core\domain\entities\shortcodes'),
+				// filepaths to classes to add
+				array(),
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			)
+		);
+		return $loader->getCollection();
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	public function registerShortcodes()
+	{
+		try {
+			$this->shortcodes = apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+				$this->getShortcodes()
+			);
+			if (! $this->shortcodes instanceof CollectionInterface) {
+				throw new InvalidEntityException(
+					$this->shortcodes,
+					'CollectionInterface',
+					sprintf(
+						esc_html__(
+							'The "FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection" filter must return a Collection of EspressoShortcode objects. "%1$s" was received instead.',
+							'event_espresso'
+						),
+						is_object($this->shortcodes) ? get_class($this->shortcodes) : gettype($this->shortcodes)
+					)
+				);
+			}
+			$this->legacy_shortcodes_manager->registerShortcodes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		try {
+			// cycle thru shortcode folders
+			foreach ($this->shortcodes as $shortcode) {
+				/** @var ShortcodeInterface $shortcode */
+				if ( $shortcode instanceof EnqueueAssetsInterface) {
+					add_action('wp_enqueue_scripts', array($shortcode, 'registerScriptsAndStylesheets'), 10);
+					add_action('wp_enqueue_scripts', array($shortcode, 'enqueueStylesheets'), 11);
+				}
+				// add_shortcode() if it has not already been added
+				if ( ! shortcode_exists($shortcode->getTag())) {
+					add_shortcode($shortcode->getTag(), array($shortcode, 'processShortcodeCallback'));
+				}
+			}
+			$this->legacy_shortcodes_manager->addShortcodes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+
+	/**
+	 * callback for the "wp_head" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @return void
+	 */
+	public function wpHead()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		$load_assets = false;
+		// array of posts displayed in current request
+		$posts = is_array($wp_query->posts) ? $wp_query->posts : array($wp_query->posts);
+		foreach ($posts as $post) {
+			// now check post content and excerpt for EE shortcodes
+			$load_assets = $this->parseContentForShortcodes($post->post_content)
+				? true
+				: $load_assets;
+		}
+		if ($load_assets) {
+			$this->legacy_shortcodes_manager->registry()->REQ->set_espresso_page(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+	}
+
+
+
+	/**
+	 * checks supplied content against list of shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content)
+	{
+		$has_shortcode = false;
+		if(empty($this->shortcodes)){
+			return $has_shortcode;
+		}
+		foreach ($this->shortcodes as $shortcode) {
+			/** @var ShortcodeInterface $shortcode */
+			if (has_shortcode($content, $shortcode->getTag())) {
+				$shortcode->initializeShortcode();
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
 
 }
 // End of file ShortcodesManager.php

core/services/shortcodes/EspressoShortcode.php

Indentation +213 added lines, -213 removed lines

@@ -21,219 +21,219 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof \EE_Event) {
-            $post_ID = $event->ID();
-        } else {
-            global $post;
-            $post_ID = $post->ID;
-        }
-        return $post_ID;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if($shortcode->initialized === false){
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof \EE_Event) {
+			$post_ID = $event->ID();
+		} else {
+			global $post;
+			$post_ID = $post->ID;
+		}
+		return $post_ID;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}