eventespresso / event-espresso-core

core/EE_System.core.php

Indentation +1236 added lines, -1236 removed lines

@@ -21,1242 +21,1242 @@
 {
 
 
-    /**
-     * 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_';
-
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * 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 $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param EE_Capabilities|null     $capabilities
-     * @param EE_Request|null          $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        EE_Capabilities $capabilities = null,
-        EE_Request $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $capabilities, $request, $maintenance_mode);
-        }
-        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
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param EE_Capabilities     $capabilities
-     * @param EE_Request          $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        EE_Capabilities $capabilities,
-        EE_Request $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->capabilities = $capabilities;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // 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 and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function() {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // 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');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * 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' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.rc.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.rc.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        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 (
-            ! (
-                isset($_GET['activate'])
-                && $_GET['activate'] === 'true'
-            )
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! (
-                isset($_GET['action'])
-                && in_array($_GET['action'], array('activate', 'activate-selected'), 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) {
-            if ($addon instanceof EE_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');
-        // 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
-                $this->maintenance_mode->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
-                $this->maintenance_mode->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
-     */
-    private 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 mixed $espresso_db_update 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
-     * @throws EE_Error
-     */
-    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 ($this->maintenance_mode->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
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        //foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_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 = EE_System::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
-     */
-    private 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;
-                    } else if ($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;
-                    } else if ($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) ;
-     */
-    private 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
-     */
-    private 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->capabilities->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
-     * @throws ReflectionException
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        //load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($config->admin->use_full_logging) {
-            $this->loader->getShared('EE_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
-     * @throws ReflectionException
-     */
-    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
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        try {
-            // load, register, and add shortcodes the new way
-            $this->loader->getShared(
-                'EventEspresso\core\services\shortcodes\ShortcodesManager',
-                array(
-                    // 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 hook point
-        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' hook point
-     * 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);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EE_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
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        //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();
-    }
-
-
-
-    /**
-     * 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->loader->getShared('EE_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() && ! $this->maintenance_mode->level()) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } else if (! EE_FRONT_AJAX) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_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->loader->getShared('EE_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->loader->getShared('EventEspresso\core\services\assets\Registry');
-    }
-
-
-
-    /**
-     * 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 hook point, 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');
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-
-    /**
-     * 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();
-    }
-
-
-
-
-    /**
-     * 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_';
+
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * 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 $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param EE_Capabilities|null     $capabilities
+	 * @param EE_Request|null          $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		EE_Capabilities $capabilities = null,
+		EE_Request $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $capabilities, $request, $maintenance_mode);
+		}
+		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
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param EE_Capabilities     $capabilities
+	 * @param EE_Request          $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		EE_Capabilities $capabilities,
+		EE_Request $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->capabilities = $capabilities;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// 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 and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function() {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// 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');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * 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' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.rc.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.rc.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		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 (
+			! (
+				isset($_GET['activate'])
+				&& $_GET['activate'] === 'true'
+			)
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! (
+				isset($_GET['action'])
+				&& in_array($_GET['action'], array('activate', 'activate-selected'), 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) {
+			if ($addon instanceof EE_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');
+		// 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
+				$this->maintenance_mode->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
+				$this->maintenance_mode->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
+	 */
+	private 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 mixed $espresso_db_update 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
+	 * @throws EE_Error
+	 */
+	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 ($this->maintenance_mode->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
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		//foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_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 = EE_System::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
+	 */
+	private 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;
+					} else if ($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;
+					} else if ($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) ;
+	 */
+	private 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
+	 */
+	private 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->capabilities->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
+	 * @throws ReflectionException
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		//load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($config->admin->use_full_logging) {
+			$this->loader->getShared('EE_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
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		try {
+			// load, register, and add shortcodes the new way
+			$this->loader->getShared(
+				'EventEspresso\core\services\shortcodes\ShortcodesManager',
+				array(
+					// 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 hook point
+		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' hook point
+	 * 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);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EE_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
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		//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();
+	}
+
+
+
+	/**
+	 * 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->loader->getShared('EE_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() && ! $this->maintenance_mode->level()) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} else if (! EE_FRONT_AJAX) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_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->loader->getShared('EE_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->loader->getShared('EventEspresso\core\services\assets\Registry');
+	}
+
+
+
+	/**
+	 * 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 hook point, 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');
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+
+	/**
+	 * 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();
+	}
+
+
+
+
+	/**
+	 * 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 +26 added lines, -26 removed lines

@@ -132,7 +132,7 @@ 
         EE_Maintenance_Mode $maintenance_mode = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($registry, $loader, $capabilities, $request, $maintenance_mode);
         }
         return self::$_instance;
@@ -298,7 +298,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');
     }
 
 
@@ -317,14 +317,14 @@ 
         $load_callback,
         $plugin_file_constant
     ) {
-        if (! defined($version_constant)) {
+        if ( ! defined($version_constant)) {
             return;
         }
         $addon_version = constant($version_constant);
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
             unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']);
@@ -337,7 +337,7 @@ 
                     $addon_name,
                     $min_version_required
                 ),
-                __FILE__, __FUNCTION__ . "({$addon_name})", __LINE__
+                __FILE__, __FUNCTION__."({$addon_name})", __LINE__
             );
             EE_Error::get_notices(false, true);
         }
@@ -389,7 +389,7 @@ 
                 && in_array($_GET['action'], array('activate', 'activate-selected'), 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');
     }
@@ -497,11 +497,11 @@ 
     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) {
+        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 ( ! 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
@@ -606,7 +606,7 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
@@ -704,7 +704,7 @@ 
         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])) {
+            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;
@@ -784,7 +784,7 @@ 
             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) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -884,7 +884,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) {
@@ -914,8 +914,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';
         }
     }
 
@@ -966,17 +966,17 @@ 
         $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)) {
+        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(
+                $msg .= '<li><b>Event Espresso - '.str_replace(
                         array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), '',
                         $class_name
-                    ) . '</b></li>';
+                    ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __(
@@ -1047,7 +1047,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', array());
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1108,10 +1108,10 @@ 
     {
         do_action('AHEE__EE_System__load_controllers__start');
         // let's get it started
-        if (! is_admin() && ! $this->maintenance_mode->level()) {
+        if ( ! is_admin() && ! $this->maintenance_mode->level()) {
             do_action('AHEE__EE_System__load_controllers__load_front_controllers');
             $this->loader->getShared('EE_Front_Controller');
-        } else if (! EE_FRONT_AJAX) {
+        } else if ( ! EE_FRONT_AJAX) {
             do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
             $this->loader->getShared('EE_Admin');
         }
@@ -1132,8 +1132,8 @@ 
         $this->loader->getShared('EE_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->loader->getShared('EventEspresso\core\services\assets\Registry');
@@ -1195,13 +1195,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

core/helpers/EEH_Template.helper.php

Indentation +930 added lines, -930 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 /**
  * Event Espresso
@@ -16,35 +16,35 @@ 
 
 
 if ( ! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @return string        the html output for the formatted money value
-     */
-    function espresso_get_template_part($slug = null, $name = null)
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @return string        the html output for the formatted money value
+	 */
+	function espresso_get_template_part($slug = null, $name = null)
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if ( ! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -59,650 +59,650 @@ 
 class EEH_Template
 {
 
-    private static $_espresso_themes = array();
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
-    }
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load it's functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes()
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return array();
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[$key]);
-            }
-            EEH_Template::$_espresso_themes = array();
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = null,
-        $name = null,
-        $template_args = array(),
-        $return_string = false
-    ) {
-        do_action("get_template_part_{$slug}-{$name}", $slug, $name);
-        $templates = array();
-        $name      = (string)$name;
-        if ($name != '') {
-            $templates[] = "{$slug}-{$name}.php";
-        }
-        // allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
-            EEH_Template::locate_template($templates, $template_args, true, $return_string);
-        }
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param  array       $template_args   an array of arguments to be extracted for use in the template
-     * @param  boolean     $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return mixed
-     */
-    public static function locate_template(
-        $templates = array(),
-        $template_args = array(),
-        $load = true,
-        $return_string = true,
-        $check_if_custom = false
-    ) {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = locate_template($templates);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                // get post_type
-                $post_type = EE_Registry::instance()->REQ->get('post_type');
-                // get array of EE Custom Post Types
-                $EE_CPTs = EE_Register_CPTs::get_CPTs();
-                // build template name based on request
-                if (isset($EE_CPTs[$post_type])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-
-            // array of paths to folders that may contain templates
-            $template_folder_paths = array(
-                // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
-                // then in the root of the /wp-content/uploads/espresso/templates/ folder
-                EVENT_ESPRESSO_TEMPLATE_DIR,
-            );
-
-            //add core plugin folders for checking only if we're not $check_if_custom
-            if ( ! $check_if_custom) {
-                $core_paths            = array(
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                );
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = apply_filters('FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths);
-            $templates             = is_array($templates) ? $templates : array($templates);
-            $template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
-            // array to hold all possible template paths
-            $full_template_paths = array();
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        array($template_folder_path, $template_path_minus_file_name)
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths, $file_name);
-            // now loop through our final array of template location paths and check each location
-            foreach ((array)$full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
-                    break;
-                }
-            }
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            } else {
-                EEH_Template::display_template($template_path, $template_args, false);
-            }
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path server path to the file to be loaded, including file name and extension
-     * @param  array      $template_args an array of arguments to be extracted for use in the template
-     * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return mixed string
-     * @throws \DomainException
-     */
+	private static $_espresso_themes = array();
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') == 'event_espresso' ? true : false;
+	}
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load it's functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes()
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return array();
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[$key]);
+			}
+			EEH_Template::$_espresso_themes = array();
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = null,
+		$name = null,
+		$template_args = array(),
+		$return_string = false
+	) {
+		do_action("get_template_part_{$slug}-{$name}", $slug, $name);
+		$templates = array();
+		$name      = (string)$name;
+		if ($name != '') {
+			$templates[] = "{$slug}-{$name}.php";
+		}
+		// allow template parts to be turned off via something like: add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
+			EEH_Template::locate_template($templates, $template_args, true, $return_string);
+		}
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param  array       $template_args   an array of arguments to be extracted for use in the template
+	 * @param  boolean     $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param  boolean     $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return mixed
+	 */
+	public static function locate_template(
+		$templates = array(),
+		$template_args = array(),
+		$load = true,
+		$return_string = true,
+		$check_if_custom = false
+	) {
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = locate_template($templates);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				// get post_type
+				$post_type = EE_Registry::instance()->REQ->get('post_type');
+				// get array of EE Custom Post Types
+				$EE_CPTs = EE_Register_CPTs::get_CPTs();
+				// build template name based on request
+				if (isset($EE_CPTs[$post_type])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates         = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+
+			// array of paths to folders that may contain templates
+			$template_folder_paths = array(
+				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
+				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+				// then in the root of the /wp-content/uploads/espresso/templates/ folder
+				EVENT_ESPRESSO_TEMPLATE_DIR,
+			);
+
+			//add core plugin folders for checking only if we're not $check_if_custom
+			if ( ! $check_if_custom) {
+				$core_paths            = array(
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				);
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = apply_filters('FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths);
+			$templates             = is_array($templates) ? $templates : array($templates);
+			$template_folder_paths = is_array($template_folder_paths) ? $template_folder_paths : array($template_folder_paths);
+			// array to hold all possible template paths
+			$full_template_paths = array();
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						array($template_folder_path, $template_path_minus_file_name)
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths, $file_name);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array)$full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
+					break;
+				}
+			}
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			} else {
+				EEH_Template::display_template($template_path, $template_args, false);
+			}
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], DS, $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path server path to the file to be loaded, including file name and extension
+	 * @param  array      $template_args an array of arguments to be extracted for use in the template
+	 * @param  boolean    $return_string whether to send output immediately to screen, or capture and return as a string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return mixed string
+	 * @throws \DomainException
+	 */
 	public static function display_template(
-        $template_path    = false,
-        $template_args    = array(),
-        $return_string    = false,
-        $throw_exceptions = false
-    ) {
-
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if ( ! $template_path || ! is_readable($template_path)) {
-            return '';
-        }
-        // if $template_args are not in an array, then make it so
-        if ( ! is_array($template_args) && ! is_object($template_args)) {
-            $template_args = array($template_args);
-        }
-        extract( $template_args, EXTR_SKIP );
-        // ignore whether template is accessible ?
-        if ( $throw_exceptions && ! is_readable( $template_path ) ) {
-            throw new \DomainException(
-                    esc_html__(
-                            'Invalid, unreadable, or missing file.',
-                            'event_espresso'
-                    )
-            );
-        }
-
-
-        if ($return_string) {
-            // because we want to return a string, we are going to capture the output
-            ob_start();
-            include($template_path);
-            return ob_get_clean();
-        } else {
-            include($template_path);
-        }
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param  string       $prefix added to the beginning of the generated class
-     * @param  string       $suffix added to the end of the generated class
-     * @return string
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            switch ($obj_class) {
-                // no specifics just yet...
-                default :
-                    $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-
-            }
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param  float   $amount       raw money value
-     * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string   $CNT_ISO      2 letter ISO code for a country
-     * @param string   $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     * @throws \EE_Error
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        //ensure amount is float
-        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float)$amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number or was amount converted to a string like "free" ?
-        if (is_float($amount_formatted)) {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-            // verify results
-            if ( ! $mny instanceof EE_Currency_Config) {
-                // set default config country currency settings
-                $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                    ? EE_Registry::instance()->CFG->currency
-                    : new EE_Currency_Config();
-            }
-            // format float
-            $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-            // add formatting ?
-            if ( ! $return_raw) {
-                // add currency sign
-                if ($mny->sign_b4) {
-                    if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
-                    } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                    }
-
-                } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
-                }
-
-                // filter to allow global setting of display_code
-                $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
-
-                // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
-            }
-            // filter results
-            $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted',
-                $amount_formatted, $mny, $return_raw);
-        }
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param  boolean $plural    Whether to return plural or not
-     * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        /** @type EEM_Status $EEM_Status */
-        $EEM_Status = EE_Registry::instance()->load_model('Status');
-        $status     = $EEM_Status->localized_status(array($status_id => __('unknown', 'event_espresso')), $plural,
-            $schema);
-        return $status[$status_id];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param  string $url   the url for the link, note that `esc_url` will be called on it
-     * @param  string $label What is the label you want displayed for the button
-     * @param  string $class what class is used for the button (defaults to 'button-primary')
-     * @param string  $icon
-     * @param string  $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if ( ! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
-        return $button;
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param  string     $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-
-        if ( ! $page) {
-            $page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
-        }
-
-        if ( ! $action) {
-            $action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
-        }
-
-        $action = empty($action) ? 'default' : $action;
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
-                'event_espresso') . '" > ' . $help_text . ' </a>';
-    }
-
-
-    /**
-     * This helper generates the html structure for the jquery joyride plugin with the given params.
-     *
-     * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
-     * @param EE_Help_Tour
-     * @return string         html
-     */
-    public static function help_tour_stops_generator(EE_Help_Tour $tour)
-    {
-        $id    = $tour->get_slug();
-        $stops = $tour->get_stops();
-
-        $content = '<ol style="display:none" id="' . $id . '">';
-
-        foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
-
-            //if container is set to modal then let's make sure we set the options accordingly
-            if (empty($data_id) && empty($data_class)) {
-                $stop['options']['modal']  = true;
-                $stop['options']['expose'] = true;
-            }
-
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
-            $inner_content = isset($stop['content']) ? $stop['content'] : '';
-
-            //options
-            if (isset($stop['options']) && is_array($stop['options'])) {
-                $options = ' data-options="';
-                foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
-                }
-                $options .= '"';
-            } else {
-                $options = '';
-            }
-
-            //let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
-        }
-
-        $content .= '</ol>';
-        return $content;
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param  array  $status_array  array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @throws EE_Error
-     * @return string               html structure for status.
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if ( ! is_array($status_array)) {
-            throw new EE_Error(esc_html__('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                'event_espresso'));
-        }
-
-        $setup_array = array();
-        foreach ($status_array as $item => $status) {
-            $setup_array[$item] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
-                'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
-                'status' => $status,
-            );
-        }
-
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
-        foreach ($setup_array as $item => $details) {
-            $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
-        }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array)$data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) {
-                ?>
+		$template_path    = false,
+		$template_args    = array(),
+		$return_string    = false,
+		$throw_exceptions = false
+	) {
+
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if ( ! $template_path || ! is_readable($template_path)) {
+			return '';
+		}
+		// if $template_args are not in an array, then make it so
+		if ( ! is_array($template_args) && ! is_object($template_args)) {
+			$template_args = array($template_args);
+		}
+		extract( $template_args, EXTR_SKIP );
+		// ignore whether template is accessible ?
+		if ( $throw_exceptions && ! is_readable( $template_path ) ) {
+			throw new \DomainException(
+					esc_html__(
+							'Invalid, unreadable, or missing file.',
+							'event_espresso'
+					)
+			);
+		}
+
+
+		if ($return_string) {
+			// because we want to return a string, we are going to capture the output
+			ob_start();
+			include($template_path);
+			return ob_get_clean();
+		} else {
+			include($template_path);
+		}
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param  string       $prefix added to the beginning of the generated class
+	 * @param  string       $suffix added to the end of the generated class
+	 * @return string
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			switch ($obj_class) {
+				// no specifics just yet...
+				default :
+					$class = strtolower(str_replace('_', '-', $obj_class));
+					$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+
+			}
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param  float   $amount       raw money value
+	 * @param  boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param  boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string   $CNT_ISO      2 letter ISO code for a country
+	 * @param string   $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 * @throws \EE_Error
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = __('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		//ensure amount is float
+		$amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float)$amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number or was amount converted to a string like "free" ?
+		if (is_float($amount_formatted)) {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+			// verify results
+			if ( ! $mny instanceof EE_Currency_Config) {
+				// set default config country currency settings
+				$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+					? EE_Registry::instance()->CFG->currency
+					: new EE_Currency_Config();
+			}
+			// format float
+			$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+			// add formatting ?
+			if ( ! $return_raw) {
+				// add currency sign
+				if ($mny->sign_b4) {
+					if ($amount >= 0) {
+						$amount_formatted = $mny->sign . $amount_formatted;
+					} else {
+						$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+					}
+
+				} else {
+					$amount_formatted = $amount_formatted . $mny->sign;
+				}
+
+				// filter to allow global setting of display_code
+				$display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
+
+				// add currency code ?
+				$amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+			}
+			// filter results
+			$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted',
+				$amount_formatted, $mny, $return_raw);
+		}
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param  string  $status_id Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param  boolean $plural    Whether to return plural or not
+	 * @param  string  $schema    'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		/** @type EEM_Status $EEM_Status */
+		$EEM_Status = EE_Registry::instance()->load_model('Status');
+		$status     = $EEM_Status->localized_status(array($status_id => __('unknown', 'event_espresso')), $plural,
+			$schema);
+		return $status[$status_id];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param  string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param  string $label What is the label you want displayed for the button
+	 * @param  string $class what class is used for the button (defaults to 'button-primary')
+	 * @param string  $icon
+	 * @param string  $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button-primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if ( ! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		$label  = ! empty($icon) ? $icon_html . $label : $label;
+		$button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+		return $button;
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param  string     $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+
+		if ( ! $page) {
+			$page = isset($_REQUEST['page']) && ! empty($_REQUEST['page']) ? sanitize_key($_REQUEST['page']) : $page;
+		}
+
+		if ( ! $action) {
+			$action = isset($_REQUEST['action']) && ! empty($_REQUEST['action']) ? sanitize_key($_REQUEST['action']) : $action;
+		}
+
+		$action = empty($action) ? 'default' : $action;
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
+				'event_espresso') . '" > ' . $help_text . ' </a>';
+	}
+
+
+	/**
+	 * This helper generates the html structure for the jquery joyride plugin with the given params.
+	 *
+	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
+	 * @param EE_Help_Tour
+	 * @return string         html
+	 */
+	public static function help_tour_stops_generator(EE_Help_Tour $tour)
+	{
+		$id    = $tour->get_slug();
+		$stops = $tour->get_stops();
+
+		$content = '<ol style="display:none" id="' . $id . '">';
+
+		foreach ($stops as $stop) {
+			$data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
+			$data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+
+			//if container is set to modal then let's make sure we set the options accordingly
+			if (empty($data_id) && empty($data_class)) {
+				$stop['options']['modal']  = true;
+				$stop['options']['expose'] = true;
+			}
+
+			$custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
+			$button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+			$inner_content = isset($stop['content']) ? $stop['content'] : '';
+
+			//options
+			if (isset($stop['options']) && is_array($stop['options'])) {
+				$options = ' data-options="';
+				foreach ($stop['options'] as $option => $value) {
+					$options .= $option . ':' . $value . ';';
+				}
+				$options .= '"';
+			} else {
+				$options = '';
+			}
+
+			//let's put all together
+			$content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+		}
+
+		$content .= '</ol>';
+		return $content;
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param  array  $status_array  array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param  string $active_status This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @throws EE_Error
+	 * @return string               html structure for status.
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if ( ! is_array($status_array)) {
+			throw new EE_Error(esc_html__('The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+				'event_espresso'));
+		}
+
+		$setup_array = array();
+		foreach ($status_array as $item => $status) {
+			$setup_array[$item] = array(
+				'class'  => 'ee-status-legend ee-status-legend-' . $status,
+				'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
+				'status' => $status,
+			);
+		}
+
+		$content = '<div class="ee-list-table-legend-container">' . "\n";
+		$content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
+		$content .= '<dl class="ee-list-table-legend">' . "\n\t";
+		foreach ($setup_array as $item => $details) {
+			$active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
+			$content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
+			$content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
+			$content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
+			$content .= '</dt>' . "\n";
+		}
+		$content .= '</dl>' . "\n";
+		$content .= '</div>' . "\n";
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array)$data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) {
+				?>
                 <table class="widefat">
                     <tbody>
                     <?php
-                    foreach ($data as $data_key => $data_values) {
-                        ?>
+					foreach ($data as $data_key => $data_values) {
+						?>
                         <tr>
                             <td>
                                 <?php echo $data_key; ?>
@@ -712,248 +712,248 @@ 
                             </td>
                         </tr>
                         <?php
-                    } ?>
+					} ?>
                     </tbody>
                 </table>
                 <?php
-            } else {
-                ?>
+			} else {
+				?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
                 <?php
-            }
-        } else {
-            //simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @since 4.4.0
-     * @see   self:get_paging_html() for argument docs.
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @return string
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        echo self::get_paging_html($total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name,
-            $items_label);
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     * @param  integer $total_items     How many total items there are to page.
-     * @param  integer $current         What the current page is.
-     * @param  integer $per_page        How many items per page.
-     * @param  string  $url             What the base url for page links is.
-     * @param  boolean $show_num_field  Whether to show the input for changing page number.
-     * @param  string  $paged_arg_name  The name of the key for the paged query argument.
-     * @param  array   $items_label     An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     */
-    public static function get_paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = array()
-    ) {
-        $page_links     = array();
-        $disable_first  = $disable_last = '';
-        $total_items    = (int)$total_items;
-        $per_page       = (int)$per_page;
-        $current        = (int)$current;
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        //filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = array(
-                'single' => __('1 item', 'event_espresso'),
-                'plural' => __('%s items', 'event_espresso'),
-            );
-        } else {
-            $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            );
-        }
-
-        $total_pages = ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        if ($current === 1) {
-            $disable_first = ' disabled';
-        }
-        if ($current == $total_pages) {
-            $disable_last = ' disabled';
-        }
-
-        $page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
-            esc_attr__('Go to the first page'),
-            esc_url(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
-            esc_attr__('Go to the previous page'),
-            esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        if ( ! $show_num_field) {
-            $html_current_page = $current;
-        } else {
-            $html_current_page = sprintf("<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page'),
-                $current,
-                strlen($total_pages)
-            );
-        }
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging'),
-            $html_current_page,
-            $html_total_pages,
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
-            esc_attr__('Go to the next page'),
-            esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
-            esc_attr__('Go to the last page'),
-            esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-        // set page class
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        } else {
-            $page_class = ' no-pages';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string $wrap_class
-     * @param string $wrap_id
-     * @return string
-     */
-    public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
-    {
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (
-            ! $admin &&
-            ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
-        $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            array(
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ),
-            $query_args
-        );
-        $powered_by = apply_filters('FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso');
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string)apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<{$tag}{$attributes}>",
-                "<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-    }
+			}
+		} else {
+			//simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @since 4.4.0
+	 * @see   self:get_paging_html() for argument docs.
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @return string
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		echo self::get_paging_html($total_items, $current, $per_page, $url, $show_num_field, $paged_arg_name,
+			$items_label);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 * @param  integer $total_items     How many total items there are to page.
+	 * @param  integer $current         What the current page is.
+	 * @param  integer $per_page        How many items per page.
+	 * @param  string  $url             What the base url for page links is.
+	 * @param  boolean $show_num_field  Whether to show the input for changing page number.
+	 * @param  string  $paged_arg_name  The name of the key for the paged query argument.
+	 * @param  array   $items_label     An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 */
+	public static function get_paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = array()
+	) {
+		$page_links     = array();
+		$disable_first  = $disable_last = '';
+		$total_items    = (int)$total_items;
+		$per_page       = (int)$per_page;
+		$current        = (int)$current;
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		//filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = array(
+				'single' => __('1 item', 'event_espresso'),
+				'plural' => __('%s items', 'event_espresso'),
+			);
+		} else {
+			$items_label = array(
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			);
+		}
+
+		$total_pages = ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		if ($current === 1) {
+			$disable_first = ' disabled';
+		}
+		if ($current == $total_pages) {
+			$disable_last = ' disabled';
+		}
+
+		$page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
+			'first-page' . $disable_first,
+			esc_attr__('Go to the first page'),
+			esc_url(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'prev-page' . $disable_first,
+			esc_attr__('Go to the previous page'),
+			esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		if ( ! $show_num_field) {
+			$html_current_page = $current;
+		} else {
+			$html_current_page = sprintf("<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page'),
+				$current,
+				strlen($total_pages)
+			);
+		}
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging'),
+			$html_current_page,
+			$html_total_pages,
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'next-page' . $disable_last,
+			esc_attr__('Go to the next page'),
+			esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'last-page' . $disable_last,
+			esc_attr__('Go to the last page'),
+			esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+		// set page class
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		} else {
+			$page_class = ' no-pages';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string $wrap_class
+	 * @param string $wrap_id
+	 * @return string
+	 */
+	public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = array())
+	{
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (
+			! $admin &&
+			! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
+		$wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			array(
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			),
+			$query_args
+		);
+		$powered_by = apply_filters('FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso');
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		return (string)apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<{$tag}{$attributes}>",
+				"<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+	}
 
 
 } //end EEH_Template class
@@ -962,33 +962,33 @@ 
 
 
 if ( ! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            array(
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            )
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			array(
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => __('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => __('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			)
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }
\ No newline at end of file

Spacing +65 added lines, -65 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 /**
@@ -81,8 +81,8 @@ 
     public static function load_espresso_theme_functions()
     {
         if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . DS . 'functions.php');
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().DS.'functions.php');
             }
         }
     }
@@ -96,7 +96,7 @@ 
     public static function get_espresso_themes()
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return array();
             }
@@ -132,7 +132,7 @@ 
     ) {
         do_action("get_template_part_{$slug}-{$name}", $slug, $name);
         $templates = array();
-        $name      = (string)$name;
+        $name      = (string) $name;
         if ($name != '') {
             $templates[] = "{$slug}-{$name}.php";
         }
@@ -211,7 +211,7 @@ 
                 if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
+                    $templates         = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -220,18 +220,18 @@ 
             // array of paths to folders that may contain templates
             $template_folder_paths = array(
                 // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+                EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme,
                 // then in the root of the /wp-content/uploads/espresso/templates/ folder
                 EVENT_ESPRESSO_TEMPLATE_DIR,
             );
 
             //add core plugin folders for checking only if we're not $check_if_custom
             if ( ! $check_if_custom) {
-                $core_paths            = array(
+                $core_paths = array(
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 );
@@ -262,10 +262,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -273,13 +273,13 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . DS . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().DS.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters('FHEE__EEH_Template__locate_template__full_template_paths',
                 $full_template_paths, $file_name);
             // now loop through our final array of template location paths and check each location
-            foreach ((array)$full_template_paths as $full_template_path) {
+            foreach ((array) $full_template_paths as $full_template_path) {
                 if (is_readable($full_template_path)) {
                     $template_path = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $full_template_path);
                     break;
@@ -366,9 +366,9 @@ 
         if ( ! is_array($template_args) && ! is_object($template_args)) {
             $template_args = array($template_args);
         }
-        extract( $template_args, EXTR_SKIP );
+        extract($template_args, EXTR_SKIP);
         // ignore whether template is accessible ?
-        if ( $throw_exceptions && ! is_readable( $template_path ) ) {
+        if ($throw_exceptions && ! is_readable($template_path)) {
             throw new \DomainException(
                     esc_html__(
                             'Invalid, unreadable, or missing file.',
@@ -401,11 +401,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -415,11 +415,11 @@ 
                 // no specifics just yet...
                 default :
                     $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+                    $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
 
             }
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -451,7 +451,7 @@ 
             return '';
         }
         //ensure amount is float
-        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float)$amount);
+        $amount  = apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
         $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
         // filter raw amount (allows 0.00 to be changed to "free" for example)
         $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
@@ -473,20 +473,20 @@ 
                 // add currency sign
                 if ($mny->sign_b4) {
                     if ($amount >= 0) {
-                        $amount_formatted = $mny->sign . $amount_formatted;
+                        $amount_formatted = $mny->sign.$amount_formatted;
                     } else {
-                        $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                        $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                     }
 
                 } else {
-                    $amount_formatted = $amount_formatted . $mny->sign;
+                    $amount_formatted = $amount_formatted.$mny->sign;
                 }
 
                 // filter to allow global setting of display_code
                 $display_code = apply_filters('FHEE__EEH_Template__format_currency__display_code', $display_code);
 
                 // add currency code ?
-                $amount_formatted = $display_code ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>' : $amount_formatted;
+                $amount_formatted = $display_code ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>' : $amount_formatted;
             }
             // filter results
             $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount_formatted',
@@ -540,12 +540,12 @@ 
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
                 $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
-        $label  = ! empty($icon) ? $icon_html . $label : $label;
-        $button = '<a id="' . sanitize_title_with_dashes($label) . '" href="' . esc_url($url) . '" class="' . $class . '" title="' . $title . '">' . $label . '</a>';
+        $label  = ! empty($icon) ? $icon_html.$label : $label;
+        $button = '<a id="'.sanitize_title_with_dashes($label).'" href="'.esc_url($url).'" class="'.$class.'" title="'.$title.'">'.$label.'</a>';
         return $button;
     }
 
@@ -579,11 +579,11 @@ 
         $action = empty($action) ? 'default' : $action;
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="' . $help_tab_lnk . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22' . $icon . '" title="' . esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
-                'event_espresso') . '" > ' . $help_text . ' </a>';
+        return '<a id="'.$help_tab_lnk.'" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'.$icon.'" title="'.esc_attr__('Click to open the \'Help\' tab for more information about this feature.',
+                'event_espresso').'" > '.$help_text.' </a>';
     }
 
 
@@ -600,11 +600,11 @@ 
         $id    = $tour->get_slug();
         $stops = $tour->get_stops();
 
-        $content = '<ol style="display:none" id="' . $id . '">';
+        $content = '<ol style="display:none" id="'.$id.'">';
 
         foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id']) ? ' data-id="' . $stop['id'] . '"' : '';
-            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="' . $stop['class'] . '"' : '';
+            $data_id    = ! empty($stop['id']) ? ' data-id="'.$stop['id'].'"' : '';
+            $data_class = empty($data_id) && ! empty($stop['class']) ? ' data-class="'.$stop['class'].'"' : '';
 
             //if container is set to modal then let's make sure we set the options accordingly
             if (empty($data_id) && empty($data_class)) {
@@ -612,15 +612,15 @@ 
                 $stop['options']['expose'] = true;
             }
 
-            $custom_class  = ! empty($stop['custom_class']) ? ' class="' . $stop['custom_class'] . '"' : '';
-            $button_text   = ! empty($stop['button_text']) ? ' data-button="' . $stop['button_text'] . '"' : '';
+            $custom_class  = ! empty($stop['custom_class']) ? ' class="'.$stop['custom_class'].'"' : '';
+            $button_text   = ! empty($stop['button_text']) ? ' data-button="'.$stop['button_text'].'"' : '';
             $inner_content = isset($stop['content']) ? $stop['content'] : '';
 
             //options
             if (isset($stop['options']) && is_array($stop['options'])) {
                 $options = ' data-options="';
                 foreach ($stop['options'] as $option => $value) {
-                    $options .= $option . ':' . $value . ';';
+                    $options .= $option.':'.$value.';';
                 }
                 $options .= '"';
             } else {
@@ -628,7 +628,7 @@ 
             }
 
             //let's put all together
-            $content .= '<li' . $data_id . $data_class . $custom_class . $button_text . $options . '>' . $inner_content . '</li>';
+            $content .= '<li'.$data_id.$data_class.$custom_class.$button_text.$options.'>'.$inner_content.'</li>';
         }
 
         $content .= '</ol>';
@@ -660,24 +660,24 @@ 
         $setup_array = array();
         foreach ($status_array as $item => $status) {
             $setup_array[$item] = array(
-                'class'  => 'ee-status-legend ee-status-legend-' . $status,
+                'class'  => 'ee-status-legend ee-status-legend-'.$status,
                 'desc'   => EEH_Template::pretty_status($status, false, 'sentence'),
                 'status' => $status,
             );
         }
 
-        $content = '<div class="ee-list-table-legend-container">' . "\n";
-        $content .= '<h4 class="status-legend-title">' . esc_html__('Status Legend', 'event_espresso') . '</h4>' . "\n";
-        $content .= '<dl class="ee-list-table-legend">' . "\n\t";
+        $content = '<div class="ee-list-table-legend-container">'."\n";
+        $content .= '<h4 class="status-legend-title">'.esc_html__('Status Legend', 'event_espresso').'</h4>'."\n";
+        $content .= '<dl class="ee-list-table-legend">'."\n\t";
         foreach ($setup_array as $item => $details) {
             $active_class = $active_status == $details['status'] ? ' class="ee-is-active-status"' : '';
-            $content .= '<dt id="ee-legend-item-tooltip-' . $item . '"' . $active_class . '>' . "\n\t\t";
-            $content .= '<span class="' . $details['class'] . '"></span>' . "\n\t\t";
-            $content .= '<span class="ee-legend-description">' . $details['desc'] . '</span>' . "\n\t";
-            $content .= '</dt>' . "\n";
+            $content .= '<dt id="ee-legend-item-tooltip-'.$item.'"'.$active_class.'>'."\n\t\t";
+            $content .= '<span class="'.$details['class'].'"></span>'."\n\t\t";
+            $content .= '<span class="ee-legend-description">'.$details['desc'].'</span>'."\n\t";
+            $content .= '</dt>'."\n";
         }
-        $content .= '</dl>' . "\n";
-        $content .= '</div>' . "\n";
+        $content .= '</dl>'."\n";
+        $content .= '</div>'."\n";
         return $content;
     }
 
@@ -692,7 +692,7 @@ 
     public static function layout_array_as_table($data)
     {
         if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array)$data;
+            $data = (array) $data;
         }
         ob_start();
         if (is_array($data)) {
@@ -793,9 +793,9 @@ 
     ) {
         $page_links     = array();
         $disable_first  = $disable_last = '';
-        $total_items    = (int)$total_items;
-        $per_page       = (int)$per_page;
-        $current        = (int)$current;
+        $total_items    = (int) $total_items;
+        $per_page       = (int) $per_page;
+        $current        = (int) $current;
         $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
 
         //filter items_label
@@ -815,8 +815,8 @@ 
             );
         } else {
             $items_label = array(
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             );
         }
 
@@ -828,7 +828,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         if ($current === 1) {
             $disable_first = ' disabled';
@@ -838,7 +838,7 @@ 
         }
 
         $page_links[] = sprintf("<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
+            'first-page'.$disable_first,
             esc_attr__('Go to the first page'),
             esc_url(remove_query_arg($paged_arg_name, $url)),
             '&laquo;'
@@ -846,7 +846,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
+            'prev-page'.$disable_first,
             esc_attr__('Go to the previous page'),
             esc_url(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
             '&lsaquo;'
@@ -866,7 +866,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging'),
             $html_current_page,
             $html_total_pages,
@@ -876,7 +876,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
+            'next-page'.$disable_last,
             esc_attr__('Go to the next page'),
             esc_url(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
             '&rsaquo;'
@@ -884,13 +884,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
+            'last-page'.$disable_last,
             esc_attr__('Go to the last page'),
             esc_url(add_query_arg($paged_arg_name, $total_pages, $url)),
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
         // set page class
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
@@ -898,7 +898,7 @@ 
             $page_class = ' no-pages';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -935,10 +935,10 @@ 
             $query_args
         );
         $powered_by = apply_filters('FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso');
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso');
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string)apply_filters(
+        return (string) apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso__html',
             sprintf(
                 esc_html_x(
@@ -989,6 +989,6 @@ 
                 'add_fragment' => '',
             )
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }
\ No newline at end of file

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +718 added lines, -718 removed lines

@@ -21,724 +21,724 @@
 abstract class EE_PMT_Base
 {
 
-    const onsite = 'on-site';
-    const offsite = 'off-site';
-    const offline = 'off-line';
-
-    /**
-     * @var EE_Payment_Method
-     */
-    protected $_pm_instance = NULL;
-
-    /**
-     * @var boolean
-     */
-    protected $_requires_https = FALSE;
-
-    /**
-     * @var boolean
-     */
-    protected $_has_billing_form;
-
-    /**
-     * @var EE_Gateway
-     */
-    protected $_gateway = NULL;
-
-    /**
-     * @var EE_Payment_Method_Form
-     */
-    protected $_settings_form = NULL;
-
-    /**
-     * @var EE_Form_Section_Proper
-     */
-    protected $_billing_form = NULL;
-
-    /**
-     * @var boolean
-     */
-    protected $_cache_billing_form = TRUE;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     * @var string
-     */
-    protected $_file_folder = NULL;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     * @var string
-     */
-    protected $_file_url = NULL;
-
-    /**
-     * Pretty name for the payment method
-     * @var string
-     */
-    protected $_pretty_name = NULL;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_button_url = NULL;
-
-    /**
-     *
-     * @var string
-     */
-    protected $_default_description = NULL;
-
-
-    /**
-     *
-     * @param EE_Payment_Method $pm_instance
-     * @throws EE_Error
-     * @return EE_PMT_Base
-     */
-    function __construct($pm_instance = NULL)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (!isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (!$this->_pretty_name) {
-            throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
-        }
-        //if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === NULL) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param boolean $has_billing_form
-     */
-    public function set_has_billing_form($has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', DS, $this->file_folder());
-        $file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url = $file_path;
-    }
-
-    /**
-     * Gets the default description on all payment methods of this type
-     * @return string
-     */
-    public function default_description()
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     * @return string
-     */
-    public function file_folder()
-    {
-        if (!$this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url()
-    {
-        if (!$this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     * @param EE_Payment_Method $payment_method_instance
-     */
-    function set_instance($payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        //if they have already requested the settings form, make sure its
-        //data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they setup the payment method
-     * @return EE_Payment_Method_Form
-     */
-    function settings_form()
-    {
-        if (!$this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            //if we have already assigned a model object to this pmt, make
-            //sure its reflected in teh form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     * @return EE_Payment_Method_Form
-     */
-    abstract function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form($form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form()
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param \EE_Transaction $transaction
-     * @param array $extra_args
-     * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
-     */
-    public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array())
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (!$this->_billing_form instanceof EE_Billing_Info_Form || !$this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        //if we know who the attendee is, and this is a billing form
-        //that uses attendee info, populate it
-        if (
-        apply_filters(
-            'FHEE__populate_billing_form_fields_from_attendee',
-            (
-                $this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $transaction instanceof EE_Transaction
-                && $transaction->primary_registration() instanceof EE_Registration
-                && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-            ),
-            $this->_billing_form,
-            $transaction
-        )
-        ) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    abstract function generate_new_billing_form(EE_Transaction $transaction = NULL);
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     * @param EE_Payment_Method $form
-     */
-    public function set_billing_form($form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether or not this payment method requires HTTPS to be used
-     * @return boolean
-     */
-    function requires_https()
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     *
-     * @param EE_Transaction $transaction
-     * @param float $amount
-     * @param EE_Billing_Info_Form $billing_info
-     * @param string $return_url
-     * @param string $fail_url
-     * @param string $method
-     * @param bool $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    function process_payment(EE_Transaction $transaction, $amount = null, $billing_info = null, $return_url = null, $fail_url = '', $method = 'CART', $by_admin = false)
-    {
-        // @todo: add surcharge for the payment method, if any
-        if ($this->_gateway) {
-            //there is a gateway, so we're going to make a payment object
-            //but wait! do they already have a payment in progress that we thought was failed?
-            $duplicate_properties = array(
-                'STS_ID' => EEM_Payment::status_id_failed,
-                'TXN_ID' => $transaction->ID(),
-                'PMD_ID' => $this->_pm_instance->ID(),
-                'PAY_source' => $method,
-                'PAY_amount' => $amount !== null ? $amount : $transaction->remaining(),
-                'PAY_gateway_response' => null,
-            );
-            $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
-            //if we didn't already have a payment in progress for the same thing,
-            //then we actually want to make a new payment
-            if (!$payment instanceof EE_Payment) {
-                $payment = EE_Payment::new_instance(
-                    array_merge(
-                        $duplicate_properties,
-                        array(
-                            'PAY_timestamp' => time(),
-                            'PAY_txn_id_chq_nmbr' => null,
-                            'PAY_po_number' => null,
-                            'PAY_extra_accntng' => null,
-                            'PAY_details' => null,
-                        )
-                    )
-                );
-            }
-            //make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
-            $payment->save();
-            $billing_values = $this->_get_billing_values_from_form($billing_info);
-
-            //  Offsite Gateway
-            if ($this->_gateway instanceof EE_Offsite_Gateway) {
-
-                $payment = $this->_gateway->set_redirection_info(
-                    $payment,
-                    $billing_values,
-                    $return_url,
-                    EE_Config::instance()->core->txn_page_url(
-                        array(
-                            'e_reg_url_link' => $transaction->primary_registration()->reg_url_link(),
-                            'ee_payment_method' => $this->_pm_instance->slug()
-                        )
-                    ),
-                    $fail_url
-                );
-                $payment->save();
-                //  Onsite Gateway
-            } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-
-                $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-                $payment->save();
-
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __('Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)', 'event_espresso'),
-                        get_class($this),
-                        gettype($this->_gateway)
-                    )
-                );
-            }
-
-        } else {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but dont save it
-            $payment = EE_Payment::new_instance(
-                array(
-                    'STS_ID' => EEM_Payment::status_id_pending,
-                    'TXN_ID' => $transaction->ID(),
-                    'PMD_ID' => $transaction->payment_method_ID(),
-                    'PAY_amount' => 0.00,
-                    'PAY_timestamp' => time(),
-                )
-            );
-
-        }
-
-        // if there is billing info, clean it and save it now
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            return $billing_form->input_pretty_values(true);
-        } else {
-            return NULL;
-        }
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     * @param array $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function handle_ipn($req_data, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (!$this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
-
-        }
-        $payment = $this->_gateway->handle_payment_update($req_data, $transaction);
-        return $payment;
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction $transaction
-     * @return boolean success
-     */
-    protected function _save_billing_info_to_attendee($billing_form, $transaction)
-    {
-        if (!$transaction || !$transaction instanceof EE_Transaction) {
-            EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (!$primary_reg) {
-            EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (!$attendee) {
-            EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     * @param EE_Transaction $transaction
-     * @param array $req_data
-     * @return EE_Payment
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn($req_data = array())
-    {
-        throw new EE_Error(sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this)));
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     */
-    public function finalize_payment_for($transaction)
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether or not this payment method's gateway supports sending refund requests
-     * @return boolean
-     */
-    public function supports_sending_refunds()
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->supports_sending_refunds();
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     *
-     * @param EE_Payment $payment
-     * @param array $refund_info
-     * @throws EE_Error
-     * @return EE_Payment
-     */
-    public function process_refund(EE_Payment $payment, $refund_info = array())
-    {
-        if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    __('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs()
-    {
-        if (!$this->_gateway) {
-            return EE_PMT_Base::offline;
-        } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        } elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        } else {
-            throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"), get_class($this)));
-        }
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title i18n name for the help tab
-     * @type string $filename name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array $template_args any arguments you want passed to the template file while rendering.
-     *                Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return array();
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     * @return string
-     */
-    public function pretty_name()
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     * @return string
-     */
-    public function default_button_url()
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     * @return EE_Gateway
-     */
-    public function get_gateway()
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link()
-    {
-        return EEH_Template::get_help_tab_link($this->get_help_tab_name());
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     * @return string
-     */
-    public function get_help_tab_name()
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     * @return string
-     */
-    public function cap_name()
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     * @return string
-     */
-    public function introductory_html()
-    {
-        return EEH_Template::locate_template($this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
-    }
+	const onsite = 'on-site';
+	const offsite = 'off-site';
+	const offline = 'off-line';
+
+	/**
+	 * @var EE_Payment_Method
+	 */
+	protected $_pm_instance = NULL;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_requires_https = FALSE;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_has_billing_form;
+
+	/**
+	 * @var EE_Gateway
+	 */
+	protected $_gateway = NULL;
+
+	/**
+	 * @var EE_Payment_Method_Form
+	 */
+	protected $_settings_form = NULL;
+
+	/**
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_billing_form = NULL;
+
+	/**
+	 * @var boolean
+	 */
+	protected $_cache_billing_form = TRUE;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 * @var string
+	 */
+	protected $_file_folder = NULL;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 * @var string
+	 */
+	protected $_file_url = NULL;
+
+	/**
+	 * Pretty name for the payment method
+	 * @var string
+	 */
+	protected $_pretty_name = NULL;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_button_url = NULL;
+
+	/**
+	 *
+	 * @var string
+	 */
+	protected $_default_description = NULL;
+
+
+	/**
+	 *
+	 * @param EE_Payment_Method $pm_instance
+	 * @throws EE_Error
+	 * @return EE_PMT_Base
+	 */
+	function __construct($pm_instance = NULL)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (!isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (!$this->_pretty_name) {
+			throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
+		}
+		//if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === NULL) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param boolean $has_billing_form
+	 */
+	public function set_has_billing_form($has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		$fn = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . DS;
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', DS, WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', DS, $this->file_folder());
+		$file_path = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url = $file_path;
+	}
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 * @return string
+	 */
+	public function default_description()
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 * @return string
+	 */
+	public function file_folder()
+	{
+		if (!$this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url()
+	{
+		if (!$this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 * @param EE_Payment_Method $payment_method_instance
+	 */
+	function set_instance($payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		//if they have already requested the settings form, make sure its
+		//data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they setup the payment method
+	 * @return EE_Payment_Method_Form
+	 */
+	function settings_form()
+	{
+		if (!$this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			//if we have already assigned a model object to this pmt, make
+			//sure its reflected in teh form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form($form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form()
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param array $extra_args
+	 * @return \EE_Billing_Attendee_Info_Form|\EE_Billing_Info_Form|null
+	 */
+	public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array())
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (!$this->_billing_form instanceof EE_Billing_Info_Form || !$this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		//if we know who the attendee is, and this is a billing form
+		//that uses attendee info, populate it
+		if (
+		apply_filters(
+			'FHEE__populate_billing_form_fields_from_attendee',
+			(
+				$this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $transaction instanceof EE_Transaction
+				&& $transaction->primary_registration() instanceof EE_Registration
+				&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+			),
+			$this->_billing_form,
+			$transaction
+		)
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	abstract function generate_new_billing_form(EE_Transaction $transaction = NULL);
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 * @param EE_Payment_Method $form
+	 */
+	public function set_billing_form($form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether or not this payment method requires HTTPS to be used
+	 * @return boolean
+	 */
+	function requires_https()
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param float $amount
+	 * @param EE_Billing_Info_Form $billing_info
+	 * @param string $return_url
+	 * @param string $fail_url
+	 * @param string $method
+	 * @param bool $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	function process_payment(EE_Transaction $transaction, $amount = null, $billing_info = null, $return_url = null, $fail_url = '', $method = 'CART', $by_admin = false)
+	{
+		// @todo: add surcharge for the payment method, if any
+		if ($this->_gateway) {
+			//there is a gateway, so we're going to make a payment object
+			//but wait! do they already have a payment in progress that we thought was failed?
+			$duplicate_properties = array(
+				'STS_ID' => EEM_Payment::status_id_failed,
+				'TXN_ID' => $transaction->ID(),
+				'PMD_ID' => $this->_pm_instance->ID(),
+				'PAY_source' => $method,
+				'PAY_amount' => $amount !== null ? $amount : $transaction->remaining(),
+				'PAY_gateway_response' => null,
+			);
+			$payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
+			//if we didn't already have a payment in progress for the same thing,
+			//then we actually want to make a new payment
+			if (!$payment instanceof EE_Payment) {
+				$payment = EE_Payment::new_instance(
+					array_merge(
+						$duplicate_properties,
+						array(
+							'PAY_timestamp' => time(),
+							'PAY_txn_id_chq_nmbr' => null,
+							'PAY_po_number' => null,
+							'PAY_extra_accntng' => null,
+							'PAY_details' => null,
+						)
+					)
+				);
+			}
+			//make sure the payment has been saved to show we started it, and so it has an ID should the gateway try to log it
+			$payment->save();
+			$billing_values = $this->_get_billing_values_from_form($billing_info);
+
+			//  Offsite Gateway
+			if ($this->_gateway instanceof EE_Offsite_Gateway) {
+
+				$payment = $this->_gateway->set_redirection_info(
+					$payment,
+					$billing_values,
+					$return_url,
+					EE_Config::instance()->core->txn_page_url(
+						array(
+							'e_reg_url_link' => $transaction->primary_registration()->reg_url_link(),
+							'ee_payment_method' => $this->_pm_instance->slug()
+						)
+					),
+					$fail_url
+				);
+				$payment->save();
+				//  Onsite Gateway
+			} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+
+				$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+				$payment->save();
+
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__('Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)', 'event_espresso'),
+						get_class($this),
+						gettype($this->_gateway)
+					)
+				);
+			}
+
+		} else {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but dont save it
+			$payment = EE_Payment::new_instance(
+				array(
+					'STS_ID' => EEM_Payment::status_id_pending,
+					'TXN_ID' => $transaction->ID(),
+					'PMD_ID' => $transaction->payment_method_ID(),
+					'PAY_amount' => 0.00,
+					'PAY_timestamp' => time(),
+				)
+			);
+
+		}
+
+		// if there is billing info, clean it and save it now
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			return $billing_form->input_pretty_values(true);
+		} else {
+			return NULL;
+		}
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 * @param array $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function handle_ipn($req_data, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (!$this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
+
+		}
+		$payment = $this->_gateway->handle_payment_update($req_data, $transaction);
+		return $payment;
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction $transaction
+	 * @return boolean success
+	 */
+	protected function _save_billing_info_to_attendee($billing_form, $transaction)
+	{
+		if (!$transaction || !$transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (!$primary_reg) {
+			EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (!$attendee) {
+			EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 * @param EE_Transaction $transaction
+	 * @param array $req_data
+	 * @return EE_Payment
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, $req_data = array())
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment its for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn($req_data = array())
+	{
+		throw new EE_Error(sprintf(__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"), get_class($this)));
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 */
+	public function finalize_payment_for($transaction)
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether or not this payment method's gateway supports sending refund requests
+	 * @return boolean
+	 */
+	public function supports_sending_refunds()
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->supports_sending_refunds();
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 *
+	 * @param EE_Payment $payment
+	 * @param array $refund_info
+	 * @throws EE_Error
+	 * @return EE_Payment
+	 */
+	public function process_refund(EE_Payment $payment, $refund_info = array())
+	{
+		if ($this->_gateway && $this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs()
+	{
+		if (!$this->_gateway) {
+			return EE_PMT_Base::offline;
+		} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		} elseif ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		} else {
+			throw new EE_Error(sprintf(__("Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those", "event_espresso"), get_class($this)));
+		}
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title i18n name for the help tab
+	 * @type string $filename name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array $template_args any arguments you want passed to the template file while rendering.
+	 *                Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return array();
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 * @return string
+	 */
+	public function default_button_url()
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 * @return EE_Gateway
+	 */
+	public function get_gateway()
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link()
+	{
+		return EEH_Template::get_help_tab_link($this->get_help_tab_name());
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 * @return string
+	 */
+	public function get_help_tab_name()
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 * @return string
+	 */
+	public function cap_name()
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 * @return string
+	 */
+	public function introductory_html()
+	{
+		return EEH_Template::locate_template($this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
+	}
 
 
 }

Spacing +18 added lines, -18 removed lines

@@ -114,7 +114,7 @@ 
             $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
             do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
         }
-        if (!isset($this->_has_billing_form)) {
+        if ( ! isset($this->_has_billing_form)) {
             // by default, On Site gateways have a billing form
             if ($this->payment_occurs() == EE_PMT_Base::onsite) {
                 $this->set_has_billing_form(true);
@@ -123,12 +123,12 @@ 
             }
         }
 
-        if (!$this->_pretty_name) {
+        if ( ! $this->_pretty_name) {
             throw new EE_Error(sprintf(__("You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized", "event_espresso")));
         }
         //if the child didn't specify a default button, use the credit card one
         if ($this->_default_button_url === NULL) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods' . DS . 'pay-by-credit-card.png';
+            $this->_default_button_url = EE_PLUGIN_DIR_URL.'payment_methods'.DS.'pay-by-credit-card.png';
         }
     }
 
@@ -149,7 +149,7 @@ 
     {
         $reflector = new ReflectionClass(get_class($this));
         $fn = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . DS;
+        $this->_file_folder = dirname($fn).DS;
     }
 
 
@@ -180,7 +180,7 @@ 
      */
     public function file_folder()
     {
-        if (!$this->_file_folder) {
+        if ( ! $this->_file_folder) {
             $this->_set_file_folder();
         }
         return $this->_file_folder;
@@ -192,7 +192,7 @@ 
      */
     public function file_url()
     {
-        if (!$this->_file_url) {
+        if ( ! $this->_file_url) {
             $this->_set_file_url();
         }
         return $this->_file_url;
@@ -224,7 +224,7 @@ 
      */
     function settings_form()
     {
-        if (!$this->_settings_form) {
+        if ( ! $this->_settings_form) {
             $this->_settings_form = $this->generate_new_settings_form();
             $this->_settings_form->set_payment_method_type($this);
             //if we have already assigned a model object to this pmt, make
@@ -276,7 +276,7 @@ 
     public function billing_form(EE_Transaction $transaction = NULL, $extra_args = array())
     {
         // has billing form already been regenerated ? or overwrite cache?
-        if (!$this->_billing_form instanceof EE_Billing_Info_Form || !$this->_cache_billing_form) {
+        if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
             $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
         }
         //if we know who the attendee is, and this is a billing form
@@ -371,7 +371,7 @@ 
             $payment = EEM_Payment::instance()->get_one(array($duplicate_properties));
             //if we didn't already have a payment in progress for the same thing,
             //then we actually want to make a new payment
-            if (!$payment instanceof EE_Payment) {
+            if ( ! $payment instanceof EE_Payment) {
                 $payment = EE_Payment::new_instance(
                     array_merge(
                         $duplicate_properties,
@@ -472,7 +472,7 @@ 
     public function handle_ipn($req_data, $transaction)
     {
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (!$this->_gateway instanceof EE_Offsite_Gateway) {
+        if ( ! $this->_gateway instanceof EE_Offsite_Gateway) {
             throw new EE_Error(sprintf(__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"), print_r($this->_gateway, TRUE)));
 
         }
@@ -490,17 +490,17 @@ 
      */
     protected function _save_billing_info_to_attendee($billing_form, $transaction)
     {
-        if (!$transaction || !$transaction instanceof EE_Transaction) {
+        if ( ! $transaction || ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(__("Cannot save billing info because no transaction was specified", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $primary_reg = $transaction->primary_registration();
-        if (!$primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(__("Cannot save billing info because the transaction has no primary registration", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $attendee = $primary_reg->attendee();
-        if (!$attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(__("Cannot save billing info because the transaction's primary registration has no attendee!", "event_espresso"), __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
@@ -600,7 +600,7 @@ 
      */
     public function payment_occurs()
     {
-        if (!$this->_gateway) {
+        if ( ! $this->_gateway) {
             return EE_PMT_Base::offline;
         } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
             return EE_PMT_Base::onsite;
@@ -621,7 +621,7 @@ 
      */
     public function payment_overview_content(EE_Payment $payment)
     {
-        return EEH_Template::display_template(EE_LIBRARIES . 'payment_methods' . DS . 'templates' . DS . 'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
+        return EEH_Template::display_template(EE_LIBRARIES.'payment_methods'.DS.'templates'.DS.'payment_details_content.template.php', array('payment_method' => $this->_pm_instance, 'payment' => $payment), true);
     }
 
 
@@ -696,7 +696,7 @@ 
      */
     public function get_help_tab_name()
     {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+        return 'ee_'.strtolower($this->system_name()).'_help_tab';
     }
 
     /**
@@ -706,7 +706,7 @@ 
      */
     public function cap_name()
     {
-        return 'ee_payment_method_' . strtolower($this->system_name());
+        return 'ee_payment_method_'.strtolower($this->system_name());
     }
 
     /**
@@ -737,7 +737,7 @@ 
      */
     public function introductory_html()
     {
-        return EEH_Template::locate_template($this->file_folder() . 'templates' . DS . strtolower($this->system_name()) . '_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
+        return EEH_Template::locate_template($this->file_folder().'templates'.DS.strtolower($this->system_name()).'_intro.template.php', array('pmt_obj' => $this, 'pm_instance' => $this->_pm_instance));
     }
 
 

core/helpers/EEH_Money.helper.php

Indentation +200 added lines, -200 removed lines

@@ -15,214 +15,214 @@
 class EEH_Money extends EEH_Base
 {
 
-    /**
-     * This removes all localized money formatting from the incoming value
-     * Note: uses this site's currency settings for deciding what is considered a
-     * "thousands separator" (usually the character "," )
-     * and what is a "decimal mark" (usually the character ".")
-     *
-     * @param int|float|string $money_value
-     * @param string           $CNT_ISO
-     * @return float
-     * @throws EE_Error
-     */
-    public static function strip_localized_money_formatting($money_value, $CNT_ISO = '')
-    {
-        $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        $money_value     = str_replace(
-            array(
-                $currency_config->thsnds,
-                $currency_config->dec_mrk,
-            ),
-            array(
-                '', // remove thousands separator
-                '.', // convert decimal mark to what PHP expects
-            ),
-            $money_value
-        );
-        $money_value     = filter_var(
-            $money_value,
-            FILTER_SANITIZE_NUMBER_FLOAT,
-            FILTER_FLAG_ALLOW_FRACTION
-        );
-        return $money_value;
-    }
+	/**
+	 * This removes all localized money formatting from the incoming value
+	 * Note: uses this site's currency settings for deciding what is considered a
+	 * "thousands separator" (usually the character "," )
+	 * and what is a "decimal mark" (usually the character ".")
+	 *
+	 * @param int|float|string $money_value
+	 * @param string           $CNT_ISO
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public static function strip_localized_money_formatting($money_value, $CNT_ISO = '')
+	{
+		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		$money_value     = str_replace(
+			array(
+				$currency_config->thsnds,
+				$currency_config->dec_mrk,
+			),
+			array(
+				'', // remove thousands separator
+				'.', // convert decimal mark to what PHP expects
+			),
+			$money_value
+		);
+		$money_value     = filter_var(
+			$money_value,
+			FILTER_SANITIZE_NUMBER_FLOAT,
+			FILTER_FLAG_ALLOW_FRACTION
+		);
+		return $money_value;
+	}
 
 
-    /**
-     * This converts an incoming localized money value into a standard float item (to three decimal places)
-     * Only use this if you know the $money_value follows your currency configuration's
-     * settings. Note: this uses this site's currency settings for deciding what is considered a
-     * "thousands separator" (usually the character "," )
-     * and what is a "decimal mark" (usually the character ".")
-     *
-     * @param int|string $money_value
-     * @return float
-     * @throws EE_Error
-     */
-    public static function convert_to_float_from_localized_money($money_value)
-    {
-        //float it! and round to three decimal places
-        return round((float) EEH_Money::strip_localized_money_formatting($money_value), 3);
-    }
+	/**
+	 * This converts an incoming localized money value into a standard float item (to three decimal places)
+	 * Only use this if you know the $money_value follows your currency configuration's
+	 * settings. Note: this uses this site's currency settings for deciding what is considered a
+	 * "thousands separator" (usually the character "," )
+	 * and what is a "decimal mark" (usually the character ".")
+	 *
+	 * @param int|string $money_value
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public static function convert_to_float_from_localized_money($money_value)
+	{
+		//float it! and round to three decimal places
+		return round((float) EEH_Money::strip_localized_money_formatting($money_value), 3);
+	}
 
 
-    /**
-     * For comparing floats. Default operator is '=', but see the $operator below for all options.
-     * This should be used to compare floats instead of normal '==' because floats
-     * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
-     * but actually differ by 0.00000001.
-     *
-     * @see http://biostall.com/php-function-to-compare-floating-point-numbers
-     * @param float  $float1
-     * @param float  $float2
-     * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
-     * @return bool whether the equation is true or false
-     * @throws EE_Error
-     */
-    public static function compare_floats($float1, $float2, $operator = '=')
-    {
-        // Check numbers to 5 digits of precision
-        $epsilon = 0.00001;
-        $float1 = (float) $float1;
-        $float2 = (float) $float2;
-        switch ($operator) {
-            // equal
-            case "=":
-            case "==":
-            case "===":
-            case "eq":
-                if (abs($float1 - $float2) < $epsilon) {
-                    return true;
-                }
-                break;
-            // less than
-            case "<":
-            case "lt":
-                if (abs($float1 - $float2) < $epsilon) {
-                    return false;
-                } else {
-                    if ($float1 < $float2) {
-                        return true;
-                    }
-                }
-                break;
-            // less than or equal
-            case "<=":
-            case "lte":
-                if (self::compare_floats($float1, $float2, '<') || self::compare_floats($float1, $float2, '=')) {
-                    return true;
-                }
-                break;
-            // greater than
-            case ">":
-            case "gt":
-                if (abs($float1 - $float2) < $epsilon) {
-                    return false;
-                } else {
-                    if ($float1 > $float2) {
-                        return true;
-                    }
-                }
-                break;
-            // greater than or equal
-            case ">=":
-            case "gte":
-                if (self::compare_floats($float1, $float2, '>') || self::compare_floats($float1, $float2, '=')) {
-                    return true;
-                }
-                break;
-            case "<>":
-            case "!=":
-            case "ne":
-                if (abs($float1 - $float2) > $epsilon) {
-                    return true;
-                }
-                break;
-            default:
-                throw new EE_Error(__("Unknown operator '" . $operator . "' in EEH_Money::compare_floats()",
-                    'event_espresso'));
-        }
-        return false;
-    }
+	/**
+	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
+	 * This should be used to compare floats instead of normal '==' because floats
+	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
+	 * but actually differ by 0.00000001.
+	 *
+	 * @see http://biostall.com/php-function-to-compare-floating-point-numbers
+	 * @param float  $float1
+	 * @param float  $float2
+	 * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
+	 * @return bool whether the equation is true or false
+	 * @throws EE_Error
+	 */
+	public static function compare_floats($float1, $float2, $operator = '=')
+	{
+		// Check numbers to 5 digits of precision
+		$epsilon = 0.00001;
+		$float1 = (float) $float1;
+		$float2 = (float) $float2;
+		switch ($operator) {
+			// equal
+			case "=":
+			case "==":
+			case "===":
+			case "eq":
+				if (abs($float1 - $float2) < $epsilon) {
+					return true;
+				}
+				break;
+			// less than
+			case "<":
+			case "lt":
+				if (abs($float1 - $float2) < $epsilon) {
+					return false;
+				} else {
+					if ($float1 < $float2) {
+						return true;
+					}
+				}
+				break;
+			// less than or equal
+			case "<=":
+			case "lte":
+				if (self::compare_floats($float1, $float2, '<') || self::compare_floats($float1, $float2, '=')) {
+					return true;
+				}
+				break;
+			// greater than
+			case ">":
+			case "gt":
+				if (abs($float1 - $float2) < $epsilon) {
+					return false;
+				} else {
+					if ($float1 > $float2) {
+						return true;
+					}
+				}
+				break;
+			// greater than or equal
+			case ">=":
+			case "gte":
+				if (self::compare_floats($float1, $float2, '>') || self::compare_floats($float1, $float2, '=')) {
+					return true;
+				}
+				break;
+			case "<>":
+			case "!=":
+			case "ne":
+				if (abs($float1 - $float2) > $epsilon) {
+					return true;
+				}
+				break;
+			default:
+				throw new EE_Error(__("Unknown operator '" . $operator . "' in EEH_Money::compare_floats()",
+					'event_espresso'));
+		}
+		return false;
+	}
 
 
-    /**
-     * This returns a localized format string suitable for jQplot.
-     *
-     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
-     *                         Otherwise will use currency settings for current active country on site.
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_format_for_jqplot($CNT_ISO = '')
-    {
-        //default format
-        $format          = 'f';
-        $currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        //first get the decimal place and number of places
-        $format = "%'." . $currency_config->dec_plc . $format;
-        //currency symbol on right side.
-        $format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
-        return $format;
-    }
+	/**
+	 * This returns a localized format string suitable for jQplot.
+	 *
+	 * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
+	 *                         Otherwise will use currency settings for current active country on site.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_format_for_jqplot($CNT_ISO = '')
+	{
+		//default format
+		$format          = 'f';
+		$currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		//first get the decimal place and number of places
+		$format = "%'." . $currency_config->dec_plc . $format;
+		//currency symbol on right side.
+		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
+		return $format;
+	}
 
 
-    /**
-     * This returns a localized format string suitable for usage with the Google Charts API format param.
-     *
-     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
-     *                         Otherwise will use currency settings for current active country on site.
-     *                         Note: GoogleCharts uses ICU pattern set
-     *                         (@see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_format_for_google_charts($CNT_ISO = '')
-    {
-        $currency_config            = EEH_Money::get_currency_config($CNT_ISO);
-        $decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
-        //first get the decimal place and number of places
-        $format = '#,##0.' . $decimal_places_placeholder;
-        //currency symbol on right side.
-        $format          = $currency_config->sign_b4
-            ? $currency_config->sign . $format
-            : $format
-              . $currency_config->sign;
-        $formatterObject = array(
-            'decimalSymbol'  => $currency_config->dec_mrk,
-            'groupingSymbol' => $currency_config->thsnds,
-            'fractionDigits' => $currency_config->dec_plc,
-        );
-        if ($currency_config->sign_b4) {
-            $formatterObject['prefix'] = $currency_config->sign;
-        } else {
-            $formatterObject['suffix'] = $currency_config->sign;
-        }
-        return array(
-            'format'          => $format,
-            'formatterObject' => $formatterObject,
-        );
-    }
+	/**
+	 * This returns a localized format string suitable for usage with the Google Charts API format param.
+	 *
+	 * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
+	 *                         Otherwise will use currency settings for current active country on site.
+	 *                         Note: GoogleCharts uses ICU pattern set
+	 *                         (@see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_format_for_google_charts($CNT_ISO = '')
+	{
+		$currency_config            = EEH_Money::get_currency_config($CNT_ISO);
+		$decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
+		//first get the decimal place and number of places
+		$format = '#,##0.' . $decimal_places_placeholder;
+		//currency symbol on right side.
+		$format          = $currency_config->sign_b4
+			? $currency_config->sign . $format
+			: $format
+			  . $currency_config->sign;
+		$formatterObject = array(
+			'decimalSymbol'  => $currency_config->dec_mrk,
+			'groupingSymbol' => $currency_config->thsnds,
+			'fractionDigits' => $currency_config->dec_plc,
+		);
+		if ($currency_config->sign_b4) {
+			$formatterObject['prefix'] = $currency_config->sign;
+		} else {
+			$formatterObject['suffix'] = $currency_config->sign;
+		}
+		return array(
+			'format'          => $format,
+			'formatterObject' => $formatterObject,
+		);
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @return EE_Currency_Config|null
-     * @throws EE_Error
-     */
-    public static function get_currency_config($CNT_ISO = '')
-    {
-        //if CNT_ISO passed lets try to get currency settings for it.
-        $currency_config = $CNT_ISO !== ''
-            ? new EE_Currency_Config($CNT_ISO)
-            : null;
-        //default currency settings for site if not set
-        if (! $currency_config instanceof EE_Currency_Config) {
-            $currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                ? EE_Registry::instance()->CFG->currency
-                : new EE_Currency_Config();
-        }
-        return $currency_config;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @return EE_Currency_Config|null
+	 * @throws EE_Error
+	 */
+	public static function get_currency_config($CNT_ISO = '')
+	{
+		//if CNT_ISO passed lets try to get currency settings for it.
+		$currency_config = $CNT_ISO !== ''
+			? new EE_Currency_Config($CNT_ISO)
+			: null;
+		//default currency settings for site if not set
+		if (! $currency_config instanceof EE_Currency_Config) {
+			$currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+				? EE_Registry::instance()->CFG->currency
+				: new EE_Currency_Config();
+		}
+		return $currency_config;
+	}
 } //end class EEH_Money

Spacing +8 added lines, -8 removed lines

@@ -40,7 +40,7 @@ 
             ),
             $money_value
         );
-        $money_value     = filter_var(
+        $money_value = filter_var(
             $money_value,
             FILTER_SANITIZE_NUMBER_FLOAT,
             FILTER_FLAG_ALLOW_FRACTION
@@ -140,7 +140,7 @@ 
                 }
                 break;
             default:
-                throw new EE_Error(__("Unknown operator '" . $operator . "' in EEH_Money::compare_floats()",
+                throw new EE_Error(__("Unknown operator '".$operator."' in EEH_Money::compare_floats()",
                     'event_espresso'));
         }
         return false;
@@ -161,9 +161,9 @@ 
         $format          = 'f';
         $currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
         //first get the decimal place and number of places
-        $format = "%'." . $currency_config->dec_plc . $format;
+        $format = "%'.".$currency_config->dec_plc.$format;
         //currency symbol on right side.
-        $format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
+        $format = $currency_config->sign_b4 ? $currency_config->sign.$format : $format.$currency_config->sign;
         return $format;
     }
 
@@ -183,10 +183,10 @@ 
         $currency_config            = EEH_Money::get_currency_config($CNT_ISO);
         $decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
         //first get the decimal place and number of places
-        $format = '#,##0.' . $decimal_places_placeholder;
+        $format = '#,##0.'.$decimal_places_placeholder;
         //currency symbol on right side.
-        $format          = $currency_config->sign_b4
-            ? $currency_config->sign . $format
+        $format = $currency_config->sign_b4
+            ? $currency_config->sign.$format
             : $format
               . $currency_config->sign;
         $formatterObject = array(
@@ -218,7 +218,7 @@ 
             ? new EE_Currency_Config($CNT_ISO)
             : null;
         //default currency settings for site if not set
-        if (! $currency_config instanceof EE_Currency_Config) {
+        if ( ! $currency_config instanceof EE_Currency_Config) {
             $currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                 ? EE_Registry::instance()->CFG->currency
                 : new EE_Currency_Config();

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Indentation +969 added lines, -969 removed lines

@@ -3,7 +3,7 @@ 
 use EventEspresso\core\exceptions\UnexpectedEntityException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,975 +22,975 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // release tickets for expired carts
-        add_action(
-            'EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
-            1
-        );
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter(
-            'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20,
-            3
-        );
-        // add notices for sold out tickets
-        add_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-        // handle ticket quantities adjusted in cart
-        //add_action(
-        //	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
-        //	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
-        //	10, 2
-        //);
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10,
-            2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10,
-            1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10,
-            1
-        );
-    }
-
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** PRE_TICKET_SALES  **********************************/
-
-
-
-    /**
-     * Retrieves grand totals from the line items that have no TXN ID
-     * and timestamps less than the current time minus the session lifespan.
-     * These are carts that have been abandoned before the "registrant" even attempted to checkout.
-     * We're going to release the tickets for these line items before attempting to add more to the cart.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function release_tickets_for_expired_carts()
-    {
-        do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
-        $expired_ticket_IDs      = array();
-        $valid_ticket_line_items = array();
-        $total_line_items        = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
-        if (empty($total_line_items)) {
-            do_action(
-                'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
-                $total_line_items,
-                $valid_ticket_line_items,
-                $expired_ticket_IDs
-            );
-            return;
-        }
-        $expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
-        foreach ($total_line_items as $total_line_item) {
-            /** @var EE_Line_Item $total_line_item */
-            $ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if (! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                if ($total_line_item->timestamp(true) <= $expired) {
-                    $expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
-                } else {
-                    $valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
-                }
-            }
-        }
-        if (! empty($expired_ticket_IDs)) {
-            EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-                \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
-                $valid_ticket_line_items
-            );
-            // let's get rid of expired line items so that they can't interfere with tracking
-            add_action(
-                'shutdown',
-                array('EED_Ticket_Sales_Monitor', 'clear_expired_line_items_with_no_transaction'),
-                999
-            );
-        }
-        do_action(
-            'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
-            $total_line_items,
-            $valid_ticket_line_items,
-            $expired_ticket_IDs
-        );
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-
-    /**
-     * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @param int       $qty
-     * @param EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
-            echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-
-    /**
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @param   EE_Ticket $ticket
-     * @param int         $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if (! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo '<br /> . . . ticket->qty: ' . $ticket->qty();
-            echo '<br /> . . . ticket->sold: ' . $ticket->sold();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-            echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo '<br /> . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /> . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo '<br /> . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        $this->_reserve_ticket($ticket, $qty);
-        return $qty;
-    }
-
-
-
-    /**
-     * increments ticket reserved based on quantity passed
-     *
-     * @param    EE_Ticket $ticket
-     * @param int          $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
-        }
-        $ticket->increase_reserved($quantity);
-        return $ticket->save();
-    }
-
-
-
-    /**
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /> . . . ticket->ID: ' . $ticket->ID();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->decrease_reserved($quantity);
-        if (self::debug) {
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-
-    /**
-     * removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     * adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     * builds string out of ticket and event name
-     *
-     * @param    EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-
-    /**
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-
-    /**
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _post_notices()
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg    = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg    = __(
-                'Please refresh the page to view updated ticket quantities.',
-                'event_espresso'
-            );
-            $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
-        }
-        if (! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        __(
-                            'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if (! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        __(
-                            'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-
-    /**
-     * releases reserved tickets for all registrations of an EE_Transaction
-     * by default, will NOT release tickets for finalized transactions
-     *
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . transaction->ID: ' . $transaction->ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__,
-                __FUNCTION__,
-                __LINE__,
-                array('finalized' => $finalized),
-                false,
-                'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo '<br /> . . . finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        // if the session is getting cleared BEFORE the TXN has been finalized
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // let's cancel any reserved tickets
-            $registrations = $transaction->registrations();
-            if (! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        $count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
-                    }
-                }
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * releases reserved tickets for an EE_Registration
-     * by default, will NOT release tickets for APPROVED registrations
-     *
-     * @param    EE_Registration $registration
-     * @param    EE_Transaction  $transaction
-     * @return    int
-     * @throws    EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . registration->ID: ' . $registration->ID();
-            echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
-            echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (
-            // release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            $ticket = $registration->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                return $this->_release_reserved_ticket($ticket);
-            }
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @param    EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo '<br /><br /> cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
-        } else {
-            if (self::debug) {
-                echo '<br /><br /> invalid EE_Cart: ';
-                var_export($cart, true);
-            }
-        }
-    }
-
-
-
-    /**
-     * releases reserved tickets in the EE_Cart
-     *
-     * @param    EE_Cart $cart
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function _session_cart_reset(EE_Cart $cart)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo '<br /> . . ticket->ID(): ' . $ticket->ID();
-                        echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo '<br /><br /> RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @param    EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-
-    /**
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @param    EE_Checkout $checkout
-     * @return void
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-
-    /**
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     * by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @param    EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__,
-                    __FUNCTION__,
-                    __LINE__,
-                    array($transaction),
-                    false,
-                    'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__,
-                        __FUNCTION__,
-                        __LINE__,
-                        array($payment),
-                        false,
-                        'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @param    EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-    /**
-     * Resets all ticket and datetime reserved counts to zero
-     * Tickets that are currently associated with a Transaction that is in progress
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \InvalidArgumentException
-     */
-    public static function reset_reservation_counts()
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets   = array();
-        $transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
-        foreach ($transactions_in_progress as $transaction_in_progress) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            /** @var EE_Transaction $transaction_in_progress */
-            $total_line_item = $transaction_in_progress->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__(
-                        'Transaction does not have a valid Total Line Item associated with it.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            EEM_Ticket::instance()->get_tickets_with_reservations(),
-            $valid_reserved_tickets
-        );
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item[]
-     */
-    private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items      = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
-
-
-
-    /**
-     * @param EE_Ticket[]    $tickets_with_reservations
-     * @param EE_Line_Item[] $valid_reserved_ticket_line_items
-     * @return int
-     * @throws \EE_Error
-     */
-    private static function release_reservations_for_tickets(
-        array $tickets_with_reservations,
-        $valid_reserved_ticket_line_items = array()
-    ) {
-        $total_tickets_released = 0;
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            $reserved_qty = $ticket_with_reservations->reserved();
-            foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
-                if (
-                    $valid_reserved_ticket_line_item instanceof EE_Line_Item
-                    && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
-                }
-            }
-            if ($reserved_qty > 0) {
-                $ticket_with_reservations->decrease_reserved($reserved_qty);
-                $ticket_with_reservations->save();
-                $total_tickets_released += $reserved_qty;
-            }
-        }
-        return $total_tickets_released;
-    }
-
-
-
-    /********************************** SHUTDOWN  **********************************/
-
-
-
-    /**
-     * @return false|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function clear_expired_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+	const debug = false;    //	true false
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// release tickets for expired carts
+		add_action(
+			'EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
+			1
+		);
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter(
+			'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20,
+			3
+		);
+		// add notices for sold out tickets
+		add_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+		// handle ticket quantities adjusted in cart
+		//add_action(
+		//	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
+		//	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
+		//	10, 2
+		//);
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10,
+			2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10,
+			1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10,
+			1
+		);
+	}
+
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** PRE_TICKET_SALES  **********************************/
+
+
+
+	/**
+	 * Retrieves grand totals from the line items that have no TXN ID
+	 * and timestamps less than the current time minus the session lifespan.
+	 * These are carts that have been abandoned before the "registrant" even attempted to checkout.
+	 * We're going to release the tickets for these line items before attempting to add more to the cart.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function release_tickets_for_expired_carts()
+	{
+		do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
+		$expired_ticket_IDs      = array();
+		$valid_ticket_line_items = array();
+		$total_line_items        = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
+		if (empty($total_line_items)) {
+			do_action(
+				'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
+				$total_line_items,
+				$valid_ticket_line_items,
+				$expired_ticket_IDs
+			);
+			return;
+		}
+		$expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
+		foreach ($total_line_items as $total_line_item) {
+			/** @var EE_Line_Item $total_line_item */
+			$ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if (! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				if ($total_line_item->timestamp(true) <= $expired) {
+					$expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
+				} else {
+					$valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
+				}
+			}
+		}
+		if (! empty($expired_ticket_IDs)) {
+			EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+				\EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
+				$valid_ticket_line_items
+			);
+			// let's get rid of expired line items so that they can't interfere with tracking
+			add_action(
+				'shutdown',
+				array('EED_Ticket_Sales_Monitor', 'clear_expired_line_items_with_no_transaction'),
+				999
+			);
+		}
+		do_action(
+			'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
+			$total_line_items,
+			$valid_ticket_line_items,
+			$expired_ticket_IDs
+		);
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+
+	/**
+	 * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @param int       $qty
+	 * @param EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
+			echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+
+	/**
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @param   EE_Ticket $ticket
+	 * @param int         $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if (! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo '<br /> . . . ticket->qty: ' . $ticket->qty();
+			echo '<br /> . . . ticket->sold: ' . $ticket->sold();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+			echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo '<br /> . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /> . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo '<br /> . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		$this->_reserve_ticket($ticket, $qty);
+		return $qty;
+	}
+
+
+
+	/**
+	 * increments ticket reserved based on quantity passed
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @param int          $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
+		}
+		$ticket->increase_reserved($quantity);
+		return $ticket->save();
+	}
+
+
+
+	/**
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /> . . . ticket->ID: ' . $ticket->ID();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->decrease_reserved($quantity);
+		if (self::debug) {
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+
+	/**
+	 * removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 * adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 * builds string out of ticket and event name
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+
+	/**
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+
+	/**
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _post_notices()
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg    = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg    = __(
+				'Please refresh the page to view updated ticket quantities.',
+				'event_espresso'
+			);
+			$none_added_msg = __('No tickets were added for the event.', 'event_espresso');
+		}
+		if (! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						__(
+							'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if (! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						__(
+							'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+
+	/**
+	 * releases reserved tickets for all registrations of an EE_Transaction
+	 * by default, will NOT release tickets for finalized transactions
+	 *
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . transaction->ID: ' . $transaction->ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__,
+				__FUNCTION__,
+				__LINE__,
+				array('finalized' => $finalized),
+				false,
+				'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo '<br /> . . . finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		// if the session is getting cleared BEFORE the TXN has been finalized
+		if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// let's cancel any reserved tickets
+			$registrations = $transaction->registrations();
+			if (! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if ($registration instanceof EE_Registration) {
+						$count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
+					}
+				}
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * releases reserved tickets for an EE_Registration
+	 * by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @param    EE_Registration $registration
+	 * @param    EE_Transaction  $transaction
+	 * @return    int
+	 * @throws    EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . registration->ID: ' . $registration->ID();
+			echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
+			echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (
+			// release Tickets for Failed Transactions and Abandoned Transactions
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			$ticket = $registration->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				return $this->_release_reserved_ticket($ticket);
+			}
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @param    EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo '<br /><br /> cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
+		} else {
+			if (self::debug) {
+				echo '<br /><br /> invalid EE_Cart: ';
+				var_export($cart, true);
+			}
+		}
+	}
+
+
+
+	/**
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @param    EE_Cart $cart
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function _session_cart_reset(EE_Cart $cart)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo '<br /> . . ticket->ID(): ' . $ticket->ID();
+						echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo '<br /><br /> RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @param    EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+
+	/**
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @param    EE_Checkout $checkout
+	 * @return void
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+
+	/**
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 * by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @param    EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__,
+					__FUNCTION__,
+					__LINE__,
+					array($transaction),
+					false,
+					'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__,
+						__FUNCTION__,
+						__LINE__,
+						array($payment),
+						false,
+						'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @param    EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+	/**
+	 * Resets all ticket and datetime reserved counts to zero
+	 * Tickets that are currently associated with a Transaction that is in progress
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \InvalidArgumentException
+	 */
+	public static function reset_reservation_counts()
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets   = array();
+		$transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
+		foreach ($transactions_in_progress as $transaction_in_progress) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			/** @var EE_Transaction $transaction_in_progress */
+			$total_line_item = $transaction_in_progress->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__(
+						'Transaction does not have a valid Total Line Item associated with it.',
+						'event_espresso'
+					)
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			EEM_Ticket::instance()->get_tickets_with_reservations(),
+			$valid_reserved_tickets
+		);
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item[]
+	 */
+	private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items      = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
+
+
+
+	/**
+	 * @param EE_Ticket[]    $tickets_with_reservations
+	 * @param EE_Line_Item[] $valid_reserved_ticket_line_items
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private static function release_reservations_for_tickets(
+		array $tickets_with_reservations,
+		$valid_reserved_ticket_line_items = array()
+	) {
+		$total_tickets_released = 0;
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			$reserved_qty = $ticket_with_reservations->reserved();
+			foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
+				if (
+					$valid_reserved_ticket_line_item instanceof EE_Line_Item
+					&& $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					$reserved_qty -= $valid_reserved_ticket_line_item->quantity();
+				}
+			}
+			if ($reserved_qty > 0) {
+				$ticket_with_reservations->decrease_reserved($reserved_qty);
+				$ticket_with_reservations->save();
+				$total_tickets_released += $reserved_qty;
+			}
+		}
+		return $total_tickets_released;
+	}
+
+
+
+	/********************************** SHUTDOWN  **********************************/
+
+
+
+	/**
+	 * @return false|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function clear_expired_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
-                // use GMT time because that's what LIN_timestamps are in
-                date('Y-m-d H:i:s', time() - EE_Registry::instance()->SSN->lifespan())
-            )
-        );
-    }
+				// use GMT time because that's what LIN_timestamps are in
+				date('Y-m-d H:i:s', time() - EE_Registry::instance()->SSN->lifespan())
+			)
+		);
+	}
 
 }
 // End of file EED_Ticket_Sales_Monitor.module.php

modules/ticket_selector/ProcessTicketSelector.php

Doc Comments +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * cancelTicketSelections
      *
-     * @return        string
+     * @return        false|null
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -113,7 +113,7 @@ 
     /**
      * process_ticket_selections
      *
-     * @return array|bool
+     * @return boolean|null
      * @throws \ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -287,7 +287,7 @@ 
      * validate_post_data
      *
      * @param int $id
-     * @return array|FALSE
+     * @return string
      * @throws \ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -410,7 +410,7 @@ 
      *
      * @param EE_Ticket $ticket
      * @param int        $qty
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException

Indentation +569 added lines, -569 removed lines

@@ -13,7 +13,7 @@ 
 use InvalidArgumentException;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -30,592 +30,592 @@ 
 class ProcessTicketSelector
 {
 
-    /**
-     * array of datetimes and the spaces available for them
-     *
-     * @var array[][]
-     */
-    private static $_available_spaces = array();
+	/**
+	 * array of datetimes and the spaces available for them
+	 *
+	 * @var array[][]
+	 */
+	private static $_available_spaces = array();
 
 
-    /**
-     * cancelTicketSelections
-     *
-     * @return        string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
-            return false;
-        }
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        if (EE_Registry::instance()->REQ->is_set('event_id')) {
-            wp_safe_redirect(
-                EEH_Event_View::event_link_url(
-                    EE_Registry::instance()->REQ->get('event_id')
-                )
-            );
-        } else {
-            wp_safe_redirect(
-                site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
-            );
-        }
-        exit();
-    }
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return        string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+			return false;
+		}
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		if (EE_Registry::instance()->REQ->is_set('event_id')) {
+			wp_safe_redirect(
+				EEH_Event_View::event_link_url(
+					EE_Registry::instance()->REQ->get('event_id')
+				)
+			);
+		} else {
+			wp_safe_redirect(
+				site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+			);
+		}
+		exit();
+	}
 
 
-    /**
-     * processTicketSelectorNonce
-     *
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private function processTicketSelectorNonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (
-            ! is_admin()
-            && (
-                ! EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    EE_Registry::instance()->REQ->get($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private function processTicketSelectorNonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (
+			! is_admin()
+			&& (
+				! EE_Registry::instance()->REQ->is_set($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					EE_Registry::instance()->REQ->get($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * process_ticket_selections
-     *
-     * @return array|bool
-     * @throws \ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        // do we have an event id?
-        if (! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
-            // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        //if event id is valid
-        $id = absint(EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
-        //		d( \EE_Registry::instance()->REQ );
-        self::$_available_spaces = array(
-            'tickets'   => array(),
-            'datetimes' => array(),
-        );
-        //we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
-        // When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
-        EE_Registry::instance()->load_core('Session');
-        // unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        }
-        //d( \EE_Registry::instance()->SSN );
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // validate/sanitize data
-        $valid = $this->validatePostData($id);
-        //EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
-        //EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
-        //check total tickets ordered vs max number of attendees that can register
-        if ($valid['total_tickets'] > $valid['max_atndz']) {
-            // ordering too many tickets !!!
-            $total_tickets_string = _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            );
-            $limit_error_1        = sprintf($total_tickets_string, $valid['total_tickets']);
-            // dev only message
-            $max_atndz_string = _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            );
-            $limit_error_2    = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-        } else {
-            // all data appears to be valid
-            $tckts_slctd   = false;
-            $tickets_added = 0;
-            $valid         = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
-                $valid);
-            if ($valid['total_tickets'] > 0) {
-                // load cart
-                EE_Registry::instance()->load_core('Cart');
-                // cycle thru the number of data rows sent from the event listing
-                for ($x = 0; $x < $valid['rows']; $x++) {
-                    // does this row actually contain a ticket quantity?
-                    if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
-                        // YES we have a ticket quantity
-                        $tckts_slctd = true;
-                        //						d( $valid['ticket_obj'][$x] );
-                        if ($valid['ticket_obj'][ $x ] instanceof EE_Ticket) {
-                            // then add ticket to cart
-                            $tickets_added += $this->addTicketToCart(
-                                $valid['ticket_obj'][ $x ],
-                                $valid['qty'][ $x ]
-                            );
-                            if (EE_Error::has_error()) {
-                                break;
-                            }
-                        } else {
-                            // nothing added to cart retrieved
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                        'event_espresso'
-                                    ),
-                                    '<br/>'
-                                ),
-                                __FILE__, __FUNCTION__, __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-            do_action(
-                'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-                EE_Registry::instance()->CART,
-                $this
-            );
-            //d( \EE_Registry::instance()->CART );
-            //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-            if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
-                if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-                    do_action(
-                        'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                        EE_Registry::instance()->CART,
-                        $this
-                    );
-                    EE_Registry::instance()->CART->recalculate_all_cart_totals();
-                    EE_Registry::instance()->CART->save_cart(false);
-                    // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-                    // just return TRUE for registrations being made from admin
-                    if (is_admin()) {
-                        return true;
-                    }
-                    EE_Error::get_notices(false, true);
-                    wp_safe_redirect(
-                        apply_filters(
-                            'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                            EE_Registry::instance()->CFG->core->reg_page_url()
-                        )
-                    );
-                    exit();
-                } else {
-                    if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-                        // nothing added to cart
-                        EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
-                            __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-            } else {
-                // no ticket quantities were selected
-                EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
-                    'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        //die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if (is_admin()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            EE_Error::get_notices(false, true);
-            wp_safe_redirect($valid['return_url']);
-            exit();
-        } elseif (isset($event_to_add['id'])) {
-            EE_Error::get_notices(false, true);
-            wp_safe_redirect(get_permalink($event_to_add['id']));
-            exit();
-        } else {
-            echo EE_Error::get_notices();
-        }
-        return false;
-    }
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return array|bool
+	 * @throws \ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		// do we have an event id?
+		if (! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
+			// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+			EE_Error::add_error(
+				sprintf(
+					__(
+						'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		//if event id is valid
+		$id = absint(EE_Registry::instance()->REQ->get('tkt-slctr-event-id'));
+		//		d( \EE_Registry::instance()->REQ );
+		self::$_available_spaces = array(
+			'tickets'   => array(),
+			'datetimes' => array(),
+		);
+		//we should really only have 1 registration in the works now (ie, no MER) so clear any previous items in the cart.
+		// When MER happens this will probably need to be tweaked, possibly wrapped in a conditional checking for some constant defined in MER etc.
+		EE_Registry::instance()->load_core('Session');
+		// unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		}
+		//d( \EE_Registry::instance()->SSN );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// validate/sanitize data
+		$valid = $this->validatePostData($id);
+		//EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid, '$valid', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'total_tickets' ], 'total_tickets', __FILE__, __LINE__ );
+		//EEH_Debug_Tools::printr( $valid[ 'max_atndz' ], 'max_atndz', __FILE__, __LINE__ );
+		//check total tickets ordered vs max number of attendees that can register
+		if ($valid['total_tickets'] > $valid['max_atndz']) {
+			// ordering too many tickets !!!
+			$total_tickets_string = _n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			);
+			$limit_error_1        = sprintf($total_tickets_string, $valid['total_tickets']);
+			// dev only message
+			$max_atndz_string = _n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			);
+			$limit_error_2    = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
+			EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+		} else {
+			// all data appears to be valid
+			$tckts_slctd   = false;
+			$tickets_added = 0;
+			$valid         = apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
+				$valid);
+			if ($valid['total_tickets'] > 0) {
+				// load cart
+				EE_Registry::instance()->load_core('Cart');
+				// cycle thru the number of data rows sent from the event listing
+				for ($x = 0; $x < $valid['rows']; $x++) {
+					// does this row actually contain a ticket quantity?
+					if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+						// YES we have a ticket quantity
+						$tckts_slctd = true;
+						//						d( $valid['ticket_obj'][$x] );
+						if ($valid['ticket_obj'][ $x ] instanceof EE_Ticket) {
+							// then add ticket to cart
+							$tickets_added += $this->addTicketToCart(
+								$valid['ticket_obj'][ $x ],
+								$valid['qty'][ $x ]
+							);
+							if (EE_Error::has_error()) {
+								break;
+							}
+						} else {
+							// nothing added to cart retrieved
+							EE_Error::add_error(
+								sprintf(
+									__(
+										'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+										'event_espresso'
+									),
+									'<br/>'
+								),
+								__FILE__, __FUNCTION__, __LINE__
+							);
+						}
+					}
+				}
+			}
+			do_action(
+				'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+				EE_Registry::instance()->CART,
+				$this
+			);
+			//d( \EE_Registry::instance()->CART );
+			//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+			if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tckts_slctd)) {
+				if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+					do_action(
+						'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+						EE_Registry::instance()->CART,
+						$this
+					);
+					EE_Registry::instance()->CART->recalculate_all_cart_totals();
+					EE_Registry::instance()->CART->save_cart(false);
+					// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+					// just return TRUE for registrations being made from admin
+					if (is_admin()) {
+						return true;
+					}
+					EE_Error::get_notices(false, true);
+					wp_safe_redirect(
+						apply_filters(
+							'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+							EE_Registry::instance()->CFG->core->reg_page_url()
+						)
+					);
+					exit();
+				} else {
+					if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+						// nothing added to cart
+						EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
+							__FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+			} else {
+				// no ticket quantities were selected
+				EE_Error::add_error(__('You need to select a ticket quantity before you can proceed.',
+					'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		//die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if (is_admin()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			EE_Error::get_notices(false, true);
+			wp_safe_redirect($valid['return_url']);
+			exit();
+		} elseif (isset($event_to_add['id'])) {
+			EE_Error::get_notices(false, true);
+			wp_safe_redirect(get_permalink($event_to_add['id']));
+			exit();
+		} else {
+			echo EE_Error::get_notices();
+		}
+		return false;
+	}
 
 
-    /**
-     * validate_post_data
-     *
-     * @param int $id
-     * @return array|FALSE
-     * @throws \ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function validatePostData($id = 0)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $id) {
-            EE_Error::add_error(
-                __('The event id provided was not valid.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // start with an empty array()
-        $valid_data = array();
-        // grab valid id
-        $valid_data['id'] = $id;
-        // array of other form names
-        $inputs_to_clean = array(
-            'event_id'   => 'tkt-slctr-event-id',
-            'max_atndz'  => 'tkt-slctr-max-atndz-',
-            'rows'       => 'tkt-slctr-rows-',
-            'qty'        => 'tkt-slctr-qty-',
-            'ticket_id'  => 'tkt-slctr-ticket-id-',
-            'return_url' => 'tkt-slctr-return-url-',
-        );
-        // let's track the total number of tickets ordered.'
-        $valid_data['total_tickets'] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($inputs_to_clean as $what => $input_to_clean) {
-            // check for POST data
-            if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
-                // grab value
-                $input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
-                switch ($what) {
-                    // integers
-                    case 'event_id':
-                        $valid_data[ $what ] = absint($input_value);
-                        // get event via the event id we put in the form
-                        $valid_data['event'] = EE_Registry::instance()
-                                                           ->load_model('Event')
-                                                           ->get_one_by_ID($valid_data['event_id']);
-                        break;
-                    case 'rows':
-                    case 'max_atndz':
-                        $valid_data[ $what ] = absint($input_value);
-                        break;
-                    // arrays of integers
-                    case 'qty':
-                        /** @var array $row_qty */
-                        $row_qty = $input_value;
-                        // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
-                            // get number of rows
-                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
-                                : 1;
-                            // explode ints by the dash
-                            $row_qty = explode('-', $row_qty);
-                            $row     = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-                            $qty     = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-                            $row_qty = array($row => $qty);
-                            for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
-                                }
-                            }
-                        }
-                        ksort($row_qty);
-                        // cycle thru values
-                        foreach ($row_qty as $qty) {
-                            $qty = absint($qty);
-                            // sanitize as integers
-                            $valid_data[ $what ][]       = $qty;
-                            $valid_data['total_tickets'] += $qty;
-                        }
-                        break;
-                    // array of integers
-                    case 'ticket_id':
-                        $value_array = array();
-                        // cycle thru values
-                        foreach ((array) $input_value as $key => $value) {
-                            // allow only numbers, letters,  spaces, commas and dashes
-                            $value_array[ $key ] = wp_strip_all_tags($value);
-                            // get ticket via the ticket id we put in the form
-                            $ticket_obj                       = EE_Registry::instance()
-                                                                            ->load_model('Ticket')
-                                                                            ->get_one_by_ID($value);
-                            $valid_data['ticket_obj'][ $key ] = $ticket_obj;
-                        }
-                        $valid_data[ $what ] = $value_array;
-                        break;
-                    case 'return_url' :
-                        // grab and sanitize return-url
-                        $input_value = esc_url_raw($input_value);
-                        // was the request coming from an iframe ? if so, then:
-                        if (strpos($input_value, 'event_list=iframe')) {
-                            // get anchor fragment
-                            $input_value = explode('#', $input_value);
-                            $input_value = end($input_value);
-                            // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
-                        }
-                        $valid_data[ $what ] = $input_value;
-                        break;
-                }    // end switch $what
-            }
-        }    // end foreach $inputs_to_clean
-        return $valid_data;
-    }
+	/**
+	 * validate_post_data
+	 *
+	 * @param int $id
+	 * @return array|FALSE
+	 * @throws \ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function validatePostData($id = 0)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! $id) {
+			EE_Error::add_error(
+				__('The event id provided was not valid.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// start with an empty array()
+		$valid_data = array();
+		// grab valid id
+		$valid_data['id'] = $id;
+		// array of other form names
+		$inputs_to_clean = array(
+			'event_id'   => 'tkt-slctr-event-id',
+			'max_atndz'  => 'tkt-slctr-max-atndz-',
+			'rows'       => 'tkt-slctr-rows-',
+			'qty'        => 'tkt-slctr-qty-',
+			'ticket_id'  => 'tkt-slctr-ticket-id-',
+			'return_url' => 'tkt-slctr-return-url-',
+		);
+		// let's track the total number of tickets ordered.'
+		$valid_data['total_tickets'] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($inputs_to_clean as $what => $input_to_clean) {
+			// check for POST data
+			if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+				// grab value
+				$input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
+				switch ($what) {
+					// integers
+					case 'event_id':
+						$valid_data[ $what ] = absint($input_value);
+						// get event via the event id we put in the form
+						$valid_data['event'] = EE_Registry::instance()
+														   ->load_model('Event')
+														   ->get_one_by_ID($valid_data['event_id']);
+						break;
+					case 'rows':
+					case 'max_atndz':
+						$valid_data[ $what ] = absint($input_value);
+						break;
+					// arrays of integers
+					case 'qty':
+						/** @var array $row_qty */
+						$row_qty = $input_value;
+						// if qty is coming from a radio button input, then we need to assemble an array of rows
+						if (! is_array($row_qty)) {
+							// get number of rows
+							$rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
+								? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+								: 1;
+							// explode ints by the dash
+							$row_qty = explode('-', $row_qty);
+							$row     = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+							$qty     = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+							$row_qty = array($row => $qty);
+							for ($x = 1; $x <= $rows; $x++) {
+								if (! isset($row_qty[ $x ])) {
+									$row_qty[ $x ] = 0;
+								}
+							}
+						}
+						ksort($row_qty);
+						// cycle thru values
+						foreach ($row_qty as $qty) {
+							$qty = absint($qty);
+							// sanitize as integers
+							$valid_data[ $what ][]       = $qty;
+							$valid_data['total_tickets'] += $qty;
+						}
+						break;
+					// array of integers
+					case 'ticket_id':
+						$value_array = array();
+						// cycle thru values
+						foreach ((array) $input_value as $key => $value) {
+							// allow only numbers, letters,  spaces, commas and dashes
+							$value_array[ $key ] = wp_strip_all_tags($value);
+							// get ticket via the ticket id we put in the form
+							$ticket_obj                       = EE_Registry::instance()
+																			->load_model('Ticket')
+																			->get_one_by_ID($value);
+							$valid_data['ticket_obj'][ $key ] = $ticket_obj;
+						}
+						$valid_data[ $what ] = $value_array;
+						break;
+					case 'return_url' :
+						// grab and sanitize return-url
+						$input_value = esc_url_raw($input_value);
+						// was the request coming from an iframe ? if so, then:
+						if (strpos($input_value, 'event_list=iframe')) {
+							// get anchor fragment
+							$input_value = explode('#', $input_value);
+							$input_value = end($input_value);
+							// use event list url instead, but append anchor
+							$input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+						}
+						$valid_data[ $what ] = $input_value;
+						break;
+				}    // end switch $what
+			}
+		}    // end foreach $inputs_to_clean
+		return $valid_data;
+	}
 
 
-    /**
-     * adds a ticket to the cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int        $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function addTicketToCart(EE_Ticket $ticket = null, $qty = 1)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (
-            ! apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if (EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
-                $this->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        // tickets can not be purchased but let's find the exact number left
-        // for the last ticket selected PRIOR to subtracting tickets
-        $available_spaces = $this->ticketDatetimeAvailability($ticket, true);
-        // greedy greedy greedy eh?
-        if ($available_spaces > 0) {
-            if (
-            apply_filters(
-                'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
-                true,
-                $ticket,
-                $qty,
-                $available_spaces
-            )
-            ) {
-                $this->displayAvailabilityError($available_spaces);
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        return false;
-    }
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int        $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function addTicketToCart(EE_Ticket $ticket = null, $qty = 1)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (
+			! apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if (EE_Registry::instance()->CART->add_ticket_to_cart($ticket, $qty)) {
+				$this->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		// tickets can not be purchased but let's find the exact number left
+		// for the last ticket selected PRIOR to subtracting tickets
+		$available_spaces = $this->ticketDatetimeAvailability($ticket, true);
+		// greedy greedy greedy eh?
+		if ($available_spaces > 0) {
+			if (
+			apply_filters(
+				'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
+				true,
+				$ticket,
+				$qty,
+				$available_spaces
+			)
+			) {
+				$this->displayAvailabilityError($available_spaces);
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		return false;
+	}
 
 
-    /**
-     * @param int $available_spaces
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function displayAvailabilityError($available_spaces = 1)
-    {
-        // add error messaging - we're using the _n function that will generate
-        // the appropriate singular or plural message based on the number of $available_spaces
-        if (EE_Registry::instance()->CART->all_ticket_quantity_count()) {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        } else {
-            $msg = sprintf(
-                _n(
-                    'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                    $available_spaces,
-                    'event_espresso'
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        }
-        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * @param int $available_spaces
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function displayAvailabilityError($available_spaces = 1)
+	{
+		// add error messaging - we're using the _n function that will generate
+		// the appropriate singular or plural message based on the number of $available_spaces
+		if (EE_Registry::instance()->CART->all_ticket_quantity_count()) {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		} else {
+			$msg = sprintf(
+				_n(
+					'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+					$available_spaces,
+					'event_espresso'
+				),
+				$available_spaces,
+				'<br />'
+			);
+		}
+		EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+	}
 
 
-    /**
-     * ticketDatetimeAvailability
-     * creates an array of tickets plus all of the datetimes available to each ticket
-     * and tracks the spaces remaining for each of those datetimes
-     *
-     * @param EE_Ticket $ticket - selected ticket
-     * @param bool      $get_original_ticket_spaces
-     * @return int
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
-    {
-        // if the $_available_spaces array has not been set up yet...
-        if (! isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
-            $this->setInitialTicketDatetimeAvailability($ticket);
-        }
-        $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // if we want the original datetime availability BEFORE we started subtracting tickets ?
-                if ($get_original_ticket_spaces) {
-                    // then grab the available spaces from the "tickets" array
-                    // and compare with the above to get the lowest number
-                    $available_spaces = min(
-                        $available_spaces,
-                        self::$_available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
-                    );
-                } else {
-                    // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][ $DTD_ID ]);
-                }
-            }
-        }
-        return $available_spaces;
-    }
+	/**
+	 * ticketDatetimeAvailability
+	 * creates an array of tickets plus all of the datetimes available to each ticket
+	 * and tracks the spaces remaining for each of those datetimes
+	 *
+	 * @param EE_Ticket $ticket - selected ticket
+	 * @param bool      $get_original_ticket_spaces
+	 * @return int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
+	{
+		// if the $_available_spaces array has not been set up yet...
+		if (! isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+			$this->setInitialTicketDatetimeAvailability($ticket);
+		}
+		$available_spaces = $ticket->qty() - $ticket->sold();
+		if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// if we want the original datetime availability BEFORE we started subtracting tickets ?
+				if ($get_original_ticket_spaces) {
+					// then grab the available spaces from the "tickets" array
+					// and compare with the above to get the lowest number
+					$available_spaces = min(
+						$available_spaces,
+						self::$_available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+					);
+				} else {
+					// we want the updated ticket availability as stored in the "datetimes" array
+					$available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][ $DTD_ID ]);
+				}
+			}
+		}
+		return $available_spaces;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
-    {
-        // first, get all of the datetimes that are available to this ticket
-        $datetimes = $ticket->get_many_related(
-            'Datetime',
-            array(
-                array(
-                    'DTT_EVT_end' => array(
-                        '>=',
-                        EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-                    ),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-        if (! empty($datetimes)) {
-            // now loop thru all of the datetimes
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    // the number of spaces available for the datetime without considering individual ticket quantities
-                    $spaces_remaining = $datetime->spaces_remaining();
-                    // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
-                    // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    self::$_available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
-                        $ticket->qty() - $ticket->sold(),
-                        $spaces_remaining
-                    );
-                    // if the remaining spaces for this datetime is already set,
-                    // then compare that against the datetime spaces remaining, and take the lowest number,
-                    // else just take the datetime spaces remaining, and assign to the datetimes array
-                    self::$_available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        self::$_available_spaces['datetimes'][ $datetime->ID() ]
-                    )
-                        ? min(self::$_available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
-                        : $spaces_remaining;
-                }
-            }
-        }
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
+	{
+		// first, get all of the datetimes that are available to this ticket
+		$datetimes = $ticket->get_many_related(
+			'Datetime',
+			array(
+				array(
+					'DTT_EVT_end' => array(
+						'>=',
+						EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+					),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+		if (! empty($datetimes)) {
+			// now loop thru all of the datetimes
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					// the number of spaces available for the datetime without considering individual ticket quantities
+					$spaces_remaining = $datetime->spaces_remaining();
+					// save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
+					// or the datetime spaces remaining) to this ticket using the datetime ID as the key
+					self::$_available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+						$ticket->qty() - $ticket->sold(),
+						$spaces_remaining
+					);
+					// if the remaining spaces for this datetime is already set,
+					// then compare that against the datetime spaces remaining, and take the lowest number,
+					// else just take the datetime spaces remaining, and assign to the datetimes array
+					self::$_available_spaces['datetimes'][ $datetime->ID() ] = isset(
+						self::$_available_spaces['datetimes'][ $datetime->ID() ]
+					)
+						? min(self::$_available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+						: $spaces_remaining;
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @param    EE_Ticket $ticket
-     * @param    int        $qty
-     * @return    void
-     * @throws EE_Error
-     */
-    private function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
-    {
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                self::$_available_spaces['datetimes'][ $DTD_ID ] -= $qty;
-            }
-        }
-    }
+	/**
+	 * @param    EE_Ticket $ticket
+	 * @param    int        $qty
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	private function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
+	{
+		if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
+				self::$_available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+			}
+		}
+	}
 }
 // End of file ProcessTicketSelector.php
 // Location: /ProcessTicketSelector.php

Spacing +41 added lines, -41 removed lines

@@ -12,7 +12,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use InvalidArgumentException;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -50,7 +50,7 @@ 
     public function cancelTicketSelections()
     {
         // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+        if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
             return false;
         }
         EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
@@ -62,7 +62,7 @@ 
             );
         } else {
             wp_safe_redirect(
-                site_url('/' . EE_Registry::instance()->CFG->core->event_cpt_slug . '/')
+                site_url('/'.EE_Registry::instance()->CFG->core->event_cpt_slug.'/')
             );
         }
         exit();
@@ -124,7 +124,7 @@ 
     {
         do_action('EED_Ticket_Selector__process_ticket_selections__before');
         // do we have an event id?
-        if (! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
+        if ( ! EE_Registry::instance()->REQ->is_set('tkt-slctr-event-id')) {
             // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
             EE_Error::add_error(
                 sprintf(
@@ -170,7 +170,7 @@ 
                 $valid['total_tickets'],
                 'event_espresso'
             );
-            $limit_error_1        = sprintf($total_tickets_string, $valid['total_tickets']);
+            $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
             // dev only message
             $max_atndz_string = _n(
                 'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
@@ -178,8 +178,8 @@ 
                 $valid['max_atndz'],
                 'event_espresso'
             );
-            $limit_error_2    = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
-            EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+            $limit_error_2 = sprintf($max_atndz_string, $valid['max_atndz'], $valid['max_atndz']);
+            EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
         } else {
             // all data appears to be valid
             $tckts_slctd   = false;
@@ -192,15 +192,15 @@ 
                 // cycle thru the number of data rows sent from the event listing
                 for ($x = 0; $x < $valid['rows']; $x++) {
                     // does this row actually contain a ticket quantity?
-                    if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+                    if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
                         // YES we have a ticket quantity
                         $tckts_slctd = true;
                         //						d( $valid['ticket_obj'][$x] );
-                        if ($valid['ticket_obj'][ $x ] instanceof EE_Ticket) {
+                        if ($valid['ticket_obj'][$x] instanceof EE_Ticket) {
                             // then add ticket to cart
                             $tickets_added += $this->addTicketToCart(
-                                $valid['ticket_obj'][ $x ],
-                                $valid['qty'][ $x ]
+                                $valid['ticket_obj'][$x],
+                                $valid['qty'][$x]
                             );
                             if (EE_Error::has_error()) {
                                 break;
@@ -251,7 +251,7 @@ 
                     );
                     exit();
                 } else {
-                    if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+                    if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
                         // nothing added to cart
                         EE_Error::add_attention(__('No tickets were added for the event', 'event_espresso'),
                             __FILE__, __FUNCTION__, __LINE__);
@@ -297,7 +297,7 @@ 
     private function validatePostData($id = 0)
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $id) {
+        if ( ! $id) {
             EE_Error::add_error(
                 __('The event id provided was not valid.', 'event_espresso'),
                 __FILE__,
@@ -324,13 +324,13 @@ 
         // cycle through $inputs_to_clean array
         foreach ($inputs_to_clean as $what => $input_to_clean) {
             // check for POST data
-            if (EE_Registry::instance()->REQ->is_set($input_to_clean . $id)) {
+            if (EE_Registry::instance()->REQ->is_set($input_to_clean.$id)) {
                 // grab value
-                $input_value = EE_Registry::instance()->REQ->get($input_to_clean . $id);
+                $input_value = EE_Registry::instance()->REQ->get($input_to_clean.$id);
                 switch ($what) {
                     // integers
                     case 'event_id':
-                        $valid_data[ $what ] = absint($input_value);
+                        $valid_data[$what] = absint($input_value);
                         // get event via the event id we put in the form
                         $valid_data['event'] = EE_Registry::instance()
                                                            ->load_model('Event')
@@ -338,17 +338,17 @@ 
                         break;
                     case 'rows':
                     case 'max_atndz':
-                        $valid_data[ $what ] = absint($input_value);
+                        $valid_data[$what] = absint($input_value);
                         break;
                     // arrays of integers
                     case 'qty':
                         /** @var array $row_qty */
                         $row_qty = $input_value;
                         // if qty is coming from a radio button input, then we need to assemble an array of rows
-                        if (! is_array($row_qty)) {
+                        if ( ! is_array($row_qty)) {
                             // get number of rows
-                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-' . $id)
-                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-' . $id))
+                            $rows = EE_Registry::instance()->REQ->is_set('tkt-slctr-rows-'.$id)
+                                ? absint(EE_Registry::instance()->REQ->get('tkt-slctr-rows-'.$id))
                                 : 1;
                             // explode ints by the dash
                             $row_qty = explode('-', $row_qty);
@@ -356,8 +356,8 @@ 
                             $qty     = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
                             $row_qty = array($row => $qty);
                             for ($x = 1; $x <= $rows; $x++) {
-                                if (! isset($row_qty[ $x ])) {
-                                    $row_qty[ $x ] = 0;
+                                if ( ! isset($row_qty[$x])) {
+                                    $row_qty[$x] = 0;
                                 }
                             }
                         }
@@ -366,7 +366,7 @@ 
                         foreach ($row_qty as $qty) {
                             $qty = absint($qty);
                             // sanitize as integers
-                            $valid_data[ $what ][]       = $qty;
+                            $valid_data[$what][] = $qty;
                             $valid_data['total_tickets'] += $qty;
                         }
                         break;
@@ -376,14 +376,14 @@ 
                         // cycle thru values
                         foreach ((array) $input_value as $key => $value) {
                             // allow only numbers, letters,  spaces, commas and dashes
-                            $value_array[ $key ] = wp_strip_all_tags($value);
+                            $value_array[$key] = wp_strip_all_tags($value);
                             // get ticket via the ticket id we put in the form
                             $ticket_obj                       = EE_Registry::instance()
                                                                             ->load_model('Ticket')
                                                                             ->get_one_by_ID($value);
-                            $valid_data['ticket_obj'][ $key ] = $ticket_obj;
+                            $valid_data['ticket_obj'][$key] = $ticket_obj;
                         }
-                        $valid_data[ $what ] = $value_array;
+                        $valid_data[$what] = $value_array;
                         break;
                     case 'return_url' :
                         // grab and sanitize return-url
@@ -394,9 +394,9 @@ 
                             $input_value = explode('#', $input_value);
                             $input_value = end($input_value);
                             // use event list url instead, but append anchor
-                            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+                            $input_value = EEH_Event_View::event_archive_url().'#'.$input_value;
                         }
-                        $valid_data[ $what ] = $input_value;
+                        $valid_data[$what] = $input_value;
                         break;
                 }    // end switch $what
             }
@@ -526,24 +526,24 @@ 
     private function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
     {
         // if the $_available_spaces array has not been set up yet...
-        if (! isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+        if ( ! isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             $this->setInitialTicketDatetimeAvailability($ticket);
         }
         $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // if we want the original datetime availability BEFORE we started subtracting tickets ?
                 if ($get_original_ticket_spaces) {
                     // then grab the available spaces from the "tickets" array
                     // and compare with the above to get the lowest number
                     $available_spaces = min(
                         $available_spaces,
-                        self::$_available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+                        self::$_available_spaces['tickets'][$ticket->ID()][$DTD_ID]
                     );
                 } else {
                     // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][ $DTD_ID ]);
+                    $available_spaces = min($available_spaces, self::$_available_spaces['datetimes'][$DTD_ID]);
                 }
             }
         }
@@ -574,7 +574,7 @@ 
                 'order_by' => array('DTT_EVT_start' => 'ASC'),
             )
         );
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             // now loop thru all of the datetimes
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
@@ -582,17 +582,17 @@ 
                     $spaces_remaining = $datetime->spaces_remaining();
                     // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
                     // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    self::$_available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+                    self::$_available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
                         $ticket->qty() - $ticket->sold(),
                         $spaces_remaining
                     );
                     // if the remaining spaces for this datetime is already set,
                     // then compare that against the datetime spaces remaining, and take the lowest number,
                     // else just take the datetime spaces remaining, and assign to the datetimes array
-                    self::$_available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        self::$_available_spaces['datetimes'][ $datetime->ID() ]
+                    self::$_available_spaces['datetimes'][$datetime->ID()] = isset(
+                        self::$_available_spaces['datetimes'][$datetime->ID()]
                     )
-                        ? min(self::$_available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+                        ? min(self::$_available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
                         : $spaces_remaining;
                 }
             }
@@ -608,11 +608,11 @@ 
      */
     private function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
     {
-        if (isset(self::$_available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset(self::$_available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach (self::$_available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach (self::$_available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                self::$_available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+                self::$_available_spaces['datetimes'][$DTD_ID] -= $qty;
             }
         }
     }

espresso.php

Indentation +191 added lines, -191 removed lines

@@ -38,216 +38,216 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.56.rc.012');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.56.rc.012');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            static $error_handling_loaded = false;
-            if ($error_handling_loaded) {
-                return;
-            }
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
-                \EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once EE_CORE . 'EE_Error.core.php';
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-            $error_handling_loaded = true;
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			static $error_handling_loaded = false;
+			if ($error_handling_loaded) {
+				return;
+			}
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once   EE_HELPERS . 'EEH_Debug_Tools.helper.php';
+				\EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once EE_CORE . 'EE_Error.core.php';
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+			$error_handling_loaded = true;
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            if (is_readable($full_path_to_file)) {
-                require_once $full_path_to_file;
-            } else {
-                throw new \EE_Error (
-                    sprintf(
-                        esc_html__(
-                            'The %s class file could not be located or is not readable due to file permissions.',
-                            'event_espresso'
-                        ),
-                        $classname
-                    )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			if (is_readable($full_path_to_file)) {
+				require_once $full_path_to_file;
+			} else {
+				throw new \EE_Error (
+					sprintf(
+						esc_html__(
+							'The %s class file could not be located or is not readable due to file permissions.',
+							'event_espresso'
+						),
+						$classname
+					)
+				);
+			}
+		}
 
-        /**
-         * @since 4.9.27
-         * @throws \EE_Error
-         * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-         * @throws \EventEspresso\core\exceptions\InvalidEntityException
-         * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-         * @throws \EventEspresso\core\exceptions\InvalidClassException
-         * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
-         * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
-         * @throws \OutOfBoundsException
-         */
-        function bootstrap_espresso()
-        {
-            require_once __DIR__ . '/core/espresso_definitions.php';
-            try {
-                espresso_load_error_handling();
-                espresso_load_required(
-                    'EEH_Base',
-                    EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
-                );
-                espresso_load_required(
-                    'EEH_File',
-                    EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
-                );
-                espresso_load_required(
-                    'EEH_Array',
-                    EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
-                );
-                // instantiate and configure PSR4 autoloader
-                espresso_load_required(
-                    'Psr4Autoloader',
-                    EE_CORE . 'Psr4Autoloader.php'
-                );
-                espresso_load_required(
-                    'EE_Psr4AutoloaderInit',
-                    EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
-                );
-                $AutoloaderInit = new EE_Psr4AutoloaderInit();
-                $AutoloaderInit->initializeAutoloader();
-                espresso_load_required(
-                    'EE_Request',
-                    EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
-                );
-                espresso_load_required(
-                    'EE_Response',
-                    EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
-                );
-                espresso_load_required(
-                    'EE_Bootstrap',
-                    EE_CORE . 'EE_Bootstrap.core.php'
-                );
-                // bootstrap EE and the request stack
-                new EE_Bootstrap(
-                    new EE_Request($_GET, $_POST, $_COOKIE),
-                    new EE_Response()
-                );
-            } catch (Exception $e) {
-                require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
-                new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
-            }
-        }
-        bootstrap_espresso();
-    }
+		/**
+		 * @since 4.9.27
+		 * @throws \EE_Error
+		 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+		 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+		 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+		 * @throws \EventEspresso\core\exceptions\InvalidClassException
+		 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceExistsException
+		 * @throws \EventEspresso\core\services\container\exceptions\ServiceNotFoundException
+		 * @throws \OutOfBoundsException
+		 */
+		function bootstrap_espresso()
+		{
+			require_once __DIR__ . '/core/espresso_definitions.php';
+			try {
+				espresso_load_error_handling();
+				espresso_load_required(
+					'EEH_Base',
+					EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'interfaces' . DS . 'EEHI_File.interface.php'
+				);
+				espresso_load_required(
+					'EEH_File',
+					EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'
+				);
+				espresso_load_required(
+					'EEH_Array',
+					EE_CORE . 'helpers' . DS . 'EEH_Array.helper.php'
+				);
+				// instantiate and configure PSR4 autoloader
+				espresso_load_required(
+					'Psr4Autoloader',
+					EE_CORE . 'Psr4Autoloader.php'
+				);
+				espresso_load_required(
+					'EE_Psr4AutoloaderInit',
+					EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
+				);
+				$AutoloaderInit = new EE_Psr4AutoloaderInit();
+				$AutoloaderInit->initializeAutoloader();
+				espresso_load_required(
+					'EE_Request',
+					EE_CORE . 'request_stack' . DS . 'EE_Request.core.php'
+				);
+				espresso_load_required(
+					'EE_Response',
+					EE_CORE . 'request_stack' . DS . 'EE_Response.core.php'
+				);
+				espresso_load_required(
+					'EE_Bootstrap',
+					EE_CORE . 'EE_Bootstrap.core.php'
+				);
+				// bootstrap EE and the request stack
+				new EE_Bootstrap(
+					new EE_Request($_GET, $_POST, $_COOKIE),
+					new EE_Response()
+				);
+			} catch (Exception $e) {
+				require_once EE_CORE . 'exceptions' . DS . 'ExceptionStackTraceDisplay.php';
+				new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
+			}
+		}
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }