eventespresso / event-espresso-core

core/EE_Load_Espresso_Core.core.php

Indentation +223 added lines, -223 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\services\loaders\LoaderInterface;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,228 +24,228 @@ 
 class EE_Load_Espresso_Core implements EEI_Request_Decorator, EEI_Request_Stack_Core_App
 {
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var EE_Request $request
-     */
-    protected $request;
-
-    /**
-     * @var EE_Response $response
-     */
-    protected $response;
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-
-
-    /**
-     * EE_Load_Espresso_Core constructor
-     */
-    public function __construct()
-    {
-        espresso_load_required('EventEspresso\core\Factory', EE_CORE . 'Factory.php');
-    }
-
-
-
-    /**
-     * handle
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Response
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        $this->request = $request;
-        $this->response = $response;
-        // info about how to load classes required by other classes
-        $this->dependency_map = $this->_load_dependency_map();
-        // central repository for classes
-        $this->registry = $this->_load_registry();
-        // PSR4 Autoloaders
-        $this->registry->load_core('EE_Psr4AutoloaderInit');
-        do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
-        $this->loader = $this->registry->create('EventEspresso\core\services\loaders\Loader');
-        $this->dependency_map->setLoader($this->loader);
-        // build DI container
-        $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-        $OpenCoffeeShop->addRecipes();
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-        // create and cache the CommandBus, and also add middleware
-        $this->registry->create(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->registry->create('CapChecker'),
-                        $this->registry->create('AddActionHook'),
-                    )
-                ),
-            ),
-            true
-        );
-        // workarounds for PHP < 5.3
-        $this->_load_class_tools();
-        // load interfaces
-        espresso_load_required('EEI_Payment_Method_Interfaces',
-            EE_LIBRARIES . 'payment_methods' . DS . 'EEI_Payment_Method_Interfaces.php');
-        // deprecated functions
-        espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
-        // WP cron jobs
-        $this->registry->load_core('Cron_Tasks');
-        $this->registry->load_core('EE_Request_Handler');
-        $this->registry->load_core('EE_System');
-        return $this->response;
-    }
-
-
-
-    /**
-     * @return EE_Request
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-
-    /**
-     * @return EE_Response
-     */
-    public function response()
-    {
-        return $this->response;
-    }
-
-
-
-    /**
-     * @return EE_Dependency_Map
-     * @throws EE_Error
-     */
-    public function dependency_map()
-    {
-        if (! $this->dependency_map instanceof EE_Dependency_Map) {
-            throw new EE_Error(
-                sprintf(
-                    __('Invalid EE_Dependency_Map: "%1$s"', 'event_espresso'),
-                    print_r($this->dependency_map, true)
-                )
-            );
-        }
-        return $this->dependency_map;
-    }
-
-
-
-    /**
-     * @return EE_Registry
-     * @throws EE_Error
-     */
-    public function registry()
-    {
-        if (! $this->registry instanceof EE_Registry) {
-            throw new EE_Error(
-                sprintf(
-                    __('Invalid EE_Registry: "%1$s"', 'event_espresso'),
-                    print_r($this->registry, true)
-                )
-            );
-        }
-        return $this->registry;
-    }
-
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    private function _load_dependency_map()
-    {
-        if (! is_readable(EE_CORE . 'EE_Dependency_Map.core.php')) {
-            EE_Error::add_error(
-                __('The EE_Dependency_Map core class could not be loaded.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            wp_die(EE_Error::get_notices());
-        }
-        require_once(EE_CORE . 'EE_Dependency_Map.core.php');
-        return EE_Dependency_Map::instance($this->request, $this->response);
-    }
-
-
-
-    /**
-     * @return EE_Registry
-     */
-    private function _load_registry()
-    {
-        if (! is_readable(EE_CORE . 'EE_Registry.core.php')) {
-            EE_Error::add_error(
-                __('The EE_Registry core class could not be loaded.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            wp_die(EE_Error::get_notices());
-        }
-        require_once(EE_CORE . 'EE_Registry.core.php');
-        return EE_Registry::instance($this->dependency_map);
-    }
-
-
-
-    /**
-     * @return void
-     */
-    private function _load_class_tools()
-    {
-        if (! is_readable(EE_HELPERS . 'EEH_Class_Tools.helper.php')) {
-            EE_Error::add_error(
-                __('The EEH_Class_Tools helper could not be loaded.', 'event_espresso'),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-        require_once(EE_HELPERS . 'EEH_Class_Tools.helper.php');
-    }
-
-
-
-    /**
-     * called after the request stack has been fully processed
-     * if any of the middleware apps has requested the plugin be deactivated, then we do that now
-     *
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     */
-    public function handle_response(EE_Request $request, EE_Response $response)
-    {
-        if ($response->plugin_deactivated()) {
-            espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
-        }
-    }
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var EE_Request $request
+	 */
+	protected $request;
+
+	/**
+	 * @var EE_Response $response
+	 */
+	protected $response;
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+
+
+	/**
+	 * EE_Load_Espresso_Core constructor
+	 */
+	public function __construct()
+	{
+		espresso_load_required('EventEspresso\core\Factory', EE_CORE . 'Factory.php');
+	}
+
+
+
+	/**
+	 * handle
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Response
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		$this->request = $request;
+		$this->response = $response;
+		// info about how to load classes required by other classes
+		$this->dependency_map = $this->_load_dependency_map();
+		// central repository for classes
+		$this->registry = $this->_load_registry();
+		// PSR4 Autoloaders
+		$this->registry->load_core('EE_Psr4AutoloaderInit');
+		do_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading');
+		$this->loader = $this->registry->create('EventEspresso\core\services\loaders\Loader');
+		$this->dependency_map->setLoader($this->loader);
+		// build DI container
+		$OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+		$OpenCoffeeShop->addRecipes();
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+		// create and cache the CommandBus, and also add middleware
+		$this->registry->create(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->registry->create('CapChecker'),
+						$this->registry->create('AddActionHook'),
+					)
+				),
+			),
+			true
+		);
+		// workarounds for PHP < 5.3
+		$this->_load_class_tools();
+		// load interfaces
+		espresso_load_required('EEI_Payment_Method_Interfaces',
+			EE_LIBRARIES . 'payment_methods' . DS . 'EEI_Payment_Method_Interfaces.php');
+		// deprecated functions
+		espresso_load_required('EE_Deprecated', EE_CORE . 'EE_Deprecated.core.php');
+		// WP cron jobs
+		$this->registry->load_core('Cron_Tasks');
+		$this->registry->load_core('EE_Request_Handler');
+		$this->registry->load_core('EE_System');
+		return $this->response;
+	}
+
+
+
+	/**
+	 * @return EE_Request
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+
+	/**
+	 * @return EE_Response
+	 */
+	public function response()
+	{
+		return $this->response;
+	}
+
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 * @throws EE_Error
+	 */
+	public function dependency_map()
+	{
+		if (! $this->dependency_map instanceof EE_Dependency_Map) {
+			throw new EE_Error(
+				sprintf(
+					__('Invalid EE_Dependency_Map: "%1$s"', 'event_espresso'),
+					print_r($this->dependency_map, true)
+				)
+			);
+		}
+		return $this->dependency_map;
+	}
+
+
+
+	/**
+	 * @return EE_Registry
+	 * @throws EE_Error
+	 */
+	public function registry()
+	{
+		if (! $this->registry instanceof EE_Registry) {
+			throw new EE_Error(
+				sprintf(
+					__('Invalid EE_Registry: "%1$s"', 'event_espresso'),
+					print_r($this->registry, true)
+				)
+			);
+		}
+		return $this->registry;
+	}
+
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	private function _load_dependency_map()
+	{
+		if (! is_readable(EE_CORE . 'EE_Dependency_Map.core.php')) {
+			EE_Error::add_error(
+				__('The EE_Dependency_Map core class could not be loaded.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			wp_die(EE_Error::get_notices());
+		}
+		require_once(EE_CORE . 'EE_Dependency_Map.core.php');
+		return EE_Dependency_Map::instance($this->request, $this->response);
+	}
+
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	private function _load_registry()
+	{
+		if (! is_readable(EE_CORE . 'EE_Registry.core.php')) {
+			EE_Error::add_error(
+				__('The EE_Registry core class could not be loaded.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			wp_die(EE_Error::get_notices());
+		}
+		require_once(EE_CORE . 'EE_Registry.core.php');
+		return EE_Registry::instance($this->dependency_map);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	private function _load_class_tools()
+	{
+		if (! is_readable(EE_HELPERS . 'EEH_Class_Tools.helper.php')) {
+			EE_Error::add_error(
+				__('The EEH_Class_Tools helper could not be loaded.', 'event_espresso'),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+		require_once(EE_HELPERS . 'EEH_Class_Tools.helper.php');
+	}
+
+
+
+	/**
+	 * called after the request stack has been fully processed
+	 * if any of the middleware apps has requested the plugin be deactivated, then we do that now
+	 *
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 */
+	public function handle_response(EE_Request $request, EE_Response $response)
+	{
+		if ($response->plugin_deactivated()) {
+			espresso_deactivate_plugin(EE_PLUGIN_BASENAME);
+		}
+	}
 
 
 

core/EE_Registry.core.php

Indentation +1390 added lines, -1390 removed lines

@@ -16,1426 +16,1426 @@
 class EE_Registry
 {
 
-    /**
-     *    EE_Registry Object
-     *
-     * @var EE_Registry $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     * @access    protected
-     */
-    protected $_dependency_map = null;
-
-    /**
-     * @var array $_class_abbreviations
-     * @access    protected
-     */
-    protected $_class_abbreviations = array();
-
-    /**
-     * @access public
-     * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     *    EE_Cart Object
-     *
-     * @access    public
-     * @var    EE_Cart $CART
-     */
-    public $CART = null;
-
-    /**
-     *    EE_Config Object
-     *
-     * @access    public
-     * @var    EE_Config $CFG
-     */
-    public $CFG = null;
-
-    /**
-     * EE_Network_Config Object
-     *
-     * @access public
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG = null;
-
-    /**
-     *    StdClass object for storing library classes in
-     *
-     * @public LIB
-     * @var StdClass $LIB
-     */
-    public $LIB = null;
-
-    /**
-     *    EE_Request_Handler Object
-     *
-     * @access    public
-     * @var    EE_Request_Handler $REQ
-     */
-    public $REQ = null;
-
-    /**
-     *    EE_Session Object
-     *
-     * @access    public
-     * @var    EE_Session $SSN
-     */
-    public $SSN = null;
-
-    /**
-     * holds the ee capabilities object.
-     *
-     * @since 4.5.0
-     * @var EE_Capabilities
-     */
-    public $CAP = null;
-
-    /**
-     * holds the EE_Message_Resource_Manager object.
-     *
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager
-     */
-    public $MRM = null;
-
-
-    /**
-     * Holds the Assets Registry instance
-     * @var Registry
-     */
-    public $AssetsRegistry = null;
-
-    /**
-     *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
-     *
-     * @access    public
-     * @var    EE_Addon[]
-     */
-    public $addons = null;
-
-    /**
-     *    $models
-     * @access    public
-     * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     */
-    public $models = array();
-
-    /**
-     *    $modules
-     * @access    public
-     * @var    EED_Module[] $modules
-     */
-    public $modules = null;
-
-    /**
-     *    $shortcodes
-     * @access    public
-     * @var    EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes = null;
-
-    /**
-     *    $widgets
-     * @access    public
-     * @var    WP_Widget[] $widgets
-     */
-    public $widgets = null;
-
-    /**
-     * $non_abstract_db_models
-     * @access public
-     * @var array 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")
-     */
-    public $non_abstract_db_models = array();
-
-
-    /**
-     *    $i18n_js_strings - internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @access    public
-     * @var    array
-     */
-    public static $i18n_js_strings = array();
-
-
-    /**
-     *    $main_file - path to espresso.php
-     *
-     * @access    public
-     * @var    array
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @access    public
-     * @var ReflectionClass[]
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @access    protected
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param  \EE_Dependency_Map $dependency_map
-     * @return \EE_Registry instance
-     */
-    public static function instance(\EE_Dependency_Map $dependency_map = null)
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Registry) {
-            self::$_instance = new EE_Registry($dependency_map);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param  \EE_Dependency_Map $dependency_map
-     */
-    protected function __construct(\EE_Dependency_Map $dependency_map)
-    {
-        $this->_dependency_map = $dependency_map;
-        $this->LIB = new stdClass();
-        $this->addons = new stdClass();
-        $this->modules = new stdClass();
-        $this->shortcodes = new stdClass();
-        $this->widgets = new stdClass();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-    }
-
-
-
-    /**
-     * initialize
-     */
-    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('EE_Request');
-        $this->_set_cached_class(
-            $request_loader(),
-            'EE_Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader('EE_Response');
-        $this->_set_cached_class(
-            $response_loader(),
-            'EE_Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
-    }
-
-
-
-    /**
-     *    init
-     *
-     * @access    public
-     * @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)EE_Registry::$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
-     */
-    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')) {
-                $this->load_core('Module_Request_Router');
-            }
-            $this->modules->{$module} = 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
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    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 . '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
-     *
-     * @access    public
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return mixed
-     */
-    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
-     *
-     * @access    public
-     * @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
-     */
-    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, 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
-     */
-    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
-     */
-    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
-     *
-     * @access    public
-     * @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
-     */
-    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
-     */
-    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
-     */
-    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]) ? true : false;
-    }
-
-
-
-    /**
-     *    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
-     */
-    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);
-    }
-
-
-
-    /**
-     *    load_addon
-     *
-     * @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 EE_Addon
-     */
-    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 mixed                    null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    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->_dependency_map->get_alias($class_name);
-        if ( ! class_exists($class_name)) {
-            // maybe the class is registered with a preceding \
-            $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
-            // still doesn't exist ?
-            if ( ! class_exists($class_name)) {
-                return null;
-            }
-        }
-        // 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);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-    /**
-     * 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 null|object|bool         null = failure to load or instantiate class object.
-     *                                  object = class loaded and instantiated successfully.
-     *                                  bool = fail or success when $load_only is true
-     */
-    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->_dependency_map->get_alias($class_name);
-        $class_exists = class_exists($class_name);
-        // 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;
-        }
-        // $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);
-            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 loading failed, or we are only loading a file but NOT instantiating an object
-            if ( ! $loaded || $load_only) {
-                // return boolean if only loading, or null if an object was expected
-                return $load_only ? $loaded : 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);
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-
-
-    /**
-     * _get_cached_class
-     * 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
-     *
-     * @access protected
-     * @param string $class_name
-     * @param string $class_prefix
-     * @return mixed
-     */
-    protected function _get_cached_class($class_name, $class_prefix = '')
-    {
-        // have to specify something, but not anything that will conflict
-        $class_abbreviation = isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
-            : 'FANCY_BATMAN_PANTS';
-        $class_name = str_replace('\\', '_', $class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        if (isset ($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if (isset ($this->LIB->{$class_name})) {
-            return $this->LIB->{$class_name};
-        }
-        if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
-            return $this->addons->{$class_name};
-        }
-        return null;
-    }
-
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string $class_name
-     * @param boolean $addon
-     * @return boolean
-     */
-    public function clear_cached_class($class_name, $addon = false)
-    {
-        // have to specify something, but not anything that will conflict
-        $class_abbreviation = isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
-            : 'FANCY_BATMAN_PANTS';
-        $class_name = str_replace('\\', '_', $class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if (isset($this->LIB->{$class_name})) {
-            unset($this->LIB->{$class_name});
-            return true;
-        }
-        if ($addon && isset($this->addons->{$class_name})) {
-            unset($this->addons->{$class_name});
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _resolve_path
-     * 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
-     *
-     * @access protected
-     * @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;
-    }
-
-
-
-    /**
-     * _require_file
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @access protected
-     * @param  string $path
-     * @param  string $class_name
-     * @param  string $type
-     * @param  array  $file_paths
-     * @return boolean
-     * @throws \EE_Error
-     */
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
-    {
-        // don't give up! you gotta...
-        try {
-            //does the file exist and can it be read ?
-            if ( ! $path) {
-                // so sorry, can't find the file
-                throw new EE_Error (
-                    sprintf(
-                        __('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(
-                        __('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;
-    }
-
-
-
-    /**
-     * _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
-     *
-     * @access protected
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null | object
-     * @throws \EE_Error
-     */
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
-    {
-        $class_obj = null;
-        $instantiation_mode = '0) none';
-        // don't give up! you gotta...
-        try {
-            // create reflection
-            $reflector = $this->get_ReflectionClass($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";
-                $class_obj = true;
-            } else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
-                // no constructor = static methods only... nothing to instantiate, loading file was enough
-                $instantiation_mode = "2) no constructor but instantiable";
-                $class_obj = $reflector->newInstance();
-            } else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-                $instantiation_mode = "3) new_instance_from_db()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
-            } else if (method_exists($class_name, 'new_instance')) {
-                $instantiation_mode = "4) new_instance()";
-                $class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
-            } else if (method_exists($class_name, 'instance')) {
-                $instantiation_mode = "5) instance()";
-                $class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
-            } else if ($reflector->isInstantiable()) {
-                $instantiation_mode = "6) constructor";
-                $class_obj = $reflector->newInstanceArgs($arguments);
-            } else {
-                // heh ? something's not right !
-                throw new EE_Error(
-                    sprintf(
-                        __('The %s file %s could not be instantiated.', 'event_espresso'),
-                        $type,
-                        $class_name
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            if ( ! $e instanceof EE_Error) {
-                $e = new EE_Error(
-                    sprintf(
-                        __('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
-                        $class_name,
-                        '<br />',
-                        $e->getMessage(),
-                        $instantiation_mode
-                    )
-                );
-            }
-            $e->get_error();
-        }
-        return $class_obj;
-    }
-
-
-
-    /**
-     * @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;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @access public
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function get_ReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->_reflectors[$class_name])
-            || ! $this->_reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->_reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->_reflectors[$class_name];
-    }
-
-
-
-    /**
-     * _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
-     *
-     * @access protected
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws \ReflectionException
-     */
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
-    {
-        // let's examine the constructor
-        $constructor = $reflector->getConstructor();
-        // whu? huh? nothing?
-        if ( ! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $constructor->getParameters();
-        // 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 = $param->getClass() ? $param->getClass()->name : null;
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->_dependency_map->has_alias($param_class, $class_name)
-                ? $this->_dependency_map->get_alias($param_class, $class_name)
-                : $param_class;
-            if (
-                // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-            ) {
-                // 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
-                ! empty($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;
-            }
-            if (
-                // parameter is type hinted as a class, and should be injected
-                ! empty($param_class)
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
-            ) {
-                $arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
-            } else {
-                try {
-                    $arguments[$index] = $param->getDefaultValue();
-                } catch (ReflectionException $e) {
-                    throw new ReflectionException(
-                        sprintf(
-                            __('%1$s for parameter "$%2$s"', 'event_espresso'),
-                            $e->getMessage(),
-                            $param->getName()
-                        )
-                    );
-                }
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     */
-    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)
-                    !== EE_Dependency_Map::load_new_object
-            ? true
-            : false;
-        // 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;
-        } else if ($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();
-            } 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 = $this->create($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
-            if (isset($argument_keys[$index])) {
-                $arguments[$argument_keys[$index]] = $dependency;
-            } else {
-                $arguments[$index] = $dependency;
-            }
-        }
-        return $arguments;
-    }
-
-
-
-    /**
-     * _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
-     *
-     * @access protected
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @return void
-     */
-    protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
-    {
-        if (empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        if (isset($this->_class_abbreviations[$class_name])) {
-            $class_abbreviation = $this->_class_abbreviations[$class_name];
-            $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) {
-            $this->LIB->{$class_name} = $class_obj;
-        }
-    }
-
-
-
-    /**
-     * 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(EE_Registry::instance(), $loader)) {
-            return EE_Registry::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the classname as the property name on EE_Config::instance()->addons)
-     *
-     * @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_Config::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, use EE_Config::instance()->addons->{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(__('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             whether to reset data in the database too, or just refresh
-     *                                  the Registry to its state at the beginning of the request
-     * @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
-     */
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
-    {
-        $instance = self::instance();
-        EEH_Activation::reset();
-        //properties that get reset
-        $instance->_cache_on = true;
-        $instance->CFG = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART = null;
-        $instance->MRM = null;
-        $instance->AssetsRegistry = null;
-        $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
-        //messages reset
-        EED_Messages::reset();
-        if ($reset_models) {
-            foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
-                $instance->reset_model($model_name);
-            }
-        }
-        $instance->LIB = new stdClass();
-        return $instance;
-    }
-
-
-
-    /**
-     * @override magic methods
-     * @return void
-     */
-    public final function __destruct()
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    public final function __call($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    public final function __get($a)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     * @param $b
-     */
-    public final function __set($a, $b)
-    {
-    }
-
-
-
-    /**
-     * @param $a
-     */
-    public final function __isset($a)
-    {
-    }
+	/**
+	 *    EE_Registry Object
+	 *
+	 * @var EE_Registry $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 * @access    protected
+	 */
+	protected $_dependency_map = null;
+
+	/**
+	 * @var array $_class_abbreviations
+	 * @access    protected
+	 */
+	protected $_class_abbreviations = array();
+
+	/**
+	 * @access public
+	 * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 *    EE_Cart Object
+	 *
+	 * @access    public
+	 * @var    EE_Cart $CART
+	 */
+	public $CART = null;
+
+	/**
+	 *    EE_Config Object
+	 *
+	 * @access    public
+	 * @var    EE_Config $CFG
+	 */
+	public $CFG = null;
+
+	/**
+	 * EE_Network_Config Object
+	 *
+	 * @access public
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG = null;
+
+	/**
+	 *    StdClass object for storing library classes in
+	 *
+	 * @public LIB
+	 * @var StdClass $LIB
+	 */
+	public $LIB = null;
+
+	/**
+	 *    EE_Request_Handler Object
+	 *
+	 * @access    public
+	 * @var    EE_Request_Handler $REQ
+	 */
+	public $REQ = null;
+
+	/**
+	 *    EE_Session Object
+	 *
+	 * @access    public
+	 * @var    EE_Session $SSN
+	 */
+	public $SSN = null;
+
+	/**
+	 * holds the ee capabilities object.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Capabilities
+	 */
+	public $CAP = null;
+
+	/**
+	 * holds the EE_Message_Resource_Manager object.
+	 *
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager
+	 */
+	public $MRM = null;
+
+
+	/**
+	 * Holds the Assets Registry instance
+	 * @var Registry
+	 */
+	public $AssetsRegistry = null;
+
+	/**
+	 *    $addons - StdClass object for holding addons which have registered themselves to work with EE core
+	 *
+	 * @access    public
+	 * @var    EE_Addon[]
+	 */
+	public $addons = null;
+
+	/**
+	 *    $models
+	 * @access    public
+	 * @var    EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 */
+	public $models = array();
+
+	/**
+	 *    $modules
+	 * @access    public
+	 * @var    EED_Module[] $modules
+	 */
+	public $modules = null;
+
+	/**
+	 *    $shortcodes
+	 * @access    public
+	 * @var    EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes = null;
+
+	/**
+	 *    $widgets
+	 * @access    public
+	 * @var    WP_Widget[] $widgets
+	 */
+	public $widgets = null;
+
+	/**
+	 * $non_abstract_db_models
+	 * @access public
+	 * @var array 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")
+	 */
+	public $non_abstract_db_models = array();
+
+
+	/**
+	 *    $i18n_js_strings - internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public static $i18n_js_strings = array();
+
+
+	/**
+	 *    $main_file - path to espresso.php
+	 *
+	 * @access    public
+	 * @var    array
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @access    public
+	 * @var ReflectionClass[]
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @access    protected
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param  \EE_Dependency_Map $dependency_map
+	 * @return \EE_Registry instance
+	 */
+	public static function instance(\EE_Dependency_Map $dependency_map = null)
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Registry) {
+			self::$_instance = new EE_Registry($dependency_map);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param  \EE_Dependency_Map $dependency_map
+	 */
+	protected function __construct(\EE_Dependency_Map $dependency_map)
+	{
+		$this->_dependency_map = $dependency_map;
+		$this->LIB = new stdClass();
+		$this->addons = new stdClass();
+		$this->modules = new stdClass();
+		$this->shortcodes = new stdClass();
+		$this->widgets = new stdClass();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+	}
+
+
+
+	/**
+	 * initialize
+	 */
+	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('EE_Request');
+		$this->_set_cached_class(
+			$request_loader(),
+			'EE_Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader('EE_Response');
+		$this->_set_cached_class(
+			$response_loader(),
+			'EE_Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
+	}
+
+
+
+	/**
+	 *    init
+	 *
+	 * @access    public
+	 * @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)EE_Registry::$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
+	 */
+	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')) {
+				$this->load_core('Module_Request_Router');
+			}
+			$this->modules->{$module} = 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
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	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 . '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
+	 *
+	 * @access    public
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return mixed
+	 */
+	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
+	 *
+	 * @access    public
+	 * @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
+	 */
+	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, 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
+	 */
+	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
+	 */
+	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
+	 *
+	 * @access    public
+	 * @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
+	 */
+	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
+	 */
+	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
+	 */
+	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]) ? true : false;
+	}
+
+
+
+	/**
+	 *    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
+	 */
+	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);
+	}
+
+
+
+	/**
+	 *    load_addon
+	 *
+	 * @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 EE_Addon
+	 */
+	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 mixed                    null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	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->_dependency_map->get_alias($class_name);
+		if ( ! class_exists($class_name)) {
+			// maybe the class is registered with a preceding \
+			$class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
+			// still doesn't exist ?
+			if ( ! class_exists($class_name)) {
+				return null;
+			}
+		}
+		// 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);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class($class_obj, $class_name, $addon, $from_db);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * 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 null|object|bool         null = failure to load or instantiate class object.
+	 *                                  object = class loaded and instantiated successfully.
+	 *                                  bool = fail or success when $load_only is true
+	 */
+	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->_dependency_map->get_alias($class_name);
+		$class_exists = class_exists($class_name);
+		// 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;
+		}
+		// $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);
+			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 loading failed, or we are only loading a file but NOT instantiating an object
+			if ( ! $loaded || $load_only) {
+				// return boolean if only loading, or null if an object was expected
+				return $load_only ? $loaded : 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);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+
+
+	/**
+	 * _get_cached_class
+	 * 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
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @return mixed
+	 */
+	protected function _get_cached_class($class_name, $class_prefix = '')
+	{
+		// have to specify something, but not anything that will conflict
+		$class_abbreviation = isset($this->_class_abbreviations[ $class_name ])
+			? $this->_class_abbreviations[ $class_name ]
+			: 'FANCY_BATMAN_PANTS';
+		$class_name = str_replace('\\', '_', $class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		if (isset ($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if (isset ($this->LIB->{$class_name})) {
+			return $this->LIB->{$class_name};
+		}
+		if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
+			return $this->addons->{$class_name};
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string $class_name
+	 * @param boolean $addon
+	 * @return boolean
+	 */
+	public function clear_cached_class($class_name, $addon = false)
+	{
+		// have to specify something, but not anything that will conflict
+		$class_abbreviation = isset($this->_class_abbreviations[ $class_name ])
+			? $this->_class_abbreviations[ $class_name ]
+			: 'FANCY_BATMAN_PANTS';
+		$class_name = str_replace('\\', '_', $class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if (isset($this->LIB->{$class_name})) {
+			unset($this->LIB->{$class_name});
+			return true;
+		}
+		if ($addon && isset($this->addons->{$class_name})) {
+			unset($this->addons->{$class_name});
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _resolve_path
+	 * 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
+	 *
+	 * @access protected
+	 * @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;
+	}
+
+
+
+	/**
+	 * _require_file
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @access protected
+	 * @param  string $path
+	 * @param  string $class_name
+	 * @param  string $type
+	 * @param  array  $file_paths
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
+	{
+		// don't give up! you gotta...
+		try {
+			//does the file exist and can it be read ?
+			if ( ! $path) {
+				// so sorry, can't find the file
+				throw new EE_Error (
+					sprintf(
+						__('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(
+						__('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;
+	}
+
+
+
+	/**
+	 * _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
+	 *
+	 * @access protected
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null | object
+	 * @throws \EE_Error
+	 */
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
+	{
+		$class_obj = null;
+		$instantiation_mode = '0) none';
+		// don't give up! you gotta...
+		try {
+			// create reflection
+			$reflector = $this->get_ReflectionClass($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";
+				$class_obj = true;
+			} else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) {
+				// no constructor = static methods only... nothing to instantiate, loading file was enough
+				$instantiation_mode = "2) no constructor but instantiable";
+				$class_obj = $reflector->newInstance();
+			} else if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+				$instantiation_mode = "3) new_instance_from_db()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
+			} else if (method_exists($class_name, 'new_instance')) {
+				$instantiation_mode = "4) new_instance()";
+				$class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments);
+			} else if (method_exists($class_name, 'instance')) {
+				$instantiation_mode = "5) instance()";
+				$class_obj = call_user_func_array(array($class_name, 'instance'), $arguments);
+			} else if ($reflector->isInstantiable()) {
+				$instantiation_mode = "6) constructor";
+				$class_obj = $reflector->newInstanceArgs($arguments);
+			} else {
+				// heh ? something's not right !
+				throw new EE_Error(
+					sprintf(
+						__('The %s file %s could not be instantiated.', 'event_espresso'),
+						$type,
+						$class_name
+					)
+				);
+			}
+		} catch (Exception $e) {
+			if ( ! $e instanceof EE_Error) {
+				$e = new EE_Error(
+					sprintf(
+						__('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'),
+						$class_name,
+						'<br />',
+						$e->getMessage(),
+						$instantiation_mode
+					)
+				);
+			}
+			$e->get_error();
+		}
+		return $class_obj;
+	}
+
+
+
+	/**
+	 * @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;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @access public
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function get_ReflectionClass($class_name)
+	{
+		if (
+			! isset($this->_reflectors[$class_name])
+			|| ! $this->_reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->_reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->_reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * _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
+	 *
+	 * @access protected
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws \ReflectionException
+	 */
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array())
+	{
+		// let's examine the constructor
+		$constructor = $reflector->getConstructor();
+		// whu? huh? nothing?
+		if ( ! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $constructor->getParameters();
+		// 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 = $param->getClass() ? $param->getClass()->name : null;
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->_dependency_map->has_alias($param_class, $class_name)
+				? $this->_dependency_map->get_alias($param_class, $class_name)
+				: $param_class;
+			if (
+				// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+			) {
+				// 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
+				! empty($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;
+			}
+			if (
+				// parameter is type hinted as a class, and should be injected
+				! empty($param_class)
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
+			) {
+				$arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index);
+			} else {
+				try {
+					$arguments[$index] = $param->getDefaultValue();
+				} catch (ReflectionException $e) {
+					throw new ReflectionException(
+						sprintf(
+							__('%1$s for parameter "$%2$s"', 'event_espresso'),
+							$e->getMessage(),
+							$param->getName()
+						)
+					);
+				}
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 */
+	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)
+					!== EE_Dependency_Map::load_new_object
+			? true
+			: false;
+		// 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;
+		} else if ($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();
+			} 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 = $this->create($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
+			if (isset($argument_keys[$index])) {
+				$arguments[$argument_keys[$index]] = $dependency;
+			} else {
+				$arguments[$index] = $dependency;
+			}
+		}
+		return $arguments;
+	}
+
+
+
+	/**
+	 * _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
+	 *
+	 * @access protected
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @return void
+	 */
+	protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false)
+	{
+		if (empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		if (isset($this->_class_abbreviations[$class_name])) {
+			$class_abbreviation = $this->_class_abbreviations[$class_name];
+			$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) {
+			$this->LIB->{$class_name} = $class_obj;
+		}
+	}
+
+
+
+	/**
+	 * 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(EE_Registry::instance(), $loader)) {
+			return EE_Registry::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the classname as the property name on EE_Config::instance()->addons)
+	 *
+	 * @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_Config::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, use EE_Config::instance()->addons->{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(__('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             whether to reset data in the database too, or just refresh
+	 *                                  the Registry to its state at the beginning of the request
+	 * @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
+	 */
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
+	{
+		$instance = self::instance();
+		EEH_Activation::reset();
+		//properties that get reset
+		$instance->_cache_on = true;
+		$instance->CFG = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART = null;
+		$instance->MRM = null;
+		$instance->AssetsRegistry = null;
+		$instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
+		//messages reset
+		EED_Messages::reset();
+		if ($reset_models) {
+			foreach (array_keys($instance->non_abstract_db_models) as $model_name) {
+				$instance->reset_model($model_name);
+			}
+		}
+		$instance->LIB = new stdClass();
+		return $instance;
+	}
+
+
+
+	/**
+	 * @override magic methods
+	 * @return void
+	 */
+	public final function __destruct()
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	public final function __call($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	public final function __get($a)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	public final function __set($a, $b)
+	{
+	}
+
+
+
+	/**
+	 * @param $a
+	 */
+	public final function __isset($a)
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     */
-    public final function __unset($a)
-    {
-    }
+	/**
+	 * @param $a
+	 */
+	public final function __unset($a)
+	{
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public final function __sleep()
-    {
-        return array();
-    }
+	/**
+	 * @return array
+	 */
+	public final function __sleep()
+	{
+		return array();
+	}
 
 
 
-    public final function __wakeup()
-    {
-    }
+	public final function __wakeup()
+	{
+	}
 
 
 
-    /**
-     * @return string
-     */
-    public final function __toString()
-    {
-        return '';
-    }
+	/**
+	 * @return string
+	 */
+	public final function __toString()
+	{
+		return '';
+	}
 
 
 
-    public final function __invoke()
-    {
-    }
+	public final function __invoke()
+	{
+	}
 
 
 
-    public final static function __set_state($array = array())
-    {
-        return EE_Registry::instance();
-    }
+	public final static function __set_state($array = array())
+	{
+		return EE_Registry::instance();
+	}
 
 
 
-    public final function __clone()
-    {
-    }
+	public final function __clone()
+	{
+	}
 
 
 
-    /**
-     * @param $a
-     * @param $b
-     */
-    public final static function __callStatic($a, $b)
-    {
-    }
+	/**
+	 * @param $a
+	 * @param $b
+	 */
+	public final static function __callStatic($a, $b)
+	{
+	}
 
 
 
-    /**
-     * 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;
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * @return \EE_Config
+	 */
+	public static function CFG()
+	{
+		return self::instance()->CFG;
+	}
 
 
 }

Spacing +25 added lines, -25 removed lines

@@ -294,13 +294,13 @@ 
      */
     public static function localize_i18n_js_strings()
     {
-        $i18n_js_strings = (array)EE_Registry::$i18n_js_strings;
+        $i18n_js_strings = (array) EE_Registry::$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).'; /* ]]> */';
     }
 
 
@@ -351,9 +351,9 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'data_migration_scripts' . DS,
-                EE_CORE . 'request_stack' . DS,
-                EE_CORE . 'middleware' . DS,
+                EE_CORE.'data_migration_scripts'.DS,
+                EE_CORE.'request_stack'.DS,
+                EE_CORE.'middleware'.DS,
             )
         );
         // retrieve instantiated class
@@ -376,7 +376,7 @@ 
         $service_paths = apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             array(
-                EE_CORE . 'services' . DS,
+                EE_CORE.'services'.DS,
             )
         );
         // retrieve instantiated class
@@ -456,10 +456,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($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only);
@@ -498,10 +498,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($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only);
@@ -588,7 +588,7 @@ 
         $class_name = $this->_dependency_map->get_alias($class_name);
         if ( ! class_exists($class_name)) {
             // maybe the class is registered with a preceding \
-            $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name;
+            $class_name = strpos($class_name, '\\') !== 0 ? '\\'.$class_name : $class_name;
             // still doesn't exist ?
             if ( ! class_exists($class_name)) {
                 return null;
@@ -655,7 +655,7 @@ 
             // 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->_dependency_map->get_alias($class_name);
         $class_exists = class_exists($class_name);
@@ -715,8 +715,8 @@ 
     protected function _get_cached_class($class_name, $class_prefix = '')
     {
         // have to specify something, but not anything that will conflict
-        $class_abbreviation = isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
+        $class_abbreviation = isset($this->_class_abbreviations[$class_name])
+            ? $this->_class_abbreviations[$class_name]
             : 'FANCY_BATMAN_PANTS';
         $class_name = str_replace('\\', '_', $class_name);
         // check if class has already been loaded, and return it if it has been
@@ -747,8 +747,8 @@ 
     public function clear_cached_class($class_name, $addon = false)
     {
         // have to specify something, but not anything that will conflict
-        $class_abbreviation = isset($this->_class_abbreviations[ $class_name ])
-            ? $this->_class_abbreviations[ $class_name ]
+        $class_abbreviation = isset($this->_class_abbreviations[$class_name])
+            ? $this->_class_abbreviations[$class_name]
             : 'FANCY_BATMAN_PANTS';
         $class_name = str_replace('\\', '_', $class_name);
         // check if class has already been loaded, and return it if it has been
@@ -793,9 +793,9 @@ 
             // 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, '.') . '.' : '';
+            $type = ! empty($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];
@@ -826,12 +826,12 @@ 
             //does the file exist and can it be read ?
             if ( ! $path) {
                 // so sorry, can't find the file
-                throw new EE_Error (
+                throw new EE_Error(
                     sprintf(
                         __('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)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }

caffeinated/admin/new/pricing/templates/event_tickets_datetime_ticket_row.template.php

Braces +40 added lines, -16 removed lines

@@ -6,24 +6,33 @@ 
 		<?php if ( $disabled ) : ?>
 			<input type="hidden" id="edit-ticket-TKT_start_date-<?php echo $tkt_row; ?>"  name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp" value="<?php echo $TKT_start_date; ?>" >
 			<input type="text" name="archived_ticket[TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp" value="<?php echo $TKT_start_date; ?>" disabled>
-		<?php else : ?>
-			<input id="edit-ticket-TKT_start_date-<?php echo $tkt_row; ?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp ee-datepicker" value="<?php echo $TKT_start_date; ?>" data-context="start-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_end_date" data-next-field=".edit-ticket-TKT_end_date">
+		<?php else {
+	: ?>
+			<input id="edit-ticket-TKT_start_date-<?php echo $tkt_row;
+}
+?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp ee-datepicker" value="<?php echo $TKT_start_date; ?>" data-context="start-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_end_date" data-next-field=".edit-ticket-TKT_end_date">
 		<?php endif; ?>
 	</td>
 	<td>
 		<?php if ( $disabled ) : ?>
 			<input type="hidden" id="edit-ticket-TKT_end_date-<?php echo $tkt_row; ?>"  name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp" value="<?php echo $TKT_end_date; ?>" >
 			<input type="text" name="archived_ticket[TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp" value="<?php echo $TKT_end_date; ?>" disabled>
-		<?php else : ?>
-			<input id="edit-ticket-TKT_end_date-<?php echo $tkt_row; ?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp ee-datepicker" value="<?php echo $TKT_end_date; ?>" data-context="end-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_start_date" data-next-field=".edit-ticket-TKT_qty">
+		<?php else {
+	: ?>
+			<input id="edit-ticket-TKT_end_date-<?php echo $tkt_row;
+}
+?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp ee-datepicker" value="<?php echo $TKT_end_date; ?>" data-context="end-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_start_date" data-next-field=".edit-ticket-TKT_qty">
 		<?php endif; ?>
 	</td>
 	<td>
 		<?php if ( $disabled ) : ?>
 			<input id="edit-ticket-TKT_base_price-<?php echo $tkt_row; ?>" type="hidden" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>">
 			<input type="text" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>" disabled>
-		<?php else : ?>
-			<input id="edit-ticket-TKT_base_price-<?php echo $tkt_row; ?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>">
+		<?php else {
+	: ?>
+			<input id="edit-ticket-TKT_base_price-<?php echo $tkt_row;
+}
+?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>">
 		<?php endif; ?>
 		<input type="hidden" id="edit-ticket-TKT_base_price_ID-<?php echo $tkt_row; ?>" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price_ID]" value="<?php echo $TKT_base_price_ID; ?>">
 	</td>
@@ -31,8 +40,11 @@ 
 		<?php if ( $disabled ) : ?>
 			<input type="hidden" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>">
 			<input type="text" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>" disabled>
-		<?php else : ?>
-			<input type="text" id="edit-ticket-TKT_qty-<?php echo $tkt_row; ?>" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>">
+		<?php else {
+	: ?>
+			<input type="text" id="edit-ticket-TKT_qty-<?php echo $tkt_row;
+}
+?>" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>">
 		<?php endif; ?>
 	</td>
 	<!--<td><span class="ticket-display-row-TKT_price"><?php //echo $TKT_price; ?></span></td>-->
@@ -78,24 +90,33 @@ 
 								<?php if ( $disabled ) : ?>
 									<input type="hidden" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>">
 									<input type="text" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>" disabled>
-								<?php else : ?>
-									<input type="text" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>">
+								<?php else {
+	: ?>
+									<input type="text" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name;
+}
+?>[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>">
 								<?php endif; ?>
 							</td>
 							<td>
 								<?php if ( $disabled ) : ?>
 									<input type="hidden" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>">
 									<input type="text" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>" disabled>
-								<?php else: ?>
-									<input type="text" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>">
+								<?php else {
+	: ?>
+									<input type="text" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name;
+}
+?>[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>">
 								<?php endif; ?>
 							</td>
 							<td>
 								<?php if ( $disabled ) : ?>
 									<input type="hidden" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>">
 									<input type="text" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>" disabled>
-								<?php else : ?>
-									<input type="text" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>">
+								<?php else {
+	: ?>
+									<input type="text" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name;
+}
+?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>">
 								<?php endif; ?>
 							</td>
 						</tr>
@@ -116,8 +137,11 @@ 
 							?>
 							<input class="TKT-taxable-checkbox" type="hidden" name="<?php echo $edit_tickets_name;?>[<?php echo $tkt_row; ?>][TKT_taxable]" value="<?php echo $tax_value; ?>">
 							<input class="TKT-taxable-checkbox" id="edit-ticket-TKT_taxable-<?php echo $tkt_row; ?>" type="checkbox" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_taxable]" value="1"<?php echo $TKT_taxable; ?> disabled>
-						<?php else : ?>
-							<input class="TKT-taxable-checkbox" id="edit-ticket-TKT_taxable-<?php echo $tkt_row; ?>" type="checkbox" name="<?php echo $edit_tickets_name;?>[<?php echo $tkt_row; ?>][TKT_taxable]" value="1"<?php echo $TKT_taxable; ?>>
+						<?php else {
+	: ?>
+							<input class="TKT-taxable-checkbox" id="edit-ticket-TKT_taxable-<?php echo $tkt_row;
+}
+?>" type="checkbox" name="<?php echo $edit_tickets_name;?>[<?php echo $tkt_row; ?>][TKT_taxable]" value="1"<?php echo $TKT_taxable; ?>>
 						<?php endif; ?>
 						<label for="edit-ticket-TKT_taxable-<?php echo $tkt_row; ?>"> <?php esc_html_e('This ticket is taxable.', 'event_espresso'); ?>
 					<?php } //end tax_rows check ?>

acceptance_tests/Page/EventsAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
 
     /**
      * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
-     * @param     $field_name
+     * @param     string $field_name
      * @param int $row_number
      * @return string
      */

Indentation +218 added lines, -218 removed lines

@@ -14,225 +14,225 @@
 class EventsAdmin extends CoreAdmin
 {
 
-    /**
-     * Selector for the Add new Event button in the admin.
-     * @var string
-     */
-    const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event';
-
-
-    /**
-     * Selector for the Event Title field in the event editor
-     * @var string
-     */
-    const EVENT_EDITOR_TITLE_FIELD_SELECTOR = "//input[@id='title']";
-
-    /**
-     * Selector for the publish submit button in the event editor.
-     * @var string
-     */
-    const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = "#publish";
-
-
-    /**
-     * @var string
-     */
-    const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status';
-
-    /**
-     * Selector for the view link after publishing an event.
-     * @var string
-     */
-    const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//div[@id='message']/p/a";
+	/**
+	 * Selector for the Add new Event button in the admin.
+	 * @var string
+	 */
+	const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event';
+
+
+	/**
+	 * Selector for the Event Title field in the event editor
+	 * @var string
+	 */
+	const EVENT_EDITOR_TITLE_FIELD_SELECTOR = "//input[@id='title']";
+
+	/**
+	 * Selector for the publish submit button in the event editor.
+	 * @var string
+	 */
+	const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = "#publish";
+
+
+	/**
+	 * @var string
+	 */
+	const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status';
+
+	/**
+	 * Selector for the view link after publishing an event.
+	 * @var string
+	 */
+	const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//div[@id='message']/p/a";
 
-
-    /**
-     * Selector for the ID of the event in the event editor
-     * @var string
-     */
-    const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']";
+
+	/**
+	 * Selector for the ID of the event in the event editor
+	 * @var string
+	 */
+	const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']";
 
 
-    /**
-     * Selector for the search input on the event list table page.
-     * @var string
-     */
-    const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input';
-
-
-
-
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function defaultEventsListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_events', 'default', $additional_params);
-    }
-
-
-    /**
-     * The selector for the DTTname field for the given row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeNameFieldSelector($row_number = 1)
-    {
-        return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number);
-    }
-
-
-    /**
-     * The selector for the DTT_EVT_start field for the given row in the event editor.d
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1)
-    {
-        return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number);
-    }
-
-
-    /**
-     * Wrapper for getting the selector for a given field and given row of a datetime in the event editor.
-     *
-     * @param string $field_name
-     * @param int    $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1)
-    {
-        return "//input[@id='event-datetime-$field_name-$row_number']";
-    }
-
-
-    /**
-     * The selector for the TKT_name field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketNameFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number);
-    }
-
-
-    public static function eventEditorTicketPriceFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number);
-    }
-
-
-    public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1)
-    {
-        return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]";
-    }
-
-
-    public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1)
-    {
-        return "//span[@id='price-total-amount-$row_number']";
-    }
-
-
-    public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1)
-    {
-        return "//span[@id='price-total-amount-$row_number']";
-    }
-
-
-    public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1)
-    {
-        return "//input[@id='edit-ticket-TKT_taxable-$row_number']";
-    }
-
-
-    /**
-     * This returns the xpath locater for the Tax amount display container within the advanced settings view for the
-     * given ticket (row) and the given tax id (PRC_ID).
-     *
-     * @param int $tax_id     The PRC_ID for the tax you want the locater for.  Note, this defaults to the default tax
-     *                        setup on a fresh install.
-     * @param int $row_number What row representing the ticket you want the locator for.
-     * @return string
-     */
-    public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1)
-    {
-        return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']";
-    }
-
-
-    /**
-     * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
-     * @param     $field_name
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1)
-    {
-        return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]";
-    }
-
-
-    /**
-     * Returns the selector for the event title edit link in the events list table for the given Event Title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']";
-    }
-
-
-    /**
-     * Locator for for the ID column in the event list table for a given event title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventIdSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
-               . "//ancestor::tr/th[contains(@class, 'check-column')]/input";
-    }
-
-
-    /**
-     * Locator for the view link in the row of an event list table for the given event title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
-               . "//ancestor::td//span[@class='view']/a";
-    }
-
-
-    /**
-     * Locator for the messenger tab in the Notifications metabox in the event editor.
-     * @param string $messenger_slug  The slug for the messenger (it's reference slug).
-     * @return string
-     */
-    public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)
-    {
-        return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
-               . "//a[@rel='ee-tab-$messenger_slug']";
-    }
-
-
-    /**
-     * Locator for the select input within the notifications metabox.
-     * Note, this assumes the tab content for the related messenger is already visible.
-     * @param string $message_type_label The message type label (visible string in the table) you want the selector for.
-     * @return string
-     */
-    public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label)
-    {
-        return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
-               . "//table[@class='messages-custom-template-switcher']"
-               . "//tr/td[contains(.,'Registration Approved')]"
-               . "//ancestor::tr//select[contains(@class,'message-template-selector')]";
-    }
+	/**
+	 * Selector for the search input on the event list table page.
+	 * @var string
+	 */
+	const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input';
+
+
+
+
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function defaultEventsListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_events', 'default', $additional_params);
+	}
+
+
+	/**
+	 * The selector for the DTTname field for the given row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeNameFieldSelector($row_number = 1)
+	{
+		return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number);
+	}
+
+
+	/**
+	 * The selector for the DTT_EVT_start field for the given row in the event editor.d
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1)
+	{
+		return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number);
+	}
+
+
+	/**
+	 * Wrapper for getting the selector for a given field and given row of a datetime in the event editor.
+	 *
+	 * @param string $field_name
+	 * @param int    $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1)
+	{
+		return "//input[@id='event-datetime-$field_name-$row_number']";
+	}
+
+
+	/**
+	 * The selector for the TKT_name field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketNameFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number);
+	}
+
+
+	public static function eventEditorTicketPriceFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number);
+	}
+
+
+	public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1)
+	{
+		return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]";
+	}
+
+
+	public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1)
+	{
+		return "//span[@id='price-total-amount-$row_number']";
+	}
+
+
+	public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1)
+	{
+		return "//span[@id='price-total-amount-$row_number']";
+	}
+
+
+	public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1)
+	{
+		return "//input[@id='edit-ticket-TKT_taxable-$row_number']";
+	}
+
+
+	/**
+	 * This returns the xpath locater for the Tax amount display container within the advanced settings view for the
+	 * given ticket (row) and the given tax id (PRC_ID).
+	 *
+	 * @param int $tax_id     The PRC_ID for the tax you want the locater for.  Note, this defaults to the default tax
+	 *                        setup on a fresh install.
+	 * @param int $row_number What row representing the ticket you want the locator for.
+	 * @return string
+	 */
+	public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1)
+	{
+		return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']";
+	}
+
+
+	/**
+	 * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
+	 * @param     $field_name
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1)
+	{
+		return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]";
+	}
+
+
+	/**
+	 * Returns the selector for the event title edit link in the events list table for the given Event Title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']";
+	}
+
+
+	/**
+	 * Locator for for the ID column in the event list table for a given event title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventIdSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
+			   . "//ancestor::tr/th[contains(@class, 'check-column')]/input";
+	}
+
+
+	/**
+	 * Locator for the view link in the row of an event list table for the given event title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
+			   . "//ancestor::td//span[@class='view']/a";
+	}
+
+
+	/**
+	 * Locator for the messenger tab in the Notifications metabox in the event editor.
+	 * @param string $messenger_slug  The slug for the messenger (it's reference slug).
+	 * @return string
+	 */
+	public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)
+	{
+		return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
+			   . "//a[@rel='ee-tab-$messenger_slug']";
+	}
+
+
+	/**
+	 * Locator for the select input within the notifications metabox.
+	 * Note, this assumes the tab content for the related messenger is already visible.
+	 * @param string $message_type_label The message type label (visible string in the table) you want the selector for.
+	 * @return string
+	 */
+	public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label)
+	{
+		return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
+			   . "//table[@class='messages-custom-template-switcher']"
+			   . "//tr/td[contains(.,'Registration Approved')]"
+			   . "//ancestor::tr//select[contains(@class,'message-template-selector')]";
+	}
 }

acceptance_tests/Helpers/BaseCoreAdmin.php

Indentation +47 added lines, -47 removed lines

@@ -13,58 +13,58 @@
 trait BaseCoreAdmin
 {
 
-    /**
-     * Core method for going to an Event Espresso Admin page.
-     * @param string $page
-     * @param string $action
-     * @param string $additional_params
-     */
-    public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params));
-    }
+	/**
+	 * Core method for going to an Event Espresso Admin page.
+	 * @param string $page
+	 * @param string $action
+	 * @param string $additional_params
+	 */
+	public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params));
+	}
 
 
-    /**
-     * Helper method for returning an instance of the Actor.  Intended to help with IDE fill out of methods.
-     * @return \EventEspressoAcceptanceTester;
-     */
-    protected function actor()
-    {
-        /** @var \EventEspressoAcceptanceTester $this */
-        return $this;
-    }
+	/**
+	 * Helper method for returning an instance of the Actor.  Intended to help with IDE fill out of methods.
+	 * @return \EventEspressoAcceptanceTester;
+	 */
+	protected function actor()
+	{
+		/** @var \EventEspressoAcceptanceTester $this */
+		return $this;
+	}
 
 
-    /**
-     * Use this to set the per page option for a list table page.
-     * Assumes you are on a page that has this field exposed.
-     *
-     * @param int|string $per_page_value
-     * @throws \Codeception\Exception\TestRuntimeException
-     */
-    public function setPerPageOptionForScreen($per_page_value)
-    {
-        $this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR);
-        $this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value);
-        $this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR);
-        $this->actor()->wait(8);
-    }
+	/**
+	 * Use this to set the per page option for a list table page.
+	 * Assumes you are on a page that has this field exposed.
+	 *
+	 * @param int|string $per_page_value
+	 * @throws \Codeception\Exception\TestRuntimeException
+	 */
+	public function setPerPageOptionForScreen($per_page_value)
+	{
+		$this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR);
+		$this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value);
+		$this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR);
+		$this->actor()->wait(8);
+	}
 
 
 
-    /**
-     * Use this to append a given value to a wpEditor instance.
-     * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and
-     * the value is added to the text area.
-     *
-     * @param $field_reference
-     * @param $value
-     * @throws \Codeception\Exception\ElementNotFound
-     */
-    public function appendToWPEditorField($field_reference, $value)
-    {
-        $this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference));
-        $this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value);
-    }
+	/**
+	 * Use this to append a given value to a wpEditor instance.
+	 * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and
+	 * the value is added to the text area.
+	 *
+	 * @param $field_reference
+	 * @param $value
+	 * @throws \Codeception\Exception\ElementNotFound
+	 */
+	public function appendToWPEditorField($field_reference, $value)
+	{
+		$this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference));
+		$this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value);
+	}
 }

acceptance_tests/Page/CoreAdmin.php

Indentation +80 added lines, -80 removed lines

@@ -13,84 +13,84 @@
 class CoreAdmin
 {
 
-    /**
-     * @var string
-     */
-    const URL_PREFIX = 'admin.php?page=';
-
-
-    /**
-     * This is the selector for the next page button on list tables.
-     * @var string
-     */
-    const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
-
-
-    /**
-     * The selector for the search input submit button on list table pages
-     * @var string
-     */
-    const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
-
-
-    /**
-     * Selector for the screen options dropdown.
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
-
-
-    /**
-     * Selector for the per page field setting selector (found within screen options dropdown)
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
-
-
-    /**
-     * Selector for apply screen options settings.
-     * @var string
-     */
-    const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
-
-
-    /**
-     * Get the EE admin url for the given properties.
-     * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
-     * with `amOnAdminPage` action.
-     *
-     * @param string $page
-     * @param string $action
-     * @param string $additional_params
-     * @return string
-     */
-    public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
-    {
-        $url = self::URL_PREFIX . $page;
-        $url .= $action ? '&action=' . $action : '';
-        $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
-        return $url;
-    }
-
-
-    /**
-     * Returns the selector for the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextTabSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content-html';
-    }
-
-
-    /**
-     * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextAreaSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content';
-    }
+	/**
+	 * @var string
+	 */
+	const URL_PREFIX = 'admin.php?page=';
+
+
+	/**
+	 * This is the selector for the next page button on list tables.
+	 * @var string
+	 */
+	const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
+
+
+	/**
+	 * The selector for the search input submit button on list table pages
+	 * @var string
+	 */
+	const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
+
+
+	/**
+	 * Selector for the screen options dropdown.
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
+
+
+	/**
+	 * Selector for the per page field setting selector (found within screen options dropdown)
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
+
+
+	/**
+	 * Selector for apply screen options settings.
+	 * @var string
+	 */
+	const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
+
+
+	/**
+	 * Get the EE admin url for the given properties.
+	 * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
+	 * with `amOnAdminPage` action.
+	 *
+	 * @param string $page
+	 * @param string $action
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
+	{
+		$url = self::URL_PREFIX . $page;
+		$url .= $action ? '&action=' . $action : '';
+		$url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
+		return $url;
+	}
+
+
+	/**
+	 * Returns the selector for the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextTabSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content-html';
+	}
+
+
+	/**
+	 * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextAreaSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -66,9 +66,9 @@ 
      */
     public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
     {
-        $url = self::URL_PREFIX . $page;
-        $url .= $action ? '&action=' . $action : '';
-        $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
+        $url = self::URL_PREFIX.$page;
+        $url .= $action ? '&action='.$action : '';
+        $url .= $additional_params ? '&'.ltrim('&', ltrim('?', $additional_params)) : '';
         return $url;
     }
 
@@ -80,7 +80,7 @@ 
      */
     public static function wpEditorTextTabSelector($field_reference)
     {
-        return '#content-' . $field_reference . '-content-html';
+        return '#content-'.$field_reference.'-content-html';
     }
 
 
@@ -91,6 +91,6 @@ 
      */
     public static function wpEditorTextAreaSelector($field_reference)
     {
-        return '#content-' . $field_reference . '-content';
+        return '#content-'.$field_reference.'-content';
     }
 }

acceptance_tests/Page/MessagesAdmin.php

Indentation +243 added lines, -243 removed lines

@@ -12,255 +12,255 @@
 class MessagesAdmin extends CoreAdmin
 {
 
-    /**
-     * Context slug for the admin messages context.
-     * @var string
-     */
-    const ADMIN_CONTEXT_SLUG = 'admin';
+	/**
+	 * Context slug for the admin messages context.
+	 * @var string
+	 */
+	const ADMIN_CONTEXT_SLUG = 'admin';
 
-    /**
-     * Context slug for the primary attendee messages context
-     * @var string
-     */
-    const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
+	/**
+	 * Context slug for the primary attendee messages context
+	 * @var string
+	 */
+	const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
 
 
-    /**
-     * Status reference for the EEM_Message::status_sent status.
-     * @var string
-     */
-    const MESSAGE_STATUS_SENT = 'MSN';
+	/**
+	 * Status reference for the EEM_Message::status_sent status.
+	 * @var string
+	 */
+	const MESSAGE_STATUS_SENT = 'MSN';
 
 
-    /**
-     * Message type slug for the Payment Failed message type
-     */
-    const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
+	/**
+	 * Message type slug for the Payment Failed message type
+	 */
+	const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
 
 
-    /**
-     * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
-     * @var string
-     */
-    const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
-        '#global_messages_settings-do-messages-on-same-request';
-
+	/**
+	 * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
+	 * @var string
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
+		'#global_messages_settings-do-messages-on-same-request';
+
 
-    /**
-     * Selector for the Global Messages Settings submit button in the Messages Settings tab.
-     * @var string
-     */
-    const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
-
-
-    /**
-     * This is the container where active message types for a messenger are found/dragged to.
-     * @var string
-     */
-    const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
-
-
-    /**
-     * Locator for the context switcher selector on the Message Template Editor page.
-     * @var string
-     */
-    const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
-
-
-    /**
-     * Locator for the context switcher submit button in the Message Template Editor page.
-     * @var string
-     */
-    const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
-
-
-    /**
-     * Locator for the dialog container used for housing viewed messages in the message activity list table.
-     * @var string
-     */
-    const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
-
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function messageActivityListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'default', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function defaultMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function customMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function messageSettingsUrl()
-    {
-        return self::adminUrl('espresso_messages', 'settings');
-    }
-
-
-
-    public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
-        $message_type_slug,
-        $messenger_slug = 'email'
-    ) {
-        return "#$message_type_slug-messagetype-$messenger_slug";
-    }
-
-
-    /**
-     * @param string $message_type_slug
-     * @param string $context
-     * @return string
-     */
-    public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
-    {
-        return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
-    }
-
-
-    /**
-     * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
-     *
-     * @param        $field
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param string $table_cell_content_for_field
-     * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
-     *                                This allows you to indicate which item from the set to match.  If this is set to 0
-     *                                then all matches for the locator will be returned.
-     * @return string
-     */
-    public static function messagesActivityListTableCellSelectorFor(
-        $field,
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $table_cell_content_for_field = '',
-        $number_in_set = 1
-    ) {
-        $selector = $number_in_set > 0 ? '(' : '';
-        $selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
-                     . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
-        if ($messenger) {
-            $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
-        }
-        $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
-        $selector .= $table_cell_content_for_field
-            ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
-            : "/ancestor::tr/td[contains(@class, 'column-$field')]";
-        $selector .= $number_in_set > 0 ? ")[$number_in_set]" : '';
-        return $selector;
-    }
-
-
-    /**
-     * Selector for the Create Custom button found in the message template list table.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     * @return string
-     */
-    public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
-    {
-        $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
-                    . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
-                    . "//ancestor::tr/td/a[@class='button button-small']";
-        return $selector;
-    }
-
-
-    /**
-     * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
-     * the FIRST match (which will be the latest message sent if the table is default sorted).
-     *
-     * @param string $message_type_label    The visible message type label for the row you want to match
-     * @param string $message_status        The status of the message for the row you want to match.
-     * @param string $messenger             The visible messenger label for the row you want to match.
-     * @param string $context               The visible context label for the row you want to match.
-     * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
-     *                                      view. This allows you to indicate which item from the set to match.
-     * @return string
-     */
-    public static function messagesActivityListTableViewButtonSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'action',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
-                     . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
-        return $selector;
-    }
-
-
-
-    /**
-     * Locator for the delete action link for a message item in the message activity list table.
-     * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     * @return string
-     */
-    public static function messagesActivityListTableDeleteActionSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/div/span[@class='delete']/a";
-        return $selector;
-    }
+	/**
+	 * Selector for the Global Messages Settings submit button in the Messages Settings tab.
+	 * @var string
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
+
+
+	/**
+	 * This is the container where active message types for a messenger are found/dragged to.
+	 * @var string
+	 */
+	const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
+
+
+	/**
+	 * Locator for the context switcher selector on the Message Template Editor page.
+	 * @var string
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
+
+
+	/**
+	 * Locator for the context switcher submit button in the Message Template Editor page.
+	 * @var string
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
+
+
+	/**
+	 * Locator for the dialog container used for housing viewed messages in the message activity list table.
+	 * @var string
+	 */
+	const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
+
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function messageActivityListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'default', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function defaultMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function customMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function messageSettingsUrl()
+	{
+		return self::adminUrl('espresso_messages', 'settings');
+	}
+
+
+
+	public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
+		$message_type_slug,
+		$messenger_slug = 'email'
+	) {
+		return "#$message_type_slug-messagetype-$messenger_slug";
+	}
+
+
+	/**
+	 * @param string $message_type_slug
+	 * @param string $context
+	 * @return string
+	 */
+	public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
+	{
+		return $context
+			? '.' . $message_type_slug . '-' . $context . '-edit-link'
+			: '.' . $message_type_slug . '-edit-link';
+	}
+
+
+	/**
+	 * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
+	 *
+	 * @param        $field
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param string $table_cell_content_for_field
+	 * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
+	 *                                This allows you to indicate which item from the set to match.  If this is set to 0
+	 *                                then all matches for the locator will be returned.
+	 * @return string
+	 */
+	public static function messagesActivityListTableCellSelectorFor(
+		$field,
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$table_cell_content_for_field = '',
+		$number_in_set = 1
+	) {
+		$selector = $number_in_set > 0 ? '(' : '';
+		$selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
+					 . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
+		if ($messenger) {
+			$selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
+		}
+		$selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
+		$selector .= $table_cell_content_for_field
+			? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
+			: "/ancestor::tr/td[contains(@class, 'column-$field')]";
+		$selector .= $number_in_set > 0 ? ")[$number_in_set]" : '';
+		return $selector;
+	}
+
+
+	/**
+	 * Selector for the Create Custom button found in the message template list table.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 * @return string
+	 */
+	public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
+	{
+		$selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
+					. "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
+					. "//ancestor::tr/td/a[@class='button button-small']";
+		return $selector;
+	}
+
+
+	/**
+	 * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
+	 * the FIRST match (which will be the latest message sent if the table is default sorted).
+	 *
+	 * @param string $message_type_label    The visible message type label for the row you want to match
+	 * @param string $message_status        The status of the message for the row you want to match.
+	 * @param string $messenger             The visible messenger label for the row you want to match.
+	 * @param string $context               The visible context label for the row you want to match.
+	 * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
+	 *                                      view. This allows you to indicate which item from the set to match.
+	 * @return string
+	 */
+	public static function messagesActivityListTableViewButtonSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'action',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
+					 . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
+		return $selector;
+	}
+
+
+
+	/**
+	 * Locator for the delete action link for a message item in the message activity list table.
+	 * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 * @return string
+	 */
+	public static function messagesActivityListTableDeleteActionSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/div/span[@class='delete']/a";
+		return $selector;
+	}
 }
\ No newline at end of file

core/libraries/messages/EE_Messages_Generator.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -443,7 +443,7 @@ 
      * there's a single shared message template group among all the events.  Otherwise it returns null.
      *
      * @param array $event_ids
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      */
     protected function _get_shared_message_template_for_events(array $event_ids)
@@ -476,7 +476,7 @@ 
     /**
      * Retrieves the global message template group for the current messenger and message type.
      *
-     * @return EE_Message_Template_Group|null
+     * @return null|EE_Base_Class
      * @throws EE_Error
      */
     protected function _get_global_message_template_group_for_current_messenger_and_message_type()
@@ -617,7 +617,7 @@ 
      * @param EE_Messages_Addressee     $recipient
      * @param array                     $templates formatted array of templates used for parsing data.
      * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
+     * @return EE_Message
      * @throws EE_Error
      */
     protected function _setup_message_object(

Indentation +931 added lines, -931 removed lines

@@ -13,935 +13,935 @@
 {
 
 
-    /**
-     * @type EE_Messages_Data_Handler_Collection
-     */
-    protected $_data_handler_collection;
-
-    /**
-     * @type  EE_Message_Template_Group_Collection
-     */
-    protected $_template_collection;
-
-    /**
-     * This will hold the data handler for the current EE_Message being generated.
-     *
-     * @type EE_Messages_incoming_data
-     */
-    protected $_current_data_handler;
-
-    /**
-     * This holds the EE_Messages_Queue that contains the messages to generate.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_generation_queue;
-
-    /**
-     * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
-     *
-     * @type EE_Messages_Queue
-     */
-    protected $_ready_queue;
-
-    /**
-     * This is a container for any error messages that get created through the generation
-     * process.
-     *
-     * @type array
-     */
-    protected $_error_msg = array();
-
-    /**
-     * Flag used to set when the current EE_Message in the generation queue has been verified.
-     *
-     * @type bool
-     */
-    protected $_verified = false;
-
-    /**
-     * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_messenger
-     */
-    protected $_current_messenger;
-
-    /**
-     * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
-     *
-     * @type EE_message_type
-     */
-    protected $_current_message_type;
-
-    /**
-     * @type EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_parser;
-
-
-    /**
-     * @param EE_Messages_Queue                     $generation_queue
-     * @param \EE_Messages_Queue                    $ready_queue
-     * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
-     * @param \EE_Message_Template_Group_Collection $template_collection
-     * @param \EEH_Parse_Shortcodes                 $shortcode_parser
-     */
-    public function __construct(
-        EE_Messages_Queue $generation_queue,
-        EE_Messages_Queue $ready_queue,
-        EE_Messages_Data_Handler_Collection $data_handler_collection,
-        EE_Message_Template_Group_Collection $template_collection,
-        EEH_Parse_Shortcodes $shortcode_parser
-    ) {
-        $this->_generation_queue        = $generation_queue;
-        $this->_ready_queue             = $ready_queue;
-        $this->_data_handler_collection = $data_handler_collection;
-        $this->_template_collection     = $template_collection;
-        $this->_shortcode_parser        = $shortcode_parser;
-    }
-
-
-    /**
-     * @return EE_Messages_Queue
-     */
-    public function generation_queue()
-    {
-        return $this->_generation_queue;
-    }
-
-
-    /**
-     *  This iterates through the provided queue and generates the EE_Message objects.
-     *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
-     *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
-     *  for the caller to decide what to do with it.
-     *
-     * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
-     * @return EE_Messages_Queue  The new queue for holding generated EE_Message objects.
-     */
-    public function generate($save = true)
-    {
-        //iterate through the messages in the queue, generate, and add to new queue.
-        $this->_generation_queue->get_message_repository()->rewind();
-        while ($this->_generation_queue->get_message_repository()->valid()) {
-            //reset "current" properties
-            $this->_reset_current_properties();
-
-            /** @type EE_Message $msg */
-            $msg = $this->_generation_queue->get_message_repository()->current();
-
-            /**
-             * need to get the next object and capture it for setting manually after deletes.  The reason is that when
-             * an object is removed from the repo then valid for the next object will fail.
-             */
-            $this->_generation_queue->get_message_repository()->next();
-            $next_msg = $this->_generation_queue->get_message_repository()->current();
-            //restore pointer to current item
-            $this->_generation_queue->get_message_repository()->set_current($msg);
-
-            //skip and delete if the current $msg is NOT incomplete (queued for generation)
-            if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
-                //we keep this item in the db just remove from the repo.
-                $this->_generation_queue->get_message_repository()->remove($msg);
-                //next item
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            if ($this->_verify()) {
-                //let's get generating!
-                $this->_generate();
-            }
-
-            //don't persist debug_only messages if the messages system is not in debug mode.
-            if ($msg->STS_ID() === EEM_Message::status_debug_only
-                && ! EEM_Message::debug()
-            ) {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_debug_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $this->_generation_queue->get_message_repository()->delete();
-                $this->_generation_queue->get_message_repository()->set_current($next_msg);
-                continue;
-            }
-
-            //if there are error messages then let's set the status and the error message.
-            if ($this->_error_msg) {
-                //if the status is already debug only, then let's leave it at that.
-                if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
-                    $msg->set_STS_ID(EEM_Message::status_failed);
-                }
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__processing_failed_message',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                $msg->set_error_message(
-                    esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
-                    . "\n"
-                    . implode("\n", $this->_error_msg)
-                );
-                $msg->set_modified(time());
-            } else {
-                do_action(
-                    'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
-                    $msg,
-                    $this->_error_msg,
-                    $this->_current_messenger,
-                    $this->_current_message_type,
-                    $this->_current_data_handler
-                );
-                //remove from db
-                $this->_generation_queue->get_message_repository()->delete();
-            }
-            //next item
-            $this->_generation_queue->get_message_repository()->set_current($next_msg);
-        }
-
-        //generation queue is ALWAYS saved to record any errors in the generation process.
-        $this->_generation_queue->save();
-
-        /**
-         * save _ready_queue if flag set.
-         * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
-         * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
-         * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
-         * irrelevant.
-         */
-        if ($save) {
-            $this->_ready_queue->save();
-        }
-
-        //final reset of properties
-        $this->_reset_current_properties();
-
-        return $this->_ready_queue;
-    }
-
-
-    /**
-     * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
-     * in the generation queue.
-     */
-    protected function _reset_current_properties()
-    {
-        $this->_verified = false;
-        //make sure any _data value in the current message type is reset
-        if ($this->_current_message_type instanceof EE_message_type) {
-            $this->_current_message_type->reset_data();
-        }
-        $this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
-    }
-
-
-    /**
-     * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
-     * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
-     * _generating_queue.
-     *
-     * @return bool Whether the message was successfully generated or not.
-     * @throws EE_Error
-     */
-    protected function _generate()
-    {
-        //double check verification has run and that everything is ready to work with (saves us having to validate
-        // everything again).
-        if (! $this->_verified) {
-            return false; //get out because we don't have a valid setup to work with.
-        }
-
-
-        try {
-            $addressees = $this->_current_message_type->get_addressees(
-                $this->_current_data_handler,
-                $this->_generation_queue->get_message_repository()->current()->context()
-            );
-        } catch (EE_Error $e) {
-            $this->_error_msg[] = $e->getMessage();
-            return false;
-        }
-
-
-        //if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
-            do_action(
-                'AHEE__EE_Messages_Generator___generate__invalid_addressees',
-                $this->_generation_queue->get_message_repository()->current(),
-                $addressees,
-                $this->_current_messenger,
-                $this->_current_message_type,
-                $this->_current_data_handler
-            );
-            $this->_generation_queue->get_message_repository()->current()->set_STS_ID(
-                EEM_Message::status_debug_only
-            );
-            $this->_error_msg[] = esc_html__(
-                'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        $message_template_group = $this->_get_message_template_group();
-
-        //in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        //get formatted templates for using to parse and setup EE_Message objects.
-        $templates = $this->_get_templates($message_template_group);
-
-
-        //setup new EE_Message objects (and add to _ready_queue)
-        return $this->_assemble_messages($addressees, $templates, $message_template_group);
-    }
-
-
-    /**
-     * Retrieves the message template group being used for generating messages.
-     * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     */
-    protected function _get_message_template_group()
-    {
-        //first see if there is a specific message template group requested (current message in the queue has a specific
-        //GRP_ID
-        $message_template_group = $this->_specific_message_template_group_from_queue();
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //get event_ids from the datahandler so we can check to see if there's already a message template group for them
-        //in the collection.
-        $event_ids              = $this->_get_event_ids_from_current_data_handler();
-        $message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                $event_ids
-            )
-        );
-
-        //if we have a message template group then no need to hit the database, just return it.
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //okay made it here, so let's get the global group first for this messenger and message type to ensure
-        //there is no override set.
-        $global_message_template_group = $this->_get_global_message_template_group_for_current_messenger_and_message_type();
-
-        if ($global_message_template_group instanceof EE_Message_Template_Group
-            && $global_message_template_group->get('MTP_is_override')
-        ) {
-            return $global_message_template_group;
-        }
-
-        //if we're still here, that means there was no message template group for the events in the collection and
-        //the global message template group for the messenger and message type is not set for override.  So next step is
-        //to see if there is a common shared custom message template group for this set of events.
-        $message_template_group = $this->_get_shared_message_template_for_events($event_ids);
-        if ($message_template_group instanceof EE_Message_Template_Group) {
-            return $message_template_group;
-        }
-
-        //STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
-        //So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
-        //and return it.
-        if ($global_message_template_group instanceof EE_Message_Template_Group) {
-            $this->_template_collection->add(
-                $global_message_template_group,
-                $event_ids
-            );
-            return $global_message_template_group;
-        }
-
-        //if we land here that means there's NO active message template group for this set.
-        //TODO this will be a good target for some optimization down the road.  Whenever there is no active message
-        //template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
-        //this should likely bit hit rarely enough that it's not a significant issue.
-        return null;
-    }
-
-
-    /**
-     * This checks the current message in the queue and determines if there is a specific Message Template Group
-     * requested for that message.
-     *
-     * @return EE_Message_Template_Group|null
-     */
-    protected function _specific_message_template_group_from_queue()
-    {
-        //is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
-        //so let's use that.
-        $GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
-
-        if ($GRP_ID) {
-            //attempt to retrieve from repo first
-            $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  //got it!
-            }
-
-            //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
-            //is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add($message_template_group);
-                return $message_template_group;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether the event ids passed in all share the same message template group for the current message type
-     * and messenger.
-     *
-     * @param array $event_ids
-     * @return bool true means they DO share the same message template group, false means they don't.
-     * @throws EE_Error
-     */
-    protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
-    {
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[$event['ID']] = $event['ID'];
-        }
-        $count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'Event.EVT_ID'           => array('IN', $event_ids),
-                    'MTP_messenger'    => $this->_current_messenger->name,
-                    'MTP_message_type' => $this->_current_message_type->name,
-                ),
-            ),
-            'GRP_ID',
-            true
-        );
-        return $count_of_message_template_groups === 1;
-    }
-
-
-    /**
-     * This will get the shared message template group for events that are in the current data handler but ONLY if
-     * there's a single shared message template group among all the events.  Otherwise it returns null.
-     *
-     * @param array $event_ids
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     */
-    protected function _get_shared_message_template_for_events(array $event_ids)
-    {
-        $message_template_group = null;
-        if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'Event.EVT_ID'           => array('IN', $event_ids),
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                    ),
-                    'group_by' => 'GRP_ID',
-                )
-            );
-            //store this in the collection if its valid
-            if ($message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $message_template_group,
-                    $event_ids
-                );
-            }
-        }
-        return $message_template_group;
-    }
-
-
-    /**
-     * Retrieves the global message template group for the current messenger and message type.
-     *
-     * @return EE_Message_Template_Group|null
-     * @throws EE_Error
-     */
-    protected function _get_global_message_template_group_for_current_messenger_and_message_type()
-    {
-        //first check the collection (we use an array with 0 in it to represent global groups).
-        $global_message_template_group = $this->_template_collection->get_by_key(
-            $this->_template_collection->getKey(
-                $this->_current_messenger->name,
-                $this->_current_message_type->name,
-                array(0)
-            )
-        );
-
-        //if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
-            $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $this->_current_messenger->name,
-                        'MTP_message_type' => $this->_current_message_type->name,
-                        'MTP_is_active'    => true,
-                        'MTP_is_global'    => true,
-                    ),
-                )
-            );
-            //if we have a group, add it to the collection.
-            if ($global_message_template_group instanceof EE_Message_Template_Group) {
-                $this->_template_collection->add(
-                    $global_message_template_group,
-                    array(0)
-                );
-            }
-        }
-        return $global_message_template_group;
-    }
-
-
-    /**
-     * Returns an array of event ids for all the events within the current data handler.
-     *
-     * @return array
-     */
-    protected function _get_event_ids_from_current_data_handler()
-    {
-        $event_ids = array();
-        foreach ($this->_current_data_handler->events as $event) {
-            $event_ids[$event['ID']] = $event['ID'];
-        }
-        return $event_ids;
-    }
-
-
-    /**
-     *  Retrieves formatted array of template information for each context specific to the given
-     *  EE_Message_Template_Group
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @return array The returned array is in this structure:
-     *                          array(
-     *                          'field_name' => array(
-     *                          'context' => 'content'
-     *                          )
-     *                          )
-     * @throws EE_Error
-     */
-    protected function _get_templates(EE_Message_Template_Group $message_template_group)
-    {
-        $templates         = array();
-        $context_templates = $message_template_group->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
-                    continue;
-                }
-                $templates[$template_field][$context] = $template_obj->get('MTP_content');
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Assembles new fully generated EE_Message objects and adds to _ready_queue
-     *
-     * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
-     *                                               context.
-     * @param array                     $templates   formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool   true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
-     *                                               method will attempt to generate ALL EE_Message objects and add to
-     *                                               the _ready_queue.  Successfully generated messages get added to the
-     *                                               queue with EEM_Message::status_idle, unsuccessfully generated
-     *                                               messages will get added to the queue as EEM_Message::status_failed.
-     *                                               Very rarely should "false" be returned from this method.
-     */
-    protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
-    {
-
-        //if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
-            $this->_error_msg[] = esc_html__(
-                'Unable to assemble messages because there are no templates retrieved for generating the messages with',
-                'event_espresso'
-            );
-            return false;
-        }
-
-        //We use this as the counter for generated messages because don't forget we may be executing this inside of a
-        //generation_queue.  So _ready_queue may have generated EE_Message objects already.
-        $generated_count = 0;
-        foreach ($addressees as $context => $recipients) {
-            foreach ($recipients as $recipient) {
-                $message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
-                if ($message instanceof EE_Message) {
-                    $this->_ready_queue->add(
-                        $message,
-                        array(),
-                        $this->_generation_queue->get_message_repository()->is_preview(),
-                        $this->_generation_queue->get_message_repository()->is_test_send()
-                    );
-                    $generated_count++;
-                }
-
-                //if the current MSG being generated is for a test send then we'll only use ONE message in the generation.
-                if ($this->_generation_queue->get_message_repository()->is_test_send()) {
-                    break 2;
-                }
-            }
-        }
-
-        //if there are no generated messages then something else fatal went wrong.
-        return $generated_count > 0;
-    }
-
-
-    /**
-     * @param string                    $context   The context for the generated message.
-     * @param EE_Messages_Addressee     $recipient
-     * @param array                     $templates formatted array of templates used for parsing data.
-     * @param EE_Message_Template_Group $message_template_group
-     * @return bool|EE_Message
-     * @throws EE_Error
-     */
-    protected function _setup_message_object(
-        $context,
-        EE_Messages_Addressee $recipient,
-        $templates,
-        EE_Message_Template_Group $message_template_group
-    ) {
-        //stuff we already know
-        $transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
-        $transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
-            ? $this->_current_data_handler->txn->ID()
-            : $transaction_id;
-        $message_fields = array(
-            'GRP_ID'           => $message_template_group->ID(),
-            'TXN_ID'           => $transaction_id,
-            'MSG_messenger'    => $this->_current_messenger->name,
-            'MSG_message_type' => $this->_current_message_type->name,
-            'MSG_context'      => $context,
-        );
-
-        //recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
-        // the info from the att_obj found in the EE_Messages_Addressee object.
-        if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
-            $message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
-                ? $recipient->att_obj->ID()
-                : 0;
-            $message_fields['MSG_recipient_type'] = 'Attendee';
-        } else {
-            $message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
-            $message_fields['MSG_recipient_type'] = $recipient->recipient_type;
-        }
-        $message = EE_Message_Factory::create($message_fields);
-
-        //grab valid shortcodes for shortcode parser
-        $mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
-        $m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
-
-        //if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because that means this
-        //context is turned off) EXCEPT if we're previewing
-        if (empty($templates['to'][$context])
-            && ! $this->_generation_queue->get_message_repository()->is_preview()
-            && ! $this->_current_messenger->allow_empty_to_field()
-        ) {
-            //we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
-            //field.
-            return false;
-        }
-        $error_msg = array();
-        foreach ($templates as $field => $field_context) {
-            $error_msg = array();
-            //let's setup the valid shortcodes for the incoming context.
-            $valid_shortcodes = $mt_shortcodes[$context];
-            //merge in valid shortcodes for the field.
-            $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
-            if (isset($templates[$field][$context])) {
-                //prefix field.
-                $column_name = 'MSG_' . $field;
-                try {
-                    $content = $this->_shortcode_parser->parse_message_template(
-                        $templates[$field][$context],
-                        $recipient,
-                        $shortcodes,
-                        $this->_current_message_type,
-                        $this->_current_messenger,
-                        $message
-                    );
-                    $message->set_field_or_extra_meta($column_name, $content);
-                } catch (EE_Error $e) {
-                    $error_msg[] = sprintf(
-                        esc_html__(
-                            'There was a problem generating the content for the field %s: %s',
-                            'event_espresso'
-                        ),
-                        $field,
-                        $e->getMessage()
-                    );
-                    $message->set_STS_ID(EEM_Message::status_failed);
-                }
-            }
-        }
-
-        if ($message->STS_ID() === EEM_Message::status_failed) {
-            $error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
-                         . "\n"
-                         . implode("\n", $error_msg);
-            $message->set_error_message($error_msg);
-        } else {
-            $message->set_STS_ID(EEM_Message::status_idle);
-        }
-        return $message;
-    }
-
-
-    /**
-     * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
-     * error message if either is missing.
-     *
-     * @return bool         true means there were no errors, false means there were errors.
-     */
-    protected function _verify()
-    {
-        //reset error message to an empty array.
-        $this->_error_msg = array();
-        $valid            = true;
-        $valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
-        $valid            = $valid ? $this->_validate_and_setup_data() : $valid;
-
-        //set the verified flag so we know everything has been validated.
-        $this->_verified = $valid;
-
-        return $valid;
-    }
-
-
-    /**
-     * This accepts an array and validates that it is an array indexed by context with each value being an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
-     * @return bool
-     */
-    protected function _valid_addressees($addressees)
-    {
-        if (! $addressees || ! is_array($addressees)) {
-            return false;
-        }
-
-        foreach ($addressees as $addressee_array) {
-            foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
-     * queue. This process sets error messages if something is wrong.
-     *
-     * @return bool   true is if there are no errors.  false is if there is.
-     */
-    protected function _validate_messenger_and_message_type()
-    {
-
-        //first are there any existing error messages?  If so then return.
-        if ($this->_error_msg) {
-            return false;
-        }
-        /** @type EE_Message $message */
-        $message = $this->_generation_queue->get_message_repository()->current();
-        try {
-            $this->_current_messenger = $message->valid_messenger(true)
-                ? $message->messenger_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-        try {
-            $this->_current_message_type = $message->valid_message_type(true)
-                ? $message->message_type_object()
-                : null;
-        } catch (Exception $e) {
-            $this->_error_msg[] = $e->getMessage();
-        }
-
-        /**
-         * Check if there is any generation data, but only if this is not for a preview.
-         */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
-            && (
-                ! $this->_generation_queue->get_message_repository()->is_preview()
-                && $this->_generation_queue->get_message_repository()->get_data_handler()
-                   !== 'EE_Messages_Preview_incoming_data'
-            )
-        ) {
-            $this->_error_msg[] = esc_html__(
-                'There is no generation data for this message. Unable to generate.',
-                'event_espresso'
-            );
-        }
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * This method retrieves the expected data handler for the message type and validates the generation data for that
-     * data handler.
-     *
-     * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
-     */
-    protected function _validate_and_setup_data()
-    {
-
-        //First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
-        //be used anyways.
-        if ($this->_error_msg) {
-            return false;
-        }
-
-        $generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
-
-        /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
-        $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
-            ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
-
-        //If this EE_Message is for a preview, then let's switch out to the preview data handler.
-        if ($this->_generation_queue->get_message_repository()->is_preview()) {
-            $data_handler_class_name = 'EE_Messages_Preview_incoming_data';
-        }
-
-        //First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
-            $this->_error_msg[] = sprintf(
-                esc_html__(
-                    'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
-                    'event_espresso'
-                ),
-                'EE_Messages_incoming_data',
-                $data_handler_class_name
-            );
-            return false;
-        }
-
-        //convert generation_data for data_handler_instantiation.
-        $generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
-
-        //note, this may set error messages as well.
-        $this->_set_data_handler($generation_data, $data_handler_class_name);
-
-        return empty($this->_error_msg);
-    }
-
-
-    /**
-     * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
-     * adds it to the _data repository.
-     *
-     * @param mixed  $generating_data           This is data expected by the instantiated data handler.
-     * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
-     *                                          instantiated.
-     * @return void .
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_data_handler($generating_data, $data_handler_class_name)
-    {
-        //valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
-        //is already a ready data handler in the repository.
-        $this->_current_data_handler = $this->_data_handler_collection->get_by_key(
-            $this->_data_handler_collection->get_key(
-                $data_handler_class_name,
-                $generating_data
-            )
-        );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
-            //no saved data_handler in the repo so let's set one up and add it to the repo.
-            try {
-                $this->_current_data_handler = new $data_handler_class_name($generating_data);
-                $this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
-            } catch (EE_Error $e) {
-                $this->_error_msg[] = $e->get_error();
-            }
-        }
-    }
-
-
-    /**
-     * The queued EE_Message for generation does not save the data used for generation as objects
-     * because serialization of those objects could be problematic if the data is saved to the db.
-     * So this method calls the static method on the associated data_handler for the given message_type
-     * and that preps the data for later instantiation when generating.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $preview Indicate whether this is being used for a preview or not.
-     * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
-     */
-    protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
-    {
-        /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
-        $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
-            return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
-        }
-        return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
-    }
-
-
-    /**
-     * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
-     *
-     * @param EE_Message_To_Generate $message_to_generate
-     * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
-     */
-    public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
-    {
-        //prep data
-        $data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
-
-        $message = $message_to_generate->get_EE_Message();
-
-        //is there a GRP_ID in the request?
-        if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
-            $message->set_GRP_ID($GRP_ID);
-        }
-
-        if ($data === false) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                esc_html__(
-                    'Unable to prepare data for persistence to the database.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            //make sure that the data handler is cached on the message as well
-            $data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
-        }
-
-        $this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
-    }
+	/**
+	 * @type EE_Messages_Data_Handler_Collection
+	 */
+	protected $_data_handler_collection;
+
+	/**
+	 * @type  EE_Message_Template_Group_Collection
+	 */
+	protected $_template_collection;
+
+	/**
+	 * This will hold the data handler for the current EE_Message being generated.
+	 *
+	 * @type EE_Messages_incoming_data
+	 */
+	protected $_current_data_handler;
+
+	/**
+	 * This holds the EE_Messages_Queue that contains the messages to generate.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_generation_queue;
+
+	/**
+	 * This holds the EE_Messages_Queue that will store the generated EE_Message objects.
+	 *
+	 * @type EE_Messages_Queue
+	 */
+	protected $_ready_queue;
+
+	/**
+	 * This is a container for any error messages that get created through the generation
+	 * process.
+	 *
+	 * @type array
+	 */
+	protected $_error_msg = array();
+
+	/**
+	 * Flag used to set when the current EE_Message in the generation queue has been verified.
+	 *
+	 * @type bool
+	 */
+	protected $_verified = false;
+
+	/**
+	 * This will hold the current messenger object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_messenger
+	 */
+	protected $_current_messenger;
+
+	/**
+	 * This will hold the current message type object corresponding with the current EE_Message in the generation queue.
+	 *
+	 * @type EE_message_type
+	 */
+	protected $_current_message_type;
+
+	/**
+	 * @type EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_parser;
+
+
+	/**
+	 * @param EE_Messages_Queue                     $generation_queue
+	 * @param \EE_Messages_Queue                    $ready_queue
+	 * @param \EE_Messages_Data_Handler_Collection  $data_handler_collection
+	 * @param \EE_Message_Template_Group_Collection $template_collection
+	 * @param \EEH_Parse_Shortcodes                 $shortcode_parser
+	 */
+	public function __construct(
+		EE_Messages_Queue $generation_queue,
+		EE_Messages_Queue $ready_queue,
+		EE_Messages_Data_Handler_Collection $data_handler_collection,
+		EE_Message_Template_Group_Collection $template_collection,
+		EEH_Parse_Shortcodes $shortcode_parser
+	) {
+		$this->_generation_queue        = $generation_queue;
+		$this->_ready_queue             = $ready_queue;
+		$this->_data_handler_collection = $data_handler_collection;
+		$this->_template_collection     = $template_collection;
+		$this->_shortcode_parser        = $shortcode_parser;
+	}
+
+
+	/**
+	 * @return EE_Messages_Queue
+	 */
+	public function generation_queue()
+	{
+		return $this->_generation_queue;
+	}
+
+
+	/**
+	 *  This iterates through the provided queue and generates the EE_Message objects.
+	 *  When iterating through the queue, the queued item that served as the base for generating other EE_Message
+	 *  objects gets removed and the new EE_Message objects get added to a NEW queue.  The NEW queue is then returned
+	 *  for the caller to decide what to do with it.
+	 *
+	 * @param   bool $save Whether to save the EE_Message objects in the new queue or just return.
+	 * @return EE_Messages_Queue  The new queue for holding generated EE_Message objects.
+	 */
+	public function generate($save = true)
+	{
+		//iterate through the messages in the queue, generate, and add to new queue.
+		$this->_generation_queue->get_message_repository()->rewind();
+		while ($this->_generation_queue->get_message_repository()->valid()) {
+			//reset "current" properties
+			$this->_reset_current_properties();
+
+			/** @type EE_Message $msg */
+			$msg = $this->_generation_queue->get_message_repository()->current();
+
+			/**
+			 * need to get the next object and capture it for setting manually after deletes.  The reason is that when
+			 * an object is removed from the repo then valid for the next object will fail.
+			 */
+			$this->_generation_queue->get_message_repository()->next();
+			$next_msg = $this->_generation_queue->get_message_repository()->current();
+			//restore pointer to current item
+			$this->_generation_queue->get_message_repository()->set_current($msg);
+
+			//skip and delete if the current $msg is NOT incomplete (queued for generation)
+			if ($msg->STS_ID() !== EEM_Message::status_incomplete) {
+				//we keep this item in the db just remove from the repo.
+				$this->_generation_queue->get_message_repository()->remove($msg);
+				//next item
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			if ($this->_verify()) {
+				//let's get generating!
+				$this->_generate();
+			}
+
+			//don't persist debug_only messages if the messages system is not in debug mode.
+			if ($msg->STS_ID() === EEM_Message::status_debug_only
+				&& ! EEM_Message::debug()
+			) {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_debug_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$this->_generation_queue->get_message_repository()->delete();
+				$this->_generation_queue->get_message_repository()->set_current($next_msg);
+				continue;
+			}
+
+			//if there are error messages then let's set the status and the error message.
+			if ($this->_error_msg) {
+				//if the status is already debug only, then let's leave it at that.
+				if ($msg->STS_ID() !== EEM_Message::status_debug_only) {
+					$msg->set_STS_ID(EEM_Message::status_failed);
+				}
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__processing_failed_message',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				$msg->set_error_message(
+					esc_html__('Message failed to generate for the following reasons: ', 'event_espresso')
+					. "\n"
+					. implode("\n", $this->_error_msg)
+				);
+				$msg->set_modified(time());
+			} else {
+				do_action(
+					'AHEE__EE_Messages_Generator__generate__before_successful_generated_message_delete',
+					$msg,
+					$this->_error_msg,
+					$this->_current_messenger,
+					$this->_current_message_type,
+					$this->_current_data_handler
+				);
+				//remove from db
+				$this->_generation_queue->get_message_repository()->delete();
+			}
+			//next item
+			$this->_generation_queue->get_message_repository()->set_current($next_msg);
+		}
+
+		//generation queue is ALWAYS saved to record any errors in the generation process.
+		$this->_generation_queue->save();
+
+		/**
+		 * save _ready_queue if flag set.
+		 * Note: The EE_Message objects have values set via the EE_Base_Class::set_field_or_extra_meta() method.  This
+		 * means if a field was added that is not a valid database column.  The EE_Message was already saved to the db
+		 * so a EE_Extra_Meta entry could be created and attached to the EE_Message.  In those cases the save flag is
+		 * irrelevant.
+		 */
+		if ($save) {
+			$this->_ready_queue->save();
+		}
+
+		//final reset of properties
+		$this->_reset_current_properties();
+
+		return $this->_ready_queue;
+	}
+
+
+	/**
+	 * This resets all the properties used for holding "current" values corresponding to the current EE_Message object
+	 * in the generation queue.
+	 */
+	protected function _reset_current_properties()
+	{
+		$this->_verified = false;
+		//make sure any _data value in the current message type is reset
+		if ($this->_current_message_type instanceof EE_message_type) {
+			$this->_current_message_type->reset_data();
+		}
+		$this->_current_messenger = $this->_current_message_type = $this->_current_data_handler = null;
+	}
+
+
+	/**
+	 * This proceeds with the actual generation of a message.  By the time this is called, there should already be a
+	 * $_current_data_handler set and all incoming information should be validated for the current EE_Message in the
+	 * _generating_queue.
+	 *
+	 * @return bool Whether the message was successfully generated or not.
+	 * @throws EE_Error
+	 */
+	protected function _generate()
+	{
+		//double check verification has run and that everything is ready to work with (saves us having to validate
+		// everything again).
+		if (! $this->_verified) {
+			return false; //get out because we don't have a valid setup to work with.
+		}
+
+
+		try {
+			$addressees = $this->_current_message_type->get_addressees(
+				$this->_current_data_handler,
+				$this->_generation_queue->get_message_repository()->current()->context()
+			);
+		} catch (EE_Error $e) {
+			$this->_error_msg[] = $e->getMessage();
+			return false;
+		}
+
+
+		//if no addressees then get out because there is nothing to generation (possible bad data).
+		if (! $this->_valid_addressees($addressees)) {
+			do_action(
+				'AHEE__EE_Messages_Generator___generate__invalid_addressees',
+				$this->_generation_queue->get_message_repository()->current(),
+				$addressees,
+				$this->_current_messenger,
+				$this->_current_message_type,
+				$this->_current_data_handler
+			);
+			$this->_generation_queue->get_message_repository()->current()->set_STS_ID(
+				EEM_Message::status_debug_only
+			);
+			$this->_error_msg[] = esc_html__(
+				'This is not a critical error but an informational notice. Unable to generate messages EE_Messages_Addressee objects.  There were no attendees prepared by the data handler. Sometimes this is because messages only get generated for certain registration statuses. For example, the ticket notice message type only goes to approved registrations.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		$message_template_group = $this->_get_message_template_group();
+
+		//in the unlikely event there is no EE_Message_Template_Group available, get out!
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		//get formatted templates for using to parse and setup EE_Message objects.
+		$templates = $this->_get_templates($message_template_group);
+
+
+		//setup new EE_Message objects (and add to _ready_queue)
+		return $this->_assemble_messages($addressees, $templates, $message_template_group);
+	}
+
+
+	/**
+	 * Retrieves the message template group being used for generating messages.
+	 * Note: this also utilizes the EE_Message_Template_Group_Collection to avoid having to hit the db multiple times.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 */
+	protected function _get_message_template_group()
+	{
+		//first see if there is a specific message template group requested (current message in the queue has a specific
+		//GRP_ID
+		$message_template_group = $this->_specific_message_template_group_from_queue();
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//get event_ids from the datahandler so we can check to see if there's already a message template group for them
+		//in the collection.
+		$event_ids              = $this->_get_event_ids_from_current_data_handler();
+		$message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				$event_ids
+			)
+		);
+
+		//if we have a message template group then no need to hit the database, just return it.
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//okay made it here, so let's get the global group first for this messenger and message type to ensure
+		//there is no override set.
+		$global_message_template_group = $this->_get_global_message_template_group_for_current_messenger_and_message_type();
+
+		if ($global_message_template_group instanceof EE_Message_Template_Group
+			&& $global_message_template_group->get('MTP_is_override')
+		) {
+			return $global_message_template_group;
+		}
+
+		//if we're still here, that means there was no message template group for the events in the collection and
+		//the global message template group for the messenger and message type is not set for override.  So next step is
+		//to see if there is a common shared custom message template group for this set of events.
+		$message_template_group = $this->_get_shared_message_template_for_events($event_ids);
+		if ($message_template_group instanceof EE_Message_Template_Group) {
+			return $message_template_group;
+		}
+
+		//STILL here?  Okay that means the fallback is to just use the global message template group for this event set.
+		//So we'll cache the global group for this event set (so this logic doesn't have to be repeated in this request)
+		//and return it.
+		if ($global_message_template_group instanceof EE_Message_Template_Group) {
+			$this->_template_collection->add(
+				$global_message_template_group,
+				$event_ids
+			);
+			return $global_message_template_group;
+		}
+
+		//if we land here that means there's NO active message template group for this set.
+		//TODO this will be a good target for some optimization down the road.  Whenever there is no active message
+		//template group for a given event set then cache that result so we don't repeat the logic.  However, for now,
+		//this should likely bit hit rarely enough that it's not a significant issue.
+		return null;
+	}
+
+
+	/**
+	 * This checks the current message in the queue and determines if there is a specific Message Template Group
+	 * requested for that message.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 */
+	protected function _specific_message_template_group_from_queue()
+	{
+		//is there a GRP_ID already on the EE_Message object?  If there is, then a specific template has been requested
+		//so let's use that.
+		$GRP_ID = $this->_generation_queue->get_message_repository()->current()->GRP_ID();
+
+		if ($GRP_ID) {
+			//attempt to retrieve from repo first
+			$message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				return $message_template_group;  //got it!
+			}
+
+			//nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
+			//is not valid, so we'll continue on in the code assuming there's NO GRP_ID.
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add($message_template_group);
+				return $message_template_group;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether the event ids passed in all share the same message template group for the current message type
+	 * and messenger.
+	 *
+	 * @param array $event_ids
+	 * @return bool true means they DO share the same message template group, false means they don't.
+	 * @throws EE_Error
+	 */
+	protected function _queue_shares_same_message_template_group_for_events(array $event_ids)
+	{
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[$event['ID']] = $event['ID'];
+		}
+		$count_of_message_template_groups = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'Event.EVT_ID'           => array('IN', $event_ids),
+					'MTP_messenger'    => $this->_current_messenger->name,
+					'MTP_message_type' => $this->_current_message_type->name,
+				),
+			),
+			'GRP_ID',
+			true
+		);
+		return $count_of_message_template_groups === 1;
+	}
+
+
+	/**
+	 * This will get the shared message template group for events that are in the current data handler but ONLY if
+	 * there's a single shared message template group among all the events.  Otherwise it returns null.
+	 *
+	 * @param array $event_ids
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 */
+	protected function _get_shared_message_template_for_events(array $event_ids)
+	{
+		$message_template_group = null;
+		if ($this->_queue_shares_same_message_template_group_for_events($event_ids)) {
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'Event.EVT_ID'           => array('IN', $event_ids),
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+					),
+					'group_by' => 'GRP_ID',
+				)
+			);
+			//store this in the collection if its valid
+			if ($message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$message_template_group,
+					$event_ids
+				);
+			}
+		}
+		return $message_template_group;
+	}
+
+
+	/**
+	 * Retrieves the global message template group for the current messenger and message type.
+	 *
+	 * @return EE_Message_Template_Group|null
+	 * @throws EE_Error
+	 */
+	protected function _get_global_message_template_group_for_current_messenger_and_message_type()
+	{
+		//first check the collection (we use an array with 0 in it to represent global groups).
+		$global_message_template_group = $this->_template_collection->get_by_key(
+			$this->_template_collection->getKey(
+				$this->_current_messenger->name,
+				$this->_current_message_type->name,
+				array(0)
+			)
+		);
+
+		//if we don't have a group lets hit the db.
+		if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+			$global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $this->_current_messenger->name,
+						'MTP_message_type' => $this->_current_message_type->name,
+						'MTP_is_active'    => true,
+						'MTP_is_global'    => true,
+					),
+				)
+			);
+			//if we have a group, add it to the collection.
+			if ($global_message_template_group instanceof EE_Message_Template_Group) {
+				$this->_template_collection->add(
+					$global_message_template_group,
+					array(0)
+				);
+			}
+		}
+		return $global_message_template_group;
+	}
+
+
+	/**
+	 * Returns an array of event ids for all the events within the current data handler.
+	 *
+	 * @return array
+	 */
+	protected function _get_event_ids_from_current_data_handler()
+	{
+		$event_ids = array();
+		foreach ($this->_current_data_handler->events as $event) {
+			$event_ids[$event['ID']] = $event['ID'];
+		}
+		return $event_ids;
+	}
+
+
+	/**
+	 *  Retrieves formatted array of template information for each context specific to the given
+	 *  EE_Message_Template_Group
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return array The returned array is in this structure:
+	 *                          array(
+	 *                          'field_name' => array(
+	 *                          'context' => 'content'
+	 *                          )
+	 *                          )
+	 * @throws EE_Error
+	 */
+	protected function _get_templates(EE_Message_Template_Group $message_template_group)
+	{
+		$templates         = array();
+		$context_templates = $message_template_group->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			foreach ($template_fields as $template_field => $template_obj) {
+				if (! $template_obj instanceof EE_Message_Template) {
+					continue;
+				}
+				$templates[$template_field][$context] = $template_obj->get('MTP_content');
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Assembles new fully generated EE_Message objects and adds to _ready_queue
+	 *
+	 * @param array                     $addressees  Array of EE_Messages_Addressee objects indexed by message type
+	 *                                               context.
+	 * @param array                     $templates   formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool   true if message generation went a-ok.  false if some sort of exception occurred.  Note: The
+	 *                                               method will attempt to generate ALL EE_Message objects and add to
+	 *                                               the _ready_queue.  Successfully generated messages get added to the
+	 *                                               queue with EEM_Message::status_idle, unsuccessfully generated
+	 *                                               messages will get added to the queue as EEM_Message::status_failed.
+	 *                                               Very rarely should "false" be returned from this method.
+	 */
+	protected function _assemble_messages($addressees, $templates, EE_Message_Template_Group $message_template_group)
+	{
+
+		//if templates are empty then get out because we can't generate anything.
+		if (! $templates) {
+			$this->_error_msg[] = esc_html__(
+				'Unable to assemble messages because there are no templates retrieved for generating the messages with',
+				'event_espresso'
+			);
+			return false;
+		}
+
+		//We use this as the counter for generated messages because don't forget we may be executing this inside of a
+		//generation_queue.  So _ready_queue may have generated EE_Message objects already.
+		$generated_count = 0;
+		foreach ($addressees as $context => $recipients) {
+			foreach ($recipients as $recipient) {
+				$message = $this->_setup_message_object($context, $recipient, $templates, $message_template_group);
+				if ($message instanceof EE_Message) {
+					$this->_ready_queue->add(
+						$message,
+						array(),
+						$this->_generation_queue->get_message_repository()->is_preview(),
+						$this->_generation_queue->get_message_repository()->is_test_send()
+					);
+					$generated_count++;
+				}
+
+				//if the current MSG being generated is for a test send then we'll only use ONE message in the generation.
+				if ($this->_generation_queue->get_message_repository()->is_test_send()) {
+					break 2;
+				}
+			}
+		}
+
+		//if there are no generated messages then something else fatal went wrong.
+		return $generated_count > 0;
+	}
+
+
+	/**
+	 * @param string                    $context   The context for the generated message.
+	 * @param EE_Messages_Addressee     $recipient
+	 * @param array                     $templates formatted array of templates used for parsing data.
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @return bool|EE_Message
+	 * @throws EE_Error
+	 */
+	protected function _setup_message_object(
+		$context,
+		EE_Messages_Addressee $recipient,
+		$templates,
+		EE_Message_Template_Group $message_template_group
+	) {
+		//stuff we already know
+		$transaction_id = $recipient->txn instanceof EE_Transaction ? $recipient->txn->ID() : 0;
+		$transaction_id = empty($transaction_id) && $this->_current_data_handler->txn instanceof EE_Transaction
+			? $this->_current_data_handler->txn->ID()
+			: $transaction_id;
+		$message_fields = array(
+			'GRP_ID'           => $message_template_group->ID(),
+			'TXN_ID'           => $transaction_id,
+			'MSG_messenger'    => $this->_current_messenger->name,
+			'MSG_message_type' => $this->_current_message_type->name,
+			'MSG_context'      => $context,
+		);
+
+		//recipient id and type should be on the EE_Messages_Addressee object but if this is empty, let's try to grab
+		// the info from the att_obj found in the EE_Messages_Addressee object.
+		if (empty($recipient->recipient_id) || empty($recipient->recipient_type)) {
+			$message_fields['MSG_recipient_ID']   = $recipient->att_obj instanceof EE_Attendee
+				? $recipient->att_obj->ID()
+				: 0;
+			$message_fields['MSG_recipient_type'] = 'Attendee';
+		} else {
+			$message_fields['MSG_recipient_ID']   = $recipient->recipient_id;
+			$message_fields['MSG_recipient_type'] = $recipient->recipient_type;
+		}
+		$message = EE_Message_Factory::create($message_fields);
+
+		//grab valid shortcodes for shortcode parser
+		$mt_shortcodes = $this->_current_message_type->get_valid_shortcodes();
+		$m_shortcodes  = $this->_current_messenger->get_valid_shortcodes();
+
+		//if the 'to' field is empty (messages will ALWAYS have a "to" field, then we get out because that means this
+		//context is turned off) EXCEPT if we're previewing
+		if (empty($templates['to'][$context])
+			&& ! $this->_generation_queue->get_message_repository()->is_preview()
+			&& ! $this->_current_messenger->allow_empty_to_field()
+		) {
+			//we silently exit here and do NOT record a fail because the message is "turned off" by having no "to"
+			//field.
+			return false;
+		}
+		$error_msg = array();
+		foreach ($templates as $field => $field_context) {
+			$error_msg = array();
+			//let's setup the valid shortcodes for the incoming context.
+			$valid_shortcodes = $mt_shortcodes[$context];
+			//merge in valid shortcodes for the field.
+			$shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
+			if (isset($templates[$field][$context])) {
+				//prefix field.
+				$column_name = 'MSG_' . $field;
+				try {
+					$content = $this->_shortcode_parser->parse_message_template(
+						$templates[$field][$context],
+						$recipient,
+						$shortcodes,
+						$this->_current_message_type,
+						$this->_current_messenger,
+						$message
+					);
+					$message->set_field_or_extra_meta($column_name, $content);
+				} catch (EE_Error $e) {
+					$error_msg[] = sprintf(
+						esc_html__(
+							'There was a problem generating the content for the field %s: %s',
+							'event_espresso'
+						),
+						$field,
+						$e->getMessage()
+					);
+					$message->set_STS_ID(EEM_Message::status_failed);
+				}
+			}
+		}
+
+		if ($message->STS_ID() === EEM_Message::status_failed) {
+			$error_msg = esc_html__('There were problems generating this message:', 'event_espresso')
+						 . "\n"
+						 . implode("\n", $error_msg);
+			$message->set_error_message($error_msg);
+		} else {
+			$message->set_STS_ID(EEM_Message::status_idle);
+		}
+		return $message;
+	}
+
+
+	/**
+	 * This verifies that the incoming array has a EE_messenger object and a EE_message_type object and sets appropriate
+	 * error message if either is missing.
+	 *
+	 * @return bool         true means there were no errors, false means there were errors.
+	 */
+	protected function _verify()
+	{
+		//reset error message to an empty array.
+		$this->_error_msg = array();
+		$valid            = true;
+		$valid            = $valid ? $this->_validate_messenger_and_message_type() : $valid;
+		$valid            = $valid ? $this->_validate_and_setup_data() : $valid;
+
+		//set the verified flag so we know everything has been validated.
+		$this->_verified = $valid;
+
+		return $valid;
+	}
+
+
+	/**
+	 * This accepts an array and validates that it is an array indexed by context with each value being an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param array $addressees Keys correspond to contexts for the message type and values are EE_Messages_Addressee[]
+	 * @return bool
+	 */
+	protected function _valid_addressees($addressees)
+	{
+		if (! $addressees || ! is_array($addressees)) {
+			return false;
+		}
+
+		foreach ($addressees as $addressee_array) {
+			foreach ($addressee_array as $addressee) {
+				if (! $addressee instanceof EE_Messages_Addressee) {
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This validates the messenger, message type, and presences of generation data for the current EE_Message in the
+	 * queue. This process sets error messages if something is wrong.
+	 *
+	 * @return bool   true is if there are no errors.  false is if there is.
+	 */
+	protected function _validate_messenger_and_message_type()
+	{
+
+		//first are there any existing error messages?  If so then return.
+		if ($this->_error_msg) {
+			return false;
+		}
+		/** @type EE_Message $message */
+		$message = $this->_generation_queue->get_message_repository()->current();
+		try {
+			$this->_current_messenger = $message->valid_messenger(true)
+				? $message->messenger_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+		try {
+			$this->_current_message_type = $message->valid_message_type(true)
+				? $message->message_type_object()
+				: null;
+		} catch (Exception $e) {
+			$this->_error_msg[] = $e->getMessage();
+		}
+
+		/**
+		 * Check if there is any generation data, but only if this is not for a preview.
+		 */
+		if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+			&& (
+				! $this->_generation_queue->get_message_repository()->is_preview()
+				&& $this->_generation_queue->get_message_repository()->get_data_handler()
+				   !== 'EE_Messages_Preview_incoming_data'
+			)
+		) {
+			$this->_error_msg[] = esc_html__(
+				'There is no generation data for this message. Unable to generate.',
+				'event_espresso'
+			);
+		}
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * This method retrieves the expected data handler for the message type and validates the generation data for that
+	 * data handler.
+	 *
+	 * @return bool true means there are no errors.  false means there were errors (and handler did not get setup).
+	 */
+	protected function _validate_and_setup_data()
+	{
+
+		//First, are there any existing error messages?  If so, return because if there were errors elsewhere this can't
+		//be used anyways.
+		if ($this->_error_msg) {
+			return false;
+		}
+
+		$generation_data = $this->_generation_queue->get_message_repository()->get_generation_data();
+
+		/** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
+		$data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
+			? $this->_generation_queue->get_message_repository()->get_data_handler()
+			: 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+
+		//If this EE_Message is for a preview, then let's switch out to the preview data handler.
+		if ($this->_generation_queue->get_message_repository()->is_preview()) {
+			$data_handler_class_name = 'EE_Messages_Preview_incoming_data';
+		}
+
+		//First get the class name for the data handler (and also verifies it exists.
+		if (! class_exists($data_handler_class_name)) {
+			$this->_error_msg[] = sprintf(
+				esc_html__(
+					'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
+					'event_espresso'
+				),
+				'EE_Messages_incoming_data',
+				$data_handler_class_name
+			);
+			return false;
+		}
+
+		//convert generation_data for data_handler_instantiation.
+		$generation_data = $data_handler_class_name::convert_data_from_persistent_storage($generation_data);
+
+		//note, this may set error messages as well.
+		$this->_set_data_handler($generation_data, $data_handler_class_name);
+
+		return empty($this->_error_msg);
+	}
+
+
+	/**
+	 * Sets the $_current_data_handler property that is used for generating the current EE_Message in the queue, and
+	 * adds it to the _data repository.
+	 *
+	 * @param mixed  $generating_data           This is data expected by the instantiated data handler.
+	 * @param string $data_handler_class_name   This is the reference string indicating what data handler is being
+	 *                                          instantiated.
+	 * @return void .
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_data_handler($generating_data, $data_handler_class_name)
+	{
+		//valid classname for the data handler.  Now let's setup the key for the data handler repository to see if there
+		//is already a ready data handler in the repository.
+		$this->_current_data_handler = $this->_data_handler_collection->get_by_key(
+			$this->_data_handler_collection->get_key(
+				$data_handler_class_name,
+				$generating_data
+			)
+		);
+		if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+			//no saved data_handler in the repo so let's set one up and add it to the repo.
+			try {
+				$this->_current_data_handler = new $data_handler_class_name($generating_data);
+				$this->_data_handler_collection->add($this->_current_data_handler, $generating_data);
+			} catch (EE_Error $e) {
+				$this->_error_msg[] = $e->get_error();
+			}
+		}
+	}
+
+
+	/**
+	 * The queued EE_Message for generation does not save the data used for generation as objects
+	 * because serialization of those objects could be problematic if the data is saved to the db.
+	 * So this method calls the static method on the associated data_handler for the given message_type
+	 * and that preps the data for later instantiation when generating.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $preview Indicate whether this is being used for a preview or not.
+	 * @return mixed Prepped data for persisting to the queue.  false is returned if unable to prep data.
+	 */
+	protected function _prepare_data_for_queue(EE_Message_To_Generate $message_to_generate, $preview)
+	{
+		/** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
+		$data_handler = $message_to_generate->get_data_handler_class_name($preview);
+		if (! $message_to_generate->valid()) {
+			return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
+		}
+		return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());
+	}
+
+
+	/**
+	 * This sets up a EEM_Message::status_incomplete EE_Message object and adds it to the generation queue.
+	 *
+	 * @param EE_Message_To_Generate $message_to_generate
+	 * @param bool                   $test_send Whether this is just a test send or not.  Typically used for previews.
+	 */
+	public function create_and_add_message_to_queue(EE_Message_To_Generate $message_to_generate, $test_send = false)
+	{
+		//prep data
+		$data = $this->_prepare_data_for_queue($message_to_generate, $message_to_generate->preview());
+
+		$message = $message_to_generate->get_EE_Message();
+
+		//is there a GRP_ID in the request?
+		if ($GRP_ID = EE_Registry::instance()->REQ->get('GRP_ID')) {
+			$message->set_GRP_ID($GRP_ID);
+		}
+
+		if ($data === false) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				esc_html__(
+					'Unable to prepare data for persistence to the database.',
+					'event_espresso'
+				)
+			);
+		} else {
+			//make sure that the data handler is cached on the message as well
+			$data['data_handler_class_name'] = $message_to_generate->get_data_handler_class_name();
+		}
+
+		$this->_generation_queue->add($message, $data, $message_to_generate->preview(), $test_send);
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -254,7 +254,7 @@ 
     {
         //double check verification has run and that everything is ready to work with (saves us having to validate
         // everything again).
-        if (! $this->_verified) {
+        if ( ! $this->_verified) {
             return false; //get out because we don't have a valid setup to work with.
         }
 
@@ -271,7 +271,7 @@ 
 
 
         //if no addressees then get out because there is nothing to generation (possible bad data).
-        if (! $this->_valid_addressees($addressees)) {
+        if ( ! $this->_valid_addressees($addressees)) {
             do_action(
                 'AHEE__EE_Messages_Generator___generate__invalid_addressees',
                 $this->_generation_queue->get_message_repository()->current(),
@@ -293,7 +293,7 @@ 
         $message_template_group = $this->_get_message_template_group();
 
         //in the unlikely event there is no EE_Message_Template_Group available, get out!
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             $this->_error_msg[] = esc_html__(
                 'Unable to get the Message Templates for the Message being generated.  No message template group accessible.',
                 'event_espresso'
@@ -395,7 +395,7 @@ 
             //attempt to retrieve from repo first
             $message_template_group = $this->_template_collection->get_by_ID($GRP_ID);
             if ($message_template_group instanceof EE_Message_Template_Group) {
-                return $message_template_group;  //got it!
+                return $message_template_group; //got it!
             }
 
             //nope don't have it yet.  Get from DB then add to repo if its not here, then that means the current GRP_ID
@@ -491,7 +491,7 @@ 
         );
 
         //if we don't have a group lets hit the db.
-        if (! $global_message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $global_message_template_group instanceof EE_Message_Template_Group) {
             $global_message_template_group = EEM_Message_Template_Group::instance()->get_one(
                 array(
                     array(
@@ -548,7 +548,7 @@ 
         $context_templates = $message_template_group->context_templates();
         foreach ($context_templates as $context => $template_fields) {
             foreach ($template_fields as $template_field => $template_obj) {
-                if (! $template_obj instanceof EE_Message_Template) {
+                if ( ! $template_obj instanceof EE_Message_Template) {
                     continue;
                 }
                 $templates[$template_field][$context] = $template_obj->get('MTP_content');
@@ -576,7 +576,7 @@ 
     {
 
         //if templates are empty then get out because we can't generate anything.
-        if (! $templates) {
+        if ( ! $templates) {
             $this->_error_msg[] = esc_html__(
                 'Unable to assemble messages because there are no templates retrieved for generating the messages with',
                 'event_espresso'
@@ -675,7 +675,7 @@ 
             $shortcodes = isset($m_shortcodes[$field]) ? $m_shortcodes[$field] : $valid_shortcodes;
             if (isset($templates[$field][$context])) {
                 //prefix field.
-                $column_name = 'MSG_' . $field;
+                $column_name = 'MSG_'.$field;
                 try {
                     $content = $this->_shortcode_parser->parse_message_template(
                         $templates[$field][$context],
@@ -742,13 +742,13 @@ 
      */
     protected function _valid_addressees($addressees)
     {
-        if (! $addressees || ! is_array($addressees)) {
+        if ( ! $addressees || ! is_array($addressees)) {
             return false;
         }
 
         foreach ($addressees as $addressee_array) {
             foreach ($addressee_array as $addressee) {
-                if (! $addressee instanceof EE_Messages_Addressee) {
+                if ( ! $addressee instanceof EE_Messages_Addressee) {
                     return false;
                 }
             }
@@ -790,7 +790,7 @@ 
         /**
          * Check if there is any generation data, but only if this is not for a preview.
          */
-        if (! $this->_generation_queue->get_message_repository()->get_generation_data()
+        if ( ! $this->_generation_queue->get_message_repository()->get_generation_data()
             && (
                 ! $this->_generation_queue->get_message_repository()->is_preview()
                 && $this->_generation_queue->get_message_repository()->get_data_handler()
@@ -827,7 +827,7 @@ 
         /** @type EE_Messages_incoming_data $data_handler_class_name - well not really... just the class name actually */
         $data_handler_class_name = $this->_generation_queue->get_message_repository()->get_data_handler()
             ? $this->_generation_queue->get_message_repository()->get_data_handler()
-            : 'EE_Messages_' . $this->_current_message_type->get_data_handler($generation_data) . '_incoming_data';
+            : 'EE_Messages_'.$this->_current_message_type->get_data_handler($generation_data).'_incoming_data';
 
         //If this EE_Message is for a preview, then let's switch out to the preview data handler.
         if ($this->_generation_queue->get_message_repository()->is_preview()) {
@@ -835,7 +835,7 @@ 
         }
 
         //First get the class name for the data handler (and also verifies it exists.
-        if (! class_exists($data_handler_class_name)) {
+        if ( ! class_exists($data_handler_class_name)) {
             $this->_error_msg[] = sprintf(
                 esc_html__(
                     'The included data handler class name does not match any valid, accessible, "%1$s" classes.  Looking for %2$s.',
@@ -878,7 +878,7 @@ 
                 $generating_data
             )
         );
-        if (! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
+        if ( ! $this->_current_data_handler instanceof EE_Messages_incoming_data) {
             //no saved data_handler in the repo so let's set one up and add it to the repo.
             try {
                 $this->_current_data_handler = new $data_handler_class_name($generating_data);
@@ -904,7 +904,7 @@ 
     {
         /** @type EE_Messages_incoming_data $data_handler - well not really... just the class name actually */
         $data_handler = $message_to_generate->get_data_handler_class_name($preview);
-        if (! $message_to_generate->valid()) {
+        if ( ! $message_to_generate->valid()) {
             return false; //unable to get the data because the info in the EE_Message_To_Generate class is invalid.
         }
         return $data_handler::convert_data_for_persistent_storage($message_to_generate->data());

acceptance_tests/tests/c-TestCustomMessageTemplateCept.php

Indentation +27 added lines, -27 removed lines

@@ -18,14 +18,14 @@ 
 $event_one_link = $event_two_link = $event_three_link = '';
 
 $I->wantTo(
-    'Test that when registrations for multiple events are completed, and those events share the same custom'
-    . 'template, that that custom template will be used.'
+	'Test that when registrations for multiple events are completed, and those events share the same custom'
+	. 'template, that that custom template will be used.'
 );
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 $I->loginAsAdmin();
@@ -83,9 +83,9 @@ 
 
 
 $test_registration_details = array(
-    'fname' => 'CTGuy',
-    'lname' => 'Dude',
-    'email' => 'ctguy_dude@example.org'
+	'fname' => 'CTGuy',
+	'lname' => 'Dude',
+	'email' => 'ctguy_dude@example.org'
 );
 
 $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.');
@@ -111,24 +111,24 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 //closes view window
 $I->click('#espresso-admin-page-overlay-dv');
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->click('#espresso-admin-page-overlay-dv');
@@ -157,10 +157,10 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSeeTextInViewMessageModal($custom_template_a_label);
@@ -168,15 +168,15 @@ 
 //closes view window
 $I->click('#espresso-admin-page-overlay-dv');
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSee($custom_template_a_label);
@@ -188,6 +188,6 @@ 
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'Plugin deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'Plugin deactivated'
 );
\ No newline at end of file