eventespresso / event-espresso-core

core/EE_Registry.core.php

Doc Comments +3 added lines, -2 removed lines

@@ -322,6 +322,7 @@ 
 
     /**
      * @param mixed string | EED_Module $module
+     * @param string $module
      * @throws OutOfBoundsException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -794,7 +795,7 @@ 
     /**
      * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
      *
-     * @param string|object $class_name
+     * @param string $class_name
      * @param array         $arguments
      * @param int           $attempt
      * @return mixed
@@ -1377,7 +1378,7 @@ 
      * @param string $class_name
      * @param string $param_class
      * @param array  $arguments
-     * @param mixed  $index
+     * @param integer  $index
      * @return array
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException

Indentation +1660 added lines, -1660 removed lines

@@ -23,1664 +23,1664 @@
 class EE_Registry implements ResettableInterface
 {
 
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * StdClass object for storing library classes in
-     *
-     * @var RegistryContainer $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @var EE_Addon[] $addons
-     */
-    public $addons;
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public $models = array();
-
-    /**
-     * @var EED_Module[] $modules
-     */
-    public $modules;
-
-    /**
-     * @var EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes;
-
-    /**
-     * @var WP_Widget[] $widgets
-     */
-    public $widgets;
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public $non_abstract_db_models = array();
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static $i18n_js_strings = array();
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @deprecated $VID:$
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Dependency_Map|null   $dependency_map
-     * @param Mirror|null              $mirror
-     * @param ClassInterfaceCache|null $class_cache
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return EE_Registry instance
-     */
-    public static function instance(
-        EE_Dependency_Map $dependency_map = null,
-        Mirror $mirror = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry
-            && $dependency_map instanceof EE_Dependency_Map
-            && $mirror instanceof Mirror
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            self::$_instance = new self(
-                $dependency_map,
-                $mirror,
-                $class_cache,
-                $object_identifier
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param  EE_Dependency_Map  $dependency_map
-     * @param Mirror              $mirror
-     * @param ClassInterfaceCache $class_cache
-     * @param ObjectIdentifier    $object_identifier
-     */
-    protected function __construct(
-        EE_Dependency_Map $dependency_map,
-        Mirror $mirror,
-        ClassInterfaceCache $class_cache,
-        ObjectIdentifier $object_identifier
-    ) {
-        $this->_dependency_map = $dependency_map;
-        $this->mirror = $mirror;
-        $this->class_cache = $class_cache;
-        $this->object_identifier = $object_identifier;
-        // $registry_container = new RegistryContainer();
-        $this->LIB = new RegistryContainer();
-        $this->addons = new RegistryContainer();
-        $this->modules = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-    /**
-     * initialize
-     *
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            array(
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            )
-        );
-        $this->load_core('Base', array(), true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings()
-    {
-        $i18n_js_strings = (array) self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->{$module_class} = $module;
-        } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module($module_name = '')
-    {
-        return isset($this->modules->{$module_name})
-            ? $this->modules->{$module_name}
-            : null;
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_core($class_name, $arguments = array(), $load_only = false)
-    {
-        $core_paths = apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            array(
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'capabilities' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_service($class_name, $arguments = array(), $load_only = false)
-    {
-        $service_paths = apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            array(
-                EE_CORE . 'services' . DS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return EE_Data_Migration_Script_Base|mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_dms($class_name, $arguments = array())
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return EE_Base_Class | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_class__paths',
-            array(
-                EE_CORE,
-                EE_CLASSES,
-                EE_BUSINESS,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEH_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
-    {
-        $paths = array(
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return EEM_Base | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model($class_name, $arguments = array(), $load_only = false)
-    {
-        $paths = apply_filters(
-            'FHEE__EE_Registry__load_model__paths',
-            array(
-                EE_MODELS,
-                EE_CORE,
-            )
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed | bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
-    {
-        $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name($model_name)
-    {
-        return isset($this->models[ $model_name ]);
-    }
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|EE_Addon|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param bool|string $class_name   Fully Qualified Class Name
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed          null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function create(
-        $class_name = false,
-        $arguments = array(),
-        $cache = false,
-        $from_db = false,
-        $load_only = false,
-        $addon = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then
-        // verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null) {
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else {
-            if ($loader && method_exists($this, $loader)) {
-                $class_obj = $this->{$loader}($class_name, $arguments);
-            } else {
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-            }
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $addon,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string|object $class_name
-     * @param array         $arguments
-     * @param int           $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
-    {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default:
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array       $file_paths   an array of paths to folders to look in
-     * @param string      $class_prefix EE  or EEM or... ???
-     * @param bool|string $class_name   $class name
-     * @param string      $type         file type - core? class? helper? model?
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
-     * @param bool        $from_db      some classes are instantiated from the db
-     *                                  and thus call a different method to instantiate
-     * @param bool        $cache        whether to cache the instantiated object for reuse
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        $file_paths = array(),
-        $class_prefix = 'EE_',
-        $class_name = false,
-        $type = 'class',
-        $arguments = array(),
-        $from_db = false,
-        $cache = true,
-        $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : array($arguments);
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
-    {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
-            : $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        $class_name,
-        $class_prefix = '',
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (isset($this->LIB->{$object_identifier})) {
-            return $this->LIB->{$object_identifier};
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (// request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        $class_name,
-        $addon = false,
-        $arguments = array()
-    ) {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && isset($this->addons->{$class_name})) {
-            unset($this->addons->{$class_name});
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (isset($this->LIB->{$class_name})) {
-            unset($this->LIB->{$class_name});
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        $class_name,
-        $class_prefix = '',
-        $from_db = false,
-        $arguments = array()
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->{$class_name} = $class_obj;
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : array($file_paths);
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper DS, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(array('/', '\\'), DS, $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent($class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = array(
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : array($arguments);
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array(array($class_name, 'new_instance'), $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array(array($class_name, 'instance'), $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                __('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
-    {
-        return ! empty($array)
-            ? array_keys($array) === range(0, count($array) - 1)
-            : true;
-    }
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->mirror->getParametersFromReflection($reflector);
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            // is this a dependency for a specific class ?
-            $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            if (// param is not even a class
-                $param_class === null
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            if (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                $param_class !== null
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-            ) {
-                // skip this argument and move on to the next
-                continue;
-            }
-            if (// parameter is type hinted as a class, and should be injected
-                $param_class !== null
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency(
-                    $class_name,
-                    $param_class,
-                    $arguments,
-                    $index
-                );
-            } else {
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        array(),
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory($classname, $arguments = array())
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        return $this->addons->{$class_name};
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon($class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        unset($this->addons->{$class_name});
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name($name)
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name()
-    {
-        $addons = array();
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function reset_model($model_name)
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_{$model_name}"
-            : $model_name;
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name
-            && is_callable(
-                array($model_class_name, 'reset')
-            )) {
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $this->LIB->{$model_class_name};
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\assets\Registry'
-        );
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (array('LIB', 'modules') as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     */
-    private static function _reset_and_unset_object($object, $reset_models)
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models()
-    {
-        $cpt_models = array();
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return \EE_Config
-     */
-    public static function CFG()
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @deprecated $VID:$
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * StdClass object for storing library classes in
+	 *
+	 * @var RegistryContainer $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var EE_Addon[] $addons
+	 */
+	public $addons;
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public $models = array();
+
+	/**
+	 * @var EED_Module[] $modules
+	 */
+	public $modules;
+
+	/**
+	 * @var EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes;
+
+	/**
+	 * @var WP_Widget[] $widgets
+	 */
+	public $widgets;
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public $non_abstract_db_models = array();
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static $i18n_js_strings = array();
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @deprecated $VID:$
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Dependency_Map|null   $dependency_map
+	 * @param Mirror|null              $mirror
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return EE_Registry instance
+	 */
+	public static function instance(
+		EE_Dependency_Map $dependency_map = null,
+		Mirror $mirror = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registry
+			&& $dependency_map instanceof EE_Dependency_Map
+			&& $mirror instanceof Mirror
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			self::$_instance = new self(
+				$dependency_map,
+				$mirror,
+				$class_cache,
+				$object_identifier
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param  EE_Dependency_Map  $dependency_map
+	 * @param Mirror              $mirror
+	 * @param ClassInterfaceCache $class_cache
+	 * @param ObjectIdentifier    $object_identifier
+	 */
+	protected function __construct(
+		EE_Dependency_Map $dependency_map,
+		Mirror $mirror,
+		ClassInterfaceCache $class_cache,
+		ObjectIdentifier $object_identifier
+	) {
+		$this->_dependency_map = $dependency_map;
+		$this->mirror = $mirror;
+		$this->class_cache = $class_cache;
+		$this->object_identifier = $object_identifier;
+		// $registry_container = new RegistryContainer();
+		$this->LIB = new RegistryContainer();
+		$this->addons = new RegistryContainer();
+		$this->modules = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			array(
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			)
+		);
+		$this->load_core('Base', array(), true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings()
+	{
+		$i18n_js_strings = (array) self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->{$module_class} = $module;
+		} else {
+			if (! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module($module_name = '')
+	{
+		return isset($this->modules->{$module_name})
+			? $this->modules->{$module_name}
+			: null;
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_core($class_name, $arguments = array(), $load_only = false)
+	{
+		$core_paths = apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			array(
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'data_migration_scripts' . DS,
+				EE_CORE . 'capabilities' . DS,
+				EE_CORE . 'request_stack' . DS,
+				EE_CORE . 'middleware' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_service($class_name, $arguments = array(), $load_only = false)
+	{
+		$service_paths = apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			array(
+				EE_CORE . 'services' . DS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return EE_Data_Migration_Script_Base|mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_dms($class_name, $arguments = array())
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return EE_Base_Class | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_class__paths',
+			array(
+				EE_CORE,
+				EE_CLASSES,
+				EE_BUSINESS,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEH_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
+	{
+		$paths = array(
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages' . DS,
+			EE_LIBRARIES . 'shortcodes' . DS,
+			EE_LIBRARIES . 'qtips' . DS,
+			EE_LIBRARIES . 'payment_methods' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return EEM_Base | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model($class_name, $arguments = array(), $load_only = false)
+	{
+		$paths = apply_filters(
+			'FHEE__EE_Registry__load_model__paths',
+			array(
+				EE_MODELS,
+				EE_CORE,
+			)
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed | bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
+	{
+		$paths = array(
+			EE_MODELS . 'fields' . DS,
+			EE_MODELS . 'helpers' . DS,
+			EE_MODELS . 'relations' . DS,
+			EE_MODELS . 'strategies' . DS,
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name($model_name)
+	{
+		return isset($this->models[ $model_name ]);
+	}
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|EE_Addon|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			$path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param bool|string $class_name   Fully Qualified Class Name
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed          null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function create(
+		$class_name = false,
+		$arguments = array(),
+		$cache = false,
+		$from_db = false,
+		$load_only = false,
+		$addon = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then
+		// verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null) {
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}// obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else {
+			if ($loader && method_exists($this, $loader)) {
+				$class_obj = $this->{$loader}($class_name, $arguments);
+			} else {
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+			}
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$addon,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string|object $class_name
+	 * @param array         $arguments
+	 * @param int           $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
+	{
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default:
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array       $file_paths   an array of paths to folders to look in
+	 * @param string      $class_prefix EE  or EEM or... ???
+	 * @param bool|string $class_name   $class name
+	 * @param string      $type         file type - core? class? helper? model?
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool        $from_db      some classes are instantiated from the db
+	 *                                  and thus call a different method to instantiate
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		$file_paths = array(),
+		$class_prefix = 'EE_',
+		$class_name = false,
+		$type = 'class',
+		$arguments = array(),
+		$from_db = false,
+		$cache = true,
+		$load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : array($arguments);
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
+	{
+		return isset($this->_class_abbreviations[ $class_name ])
+			? $this->_class_abbreviations[ $class_name ]
+			: $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		$class_name,
+		$class_prefix = '',
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && isset($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (isset($this->LIB->{$object_identifier})) {
+			return $this->LIB->{$object_identifier};
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (// request does not contain new arguments and therefore no args identifier
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		$class_name,
+		$addon = false,
+		$arguments = array()
+	) {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && isset($this->addons->{$class_name})) {
+			unset($this->addons->{$class_name});
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (isset($this->LIB->{$class_name})) {
+			unset($this->LIB->{$class_name});
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		$class_name,
+		$class_prefix = '',
+		$from_db = false,
+		$arguments = array()
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->{$class_name} = $class_obj;
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: array($file_paths);
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper DS, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(array('/', '\\'), DS, $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent($class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = array(
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			);
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: array($arguments);
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array(array($class_name, 'new_instance'), $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array(array($class_name, 'instance'), $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
+	{
+		return ! empty($array)
+			? array_keys($array) === range(0, count($array) - 1)
+			: true;
+	}
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->mirror->getParametersFromReflection($reflector);
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			// is this a dependency for a specific class ?
+			$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			if (// param is not even a class
+				$param_class === null
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& array_key_exists($argument_keys[ $index ], $arguments)
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			if (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				$param_class !== null
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+			) {
+				// skip this argument and move on to the next
+				continue;
+			}
+			if (// parameter is type hinted as a class, and should be injected
+				$param_class !== null
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency(
+					$class_name,
+					$param_class,
+					$arguments,
+					$index
+				);
+			} else {
+				$arguments[ $index ] = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						array(),
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory($classname, $arguments = array())
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		return $this->addons->{$class_name};
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon($class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		unset($this->addons->{$class_name});
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name($name)
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name()
+	{
+		$addons = array();
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function reset_model($model_name)
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_{$model_name}"
+			: $model_name;
+		if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name
+			&& is_callable(
+				array($model_class_name, 'reset')
+			)) {
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $this->LIB->{$model_class_name};
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\assets\Registry'
+		);
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (array('LIB', 'modules') as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 */
+	private static function _reset_and_unset_object($object, $reset_models)
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models()
+	{
+		$cpt_models = array();
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @deprecated $VID:$
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
 }

Spacing +46 added lines, -46 removed lines

@@ -193,7 +193,7 @@ 
         ObjectIdentifier $object_identifier = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registry
+        if ( ! self::$_instance instanceof EE_Registry
             && $dependency_map instanceof EE_Dependency_Map
             && $mirror instanceof Mirror
             && $class_cache instanceof ClassInterfaceCache
@@ -308,10 +308,10 @@ 
         $i18n_js_strings = (array) self::$i18n_js_strings;
         foreach ($i18n_js_strings as $key => $value) {
             if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+                $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
             }
         }
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -330,7 +330,7 @@ 
             $module_class = get_class($module);
             $this->modules->{$module_class} = $module;
         } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
+            if ( ! class_exists('EE_Module_Request_Router', false)) {
                 $this->load_core('Module_Request_Router');
             }
             EE_Module_Request_Router::module_factory($module);
@@ -371,10 +371,10 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'capabilities' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
+                EE_CORE.'data_migration_scripts'.DS,
+                EE_CORE.'capabilities'.DS,
+                EE_CORE.'request_stack'.DS,
+                EE_CORE.'middleware'.DS,
             )
         );
         // retrieve instantiated class
@@ -409,7 +409,7 @@ 
         $service_paths = apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             array(
-                EE_CORE . 'services' . DS,
+                EE_CORE.'services'.DS,
             )
         );
         // retrieve instantiated class
@@ -544,10 +544,10 @@ 
     {
         $paths = array(
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages' . DS,
-            EE_LIBRARIES . 'shortcodes' . DS,
-            EE_LIBRARIES . 'qtips' . DS,
-            EE_LIBRARIES . 'payment_methods' . DS,
+            EE_LIBRARIES.'messages'.DS,
+            EE_LIBRARIES.'shortcodes'.DS,
+            EE_LIBRARIES.'qtips'.DS,
+            EE_LIBRARIES.'payment_methods'.DS,
         );
         // retrieve instantiated class
         return $this->_load(
@@ -615,10 +615,10 @@ 
     public function load_model_class($class_name, $arguments = array(), $load_only = true)
     {
         $paths = array(
-            EE_MODELS . 'fields' . DS,
-            EE_MODELS . 'helpers' . DS,
-            EE_MODELS . 'relations' . DS,
-            EE_MODELS . 'strategies' . DS,
+            EE_MODELS.'fields'.DS,
+            EE_MODELS.'helpers'.DS,
+            EE_MODELS.'relations'.DS,
+            EE_MODELS.'strategies'.DS,
         );
         // retrieve instantiated class
         return $this->_load(
@@ -642,7 +642,7 @@ 
      */
     public function is_model_name($model_name)
     {
-        return isset($this->models[ $model_name ]);
+        return isset($this->models[$model_name]);
     }
 
 
@@ -763,7 +763,7 @@ 
                 return $cached_class;
             }
         }// obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+        $loader = $this->_dependency_map->class_loader($class_name); // instantiate the requested object
         if ($loader instanceof Closure) {
             $class_obj = $loader($arguments);
         } else {
@@ -805,7 +805,7 @@ 
             case 1:
                 // if it's a FQCN then maybe the class is registered with a preceding \
                 $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
+                    ? '\\'.ltrim($class_name, '\\')
                     : $class_name;
                 break;
             case 2:
@@ -859,11 +859,11 @@ 
         // strip php file extension
         $class_name = str_replace('.php', '', trim($class_name));
         // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
+        if ( ! empty($class_prefix) && $class_prefix !== 'addon') {
             // make sure $class_prefix is uppercase
             $class_prefix = strtoupper(trim($class_prefix));
             // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name = $this->class_cache->getFqnForAlias($class_name);
         $class_exists = class_exists($class_name, false);
@@ -883,7 +883,7 @@ 
             }
         }
         // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
+        if ( ! $class_exists) {
             // get full path to file
             $path = $this->_resolve_path($class_name, $type, $file_paths);
             // load the file
@@ -894,7 +894,7 @@ 
                 return $loaded;
             }
             // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
+            if ( ! $loaded) {
                 return null;
             }
         }
@@ -922,8 +922,8 @@ 
      */
     protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
     {
-        return isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
+        return isset($this->_class_abbreviations[$class_name])
+            ? $this->_class_abbreviations[$class_name]
             : $default;
     }
 
@@ -1056,7 +1056,7 @@ 
             $this->addons->{$class_name} = $class_obj;
             return;
         }
-        if (! $from_db) {
+        if ( ! $from_db) {
             $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
             $this->LIB->{$class_name} = $class_obj;
         }
@@ -1087,13 +1087,13 @@ 
                 : EE_CLASSES;
             // prep file type
             $type = ! empty($type)
-                ? trim($type, '.') . '.'
+                ? trim($type, '.').'.'
                 : '';
             // build full file path
-            $file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, DS).DS.$class_name.'.'.$type.'php';
             // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
+            if (is_readable($file_paths[$key])) {
+                return $file_paths[$key];
             }
         }
         return false;
@@ -1118,7 +1118,7 @@ 
         // don't give up! you gotta...
         try {
             // does the file exist and can it be read ?
-            if (! $path) {
+            if ( ! $path) {
                 // just in case the file has already been autoloaded,
                 // but discrepancies in the naming schema are preventing it from
                 // being loaded via one of the EE_Registry::load_*() methods,
@@ -1136,7 +1136,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1179,8 +1179,8 @@ 
             $legacy_parent_class_map = array(
                 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
             );
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+            if (isset($legacy_parent_class_map[$class_name])) {
+                require_once EE_PLUGIN_DIR_PATH.$legacy_parent_class_map[$class_name];
             }
         } catch (Exception $exception) {
         }
@@ -1312,7 +1312,7 @@ 
         // let's examine the constructor
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1331,15 +1331,15 @@ 
                 $param_class === null
                 // and something already exists in the incoming arguments for this param
                 && array_key_exists($index, $argument_keys)
-                && array_key_exists($argument_keys[ $index ], $arguments)
+                && array_key_exists($argument_keys[$index], $arguments)
             ) {
                 // so let's skip this argument and move on to the next
                 continue;
             }
             if (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
                 $param_class !== null
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+                && $arguments[$argument_keys[$index]] instanceof $param_class
             ) {
                 // skip this argument and move on to the next
                 continue;
@@ -1355,7 +1355,7 @@ 
                     $index
                 );
             } else {
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
+                $arguments[$index] = $this->mirror->getParameterDefaultValue(
                     $param,
                     $class_name,
                     $index
@@ -1417,7 +1417,7 @@ 
         // did we successfully find the correct dependency ?
         if ($dependency instanceof $param_class) {
             // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
+            $arguments[$index] = $dependency;
         }
         return $arguments;
     }
@@ -1508,7 +1508,7 @@ 
     {
         $addons = array();
         foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
+            $addons[$addon->name()] = $addon;
         }
         return $addons;
     }
@@ -1527,7 +1527,7 @@ 
         $model_class_name = strpos($model_name, 'EEM_') !== 0
             ? "EEM_{$model_name}"
             : $model_name;
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
+        if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
             return null;
         }
         // get that model reset it and make sure we nuke the old reference to it
@@ -1619,7 +1619,7 @@ 
      */
     private static function _reset_and_unset_object($object, $reset_models)
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             // don't unset anything that's not an object
             return false;
         }
@@ -1639,7 +1639,7 @@ 
             $object->reset();
             return true;
         }
-        if (! $object instanceof InterminableInterface) {
+        if ( ! $object instanceof InterminableInterface) {
             return true;
         }
         return false;
@@ -1656,7 +1656,7 @@ 
         $cpt_models = array();
         foreach ($this->non_abstract_db_models as $short_name => $classname) {
             if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
+                $cpt_models[$short_name] = $classname;
             }
         }
         return $cpt_models;

core/services/loaders/CachingLoader.php

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
         $identifier = ''
     ) {
         parent::__construct($loader);
-        $this->cache       = $cache;
+        $this->cache = $cache;
         $this->object_identifier = $object_identifier;
         $this->setIdentifier($identifier);
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@ 
      */
     private function setIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;

Indentation +150 added lines, -150 removed lines

@@ -17,154 +17,154 @@
 class CachingLoader extends CachingLoaderDecorator
 {
 
-    /**
-     * @var string $identifier
-     */
-    protected $identifier;
-
-    /**
-     * @var CollectionInterface $cache
-     */
-    protected $cache;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param ObjectIdentifier         $object_identifier
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        LoaderDecoratorInterface $loader,
-        CollectionInterface $cache,
-        ObjectIdentifier $object_identifier,
-        $identifier = ''
-    ) {
-        parent::__construct($loader);
-        $this->cache       = $cache;
-        $this->object_identifier = $object_identifier;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object)
-    {
-        if ($object instanceof $fqcn) {
-            return $this->cache->add($object, md5($fqcn));
-        }
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
-                    'event_espresso'
-                ),
-                $fqcn
-            )
-        );
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @param array                     $interfaces
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if (apply_filters(
-            'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-            false,
-            $this
-        )) {
-            // even though $shared might be true, caching could be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        if ($this->cache->has($object_identifier)) {
-            return $this->cache->get($object_identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if ($object instanceof $fqcn) {
-            $this->cache->add($object, $object_identifier);
-        }
-        return $object;
-    }
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->clearCache();
-        $this->loader->reset();
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the cache
-     *
-     * @since $VID:$
-     */
-    public function clearCache()
-    {
-        $this->cache->trashAndDetachAll();
-    }
+	/**
+	 * @var string $identifier
+	 */
+	protected $identifier;
+
+	/**
+	 * @var CollectionInterface $cache
+	 */
+	protected $cache;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param ObjectIdentifier         $object_identifier
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $loader,
+		CollectionInterface $cache,
+		ObjectIdentifier $object_identifier,
+		$identifier = ''
+	) {
+		parent::__construct($loader);
+		$this->cache       = $cache;
+		$this->object_identifier = $object_identifier;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object)
+	{
+		if ($object instanceof $fqcn) {
+			return $this->cache->add($object, md5($fqcn));
+		}
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The supplied class name "%1$s" must match the class of the supplied object.',
+					'event_espresso'
+				),
+				$fqcn
+			)
+		);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @param array                     $interfaces
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if (apply_filters(
+			'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+			false,
+			$this
+		)) {
+			// even though $shared might be true, caching could be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		if ($this->cache->has($object_identifier)) {
+			return $this->cache->get($object_identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if ($object instanceof $fqcn) {
+			$this->cache->add($object, $object_identifier);
+		}
+		return $object;
+	}
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->clearCache();
+		$this->loader->reset();
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the cache
+	 *
+	 * @since $VID:$
+	 */
+	public function clearCache()
+	{
+		$this->cache->trashAndDetachAll();
+	}
 }

core/services/loaders/ObjectIdentifier.php

Spacing +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
     public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
     {
         return $fqcn === $object_identifier
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+               || strpos($object_identifier, $fqcn.ObjectIdentifier::DELIMITER) === 0;
     }
 
 
@@ -93,8 +93,8 @@ 
         )
             ? $this->getIdentifierForArguments($arguments)
             : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+        if ( ! empty($identifier)) {
+            $fqcn .= ObjectIdentifier::DELIMITER.md5($identifier);
         }
         return $fqcn;
     }

Indentation +98 added lines, -98 removed lines

@@ -16,113 +16,113 @@
 class ObjectIdentifier
 {
 
-    /**
-     * used to separate the FQCN from the class's arguments identifier
-     */
-    const DELIMITER = '____';
+	/**
+	 * used to separate the FQCN from the class's arguments identifier
+	 */
+	const DELIMITER = '____';
 
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
 
 
-    /**
-     * ObjectIdentifier constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    public function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-    }
+	/**
+	 * ObjectIdentifier constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	public function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+	}
 
 
-    /**
-     * Returns true if the supplied $object_identifier contains
-     * the delimiter used to separate an fqcn from the arguments hash
-     *
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function hasArguments($object_identifier)
-    {
-        // type casting to bool instead of using strpos() !== false
-        // because an object identifier should never begin with the delimiter
-        // therefore the delimiter should NOT be found at position 0
-        return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
-    }
+	/**
+	 * Returns true if the supplied $object_identifier contains
+	 * the delimiter used to separate an fqcn from the arguments hash
+	 *
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function hasArguments($object_identifier)
+	{
+		// type casting to bool instead of using strpos() !== false
+		// because an object identifier should never begin with the delimiter
+		// therefore the delimiter should NOT be found at position 0
+		return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
+	}
 
 
-    /**
-     * Returns true if the supplied FQCN equals the supplied $object_identifier
-     * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
-     * AND that $object_identifier is for an object with arguments.
-     * This allows a request for an object using a FQCN to match
-     * a previously instantiated object with arguments
-     * without having to know those arguments.
-     *
-     * @param string $fqcn
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
-    {
-        return $fqcn === $object_identifier
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
-    }
+	/**
+	 * Returns true if the supplied FQCN equals the supplied $object_identifier
+	 * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
+	 * AND that $object_identifier is for an object with arguments.
+	 * This allows a request for an object using a FQCN to match
+	 * a previously instantiated object with arguments
+	 * without having to know those arguments.
+	 *
+	 * @param string $fqcn
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
+	{
+		return $fqcn === $object_identifier
+			   || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+	}
 
 
-    /**
-     * build a string representation of an object's FQCN and arguments
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return string
-     */
-    public function getIdentifier($fqcn, array $arguments = array())
-    {
-        // only build identifier from arguments if class is not ReservedInstanceInterface
-        $identifier = ! $this->class_cache->hasInterface(
-            $fqcn,
-            'EventEspresso\core\interfaces\ReservedInstanceInterface'
-        )
-            ? $this->getIdentifierForArguments($arguments)
-            : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
-        }
-        return $fqcn;
-    }
+	/**
+	 * build a string representation of an object's FQCN and arguments
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return string
+	 */
+	public function getIdentifier($fqcn, array $arguments = array())
+	{
+		// only build identifier from arguments if class is not ReservedInstanceInterface
+		$identifier = ! $this->class_cache->hasInterface(
+			$fqcn,
+			'EventEspresso\core\interfaces\ReservedInstanceInterface'
+		)
+			? $this->getIdentifierForArguments($arguments)
+			: '';
+		if (! empty($identifier)) {
+			$fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+		}
+		return $fqcn;
+	}
 
 
-    /**
-     * build a string representation of a object's arguments
-     * (mostly because Closures can't be serialized)
-     *
-     * @param array $arguments
-     * @return string
-     */
-    protected function getIdentifierForArguments(array $arguments)
-    {
-        if (empty($arguments)) {
-            return '';
-        }
-        $identifier = '';
-        foreach ($arguments as $argument) {
-            switch (true) {
-                case is_object($argument):
-                case $argument instanceof Closure:
-                    $identifier .= spl_object_hash($argument);
-                    break;
-                case is_array($argument):
-                    $identifier .= $this->getIdentifierForArguments($argument);
-                    break;
-                default:
-                    $identifier .= $argument;
-                    break;
-            }
-        }
-        return $identifier;
-    }
+	/**
+	 * build a string representation of a object's arguments
+	 * (mostly because Closures can't be serialized)
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	protected function getIdentifierForArguments(array $arguments)
+	{
+		if (empty($arguments)) {
+			return '';
+		}
+		$identifier = '';
+		foreach ($arguments as $argument) {
+			switch (true) {
+				case is_object($argument):
+				case $argument instanceof Closure:
+					$identifier .= spl_object_hash($argument);
+					break;
+				case is_array($argument):
+					$identifier .= $this->getIdentifierForArguments($argument);
+					break;
+				default:
+					$identifier .= $argument;
+					break;
+			}
+		}
+		return $identifier;
+	}
 }

core/domain/DomainInterface.php

Indentation +36 added lines, -36 removed lines

@@ -16,55 +16,55 @@
 interface DomainInterface extends InterminableInterface
 {
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginFile();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginFile();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginBasename();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginBasename();
 
 
-    /**
-     * @return string
-     */
-    public function pluginPath();
+	/**
+	 * @return string
+	 */
+	public function pluginPath();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginUrl();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginUrl();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function version();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function version();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl();
 
 
-    /**
-     * @return string
-     */
-    public function assetNamespace();
+	/**
+	 * @return string
+	 */
+	public function assetNamespace();
 
 }

core/helpers/EEH_Debug_Tools.helper.php

Doc Comments +8 added lines, -5 removed lines

@@ -375,11 +375,11 @@ 
 
 
     /**
-     * @param mixed      $var
+     * @param string      $var
      * @param string     $var_name
      * @param string     $file
      * @param int|string $line
-     * @param int|string $heading_tag
+     * @param integer $heading_tag
      * @param bool       $die
      * @param string     $margin
      */
@@ -411,6 +411,9 @@ 
     }
 
 
+    /**
+     * @param integer $heading_tag
+     */
     protected static function headingTag($heading_tag)
     {
         $heading_tag = absint($heading_tag);
@@ -532,8 +535,8 @@ 
      * @param mixed      $var
      * @param string     $var_name
      * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
+     * @param integer $line
+     * @param integer $heading_tag
      * @param bool       $die
      */
     public static function printr(
@@ -596,7 +599,7 @@ 
 
     /**
      * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
+     * @param string $timer_name
      */
     public function start_timer($timer_name = null)
     {

Indentation +674 added lines, -674 removed lines

@@ -11,665 +11,665 @@ 
 class EEH_Debug_Tools
 {
 
-    /**
-     *    instance of the EEH_Autoloader object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    protected $_memory_usage_points = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EEH_Debug_Tools
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private class constructor
-     */
-    private function __construct()
-    {
-        // load Kint PHP debugging library
-        if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) {
-            // despite EE4 having a check for an existing copy of the Kint debugging class,
-            // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
-            // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
-            // so we've moved it to our test folder so that it is not included with production releases
-            // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php');
-        }
-        // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
-        // add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
-        // }
-        $plugin = basename(EE_PLUGIN_DIR_PATH);
-        add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
-    }
-
-
-
-    /**
-     *    show_db_name
-     *
-     * @return void
-     */
-    public static function show_db_name()
-    {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
-            echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
-                 . DB_NAME
-                 . '</p>';
-        }
-        if (EE_DEBUG) {
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    dump EE_Session object at bottom of page after everything else has happened
-     *
-     * @return void
-     */
-    public function espresso_session_footer_dump()
-    {
-        if ((defined('WP_DEBUG') && WP_DEBUG)
-            && ! defined('DOING_AJAX')
-            && class_exists('Kint')
-            && function_exists('wp_get_current_user')
-            && current_user_can('update_core')
-            && class_exists('EE_Registry')
-        ) {
-            Kint::dump(EE_Registry::instance()->SSN->id());
-            Kint::dump(EE_Registry::instance()->SSN);
-            //          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
-            $this->espresso_list_hooked_functions();
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    List All Hooked Functions
-     *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
-     *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
-     *
-     * @param string $tag
-     * @return void
-     */
-    public function espresso_list_hooked_functions($tag = '')
-    {
-        global $wp_filter;
-        echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-        if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
-                trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
-                return;
-            }
-            echo '<h5>For Tag: ' . $tag . '</h5>';
-        } else {
-            $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
-            ksort($hook);
-        }
-        foreach ($hook as $tag_name => $priorities) {
-            echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
-            ksort($priorities);
-            foreach ($priorities as $priority => $function) {
-                echo $priority;
-                foreach ($function as $name => $properties) {
-                    echo "\t$name<br />";
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    registered_filter_callbacks
-     *
-     * @param string $hook_name
-     * @return array
-     */
-    public static function registered_filter_callbacks($hook_name = '')
-    {
-        $filters = array();
-        global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
-                foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
-                }
-            }
-        }
-        return $filters;
-    }
-
-
-
-    /**
-     *    captures plugin activation errors for debugging
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ee_plugin_activation_errors()
-    {
-        if (WP_DEBUG) {
-            $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
-            if (class_exists('EEH_File')) {
-                try {
-                    EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html'
-                    );
-                    EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
-                        $activation_errors
-                    );
-                } catch (EE_Error $e) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The Event Espresso activation errors file could not be setup because: %s',
-                                'event_espresso'
-                            ),
-                            $e->getMessage()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // old school attempt
-                file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
-                    $activation_errors
-                );
-            }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
-            update_option('ee_plugin_activation_errors', $activation_errors);
-        }
-    }
-
-
-
-    /**
-     * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
-     * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
-     * or we want to make sure they use something the right way.
-     *
-     * @access public
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     * @uses   trigger_error()
-     */
-    public function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        $applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
-        $error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
-        // because we swapped the parameter order around for the last two params,
-        // let's verify that some third party isn't still passing an error type value for the third param
-        if (is_int($applies_when)) {
-            $error_type = $applies_when;
-            $applies_when = espresso_version();
-        }
-        // if not displaying notices yet, then just leave
-        if (version_compare(espresso_version(), $applies_when, '<')) {
-            return;
-        }
-        do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-        $version = $version === null
-            ? ''
-            : sprintf(
-                __('(This message was added in version %s of Event Espresso)', 'event_espresso'),
-                $version
-            );
-        $error_message = sprintf(
-            esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
-            $function,
-            '<strong>',
-            '</strong>',
-            $message,
-            $version
-        );
-        // don't trigger error if doing ajax,
-        // instead we'll add a transient EE_Error notice that in theory should show on the next request.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
-                'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
-                'event_espresso'
-            );
-            $error_message .= '<ul><li>';
-            $error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
-            $error_message .= '</ul>';
-            EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
-            // now we set this on the transient so it shows up on the next request.
-            EE_Error::get_notices(false, true);
-        } else {
-            trigger_error($error_message, $error_type);
-        }
-    }
-
-
-
-
-    /**
-     * Logger helpers
-     */
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @param string $debug_index
-     * @param string $debug_key
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    public static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        $info = array(),
-        $display_request = false,
-        $debug_index = '',
-        $debug_key = 'EE_DEBUG_SPCO'
-    ) {
-        if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
-            $debug_data = get_option($debug_key, array());
-            $default_data = array(
-                $class => $func . '() : ' . $line,
-                'REQ'  => $display_request ? $_REQUEST : '',
-            );
-            // don't serialize objects
-            $info = self::strip_objects($info);
-            $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
-            }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
-            update_option($debug_key, $debug_data);
-        }
-    }
-
-
-
-    /**
-     * strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public static function strip_objects($info = array())
-    {
-        foreach ($info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
-                if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
-                }
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     * @param string     $margin
-     */
-    public static function printv(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false,
-        $margin = ''
-    ) {
-        $var_name = ! $var_name ? 'string' : $var_name;
-        $var_name = ucwords(str_replace('$', '', $var_name));
-        $is_method = method_exists($var_name, $var);
-        $var_name = ucwords(str_replace('_', ' ', $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-    protected static function headingTag($heading_tag)
-    {
-        $heading_tag = absint($heading_tag);
-        return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
-    }
-
-
-    protected static function headingSpacer($heading_tag)
-    {
-        return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
-            ? "\n"
-            : '';
-    }
-
-
-    protected static function plainOutput()
-    {
-        return defined('EE_TESTS_DIR') || (defined('DOING_AJAX') && DOING_AJAX);
-    }
-
-
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @param int    $line
-     * @return string
-     */
-    protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            $heading = '';
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                $heading .= "\n";
-            }
-            $heading .= "\n{$line}) {$var_name}";
-            return $heading;
-        }
-        $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
-    }
-
-
-
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
-    protected static function headingX($heading_tag = 'h5')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return '';
-        }
-        return '</' . $heading_tag . '>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function grey_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
-    protected static function file_and_line($file, $line, $heading_tag)
-    {
-        if ($file === '' || $line === '') {
-            return '';
-        }
-        $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
-        if (EEH_Debug_Tools::plainOutput()) {
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})";
-            }
-            return '';
-        }
-        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
-               . $file
-               . '<br />line no: '
-               . $line
-               . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        ob_start();
-        var_dump($var);
-        $var = ob_get_clean();
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $var;
-        }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     */
-    public static function printr(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false
-    ) {
-        // return;
-        $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
-        $margin = is_admin() ? ' 180px' : '0';
-        // $print_r = false;
-        if (is_string($var)) {
-            EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
-            return;
-        }
-        if (is_object($var)) {
-            $var_name = ! $var_name ? 'object' : $var_name;
-            // $print_r = true;
-        } elseif (is_array($var)) {
-            $var_name = ! $var_name ? 'array' : $var_name;
-            // $print_r = true;
-        } elseif (is_numeric($var)) {
-            $var_name = ! $var_name ? 'numeric' : $var_name;
-        } elseif ($var === null) {
-            $var_name = ! $var_name ? 'null' : $var_name;
-        }
-        $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
-            EEH_Debug_Tools::pre_span($var)
-        );
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo $result;
-    }
-
-
-
-    /******************** deprecated ********************/
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     */
-    public function reset_times()
-    {
-        Benchmark::resetTimes();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
-     */
-    public function start_timer($timer_name = null)
-    {
-        Benchmark::startTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     */
-    public function stop_timer($timer_name = '')
-    {
-        Benchmark::stopTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public function measure_memory($label, $output_now = false)
-    {
-        Benchmark::measureMemory($label, $output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param int $size
-     * @return string
-     */
-    public function convert($size)
-    {
-        return Benchmark::convert($size);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param bool $output_now
-     * @return string
-     */
-    public function show_times($output_now = true)
-    {
-        return Benchmark::displayResults($output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public function format_time($timer_name, $total_time)
-    {
-        return Benchmark::formatTime($timer_name, $total_time);
-    }
+	/**
+	 *    instance of the EEH_Autoloader object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	protected $_memory_usage_points = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EEH_Debug_Tools
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_Debug_Tools) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private class constructor
+	 */
+	private function __construct()
+	{
+		// load Kint PHP debugging library
+		if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) {
+			// despite EE4 having a check for an existing copy of the Kint debugging class,
+			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
+			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
+			// so we've moved it to our test folder so that it is not included with production releases
+			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
+			require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php');
+		}
+		// if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
+		// add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
+		// }
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
+	}
+
+
+
+	/**
+	 *    show_db_name
+	 *
+	 * @return void
+	 */
+	public static function show_db_name()
+	{
+		if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
+				 . DB_NAME
+				 . '</p>';
+		}
+		if (EE_DEBUG) {
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    dump EE_Session object at bottom of page after everything else has happened
+	 *
+	 * @return void
+	 */
+	public function espresso_session_footer_dump()
+	{
+		if ((defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
+		) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
+			//          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
+			$this->espresso_list_hooked_functions();
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    List All Hooked Functions
+	 *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
+	 *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
+	 *
+	 * @param string $tag
+	 * @return void
+	 */
+	public function espresso_list_hooked_functions($tag = '')
+	{
+		global $wp_filter;
+		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
+		if ($tag) {
+			$hook[ $tag ] = $wp_filter[ $tag ];
+			if (! is_array($hook[ $tag ])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
+				return;
+			}
+			echo '<h5>For Tag: ' . $tag . '</h5>';
+		} else {
+			$hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
+			ksort($hook);
+		}
+		foreach ($hook as $tag_name => $priorities) {
+			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>$tag_name</strong><br />";
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
+				echo $priority;
+				foreach ($function as $name => $properties) {
+					echo "\t$name<br />";
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    registered_filter_callbacks
+	 *
+	 * @param string $hook_name
+	 * @return array
+	 */
+	public static function registered_filter_callbacks($hook_name = '')
+	{
+		$filters = array();
+		global $wp_filter;
+		if (isset($wp_filter[ $hook_name ])) {
+			$filters[ $hook_name ] = array();
+			foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
+				$filters[ $hook_name ][ $priority ] = array();
+				foreach ($callbacks as $callback) {
+					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+				}
+			}
+		}
+		return $filters;
+	}
+
+
+
+	/**
+	 *    captures plugin activation errors for debugging
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ee_plugin_activation_errors()
+	{
+		if (WP_DEBUG) {
+			$activation_errors = ob_get_contents();
+			if (! empty($activation_errors)) {
+				$activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+			}
+			espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
+				try {
+					EEH_File::ensure_file_exists_and_is_writable(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html'
+					);
+					EEH_File::write_to_file(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+						$activation_errors
+					);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The Event Espresso activation errors file could not be setup because: %s',
+								'event_espresso'
+							),
+							$e->getMessage()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// old school attempt
+				file_put_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+					$activation_errors
+				);
+			}
+			$activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
+		}
+	}
+
+
+
+	/**
+	 * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
+	 * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
+	 * or we want to make sure they use something the right way.
+	 *
+	 * @access public
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 * @uses   trigger_error()
+	 */
+	public function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
+		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
+		// because we swapped the parameter order around for the last two params,
+		// let's verify that some third party isn't still passing an error type value for the third param
+		if (is_int($applies_when)) {
+			$error_type = $applies_when;
+			$applies_when = espresso_version();
+		}
+		// if not displaying notices yet, then just leave
+		if (version_compare(espresso_version(), $applies_when, '<')) {
+			return;
+		}
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null
+			? ''
+			: sprintf(
+				__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
+				$version
+			);
+		$error_message = sprintf(
+			esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
+			$function,
+			'<strong>',
+			'</strong>',
+			$message,
+			$version
+		);
+		// don't trigger error if doing ajax,
+		// instead we'll add a transient EE_Error notice that in theory should show on the next request.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' ' . esc_html__(
+				'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
+				'event_espresso'
+			);
+			$error_message .= '<ul><li>';
+			$error_message .= implode('</li><li>', EE_Registry::instance()->REQ->params());
+			$error_message .= '</ul>';
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
+			// now we set this on the transient so it shows up on the next request.
+			EE_Error::get_notices(false, true);
+		} else {
+			trigger_error($error_message, $error_type);
+		}
+	}
+
+
+
+
+	/**
+	 * Logger helpers
+	 */
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @param string $debug_index
+	 * @param string $debug_key
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	public static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		$info = array(),
+		$display_request = false,
+		$debug_index = '',
+		$debug_key = 'EE_DEBUG_SPCO'
+	) {
+		if (WP_DEBUG) {
+			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
+			$default_data = array(
+				$class => $func . '() : ' . $line,
+				'REQ'  => $display_request ? $_REQUEST : '',
+			);
+			// don't serialize objects
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if (! isset($debug_data[ $index ])) {
+				$debug_data[ $index ] = array();
+			}
+			$debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
+		}
+	}
+
+
+
+	/**
+	 * strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public static function strip_objects($info = array())
+	{
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = self::strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[ $object_class ]['ID'] = $value->ID();
+				}
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 * @param string     $margin
+	 */
+	public static function printv(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false,
+		$margin = ''
+	) {
+		$var_name = ! $var_name ? 'string' : $var_name;
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= $is_method
+			? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
+			: EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+	protected static function headingTag($heading_tag)
+	{
+		$heading_tag = absint($heading_tag);
+		return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
+	}
+
+
+	protected static function headingSpacer($heading_tag)
+	{
+		return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
+			? "\n"
+			: '';
+	}
+
+
+	protected static function plainOutput()
+	{
+		return defined('EE_TESTS_DIR') || (defined('DOING_AJAX') && DOING_AJAX);
+	}
+
+
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			$heading = '';
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				$heading .= "\n";
+			}
+			$heading .= "\n{$line}) {$var_name}";
+			return $heading;
+		}
+		$margin = "25px 0 0 {$margin}";
+		return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+	}
+
+
+
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
+	protected static function headingX($heading_tag = 'h5')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return '';
+		}
+		return '</' . $heading_tag . '>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function grey_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function file_and_line($file, $line, $heading_tag)
+	{
+		if ($file === '' || $line === '') {
+			return '';
+		}
+		$file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
+		if (EEH_Debug_Tools::plainOutput()) {
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				return " ({$file})";
+			}
+			return '';
+		}
+		return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
+			   . $file
+			   . '<br />line no: '
+			   . $line
+			   . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		ob_start();
+		var_dump($var);
+		$var = ob_get_clean();
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $var;
+		}
+		return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 */
+	public static function printr(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false
+	) {
+		// return;
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
+		$margin = is_admin() ? ' 180px' : '0';
+		// $print_r = false;
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
+			return;
+		}
+		if (is_object($var)) {
+			$var_name = ! $var_name ? 'object' : $var_name;
+			// $print_r = true;
+		} elseif (is_array($var)) {
+			$var_name = ! $var_name ? 'array' : $var_name;
+			// $print_r = true;
+		} elseif (is_numeric($var)) {
+			$var_name = ! $var_name ? 'numeric' : $var_name;
+		} elseif ($var === null) {
+			$var_name = ! $var_name ? 'null' : $var_name;
+		}
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+			EEH_Debug_Tools::pre_span($var)
+		);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo $result;
+	}
+
+
+
+	/******************** deprecated ********************/
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 */
+	public function reset_times()
+	{
+		Benchmark::resetTimes();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param null $timer_name
+	 */
+	public function start_timer($timer_name = null)
+	{
+		Benchmark::startTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 */
+	public function stop_timer($timer_name = '')
+	{
+		Benchmark::stopTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public function measure_memory($label, $output_now = false)
+	{
+		Benchmark::measureMemory($label, $output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param int $size
+	 * @return string
+	 */
+	public function convert($size)
+	{
+		return Benchmark::convert($size);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param bool $output_now
+	 * @return string
+	 */
+	public function show_times($output_now = true)
+	{
+		return Benchmark::displayResults($output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public function format_time($timer_name, $total_time)
+	{
+		return Benchmark::formatTime($timer_name, $total_time);
+	}
 }
 
 
@@ -679,31 +679,31 @@ 
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
-    function dump_wp_query()
-    {
-        global $wp_query;
-        d($wp_query);
-    }
+	function dump_wp_query()
+	{
+		global $wp_query;
+		d($wp_query);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp')) {
-    function dump_wp()
-    {
-        global $wp;
-        d($wp);
-    }
+	function dump_wp()
+	{
+		global $wp;
+		d($wp);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_post')) {
-    function dump_post()
-    {
-        global $post;
-        d($post);
-    }
+	function dump_post()
+	{
+		global $post;
+		d($post);
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -34,7 +34,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
+        if ( ! self::$_instance instanceof EEH_Debug_Tools) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -48,13 +48,13 @@ 
     private function __construct()
     {
         // load Kint PHP debugging library
-        if (! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php')) {
+        if ( ! class_exists('Kint') && file_exists(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php')) {
             // despite EE4 having a check for an existing copy of the Kint debugging class,
             // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
             // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
             // so we've moved it to our test folder so that it is not included with production releases
             // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests' . DS . 'kint' . DS . 'Kint.class.php');
+            require_once(EE_PLUGIN_DIR_PATH.'tests'.DS.'kint'.DS.'Kint.class.php');
         }
         // if ( ! defined('DOING_AJAX') || $_REQUEST['noheader'] !== 'true' || ! isset( $_REQUEST['noheader'], $_REQUEST['TB_iframe'] ) ) {
         // add_action( 'shutdown', array($this,'espresso_session_footer_dump') );
@@ -74,7 +74,7 @@ 
      */
     public static function show_db_name()
     {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+        if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
             echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
                  . DB_NAME
                  . '</p>';
@@ -123,12 +123,12 @@ 
         global $wp_filter;
         echo '<br/><br/><br/><h3>Hooked Functions</h3>';
         if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
+            $hook[$tag] = $wp_filter[$tag];
+            if ( ! is_array($hook[$tag])) {
                 trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
                 return;
             }
-            echo '<h5>For Tag: ' . $tag . '</h5>';
+            echo '<h5>For Tag: '.$tag.'</h5>';
         } else {
             $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
             ksort($hook);
@@ -157,12 +157,12 @@ 
     {
         $filters = array();
         global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
+        if (isset($wp_filter[$hook_name])) {
+            $filters[$hook_name] = array();
+            foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+                $filters[$hook_name][$priority] = array();
                 foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
+                    $filters[$hook_name][$priority][] = $callback['function'];
                 }
             }
         }
@@ -181,17 +181,17 @@ 
     {
         if (WP_DEBUG) {
             $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+            if ( ! empty($activation_errors)) {
+                $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
             }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+            espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
             if (class_exists('EEH_File')) {
                 try {
                     EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html'
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html'
                     );
                     EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html',
                         $activation_errors
                     );
                 } catch (EE_Error $e) {
@@ -211,11 +211,11 @@ 
             } else {
                 // old school attempt
                 file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . 'espresso_plugin_activation_errors.html',
+                    EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.'espresso_plugin_activation_errors.html',
                     $activation_errors
                 );
             }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+            $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
             update_option('ee_plugin_activation_errors', $activation_errors);
         }
     }
@@ -275,7 +275,7 @@ 
         // don't trigger error if doing ajax,
         // instead we'll add a transient EE_Error notice that in theory should show on the next request.
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
+            $error_message .= ' '.esc_html__(
                 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
                 'event_espresso'
             );
@@ -319,19 +319,19 @@ 
         $debug_key = 'EE_DEBUG_SPCO'
     ) {
         if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
+            $debug_key = $debug_key.'_'.EE_Session::instance()->id();
             $debug_data = get_option($debug_key, array());
             $default_data = array(
-                $class => $func . '() : ' . $line,
+                $class => $func.'() : '.$line,
                 'REQ'  => $display_request ? $_REQUEST : '',
             );
             // don't serialize objects
             $info = self::strip_objects($info);
             $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
+            if ( ! isset($debug_data[$index])) {
+                $debug_data[$index] = array();
             }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+            $debug_data[$index][microtime()] = array_merge($default_data, $info);
             update_option($debug_key, $debug_data);
         }
     }
@@ -348,20 +348,20 @@ 
     {
         foreach ($info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
+                $info[$key] = self::strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
                 if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
+                    $info[$object_class]['ID'] = $value->ID();
                 }
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;
@@ -395,8 +395,8 @@ 
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
         $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+            ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()')
+            : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var);
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
         $result .= EEH_Debug_Tools::headingX($heading_tag);
         if ($die) {
@@ -445,7 +445,7 @@ 
             return $heading;
         }
         $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+        return '<'.$heading_tag.' style="color:#2EA2CC; margin:'.$margin.';"><b>'.$var_name.'</b>';
     }
 
 
@@ -459,7 +459,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return '';
         }
-        return '</' . $heading_tag . '>';
+        return '</'.$heading_tag.'>';
     }
 
 
@@ -473,7 +473,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -513,7 +513,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -530,7 +530,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $var;
         }
-        return '<pre style="color:#999; padding:1em; background: #fff">' . $var . '</pre>';
+        return '<pre style="color:#999; padding:1em; background: #fff">'.$var.'</pre>';
     }
 
 
@@ -574,7 +574,7 @@ 
         $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+        $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span(
             EEH_Debug_Tools::pre_span($var)
         );
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);

core/services/loaders/ClassInterfaceCache.php

Indentation +156 added lines, -156 removed lines

@@ -20,160 +20,160 @@
 class ClassInterfaceCache
 {
 
-    /**
-     * array of interfaces indexed by FQCNs where values are arrays of interface FQNs
-     *
-     * @var string[][] $interfaces
-     */
-    private $interfaces = array();
-
-    /**
-     * @type string[][] $aliases
-     */
-    protected $aliases = array();
-
-
-    /**
-     * @param string $fqn
-     * @return string
-     */
-    public function getFqn($fqn)
-    {
-        return $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn;
-    }
-
-
-    /**
-     * @param string $fqn
-     * @return array
-     */
-    public function getInterfaces($fqn)
-    {
-        $fqn = $this->getFqn($fqn);
-        // have we already seen this FQCN ?
-        if (! array_key_exists($fqn, $this->interfaces)) {
-            $this->interfaces[ $fqn ] = array();
-            if (class_exists($fqn)) {
-                $this->interfaces[ $fqn ] = class_implements($fqn, false);
-                $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
-                    ? $this->interfaces[ $fqn ]
-                    : array();
-            }
-        }
-        return $this->interfaces[ $fqn ];
-    }
-
-
-    /**
-     * @param string $fqn
-     * @param string $interface
-     * @return bool
-     */
-    public function hasInterface($fqn, $interface)
-    {
-        $fqn        = $this->getFqn($fqn);
-        $interfaces = $this->getInterfaces($fqn);
-        return in_array($interface, $interfaces, true);
-    }
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $fqn       the class name that should be used (concrete class to replace interface)
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
-     */
-    public function addAlias($fqn, $alias, $for_class = '')
-    {
-        $fqn   = $this->getFqn($fqn);
-        $alias = $this->getFqn($alias);
-        // are we adding an alias for a specific class?
-        if ($for_class !== '') {
-            // make sure it's set up as an array
-            if (! isset($this->aliases[ $for_class ])) {
-                $this->aliases[ $for_class ] = array();
-            }
-            $this->aliases[ $for_class ][ $alias ] = $fqn;
-            return;
-        }
-        $this->aliases[ $alias ] = $fqn;
-    }
-
-
-    /**
-     * returns TRUE if the provided FQN is an alias
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    public function isAlias($fqn = '', $for_class = '')
-    {
-        $fqn = $this->getFqn($fqn);
-        if ($this->isAliasForClass($fqn, $for_class)) {
-            return true;
-        }
-        if ($for_class === '' && $this->isDirectAlias($fqn)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * returns TRUE if the provided FQN is an alias
-     *
-     * @param string $fqn
-     * @return bool
-     */
-    protected function isDirectAlias($fqn = '')
-    {
-        return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
-    }
-
-
-    /**
-     * returns TRUE if the provided FQN is an alias for the specified class
-     *
-     * @param string $fqn
-     * @param string $for_class
-     * @return bool
-     */
-    protected function isAliasForClass($fqn = '', $for_class = '')
-    {
-        return (
-            $for_class !== ''
-            && isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
-        );
-    }
-
-
-    /**
-     * returns FQN for provided alias if one exists, otherwise returns the original FQN
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
-     *  for example:
-     *      if the following two entries were added to the aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use Loader::getNew( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $alias
-     * @param string $for_class
-     * @return string
-     */
-    public function getFqnForAlias($alias = '', $for_class = '')
-    {
-        $alias = $this->getFqn($alias);
-        if ($this->isAliasForClass($alias, $for_class)) {
-            return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
-        }
-        if ($this->isDirectAlias($alias)) {
-            return $this->getFqnForAlias($this->aliases[ (string) $alias ], '');
-        }
-        return $alias;
-    }
+	/**
+	 * array of interfaces indexed by FQCNs where values are arrays of interface FQNs
+	 *
+	 * @var string[][] $interfaces
+	 */
+	private $interfaces = array();
+
+	/**
+	 * @type string[][] $aliases
+	 */
+	protected $aliases = array();
+
+
+	/**
+	 * @param string $fqn
+	 * @return string
+	 */
+	public function getFqn($fqn)
+	{
+		return $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn;
+	}
+
+
+	/**
+	 * @param string $fqn
+	 * @return array
+	 */
+	public function getInterfaces($fqn)
+	{
+		$fqn = $this->getFqn($fqn);
+		// have we already seen this FQCN ?
+		if (! array_key_exists($fqn, $this->interfaces)) {
+			$this->interfaces[ $fqn ] = array();
+			if (class_exists($fqn)) {
+				$this->interfaces[ $fqn ] = class_implements($fqn, false);
+				$this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
+					? $this->interfaces[ $fqn ]
+					: array();
+			}
+		}
+		return $this->interfaces[ $fqn ];
+	}
+
+
+	/**
+	 * @param string $fqn
+	 * @param string $interface
+	 * @return bool
+	 */
+	public function hasInterface($fqn, $interface)
+	{
+		$fqn        = $this->getFqn($fqn);
+		$interfaces = $this->getInterfaces($fqn);
+		return in_array($interface, $interfaces, true);
+	}
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $fqn       the class name that should be used (concrete class to replace interface)
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
+	 */
+	public function addAlias($fqn, $alias, $for_class = '')
+	{
+		$fqn   = $this->getFqn($fqn);
+		$alias = $this->getFqn($alias);
+		// are we adding an alias for a specific class?
+		if ($for_class !== '') {
+			// make sure it's set up as an array
+			if (! isset($this->aliases[ $for_class ])) {
+				$this->aliases[ $for_class ] = array();
+			}
+			$this->aliases[ $for_class ][ $alias ] = $fqn;
+			return;
+		}
+		$this->aliases[ $alias ] = $fqn;
+	}
+
+
+	/**
+	 * returns TRUE if the provided FQN is an alias
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function isAlias($fqn = '', $for_class = '')
+	{
+		$fqn = $this->getFqn($fqn);
+		if ($this->isAliasForClass($fqn, $for_class)) {
+			return true;
+		}
+		if ($for_class === '' && $this->isDirectAlias($fqn)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * returns TRUE if the provided FQN is an alias
+	 *
+	 * @param string $fqn
+	 * @return bool
+	 */
+	protected function isDirectAlias($fqn = '')
+	{
+		return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
+	}
+
+
+	/**
+	 * returns TRUE if the provided FQN is an alias for the specified class
+	 *
+	 * @param string $fqn
+	 * @param string $for_class
+	 * @return bool
+	 */
+	protected function isAliasForClass($fqn = '', $for_class = '')
+	{
+		return (
+			$for_class !== ''
+			&& isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
+		);
+	}
+
+
+	/**
+	 * returns FQN for provided alias if one exists, otherwise returns the original FQN
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
+	 *  for example:
+	 *      if the following two entries were added to the aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use Loader::getNew( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $alias
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function getFqnForAlias($alias = '', $for_class = '')
+	{
+		$alias = $this->getFqn($alias);
+		if ($this->isAliasForClass($alias, $for_class)) {
+			return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
+		}
+		if ($this->isDirectAlias($alias)) {
+			return $this->getFqnForAlias($this->aliases[ (string) $alias ], '');
+		}
+		return $alias;
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -51,16 +51,16 @@ 
     {
         $fqn = $this->getFqn($fqn);
         // have we already seen this FQCN ?
-        if (! array_key_exists($fqn, $this->interfaces)) {
-            $this->interfaces[ $fqn ] = array();
+        if ( ! array_key_exists($fqn, $this->interfaces)) {
+            $this->interfaces[$fqn] = array();
             if (class_exists($fqn)) {
-                $this->interfaces[ $fqn ] = class_implements($fqn, false);
-                $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false
-                    ? $this->interfaces[ $fqn ]
+                $this->interfaces[$fqn] = class_implements($fqn, false);
+                $this->interfaces[$fqn] = $this->interfaces[$fqn] !== false
+                    ? $this->interfaces[$fqn]
                     : array();
             }
         }
-        return $this->interfaces[ $fqn ];
+        return $this->interfaces[$fqn];
     }
 
 
@@ -91,13 +91,13 @@ 
         // are we adding an alias for a specific class?
         if ($for_class !== '') {
             // make sure it's set up as an array
-            if (! isset($this->aliases[ $for_class ])) {
-                $this->aliases[ $for_class ] = array();
+            if ( ! isset($this->aliases[$for_class])) {
+                $this->aliases[$for_class] = array();
             }
-            $this->aliases[ $for_class ][ $alias ] = $fqn;
+            $this->aliases[$for_class][$alias] = $fqn;
             return;
         }
-        $this->aliases[ $alias ] = $fqn;
+        $this->aliases[$alias] = $fqn;
     }
 
 
@@ -129,7 +129,7 @@ 
      */
     protected function isDirectAlias($fqn = '')
     {
-        return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]);
+        return isset($this->aliases[(string) $fqn]) && ! is_array($this->aliases[(string) $fqn]);
     }
 
 
@@ -144,7 +144,7 @@ 
     {
         return (
             $for_class !== ''
-            && isset($this->aliases[ (string) $for_class ][ (string) $fqn ])
+            && isset($this->aliases[(string) $for_class][(string) $fqn])
         );
     }
 
@@ -169,10 +169,10 @@ 
     {
         $alias = $this->getFqn($alias);
         if ($this->isAliasForClass($alias, $for_class)) {
-            return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class);
+            return $this->getFqnForAlias($this->aliases[(string) $for_class][(string) $alias], $for_class);
         }
         if ($this->isDirectAlias($alias)) {
-            return $this->getFqnForAlias($this->aliases[ (string) $alias ], '');
+            return $this->getFqnForAlias($this->aliases[(string) $alias], '');
         }
         return $alias;
     }

core/domain/services/custom_post_types/RegisterCustomPostTypes.php

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
     {
         $custom_post_types = $this->custom_post_types->getDefinitions();
         foreach ($custom_post_types as $custom_post_type => $CPT) {
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
+            $this->wp_post_types[$custom_post_type] = $this->registerCustomPostType(
                 $custom_post_type,
                 $CPT['singular_name'],
                 $CPT['plural_name'],

Indentation +221 added lines, -221 removed lines

@@ -18,240 +18,240 @@
 class RegisterCustomPostTypes
 {
 
-    /**
-     * @var CustomPostTypeDefinitions $custom_post_types
-     */
-    public $custom_post_types;
+	/**
+	 * @var CustomPostTypeDefinitions $custom_post_types
+	 */
+	public $custom_post_types;
 
-    /**
-     * @var WP_Post_Type[] $wp_post_types
-     */
-    public $wp_post_types = array();
+	/**
+	 * @var WP_Post_Type[] $wp_post_types
+	 */
+	public $wp_post_types = array();
 
 
-    /**
-     * RegisterCustomPostTypes constructor.
-     *
-     * @param CustomPostTypeDefinitions $custom_post_types
-     */
-    public function __construct(CustomPostTypeDefinitions $custom_post_types)
-    {
-        $this->custom_post_types = $custom_post_types;
-    }
+	/**
+	 * RegisterCustomPostTypes constructor.
+	 *
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 */
+	public function __construct(CustomPostTypeDefinitions $custom_post_types)
+	{
+		$this->custom_post_types = $custom_post_types;
+	}
 
 
-    /**
-     * @return WP_Post_Type[]
-     */
-    public function getRegisteredCustomPostTypes()
-    {
-        return $this->wp_post_types;
-    }
+	/**
+	 * @return WP_Post_Type[]
+	 */
+	public function getRegisteredCustomPostTypes()
+	{
+		return $this->wp_post_types;
+	}
 
 
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function registerCustomPostTypes()
-    {
-        $custom_post_types = $this->custom_post_types->getDefinitions();
-        foreach ($custom_post_types as $custom_post_type => $CPT) {
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
-                $custom_post_type,
-                $CPT['singular_name'],
-                $CPT['plural_name'],
-                $CPT['singular_slug'],
-                $CPT['plural_slug'],
-                $CPT['args']
-            );
-        }
-    }
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function registerCustomPostTypes()
+	{
+		$custom_post_types = $this->custom_post_types->getDefinitions();
+		foreach ($custom_post_types as $custom_post_type => $CPT) {
+			$this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
+				$custom_post_type,
+				$CPT['singular_name'],
+				$CPT['plural_name'],
+				$CPT['singular_slug'],
+				$CPT['plural_slug'],
+				$CPT['args']
+			);
+		}
+	}
 
 
-    /**
-     * Registers a new custom post type. Sets default settings given only the following params.
-     * Returns the registered post type object, or an error object.
-     *
-     * @param string $post_type          the actual post type name
-     *                                   IMPORTANT:
-     *                                   this must match what the slug is for admin pages related to this CPT
-     *                                   Also any models must use this slug as well
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @param array  $override_arguments exactly like $args as described in
-     *                                   http://codex.wordpress.org/Function_Reference/register_post_type
-     * @return WP_Post_Type|WP_Error
-     * @throws DomainException
-     */
-    public function registerCustomPostType(
-        $post_type,
-        $singular_name,
-        $plural_name,
-        $singular_slug = '',
-        $plural_slug = '',
-        array $override_arguments = array()
-    ) {
-        $wp_post_type = register_post_type(
-            $post_type,
-            $this->prepareArguments(
-                $post_type,
-                $singular_name,
-                $plural_name,
-                $singular_slug,
-                $plural_slug,
-                $override_arguments
-            )
-        );
-        if ($wp_post_type instanceof WP_Error) {
-            throw new DomainException($wp_post_type->get_error_message());
-        }
-        return $wp_post_type;
-    }
+	/**
+	 * Registers a new custom post type. Sets default settings given only the following params.
+	 * Returns the registered post type object, or an error object.
+	 *
+	 * @param string $post_type          the actual post type name
+	 *                                   IMPORTANT:
+	 *                                   this must match what the slug is for admin pages related to this CPT
+	 *                                   Also any models must use this slug as well
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @param array  $override_arguments exactly like $args as described in
+	 *                                   http://codex.wordpress.org/Function_Reference/register_post_type
+	 * @return WP_Post_Type|WP_Error
+	 * @throws DomainException
+	 */
+	public function registerCustomPostType(
+		$post_type,
+		$singular_name,
+		$plural_name,
+		$singular_slug = '',
+		$plural_slug = '',
+		array $override_arguments = array()
+	) {
+		$wp_post_type = register_post_type(
+			$post_type,
+			$this->prepareArguments(
+				$post_type,
+				$singular_name,
+				$plural_name,
+				$singular_slug,
+				$plural_slug,
+				$override_arguments
+			)
+		);
+		if ($wp_post_type instanceof WP_Error) {
+			throw new DomainException($wp_post_type->get_error_message());
+		}
+		return $wp_post_type;
+	}
 
 
-    /**
-     * @param string $post_type          the actual post type name
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @param array  $override_arguments The default values set in this function will be overridden
-     *                                   by whatever you set in $override_arguments
-     * @return array
-     */
-    protected function prepareArguments(
-        $post_type,
-        $singular_name,
-        $plural_name,
-        $singular_slug,
-        $plural_slug,
-        array $override_arguments = array()
-    ) {
-        // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
-        $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
-        $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
-        $labels = $this->getLabels(
-            $singular_name,
-            $plural_name,
-            $singular_slug,
-            $plural_slug
-        );
-        // note the page_templates arg in the supports index is something specific to EE.
-        // WordPress doesn't actually have that in their register_post_type api.
-        $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
-        if ($override_arguments) {
-            if (isset($override_arguments['labels'])) {
-                $labels = array_merge($arguments['labels'], $override_arguments['labels']);
-            }
-            $arguments = array_merge($arguments, $override_arguments);
-            $arguments['labels'] = $labels;
-        }
-        return $arguments;
-    }
+	/**
+	 * @param string $post_type          the actual post type name
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @param array  $override_arguments The default values set in this function will be overridden
+	 *                                   by whatever you set in $override_arguments
+	 * @return array
+	 */
+	protected function prepareArguments(
+		$post_type,
+		$singular_name,
+		$plural_name,
+		$singular_slug,
+		$plural_slug,
+		array $override_arguments = array()
+	) {
+		// verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
+		$singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
+		$plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
+		$labels = $this->getLabels(
+			$singular_name,
+			$plural_name,
+			$singular_slug,
+			$plural_slug
+		);
+		// note the page_templates arg in the supports index is something specific to EE.
+		// WordPress doesn't actually have that in their register_post_type api.
+		$arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
+		if ($override_arguments) {
+			if (isset($override_arguments['labels'])) {
+				$labels = array_merge($arguments['labels'], $override_arguments['labels']);
+			}
+			$arguments = array_merge($arguments, $override_arguments);
+			$arguments['labels'] = $labels;
+		}
+		return $arguments;
+	}
 
 
-    /**
-     * @param string $singular_name
-     * @param string $plural_name
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @return array
-     */
-    private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
-    {
-        return array(
-            'name'               => $plural_name,
-            'singular_name'      => $singular_name,
-            'singular_slug'      => $singular_slug,
-            'plural_slug'        => $plural_slug,
-            'add_new'            => sprintf(
-                esc_html_x('Add %s', 'Add Event', 'event_espresso'),
-                $singular_name
-            ),
-            'add_new_item'       => sprintf(
-                esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
-                $singular_name
-            ),
-            'edit_item'          => sprintf(
-                esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
-                $singular_name
-            ),
-            'new_item'           => sprintf(
-                esc_html_x('New %s', 'New Event', 'event_espresso'),
-                $singular_name
-            ),
-            'all_items'          => sprintf(
-                esc_html_x('All %s', 'All Events', 'event_espresso'),
-                $plural_name
-            ),
-            'view_item'          => sprintf(
-                esc_html_x('View %s', 'View Event', 'event_espresso'),
-                $singular_name
-            ),
-            'search_items'       => sprintf(
-                esc_html_x('Search %s', 'Search Events', 'event_espresso'),
-                $plural_name
-            ),
-            'not_found'          => sprintf(
-                esc_html_x('No %s found', 'No Events found', 'event_espresso'),
-                $plural_name
-            ),
-            'not_found_in_trash' => sprintf(
-                esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
-                $plural_name
-            ),
-            'parent_item_colon'  => '',
-            'menu_name'          => $plural_name,
-        );
-    }
+	/**
+	 * @param string $singular_name
+	 * @param string $plural_name
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @return array
+	 */
+	private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
+	{
+		return array(
+			'name'               => $plural_name,
+			'singular_name'      => $singular_name,
+			'singular_slug'      => $singular_slug,
+			'plural_slug'        => $plural_slug,
+			'add_new'            => sprintf(
+				esc_html_x('Add %s', 'Add Event', 'event_espresso'),
+				$singular_name
+			),
+			'add_new_item'       => sprintf(
+				esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
+				$singular_name
+			),
+			'edit_item'          => sprintf(
+				esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
+				$singular_name
+			),
+			'new_item'           => sprintf(
+				esc_html_x('New %s', 'New Event', 'event_espresso'),
+				$singular_name
+			),
+			'all_items'          => sprintf(
+				esc_html_x('All %s', 'All Events', 'event_espresso'),
+				$plural_name
+			),
+			'view_item'          => sprintf(
+				esc_html_x('View %s', 'View Event', 'event_espresso'),
+				$singular_name
+			),
+			'search_items'       => sprintf(
+				esc_html_x('Search %s', 'Search Events', 'event_espresso'),
+				$plural_name
+			),
+			'not_found'          => sprintf(
+				esc_html_x('No %s found', 'No Events found', 'event_espresso'),
+				$plural_name
+			),
+			'not_found_in_trash' => sprintf(
+				esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
+				$plural_name
+			),
+			'parent_item_colon'  => '',
+			'menu_name'          => $plural_name,
+		);
+	}
 
 
-    /**
-     * @param array  $labels
-     * @param string $post_type
-     * @param string $plural_slug
-     * @return array
-     */
-    private function getDefaultArguments(array $labels, $post_type, $plural_slug)
-    {
-        return array(
-            'labels'             => $labels,
-            'public'             => true,
-            'publicly_queryable' => true,
-            'show_ui'            => false,
-            'show_ee_ui'         => true,
-            'show_in_menu'       => false,
-            'show_in_nav_menus'  => false,
-            'query_var'          => true,
-            'rewrite'            => apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
-                // legacy filter applied for now,
-                // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-                apply_filters(
-                    'FHEE__EE_Register_CPTs__register_CPT__rewrite',
-                    array('slug' => $plural_slug),
-                    $post_type
-                ),
-                $post_type,
-                $plural_slug
-            ),
-            'capability_type'    => 'post',
-            'map_meta_cap'       => true,
-            'has_archive'        => true,
-            'hierarchical'       => false,
-            'menu_position'      => null,
-            'supports'           => array(
-                'title',
-                'editor',
-                'author',
-                'thumbnail',
-                'excerpt',
-                'custom-fields',
-                'comments',
-            ),
-        );
-    }
+	/**
+	 * @param array  $labels
+	 * @param string $post_type
+	 * @param string $plural_slug
+	 * @return array
+	 */
+	private function getDefaultArguments(array $labels, $post_type, $plural_slug)
+	{
+		return array(
+			'labels'             => $labels,
+			'public'             => true,
+			'publicly_queryable' => true,
+			'show_ui'            => false,
+			'show_ee_ui'         => true,
+			'show_in_menu'       => false,
+			'show_in_nav_menus'  => false,
+			'query_var'          => true,
+			'rewrite'            => apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
+				// legacy filter applied for now,
+				// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+				apply_filters(
+					'FHEE__EE_Register_CPTs__register_CPT__rewrite',
+					array('slug' => $plural_slug),
+					$post_type
+				),
+				$post_type,
+				$plural_slug
+			),
+			'capability_type'    => 'post',
+			'map_meta_cap'       => true,
+			'has_archive'        => true,
+			'hierarchical'       => false,
+			'menu_position'      => null,
+			'supports'           => array(
+				'title',
+				'editor',
+				'author',
+				'thumbnail',
+				'excerpt',
+				'custom-fields',
+				'comments',
+			),
+		);
+	}
 }

core/services/collections/Collection.php

Doc Comments +3 added lines, -3 removed lines

@@ -156,7 +156,7 @@ 
      *
      * @access public
      * @param mixed $identifier
-     * @return mixed
+     * @return boolean
      */
     public function get($identifier)
     {
@@ -278,7 +278,7 @@ 
      * advances pointer to the provided object
      *
      * @access public
-     * @param $object
+     * @param \EventEspresso\core\libraries\form_sections\form_handlers\SequentialStepForm $object
      * @return boolean
      */
     public function setCurrentUsingObject($object)
@@ -316,7 +316,7 @@ 
      *
      * @see http://stackoverflow.com/a/8736013
      * @param $object
-     * @return boolean|int|string
+     * @return integer
      */
     public function indexOf($object)
     {

Indentation +467 added lines, -467 removed lines

@@ -21,471 +21,471 @@
 class Collection extends SplObjectStorage implements CollectionInterface
 {
 
-    /**
-     * a unique string for identifying this collection
-     *
-     * @type string $collection_identifier
-     */
-    protected $collection_identifier;
-
-    /**
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
-     * this should be set from within the child class constructor
-     *
-     * @type string $interface
-     */
-    protected $collection_interface;
-
-
-    /**
-     * Collection constructor
-     *
-     * @param string $collection_interface
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($collection_interface)
-    {
-        $this->setCollectionInterface($collection_interface);
-        $this->setCollectionIdentifier();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function collectionIdentifier()
-    {
-        return $this->collection_identifier;
-    }
-
-
-    /**
-     * creates a very readable unique 9 character identifier like:  CF2-532-DAC
-     * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
-     *
-     * @return void
-     */
-    protected function setCollectionIdentifier()
-    {
-        // hash a few collection details
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
-        // grab a few characters from the start, middle, and end of the hash
-        $id = array();
-        for ($x = 0; $x < 19; $x += 9) {
-            $id[] = substr($identifier, $x, 3);
-        }
-        $identifier = basename(str_replace('\\', '/', get_class($this)));
-        $identifier .= '-' . strtoupper(implode('-', $id));
-        $this->collection_identifier = $identifier;
-    }
-
-
-    /**
-     * setCollectionInterface
-     *
-     * @access protected
-     * @param  string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * add
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_identifier()
-     *
-     * @access public
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function add($object, $identifier = null)
-    {
-        if (! $object instanceof $this->collection_interface) {
-            throw new InvalidEntityException($object, $this->collection_interface);
-        }
-        if ($this->contains($object)) {
-            throw new DuplicateCollectionIdentifierException($identifier);
-        }
-        $this->attach($object);
-        $this->setIdentifier($object, $identifier);
-        return $this->contains($object);
-    }
-
-
-    /**
-     * setIdentifier
-     * Sets the data associated with an object in the Collection
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function setIdentifier($object, $identifier = null)
-    {
-        $identifier = ! empty($identifier)
-            ? $identifier
-            : spl_object_hash($object);
-        $this->rewind();
-        while ($this->valid()) {
-            if ($object === $this->current()) {
-                $this->setInfo($identifier);
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * get
-     * finds and returns an object in the Collection based on the identifier that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed $identifier
-     * @return mixed
-     */
-    public function get($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier
-     *
-     * @access public
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function has($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * hasObject
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function hasObject($object)
-    {
-        return $this->contains($object);
-    }
-
-
-    /**
-     * hasObjects
-     * returns true if there are objects within the Collection, and false if it is empty
-     *
-     * @access public
-     * @return bool
-     */
-    public function hasObjects()
-    {
-        return $this->count() !== 0;
-    }
-
-
-    /**
-     * isEmpty
-     * returns true if there are no objects within the Collection, and false if there are
-     *
-     * @access public
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        return $this->count() === 0;
-    }
-
-
-    /**
-     * remove
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        $this->detach($object);
-        return true;
-    }
-
-
-    /**
-     * setCurrent
-     * advances pointer to the object whose identifier matches that which was provided
-     *
-     * @access public
-     * @param mixed $identifier
-     * @return boolean
-     */
-    public function setCurrent($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * setCurrentUsingObject
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return boolean
-     */
-    public function setCurrentUsingObject($object)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current() === $object) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object occupying the index before the current object,
-     * unless this is already the first object, in which case it just returns the first object
-     *
-     * @return mixed
-     */
-    public function previous()
-    {
-        $index = $this->indexOf($this->current());
-        if ($index === 0) {
-            return $this->current();
-        }
-        $index--;
-        return $this->objectAtIndex($index);
-    }
-
-
-    /**
-     * Returns the index of a given object, or false if not found
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param $object
-     * @return boolean|int|string
-     */
-    public function indexOf($object)
-    {
-        if (! $this->contains($object)) {
-            return false;
-        }
-        foreach ($this as $index => $obj) {
-            if ($obj === $object) {
-                return $index;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     * @return mixed
-     */
-    public function objectAtIndex($index)
-    {
-        $iterator = new LimitIterator($this, $index, 1);
-        $iterator->rewind();
-        return $iterator->current();
-    }
-
-
-    /**
-     * Returns the sequence of objects as specified by the offset and length
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $offset
-     * @param int $length
-     * @return array
-     */
-    public function slice($offset, $length)
-    {
-        $slice = array();
-        $iterator = new LimitIterator($this, $offset, $length);
-        foreach ($iterator as $object) {
-            $slice[] = $object;
-        }
-        return $slice;
-    }
-
-
-    /**
-     * Inserts an object at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $object A single object
-     * @param int   $index
-     * @param mixed $identifier
-     * @return bool
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidEntityException
-     */
-    public function insertObjectAt($object, $index, $identifier = null)
-    {
-        // check to ensure that objects don't already exist in the collection
-        if ($this->has($identifier)) {
-            throw new DuplicateCollectionIdentifierException($identifier);
-        }
-        // detach any objects at or past this index
-        $remaining_objects = array();
-        if ($index < $this->count()) {
-            $remaining_objects = $this->slice($index, $this->count() - $index);
-            foreach ($remaining_objects as $key => $remaining_object) {
-                // we need to grab the identifiers for each object and use them as keys
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
-                // and then remove the object from the current tracking array
-                unset($remaining_objects[ $key ]);
-                // and then remove it from the Collection
-                $this->detach($remaining_object);
-            }
-        }
-        // add the new object we're splicing in
-        $this->add($object, $identifier);
-        // attach the objects we previously detached
-        foreach ($remaining_objects as $key => $remaining_object) {
-            $this->add($remaining_object, $key);
-        }
-        return $this->contains($object);
-    }
-
-
-    /**
-     * Inserts an object (or an array of objects) at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $objects A single object or an array of objects
-     * @param int   $index
-     */
-    public function insertAt($objects, $index)
-    {
-        if (! is_array($objects)) {
-            $objects = array($objects);
-        }
-        // check to ensure that objects don't already exist in the collection
-        foreach ($objects as $key => $object) {
-            if ($this->contains($object)) {
-                unset($objects[ $key ]);
-            }
-        }
-        // do we have any objects left?
-        if (! $objects) {
-            return;
-        }
-        // detach any objects at or past this index
-        $remaining = array();
-        if ($index < $this->count()) {
-            $remaining = $this->slice($index, $this->count() - $index);
-            foreach ($remaining as $object) {
-                $this->detach($object);
-            }
-        }
-        // add the new objects we're splicing in
-        foreach ($objects as $object) {
-            $this->attach($object);
-        }
-        // attach the objects we previously detached
-        foreach ($remaining as $object) {
-            $this->attach($object);
-        }
-    }
-
-
-    /**
-     * Removes the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     */
-    public function removeAt($index)
-    {
-        $this->detach($this->objectAtIndex($index));
-    }
-
-
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-        }
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the Collection
-     */
-    public function trashAndDetachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-            unset($object);
-        }
-    }
+	/**
+	 * a unique string for identifying this collection
+	 *
+	 * @type string $collection_identifier
+	 */
+	protected $collection_identifier;
+
+	/**
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
+	 * this should be set from within the child class constructor
+	 *
+	 * @type string $interface
+	 */
+	protected $collection_interface;
+
+
+	/**
+	 * Collection constructor
+	 *
+	 * @param string $collection_interface
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($collection_interface)
+	{
+		$this->setCollectionInterface($collection_interface);
+		$this->setCollectionIdentifier();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function collectionIdentifier()
+	{
+		return $this->collection_identifier;
+	}
+
+
+	/**
+	 * creates a very readable unique 9 character identifier like:  CF2-532-DAC
+	 * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
+	 *
+	 * @return void
+	 */
+	protected function setCollectionIdentifier()
+	{
+		// hash a few collection details
+		$identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
+		// grab a few characters from the start, middle, and end of the hash
+		$id = array();
+		for ($x = 0; $x < 19; $x += 9) {
+			$id[] = substr($identifier, $x, 3);
+		}
+		$identifier = basename(str_replace('\\', '/', get_class($this)));
+		$identifier .= '-' . strtoupper(implode('-', $id));
+		$this->collection_identifier = $identifier;
+	}
+
+
+	/**
+	 * setCollectionInterface
+	 *
+	 * @access protected
+	 * @param  string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * add
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_identifier()
+	 *
+	 * @access public
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function add($object, $identifier = null)
+	{
+		if (! $object instanceof $this->collection_interface) {
+			throw new InvalidEntityException($object, $this->collection_interface);
+		}
+		if ($this->contains($object)) {
+			throw new DuplicateCollectionIdentifierException($identifier);
+		}
+		$this->attach($object);
+		$this->setIdentifier($object, $identifier);
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * setIdentifier
+	 * Sets the data associated with an object in the Collection
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function setIdentifier($object, $identifier = null)
+	{
+		$identifier = ! empty($identifier)
+			? $identifier
+			: spl_object_hash($object);
+		$this->rewind();
+		while ($this->valid()) {
+			if ($object === $this->current()) {
+				$this->setInfo($identifier);
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * get
+	 * finds and returns an object in the Collection based on the identifier that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed $identifier
+	 * @return mixed
+	 */
+	public function get($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @access public
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function has($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * hasObject
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function hasObject($object)
+	{
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * hasObjects
+	 * returns true if there are objects within the Collection, and false if it is empty
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function hasObjects()
+	{
+		return $this->count() !== 0;
+	}
+
+
+	/**
+	 * isEmpty
+	 * returns true if there are no objects within the Collection, and false if there are
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		return $this->count() === 0;
+	}
+
+
+	/**
+	 * remove
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		$this->detach($object);
+		return true;
+	}
+
+
+	/**
+	 * setCurrent
+	 * advances pointer to the object whose identifier matches that which was provided
+	 *
+	 * @access public
+	 * @param mixed $identifier
+	 * @return boolean
+	 */
+	public function setCurrent($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * setCurrentUsingObject
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return boolean
+	 */
+	public function setCurrentUsingObject($object)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current() === $object) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object occupying the index before the current object,
+	 * unless this is already the first object, in which case it just returns the first object
+	 *
+	 * @return mixed
+	 */
+	public function previous()
+	{
+		$index = $this->indexOf($this->current());
+		if ($index === 0) {
+			return $this->current();
+		}
+		$index--;
+		return $this->objectAtIndex($index);
+	}
+
+
+	/**
+	 * Returns the index of a given object, or false if not found
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param $object
+	 * @return boolean|int|string
+	 */
+	public function indexOf($object)
+	{
+		if (! $this->contains($object)) {
+			return false;
+		}
+		foreach ($this as $index => $obj) {
+			if ($obj === $object) {
+				return $index;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 * @return mixed
+	 */
+	public function objectAtIndex($index)
+	{
+		$iterator = new LimitIterator($this, $index, 1);
+		$iterator->rewind();
+		return $iterator->current();
+	}
+
+
+	/**
+	 * Returns the sequence of objects as specified by the offset and length
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $offset
+	 * @param int $length
+	 * @return array
+	 */
+	public function slice($offset, $length)
+	{
+		$slice = array();
+		$iterator = new LimitIterator($this, $offset, $length);
+		foreach ($iterator as $object) {
+			$slice[] = $object;
+		}
+		return $slice;
+	}
+
+
+	/**
+	 * Inserts an object at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $object A single object
+	 * @param int   $index
+	 * @param mixed $identifier
+	 * @return bool
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidEntityException
+	 */
+	public function insertObjectAt($object, $index, $identifier = null)
+	{
+		// check to ensure that objects don't already exist in the collection
+		if ($this->has($identifier)) {
+			throw new DuplicateCollectionIdentifierException($identifier);
+		}
+		// detach any objects at or past this index
+		$remaining_objects = array();
+		if ($index < $this->count()) {
+			$remaining_objects = $this->slice($index, $this->count() - $index);
+			foreach ($remaining_objects as $key => $remaining_object) {
+				// we need to grab the identifiers for each object and use them as keys
+				$remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
+				// and then remove the object from the current tracking array
+				unset($remaining_objects[ $key ]);
+				// and then remove it from the Collection
+				$this->detach($remaining_object);
+			}
+		}
+		// add the new object we're splicing in
+		$this->add($object, $identifier);
+		// attach the objects we previously detached
+		foreach ($remaining_objects as $key => $remaining_object) {
+			$this->add($remaining_object, $key);
+		}
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * Inserts an object (or an array of objects) at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $objects A single object or an array of objects
+	 * @param int   $index
+	 */
+	public function insertAt($objects, $index)
+	{
+		if (! is_array($objects)) {
+			$objects = array($objects);
+		}
+		// check to ensure that objects don't already exist in the collection
+		foreach ($objects as $key => $object) {
+			if ($this->contains($object)) {
+				unset($objects[ $key ]);
+			}
+		}
+		// do we have any objects left?
+		if (! $objects) {
+			return;
+		}
+		// detach any objects at or past this index
+		$remaining = array();
+		if ($index < $this->count()) {
+			$remaining = $this->slice($index, $this->count() - $index);
+			foreach ($remaining as $object) {
+				$this->detach($object);
+			}
+		}
+		// add the new objects we're splicing in
+		foreach ($objects as $object) {
+			$this->attach($object);
+		}
+		// attach the objects we previously detached
+		foreach ($remaining as $object) {
+			$this->attach($object);
+		}
+	}
+
+
+	/**
+	 * Removes the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 */
+	public function removeAt($index)
+	{
+		$this->detach($this->objectAtIndex($index));
+	}
+
+
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+		}
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the Collection
+	 */
+	public function trashAndDetachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+			unset($object);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -68,14 +68,14 @@ 
     protected function setCollectionIdentifier()
     {
         // hash a few collection details
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
+        $identifier = md5(spl_object_hash($this).$this->collection_interface.time());
         // grab a few characters from the start, middle, and end of the hash
         $id = array();
         for ($x = 0; $x < 19; $x += 9) {
             $id[] = substr($identifier, $x, 3);
         }
         $identifier = basename(str_replace('\\', '/', get_class($this)));
-        $identifier .= '-' . strtoupper(implode('-', $id));
+        $identifier .= '-'.strtoupper(implode('-', $id));
         $this->collection_identifier = $identifier;
     }
 
@@ -89,7 +89,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -111,7 +111,7 @@ 
      */
     public function add($object, $identifier = null)
     {
-        if (! $object instanceof $this->collection_interface) {
+        if ( ! $object instanceof $this->collection_interface) {
             throw new InvalidEntityException($object, $this->collection_interface);
         }
         if ($this->contains($object)) {
@@ -322,7 +322,7 @@ 
      */
     public function indexOf($object)
     {
-        if (! $this->contains($object)) {
+        if ( ! $this->contains($object)) {
             return false;
         }
         foreach ($this as $index => $obj) {
@@ -391,9 +391,9 @@ 
             $remaining_objects = $this->slice($index, $this->count() - $index);
             foreach ($remaining_objects as $key => $remaining_object) {
                 // we need to grab the identifiers for each object and use them as keys
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
+                $remaining_objects[$remaining_object->getInfo()] = $remaining_object;
                 // and then remove the object from the current tracking array
-                unset($remaining_objects[ $key ]);
+                unset($remaining_objects[$key]);
                 // and then remove it from the Collection
                 $this->detach($remaining_object);
             }
@@ -417,17 +417,17 @@ 
      */
     public function insertAt($objects, $index)
     {
-        if (! is_array($objects)) {
+        if ( ! is_array($objects)) {
             $objects = array($objects);
         }
         // check to ensure that objects don't already exist in the collection
         foreach ($objects as $key => $object) {
             if ($this->contains($object)) {
-                unset($objects[ $key ]);
+                unset($objects[$key]);
             }
         }
         // do we have any objects left?
-        if (! $objects) {
+        if ( ! $objects) {
             return;
         }
         // detach any objects at or past this index

core/services/collections/InvalidCollectionIdentifierException.php

Indentation +21 added lines, -21 removed lines

@@ -16,26 +16,26 @@
 class InvalidCollectionIdentifierException extends OutOfBoundsException
 {
 
-    /**
-     * InvalidCollectionIdentifierException constructor.
-     *
-     * @param                $identifier
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied identifier "%1$s" does not exist within this collection. 
+	/**
+	 * InvalidCollectionIdentifierException constructor.
+	 *
+	 * @param                $identifier
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied identifier "%1$s" does not exist within this collection. 
                     You may need to delay adding this asset until the required dependency has been added.',
-                    'event_espresso'
-                ),
-                $identifier
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+					'event_espresso'
+				),
+				$identifier
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }