Completed
Branch FET/11450/reserved-instance-in... (7eae78)
by
unknown
39:56 queued 27:31
created
core/EE_Registry.core.php 3 patches
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -322,6 +322,7 @@  discard block
 block discarded – undo
322 322
 
323 323
     /**
324 324
      * @param mixed string | EED_Module $module
325
+     * @param string $module
325 326
      * @throws OutOfBoundsException
326 327
      * @throws InvalidArgumentException
327 328
      * @throws InvalidInterfaceException
@@ -794,7 +795,7 @@  discard block
 block discarded – undo
794 795
     /**
795 796
      * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
796 797
      *
797
-     * @param string|object $class_name
798
+     * @param string $class_name
798 799
      * @param array         $arguments
799 800
      * @param int           $attempt
800 801
      * @return mixed
@@ -1377,7 +1378,7 @@  discard block
 block discarded – undo
1377 1378
      * @param string $class_name
1378 1379
      * @param string $param_class
1379 1380
      * @param array  $arguments
1380
-     * @param mixed  $index
1381
+     * @param integer  $index
1381 1382
      * @return array
1382 1383
      * @throws InvalidArgumentException
1383 1384
      * @throws InvalidInterfaceException
Please login to merge, or discard this patch.
Indentation   +1661 added lines, -1661 removed lines patch added patch discarded remove patch
@@ -27,1667 +27,1667 @@
 block discarded – undo
27 27
 class EE_Registry implements ResettableInterface
28 28
 {
29 29
 
30
-    /**
31
-     * @var EE_Registry $_instance
32
-     */
33
-    private static $_instance;
34
-
35
-    /**
36
-     * @var EE_Dependency_Map $_dependency_map
37
-     */
38
-    protected $_dependency_map;
39
-
40
-    /**
41
-     * @var Mirror
42
-     */
43
-    private $mirror;
44
-
45
-    /**
46
-     * @var ClassInterfaceCache $class_cache
47
-     */
48
-    private $class_cache;
49
-
50
-    /**
51
-     * @var array $_class_abbreviations
52
-     */
53
-    protected $_class_abbreviations = array();
54
-
55
-    /**
56
-     * @var CommandBusInterface $BUS
57
-     */
58
-    public $BUS;
59
-
60
-    /**
61
-     * @var EE_Cart $CART
62
-     */
63
-    public $CART;
64
-
65
-    /**
66
-     * @var EE_Config $CFG
67
-     */
68
-    public $CFG;
69
-
70
-    /**
71
-     * @var EE_Network_Config $NET_CFG
72
-     */
73
-    public $NET_CFG;
74
-
75
-    /**
76
-     * StdClass object for storing library classes in
77
-     *
78
-     * @var RegistryContainer $LIB
79
-     */
80
-    public $LIB;
81
-
82
-    /**
83
-     * @var EE_Request_Handler $REQ
84
-     */
85
-    public $REQ;
86
-
87
-    /**
88
-     * @var EE_Session $SSN
89
-     */
90
-    public $SSN;
91
-
92
-    /**
93
-     * @since 4.5.0
94
-     * @var EE_Capabilities $CAP
95
-     */
96
-    public $CAP;
97
-
98
-    /**
99
-     * @since 4.9.0
100
-     * @var EE_Message_Resource_Manager $MRM
101
-     */
102
-    public $MRM;
103
-
104
-    /**
105
-     * @var Registry $AssetsRegistry
106
-     */
107
-    public $AssetsRegistry;
108
-
109
-    /**
110
-     * StdClass object for holding addons which have registered themselves to work with EE core
111
-     *
112
-     * @var EE_Addon[] $addons
113
-     */
114
-    public $addons;
115
-
116
-    /**
117
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
118
-     *
119
-     * @var EEM_Base[] $models
120
-     */
121
-    public $models = array();
122
-
123
-    /**
124
-     * @var EED_Module[] $modules
125
-     */
126
-    public $modules;
127
-
128
-    /**
129
-     * @var EES_Shortcode[] $shortcodes
130
-     */
131
-    public $shortcodes;
132
-
133
-    /**
134
-     * @var WP_Widget[] $widgets
135
-     */
136
-    public $widgets;
137
-
138
-    /**
139
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
140
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
141
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
142
-     * classnames (eg "EEM_Event")
143
-     *
144
-     * @var array $non_abstract_db_models
145
-     */
146
-    public $non_abstract_db_models = array();
147
-
148
-    /**
149
-     * internationalization for JS strings
150
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
151
-     *    in js file:  var translatedString = eei18n.string_key;
152
-     *
153
-     * @var array $i18n_js_strings
154
-     */
155
-    public static $i18n_js_strings = array();
156
-
157
-    /**
158
-     * $main_file - path to espresso.php
159
-     *
160
-     * @var array $main_file
161
-     */
162
-    public $main_file;
163
-
164
-    /**
165
-     * array of ReflectionClass objects where the key is the class name
166
-     *
167
-     * @deprecated $VID:$
168
-     * @var ReflectionClass[] $_reflectors
169
-     */
170
-    public $_reflectors;
171
-
172
-    /**
173
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
174
-     *
175
-     * @var boolean $_cache_on
176
-     */
177
-    protected $_cache_on = true;
178
-
179
-    /**
180
-     * @var ObjectIdentifier
181
-     */
182
-    private $object_identifier;
183
-
184
-
185
-    /**
186
-     * @singleton method used to instantiate class object
187
-     * @param EE_Dependency_Map|null   $dependency_map
188
-     * @param Mirror|null              $mirror
189
-     * @param ClassInterfaceCache|null $class_cache
190
-     * @param ObjectIdentifier|null    $object_identifier
191
-     * @return EE_Registry instance
192
-     */
193
-    public static function instance(
194
-        EE_Dependency_Map $dependency_map = null,
195
-        Mirror $mirror = null,
196
-        ClassInterfaceCache $class_cache = null,
197
-        ObjectIdentifier $object_identifier = null
198
-    ) {
199
-        // check if class object is instantiated
200
-        if (
201
-            ! self::$_instance instanceof EE_Registry
202
-            && $dependency_map instanceof EE_Dependency_Map
203
-            && $mirror instanceof Mirror
204
-            && $class_cache instanceof ClassInterfaceCache
205
-            && $object_identifier instanceof ObjectIdentifier
206
-        ) {
207
-            self::$_instance = new self(
208
-                $dependency_map,
209
-                $mirror,
210
-                $class_cache,
211
-                $object_identifier
212
-            );
213
-        }
214
-        return self::$_instance;
215
-    }
216
-
217
-
218
-    /**
219
-     * protected constructor to prevent direct creation
220
-     *
221
-     * @Constructor
222
-     * @param  EE_Dependency_Map  $dependency_map
223
-     * @param Mirror              $mirror
224
-     * @param ClassInterfaceCache $class_cache
225
-     * @param ObjectIdentifier    $object_identifier
226
-     */
227
-    protected function __construct(
228
-        EE_Dependency_Map $dependency_map,
229
-        Mirror $mirror,
230
-        ClassInterfaceCache $class_cache,
231
-        ObjectIdentifier $object_identifier
232
-    ) {
233
-        $this->_dependency_map   = $dependency_map;
234
-        $this->mirror            = $mirror;
235
-        $this->class_cache       = $class_cache;
236
-        $this->object_identifier = $object_identifier;
237
-        // $registry_container = new RegistryContainer();
238
-        $this->LIB        = new RegistryContainer();
239
-        $this->addons     = new RegistryContainer();
240
-        $this->modules    = new RegistryContainer();
241
-        $this->shortcodes = new RegistryContainer();
242
-        $this->widgets    = new RegistryContainer();
243
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
244
-    }
245
-
246
-
247
-    /**
248
-     * initialize
249
-     *
250
-     * @throws OutOfBoundsException
251
-     * @throws InvalidArgumentException
252
-     * @throws InvalidInterfaceException
253
-     * @throws InvalidDataTypeException
254
-     * @throws EE_Error
255
-     * @throws ReflectionException
256
-     */
257
-    public function initialize()
258
-    {
259
-        $this->_class_abbreviations = apply_filters(
260
-            'FHEE__EE_Registry____construct___class_abbreviations',
261
-            array(
262
-                'EE_Config'                                       => 'CFG',
263
-                'EE_Session'                                      => 'SSN',
264
-                'EE_Capabilities'                                 => 'CAP',
265
-                'EE_Cart'                                         => 'CART',
266
-                'EE_Network_Config'                               => 'NET_CFG',
267
-                'EE_Request_Handler'                              => 'REQ',
268
-                'EE_Message_Resource_Manager'                     => 'MRM',
269
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
270
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
271
-            )
272
-        );
273
-        $this->load_core('Base', array(), true);
274
-        // add our request and response objects to the cache
275
-        $request_loader = $this->_dependency_map->class_loader(
276
-            'EventEspresso\core\services\request\Request'
277
-        );
278
-        $this->_set_cached_class(
279
-            $request_loader(),
280
-            'EventEspresso\core\services\request\Request'
281
-        );
282
-        $response_loader = $this->_dependency_map->class_loader(
283
-            'EventEspresso\core\services\request\Response'
284
-        );
285
-        $this->_set_cached_class(
286
-            $response_loader(),
287
-            'EventEspresso\core\services\request\Response'
288
-        );
289
-        add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
290
-    }
291
-
292
-
293
-    /**
294
-     * @return void
295
-     */
296
-    public function init()
297
-    {
298
-        // Get current page protocol
299
-        $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
300
-        // Output admin-ajax.php URL with same protocol as current page
301
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
302
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
303
-    }
304
-
305
-
306
-    /**
307
-     * localize_i18n_js_strings
308
-     *
309
-     * @return string
310
-     */
311
-    public static function localize_i18n_js_strings()
312
-    {
313
-        $i18n_js_strings = (array) self::$i18n_js_strings;
314
-        foreach ($i18n_js_strings as $key => $value) {
315
-            if (is_scalar($value)) {
316
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
317
-            }
318
-        }
319
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
320
-    }
321
-
322
-
323
-    /**
324
-     * @param mixed string | EED_Module $module
325
-     * @throws OutOfBoundsException
326
-     * @throws InvalidArgumentException
327
-     * @throws InvalidInterfaceException
328
-     * @throws InvalidDataTypeException
329
-     * @throws EE_Error
330
-     * @throws ReflectionException
331
-     */
332
-    public function add_module($module)
333
-    {
334
-        if ($module instanceof EED_Module) {
335
-            $module_class                   = get_class($module);
336
-            $this->modules->{$module_class} = $module;
337
-        } else {
338
-            if (! class_exists('EE_Module_Request_Router', false)) {
339
-                $this->load_core('Module_Request_Router');
340
-            }
341
-            EE_Module_Request_Router::module_factory($module);
342
-        }
343
-    }
344
-
345
-
346
-    /**
347
-     * @param string $module_name
348
-     * @return mixed EED_Module | NULL
349
-     */
350
-    public function get_module($module_name = '')
351
-    {
352
-        return isset($this->modules->{$module_name})
353
-            ? $this->modules->{$module_name}
354
-            : null;
355
-    }
356
-
357
-
358
-    /**
359
-     * loads core classes - must be singletons
360
-     *
361
-     * @param string $class_name - simple class name ie: session
362
-     * @param mixed  $arguments
363
-     * @param bool   $load_only
364
-     * @return mixed
365
-     * @throws InvalidInterfaceException
366
-     * @throws InvalidDataTypeException
367
-     * @throws EE_Error
368
-     * @throws ReflectionException
369
-     * @throws InvalidArgumentException
370
-     */
371
-    public function load_core($class_name, $arguments = array(), $load_only = false)
372
-    {
373
-        $core_paths = apply_filters(
374
-            'FHEE__EE_Registry__load_core__core_paths',
375
-            array(
376
-                EE_CORE,
377
-                EE_ADMIN,
378
-                EE_CPTS,
379
-                EE_CORE . 'data_migration_scripts' . DS,
380
-                EE_CORE . 'capabilities' . DS,
381
-                EE_CORE . 'request_stack' . DS,
382
-                EE_CORE . 'middleware' . DS,
383
-            )
384
-        );
385
-        // retrieve instantiated class
386
-        return $this->_load(
387
-            $core_paths,
388
-            'EE_',
389
-            $class_name,
390
-            'core',
391
-            $arguments,
392
-            false,
393
-            true,
394
-            $load_only
395
-        );
396
-    }
397
-
398
-
399
-    /**
400
-     * loads service classes
401
-     *
402
-     * @param string $class_name - simple class name ie: session
403
-     * @param mixed  $arguments
404
-     * @param bool   $load_only
405
-     * @return mixed
406
-     * @throws InvalidInterfaceException
407
-     * @throws InvalidDataTypeException
408
-     * @throws EE_Error
409
-     * @throws ReflectionException
410
-     * @throws InvalidArgumentException
411
-     */
412
-    public function load_service($class_name, $arguments = array(), $load_only = false)
413
-    {
414
-        $service_paths = apply_filters(
415
-            'FHEE__EE_Registry__load_service__service_paths',
416
-            array(
417
-                EE_CORE . 'services' . DS,
418
-            )
419
-        );
420
-        // retrieve instantiated class
421
-        return $this->_load(
422
-            $service_paths,
423
-            'EE_',
424
-            $class_name,
425
-            'class',
426
-            $arguments,
427
-            false,
428
-            true,
429
-            $load_only
430
-        );
431
-    }
432
-
433
-
434
-    /**
435
-     * loads data_migration_scripts
436
-     *
437
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
438
-     * @param mixed  $arguments
439
-     * @return EE_Data_Migration_Script_Base|mixed
440
-     * @throws InvalidInterfaceException
441
-     * @throws InvalidDataTypeException
442
-     * @throws EE_Error
443
-     * @throws ReflectionException
444
-     * @throws InvalidArgumentException
445
-     */
446
-    public function load_dms($class_name, $arguments = array())
447
-    {
448
-        // retrieve instantiated class
449
-        return $this->_load(
450
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
451
-            'EE_DMS_',
452
-            $class_name,
453
-            'dms',
454
-            $arguments,
455
-            false,
456
-            false
457
-        );
458
-    }
459
-
460
-
461
-    /**
462
-     * loads object creating classes - must be singletons
463
-     *
464
-     * @param string $class_name - simple class name ie: attendee
465
-     * @param mixed  $arguments  - an array of arguments to pass to the class
466
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
467
-     *                           instantiate
468
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
469
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
470
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
471
-     *                           (default)
472
-     * @return EE_Base_Class | bool
473
-     * @throws InvalidInterfaceException
474
-     * @throws InvalidDataTypeException
475
-     * @throws EE_Error
476
-     * @throws ReflectionException
477
-     * @throws InvalidArgumentException
478
-     */
479
-    public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
480
-    {
481
-        $paths = apply_filters(
482
-            'FHEE__EE_Registry__load_class__paths', array(
483
-                EE_CORE,
484
-                EE_CLASSES,
485
-                EE_BUSINESS,
486
-            )
487
-        );
488
-        // retrieve instantiated class
489
-        return $this->_load(
490
-            $paths,
491
-            'EE_',
492
-            $class_name,
493
-            'class',
494
-            $arguments,
495
-            $from_db,
496
-            $cache,
497
-            $load_only
498
-        );
499
-    }
500
-
501
-
502
-    /**
503
-     * loads helper classes - must be singletons
504
-     *
505
-     * @param string $class_name - simple class name ie: price
506
-     * @param mixed  $arguments
507
-     * @param bool   $load_only
508
-     * @return EEH_Base | bool
509
-     * @throws InvalidInterfaceException
510
-     * @throws InvalidDataTypeException
511
-     * @throws EE_Error
512
-     * @throws ReflectionException
513
-     * @throws InvalidArgumentException
514
-     */
515
-    public function load_helper($class_name, $arguments = array(), $load_only = true)
516
-    {
517
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
518
-        $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
519
-        // retrieve instantiated class
520
-        return $this->_load(
521
-            $helper_paths,
522
-            'EEH_',
523
-            $class_name,
524
-            'helper',
525
-            $arguments,
526
-            false,
527
-            true,
528
-            $load_only
529
-        );
530
-    }
531
-
532
-
533
-    /**
534
-     * loads core classes - must be singletons
535
-     *
536
-     * @param string $class_name - simple class name ie: session
537
-     * @param mixed  $arguments
538
-     * @param bool   $load_only
539
-     * @param bool   $cache      whether to cache the object or not.
540
-     * @return mixed
541
-     * @throws InvalidInterfaceException
542
-     * @throws InvalidDataTypeException
543
-     * @throws EE_Error
544
-     * @throws ReflectionException
545
-     * @throws InvalidArgumentException
546
-     */
547
-    public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
548
-    {
549
-        $paths = array(
550
-            EE_LIBRARIES,
551
-            EE_LIBRARIES . 'messages' . DS,
552
-            EE_LIBRARIES . 'shortcodes' . DS,
553
-            EE_LIBRARIES . 'qtips' . DS,
554
-            EE_LIBRARIES . 'payment_methods' . DS,
555
-        );
556
-        // retrieve instantiated class
557
-        return $this->_load(
558
-            $paths,
559
-            'EE_',
560
-            $class_name,
561
-            'lib',
562
-            $arguments,
563
-            false,
564
-            $cache,
565
-            $load_only
566
-        );
567
-    }
568
-
569
-
570
-    /**
571
-     * loads model classes - must be singletons
572
-     *
573
-     * @param string $class_name - simple class name ie: price
574
-     * @param mixed  $arguments
575
-     * @param bool   $load_only
576
-     * @return EEM_Base | bool
577
-     * @throws InvalidInterfaceException
578
-     * @throws InvalidDataTypeException
579
-     * @throws EE_Error
580
-     * @throws ReflectionException
581
-     * @throws InvalidArgumentException
582
-     */
583
-    public function load_model($class_name, $arguments = array(), $load_only = false)
584
-    {
585
-        $paths = apply_filters(
586
-            'FHEE__EE_Registry__load_model__paths', array(
587
-                EE_MODELS,
588
-                EE_CORE,
589
-            )
590
-        );
591
-        // retrieve instantiated class
592
-        return $this->_load(
593
-            $paths,
594
-            'EEM_',
595
-            $class_name,
596
-            'model',
597
-            $arguments,
598
-            false,
599
-            true,
600
-            $load_only
601
-        );
602
-    }
603
-
604
-
605
-    /**
606
-     * loads model classes - must be singletons
607
-     *
608
-     * @param string $class_name - simple class name ie: price
609
-     * @param mixed  $arguments
610
-     * @param bool   $load_only
611
-     * @return mixed | bool
612
-     * @throws InvalidInterfaceException
613
-     * @throws InvalidDataTypeException
614
-     * @throws EE_Error
615
-     * @throws ReflectionException
616
-     * @throws InvalidArgumentException
617
-     */
618
-    public function load_model_class($class_name, $arguments = array(), $load_only = true)
619
-    {
620
-        $paths = array(
621
-            EE_MODELS . 'fields' . DS,
622
-            EE_MODELS . 'helpers' . DS,
623
-            EE_MODELS . 'relations' . DS,
624
-            EE_MODELS . 'strategies' . DS,
625
-        );
626
-        // retrieve instantiated class
627
-        return $this->_load(
628
-            $paths,
629
-            'EE_',
630
-            $class_name,
631
-            '',
632
-            $arguments,
633
-            false,
634
-            true,
635
-            $load_only
636
-        );
637
-    }
638
-
639
-
640
-    /**
641
-     * Determines if $model_name is the name of an actual EE model.
642
-     *
643
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
644
-     * @return boolean
645
-     */
646
-    public function is_model_name($model_name)
647
-    {
648
-        return isset($this->models[ $model_name ]);
649
-    }
650
-
651
-
652
-    /**
653
-     * generic class loader
654
-     *
655
-     * @param string $path_to_file - directory path to file location, not including filename
656
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
657
-     * @param string $type         - file type - core? class? helper? model?
658
-     * @param mixed  $arguments
659
-     * @param bool   $load_only
660
-     * @return mixed
661
-     * @throws InvalidInterfaceException
662
-     * @throws InvalidDataTypeException
663
-     * @throws EE_Error
664
-     * @throws ReflectionException
665
-     * @throws InvalidArgumentException
666
-     */
667
-    public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
668
-    {
669
-        // retrieve instantiated class
670
-        return $this->_load(
671
-            $path_to_file,
672
-            '',
673
-            $file_name,
674
-            $type,
675
-            $arguments,
676
-            false,
677
-            true,
678
-            $load_only
679
-        );
680
-    }
681
-
682
-
683
-    /**
684
-     * @param string $path_to_file - directory path to file location, not including filename
685
-     * @param string $class_name   - full class name  ie:  My_Class
686
-     * @param string $type         - file type - core? class? helper? model?
687
-     * @param mixed  $arguments
688
-     * @param bool   $load_only
689
-     * @return bool|EE_Addon|object
690
-     * @throws InvalidInterfaceException
691
-     * @throws InvalidDataTypeException
692
-     * @throws EE_Error
693
-     * @throws ReflectionException
694
-     * @throws InvalidArgumentException
695
-     */
696
-    public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
697
-    {
698
-        // retrieve instantiated class
699
-        return $this->_load(
700
-            $path_to_file,
701
-            'addon',
702
-            $class_name,
703
-            $type,
704
-            $arguments,
705
-            false,
706
-            true,
707
-            $load_only
708
-        );
709
-    }
710
-
711
-
712
-    /**
713
-     * instantiates, caches, and automatically resolves dependencies
714
-     * for classes that use a Fully Qualified Class Name.
715
-     * if the class is not capable of being loaded using PSR-4 autoloading,
716
-     * then you need to use one of the existing load_*() methods
717
-     * which can resolve the classname and filepath from the passed arguments
718
-     *
719
-     * @param bool|string $class_name   Fully Qualified Class Name
720
-     * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
721
-     * @param bool        $cache        whether to cache the instantiated object for reuse
722
-     * @param bool        $from_db      some classes are instantiated from the db
723
-     *                                  and thus call a different method to instantiate
724
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
725
-     * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
726
-     * @return bool|null|mixed          null = failure to load or instantiate class object.
727
-     *                                  object = class loaded and instantiated successfully.
728
-     *                                  bool = fail or success when $load_only is true
729
-     * @throws InvalidInterfaceException
730
-     * @throws InvalidDataTypeException
731
-     * @throws EE_Error
732
-     * @throws ReflectionException
733
-     * @throws InvalidArgumentException
734
-     */
735
-    public function create(
736
-        $class_name = false,
737
-        $arguments = array(),
738
-        $cache = false,
739
-        $from_db = false,
740
-        $load_only = false,
741
-        $addon = false
742
-    ) {
743
-        $class_name   = ltrim($class_name, '\\');
744
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
745
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
746
-        // if a non-FQCN was passed, then
747
-        // verifyClassExists() might return an object
748
-        // or it could return null if the class just could not be found anywhere
749
-        if ($class_exists instanceof $class_name || $class_exists === null) {
750
-            // either way, return the results
751
-            return $class_exists;
752
-        }
753
-        $class_name = $class_exists;
754
-        // if we're only loading the class and it already exists, then let's just return true immediately
755
-        if ($load_only) {
756
-            return true;
757
-        }
758
-        $addon = $addon ? 'addon' : '';
759
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
760
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
761
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
762
-        if ($this->_cache_on && $cache && ! $load_only) {
763
-            // return object if it's already cached
764
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
765
-            if ($cached_class !== null) {
766
-                return $cached_class;
767
-            }
768
-        }// obtain the loader method from the dependency map
769
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
770
-        if ($loader instanceof Closure) {
771
-            $class_obj = $loader($arguments);
772
-        } else {
773
-            if ($loader && method_exists($this, $loader)) {
774
-                $class_obj = $this->{$loader}($class_name, $arguments);
775
-            } else {
776
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
777
-            }
778
-        }
779
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
780
-            // save it for later... kinda like gum  { : $
781
-            $this->_set_cached_class(
782
-                $class_obj,
783
-                $class_name,
784
-                $addon,
785
-                $from_db,
786
-                $arguments
787
-            );
788
-        }
789
-        $this->_cache_on = true;
790
-        return $class_obj;
791
-    }
792
-
793
-
794
-    /**
795
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
796
-     *
797
-     * @param string|object $class_name
798
-     * @param array         $arguments
799
-     * @param int           $attempt
800
-     * @return mixed
801
-     */
802
-    private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
803
-    {
804
-        if (is_object($class_name) || class_exists($class_name)) {
805
-            return $class_name;
806
-        }
807
-        switch ($attempt) {
808
-            case 1:
809
-                // if it's a FQCN then maybe the class is registered with a preceding \
810
-                $class_name = strpos($class_name, '\\') !== false
811
-                    ? '\\' . ltrim($class_name, '\\')
812
-                    : $class_name;
813
-                break;
814
-            case 2:
815
-                //
816
-                $loader = $this->_dependency_map->class_loader($class_name);
817
-                if ($loader && method_exists($this, $loader)) {
818
-                    return $this->{$loader}($class_name, $arguments);
819
-                }
820
-                break;
821
-            case 3:
822
-            default;
823
-                return null;
824
-        }
825
-        $attempt++;
826
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
827
-    }
828
-
829
-
830
-    /**
831
-     * instantiates, caches, and injects dependencies for classes
832
-     *
833
-     * @param array       $file_paths   an array of paths to folders to look in
834
-     * @param string      $class_prefix EE  or EEM or... ???
835
-     * @param bool|string $class_name   $class name
836
-     * @param string      $type         file type - core? class? helper? model?
837
-     * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
838
-     * @param bool        $from_db      some classes are instantiated from the db
839
-     *                                  and thus call a different method to instantiate
840
-     * @param bool        $cache        whether to cache the instantiated object for reuse
841
-     * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
842
-     * @return bool|null|object null = failure to load or instantiate class object.
843
-     *                                  object = class loaded and instantiated successfully.
844
-     *                                  bool = fail or success when $load_only is true
845
-     * @throws EE_Error
846
-     * @throws ReflectionException
847
-     * @throws InvalidInterfaceException
848
-     * @throws InvalidDataTypeException
849
-     * @throws InvalidArgumentException
850
-     */
851
-    protected function _load(
852
-        $file_paths = array(),
853
-        $class_prefix = 'EE_',
854
-        $class_name = false,
855
-        $type = 'class',
856
-        $arguments = array(),
857
-        $from_db = false,
858
-        $cache = true,
859
-        $load_only = false
860
-    ) {
861
-        $class_name = ltrim($class_name, '\\');
862
-        // strip php file extension
863
-        $class_name = str_replace('.php', '', trim($class_name));
864
-        // does the class have a prefix ?
865
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
866
-            // make sure $class_prefix is uppercase
867
-            $class_prefix = strtoupper(trim($class_prefix));
868
-            // add class prefix ONCE!!!
869
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
870
-        }
871
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
872
-        $class_exists = class_exists($class_name, false);
873
-        // if we're only loading the class and it already exists, then let's just return true immediately
874
-        if ($load_only && $class_exists) {
875
-            return true;
876
-        }
877
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
878
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
879
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
880
-        if ($this->_cache_on && $cache && ! $load_only) {
881
-            // return object if it's already cached
882
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
883
-            if ($cached_class !== null) {
884
-                return $cached_class;
885
-            }
886
-        }
887
-        // if the class doesn't already exist.. then we need to try and find the file and load it
888
-        if (! $class_exists) {
889
-            // get full path to file
890
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
891
-            // load the file
892
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
893
-            // if we are only loading a file but NOT instantiating an object
894
-            // then return boolean for whether class was loaded or not
895
-            if ($load_only) {
896
-                return $loaded;
897
-            }
898
-            // if an object was expected but loading failed, then return nothing
899
-            if (! $loaded) {
900
-                return null;
901
-            }
902
-        }
903
-        // instantiate the requested object
904
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
905
-        if ($this->_cache_on && $cache) {
906
-            // save it for later... kinda like gum  { : $
907
-            $this->_set_cached_class(
908
-                $class_obj,
909
-                $class_name,
910
-                $class_prefix,
911
-                $from_db,
912
-                $arguments
913
-            );
914
-        }
915
-        $this->_cache_on = true;
916
-        return $class_obj;
917
-    }
918
-
919
-
920
-    /**
921
-     * @param string $class_name
922
-     * @param string $default have to specify something, but not anything that will conflict
923
-     * @return mixed|string
924
-     */
925
-    protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
926
-    {
927
-        return isset($this->_class_abbreviations[ $class_name ])
928
-            ? $this->_class_abbreviations[ $class_name ]
929
-            : $default;
930
-    }
931
-
932
-
933
-    /**
934
-     * attempts to find a cached version of the requested class
935
-     * by looking in the following places:
936
-     *        $this->{$class_abbreviation}            ie:    $this->CART
937
-     *        $this->{$class_name}                        ie:    $this->Some_Class
938
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
939
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
940
-     *
941
-     * @param string $class_name
942
-     * @param string $class_prefix
943
-     * @param array  $arguments
944
-     * @return mixed
945
-     */
946
-    protected function _get_cached_class(
947
-        $class_name,
948
-        $class_prefix = '',
949
-        $arguments = array()
950
-    ) {
951
-        if ($class_name === 'EE_Registry') {
952
-            return $this;
953
-        }
954
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
955
-        // check if class has already been loaded, and return it if it has been
956
-        if (isset($this->{$class_abbreviation})) {
957
-            return $this->{$class_abbreviation};
958
-        }
959
-        $class_name = str_replace('\\', '_', $class_name);
960
-        if (isset ($this->{$class_name})) {
961
-            return $this->{$class_name};
962
-        }
963
-        if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
964
-            return $this->addons->{$class_name};
965
-        }
966
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
967
-        if (isset($this->LIB->{$object_identifier})) {
968
-            return $this->LIB->{$object_identifier};
969
-        }
970
-        foreach ($this->LIB as $key => $object) {
971
-            if (
972
-                // request does not contain new arguments and therefore no args identifier
973
-                ! $this->object_identifier->hasArguments($object_identifier)
974
-                // but previously cached class with args was found
975
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
976
-            ) {
977
-                return $object;
978
-            }
979
-        }
980
-        return null;
981
-    }
982
-
983
-
984
-    /**
985
-     * removes a cached version of the requested class
986
-     *
987
-     * @param string  $class_name
988
-     * @param boolean $addon
989
-     * @param array   $arguments
990
-     * @return boolean
991
-     */
992
-    public function clear_cached_class(
993
-        $class_name,
994
-        $addon = false,
995
-        $arguments = array()
996
-    ) {
997
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
998
-        // check if class has already been loaded, and return it if it has been
999
-        if (isset($this->{$class_abbreviation})) {
1000
-            $this->{$class_abbreviation} = null;
1001
-            return true;
1002
-        }
1003
-        $class_name = str_replace('\\', '_', $class_name);
1004
-        if (isset($this->{$class_name})) {
1005
-            $this->{$class_name} = null;
1006
-            return true;
1007
-        }
1008
-        if ($addon && isset($this->addons->{$class_name})) {
1009
-            unset($this->addons->{$class_name});
1010
-            return true;
1011
-        }
1012
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
1013
-        if (isset($this->LIB->{$class_name})) {
1014
-            unset($this->LIB->{$class_name});
1015
-            return true;
1016
-        }
1017
-        return false;
1018
-    }
1019
-
1020
-
1021
-    /**
1022
-     * _set_cached_class
1023
-     * attempts to cache the instantiated class locally
1024
-     * in one of the following places, in the following order:
1025
-     *        $this->{class_abbreviation}   ie:    $this->CART
1026
-     *        $this->{$class_name}          ie:    $this->Some_Class
1027
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
1028
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
1029
-     *
1030
-     * @param object $class_obj
1031
-     * @param string $class_name
1032
-     * @param string $class_prefix
1033
-     * @param bool   $from_db
1034
-     * @param array  $arguments
1035
-     * @return void
1036
-     */
1037
-    protected function _set_cached_class(
1038
-        $class_obj,
1039
-        $class_name,
1040
-        $class_prefix = '',
1041
-        $from_db = false,
1042
-        $arguments = array()
1043
-    ) {
1044
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
1045
-            return;
1046
-        }
1047
-        // return newly instantiated class
1048
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
1049
-        if ($class_abbreviation) {
1050
-            $this->{$class_abbreviation} = $class_obj;
1051
-            return;
1052
-        }
1053
-        $class_name = str_replace('\\', '_', $class_name);
1054
-        if (property_exists($this, $class_name)) {
1055
-            $this->{$class_name} = $class_obj;
1056
-            return;
1057
-        }
1058
-        if ($class_prefix === 'addon') {
1059
-            $this->addons->{$class_name} = $class_obj;
1060
-            return;
1061
-        }
1062
-        if (! $from_db) {
1063
-            $class_name               = $this->object_identifier->getIdentifier($class_name, $arguments);
1064
-            $this->LIB->{$class_name} = $class_obj;
1065
-        }
1066
-    }
1067
-
1068
-
1069
-    /**
1070
-     * attempts to find a full valid filepath for the requested class.
1071
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
1072
-     * then returns that path if the target file has been found and is readable
1073
-     *
1074
-     * @param string $class_name
1075
-     * @param string $type
1076
-     * @param array  $file_paths
1077
-     * @return string | bool
1078
-     */
1079
-    protected function _resolve_path($class_name, $type = '', $file_paths = array())
1080
-    {
1081
-        // make sure $file_paths is an array
1082
-        $file_paths = is_array($file_paths)
1083
-            ? $file_paths
1084
-            : array($file_paths);
1085
-        // cycle thru paths
1086
-        foreach ($file_paths as $key => $file_path) {
1087
-            // convert all separators to proper DS, if no filepath, then use EE_CLASSES
1088
-            $file_path = $file_path
1089
-                ? str_replace(array('/', '\\'), DS, $file_path)
1090
-                : EE_CLASSES;
1091
-            // prep file type
1092
-            $type = ! empty($type)
1093
-                ? trim($type, '.') . '.'
1094
-                : '';
1095
-            // build full file path
1096
-            $file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
1097
-            //does the file exist and can be read ?
1098
-            if (is_readable($file_paths[ $key ])) {
1099
-                return $file_paths[ $key ];
1100
-            }
1101
-        }
1102
-        return false;
1103
-    }
1104
-
1105
-
1106
-    /**
1107
-     * basically just performs a require_once()
1108
-     * but with some error handling
1109
-     *
1110
-     * @param  string $path
1111
-     * @param  string $class_name
1112
-     * @param  string $type
1113
-     * @param  array  $file_paths
1114
-     * @return bool
1115
-     * @throws EE_Error
1116
-     * @throws ReflectionException
1117
-     */
1118
-    protected function _require_file($path, $class_name, $type = '', $file_paths = array())
1119
-    {
1120
-        $this->resolve_legacy_class_parent($class_name);
1121
-        // don't give up! you gotta...
1122
-        try {
1123
-            //does the file exist and can it be read ?
1124
-            if (! $path) {
1125
-                // just in case the file has already been autoloaded,
1126
-                // but discrepancies in the naming schema are preventing it from
1127
-                // being loaded via one of the EE_Registry::load_*() methods,
1128
-                // then let's try one last hail mary before throwing an exception
1129
-                // and call class_exists() again, but with autoloading turned ON
1130
-                if (class_exists($class_name)) {
1131
-                    return true;
1132
-                }
1133
-                // so sorry, can't find the file
1134
-                throw new EE_Error (
1135
-                    sprintf(
1136
-                        esc_html__(
1137
-                            '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',
1138
-                            'event_espresso'
1139
-                        ),
1140
-                        trim($type, '.'),
1141
-                        $class_name,
1142
-                        '<br />' . implode(',<br />', $file_paths)
1143
-                    )
1144
-                );
1145
-            }
1146
-            // get the file
1147
-            require_once($path);
1148
-            // if the class isn't already declared somewhere
1149
-            if (class_exists($class_name, false) === false) {
1150
-                // so sorry, not a class
1151
-                throw new EE_Error(
1152
-                    sprintf(
1153
-                        esc_html__(
1154
-                            'The %s file %s does not appear to contain the %s Class.',
1155
-                            'event_espresso'
1156
-                        ),
1157
-                        $type,
1158
-                        $path,
1159
-                        $class_name
1160
-                    )
1161
-                );
1162
-            }
1163
-        } catch (EE_Error $e) {
1164
-            $e->get_error();
1165
-            return false;
1166
-        }
1167
-        return true;
1168
-    }
1169
-
1170
-
1171
-    /**
1172
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
1173
-     * before their class declaration in order to ensure that the parent class was loaded.
1174
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
1175
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
1176
-     *
1177
-     * @param string $class_name
1178
-     */
1179
-    protected function resolve_legacy_class_parent($class_name = '')
1180
-    {
1181
-        try {
1182
-            $legacy_parent_class_map = array(
1183
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
1184
-            );
1185
-            if (isset($legacy_parent_class_map[ $class_name ])) {
1186
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
1187
-            }
1188
-        } catch (Exception $exception) {
1189
-        }
1190
-    }
1191
-
1192
-
1193
-    /**
1194
-     * _create_object
1195
-     * Attempts to instantiate the requested class via any of the
1196
-     * commonly used instantiation methods employed throughout EE.
1197
-     * The priority for instantiation is as follows:
1198
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
1199
-     *        - model objects via their 'new_instance_from_db' method
1200
-     *        - model objects via their 'new_instance' method
1201
-     *        - "singleton" classes" via their 'instance' method
1202
-     *    - standard instantiable classes via their __constructor
1203
-     * Prior to instantiation, if the classname exists in the dependency_map,
1204
-     * then the constructor for the requested class will be examined to determine
1205
-     * if any dependencies exist, and if they can be injected.
1206
-     * If so, then those classes will be added to the array of arguments passed to the constructor
1207
-     *
1208
-     * @param string $class_name
1209
-     * @param array  $arguments
1210
-     * @param string $type
1211
-     * @param bool   $from_db
1212
-     * @return null|object|bool
1213
-     * @throws InvalidArgumentException
1214
-     * @throws InvalidInterfaceException
1215
-     * @throws EE_Error
1216
-     * @throws ReflectionException
1217
-     * @throws InvalidDataTypeException
1218
-     */
1219
-    protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
1220
-    {
1221
-        // create reflection
1222
-        $reflector = $this->mirror->getReflectionClass($class_name);
1223
-        // make sure arguments are an array
1224
-        $arguments = is_array($arguments)
1225
-            ? $arguments
1226
-            : array($arguments);
1227
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
1228
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
1229
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
1230
-            ? $arguments
1231
-            : array($arguments);
1232
-        // attempt to inject dependencies ?
1233
-        if ($this->_dependency_map->has($class_name)) {
1234
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
1235
-        }
1236
-        // instantiate the class if possible
1237
-        if ($reflector->isAbstract()) {
1238
-            // nothing to instantiate, loading file was enough
1239
-            // does not throw an exception so $instantiation_mode is unused
1240
-            // $instantiation_mode = "1) no constructor abstract class";
1241
-            return true;
1242
-        }
1243
-        if (
1244
-            empty($arguments)
1245
-            && $this->mirror->getConstructorFromReflection($reflector) === null
1246
-            && $reflector->isInstantiable()
1247
-        ) {
1248
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
1249
-            // $instantiation_mode = "2) no constructor but instantiable";
1250
-            return $reflector->newInstance();
1251
-        }
1252
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
1253
-            // $instantiation_mode = "3) new_instance_from_db()";
1254
-            return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
1255
-        }
1256
-        if (method_exists($class_name, 'new_instance')) {
1257
-            // $instantiation_mode = "4) new_instance()";
1258
-            return call_user_func_array(array($class_name, 'new_instance'), $arguments);
1259
-        }
1260
-        if (method_exists($class_name, 'instance')) {
1261
-            // $instantiation_mode = "5) instance()";
1262
-            return call_user_func_array(array($class_name, 'instance'), $arguments);
1263
-        }
1264
-        if ($reflector->isInstantiable()) {
1265
-            // $instantiation_mode = "6) constructor";
1266
-            return $reflector->newInstanceArgs($arguments);
1267
-        }
1268
-        // heh ? something's not right !
1269
-        throw new EE_Error(
1270
-            sprintf(
1271
-                __('The %s file %s could not be instantiated.', 'event_espresso'),
1272
-                $type,
1273
-                $class_name
1274
-            )
1275
-        );
1276
-    }
1277
-
1278
-
1279
-    /**
1280
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
1281
-     * @param array $array
1282
-     * @return bool
1283
-     */
1284
-    protected function _array_is_numerically_and_sequentially_indexed(array $array)
1285
-    {
1286
-        return ! empty($array)
1287
-            ? array_keys($array) === range(0, count($array) - 1)
1288
-            : true;
1289
-    }
1290
-
1291
-
1292
-    /**
1293
-     * _resolve_dependencies
1294
-     * examines the constructor for the requested class to determine
1295
-     * if any dependencies exist, and if they can be injected.
1296
-     * If so, then those classes will be added to the array of arguments passed to the constructor
1297
-     * PLZ NOTE: this is achieved by type hinting the constructor params
1298
-     * For example:
1299
-     *        if attempting to load a class "Foo" with the following constructor:
1300
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
1301
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
1302
-     *        but only IF they are NOT already present in the incoming arguments array,
1303
-     *        and the correct classes can be loaded
1304
-     *
1305
-     * @param ReflectionClass $reflector
1306
-     * @param string          $class_name
1307
-     * @param array           $arguments
1308
-     * @return array
1309
-     * @throws InvalidArgumentException
1310
-     * @throws InvalidDataTypeException
1311
-     * @throws InvalidInterfaceException
1312
-     * @throws ReflectionException
1313
-     */
1314
-    protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
1315
-    {
1316
-        // let's examine the constructor
1317
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
1318
-        // whu? huh? nothing?
1319
-        if (! $constructor) {
1320
-            return $arguments;
1321
-        }
1322
-        // get constructor parameters
1323
-        $params = $this->mirror->getParametersFromReflection($reflector);
1324
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
1325
-        $argument_keys = array_keys($arguments);
1326
-        // now loop thru all of the constructors expected parameters
1327
-        foreach ($params as $index => $param) {
1328
-            // is this a dependency for a specific class ?
1329
-            $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
1330
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
1331
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
1332
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
1333
-                : $param_class;
1334
-            if (
1335
-                // param is not even a class
1336
-                $param_class === null
1337
-                // and something already exists in the incoming arguments for this param
1338
-                && array_key_exists($index, $argument_keys)
1339
-                && array_key_exists($argument_keys[ $index ], $arguments)
1340
-            ) {
1341
-                // so let's skip this argument and move on to the next
1342
-                continue;
1343
-            }
1344
-            if (
1345
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
1346
-                $param_class !== null
1347
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
1348
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
1349
-            ) {
1350
-                // skip this argument and move on to the next
1351
-                continue;
1352
-            }
1353
-            if (
1354
-                // parameter is type hinted as a class, and should be injected
1355
-                $param_class !== null
1356
-                && $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
1357
-            ) {
1358
-                $arguments = $this->_resolve_dependency(
1359
-                    $class_name,
1360
-                    $param_class,
1361
-                    $arguments,
1362
-                    $index
1363
-                );
1364
-            } else {
1365
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
1366
-                    $param,
1367
-                    $class_name,
1368
-                    $index
1369
-                );
1370
-            }
1371
-        }
1372
-        return $arguments;
1373
-    }
1374
-
1375
-
1376
-    /**
1377
-     * @param string $class_name
1378
-     * @param string $param_class
1379
-     * @param array  $arguments
1380
-     * @param mixed  $index
1381
-     * @return array
1382
-     * @throws InvalidArgumentException
1383
-     * @throws InvalidInterfaceException
1384
-     * @throws InvalidDataTypeException
1385
-     */
1386
-    protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
1387
-    {
1388
-        $dependency = null;
1389
-        // should dependency be loaded from cache ?
1390
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
1391
-            $class_name,
1392
-            $param_class
1393
-        );
1394
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
1395
-        // we might have a dependency...
1396
-        // let's MAYBE try and find it in our cache if that's what's been requested
1397
-        $cached_class = $cache_on
1398
-            ? $this->_get_cached_class($param_class)
1399
-            : null;
1400
-        // and grab it if it exists
1401
-        if ($cached_class instanceof $param_class) {
1402
-            $dependency = $cached_class;
1403
-        } elseif ($param_class !== $class_name) {
1404
-            // obtain the loader method from the dependency map
1405
-            $loader = $this->_dependency_map->class_loader($param_class);
1406
-            // is loader a custom closure ?
1407
-            if ($loader instanceof Closure) {
1408
-                $dependency = $loader($arguments);
1409
-            } else {
1410
-                // set the cache on property for the recursive loading call
1411
-                $this->_cache_on = $cache_on;
1412
-                // if not, then let's try and load it via the registry
1413
-                if ($loader && method_exists($this, $loader)) {
1414
-                    $dependency = $this->{$loader}($param_class);
1415
-                } else {
1416
-                    $dependency = LoaderFactory::getLoader()->load(
1417
-                        $param_class,
1418
-                        array(),
1419
-                        $cache_on
1420
-                    );
1421
-                }
1422
-            }
1423
-        }
1424
-        // did we successfully find the correct dependency ?
1425
-        if ($dependency instanceof $param_class) {
1426
-            // then let's inject it into the incoming array of arguments at the correct location
1427
-            $arguments[ $index ] = $dependency;
1428
-        }
1429
-        return $arguments;
1430
-    }
1431
-
1432
-
1433
-    /**
1434
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
1435
-     *
1436
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
1437
-     *                          in the EE_Dependency_Map::$_class_loaders array,
1438
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
1439
-     * @param array  $arguments
1440
-     * @return object
1441
-     */
1442
-    public static function factory($classname, $arguments = array())
1443
-    {
1444
-        $loader = self::instance()->_dependency_map->class_loader($classname);
1445
-        if ($loader instanceof Closure) {
1446
-            return $loader($arguments);
1447
-        }
1448
-        if (method_exists(self::instance(), $loader)) {
1449
-            return self::instance()->{$loader}($classname, $arguments);
1450
-        }
1451
-        return null;
1452
-    }
1453
-
1454
-
1455
-    /**
1456
-     * Gets the addon by its class name
1457
-     *
1458
-     * @param string $class_name
1459
-     * @return EE_Addon
1460
-     */
1461
-    public function getAddon($class_name)
1462
-    {
1463
-        $class_name = str_replace('\\', '_', $class_name);
1464
-        return $this->addons->{$class_name};
1465
-    }
1466
-
1467
-
1468
-    /**
1469
-     * removes the addon from the internal cache
1470
-     *
1471
-     * @param string $class_name
1472
-     * @return void
1473
-     */
1474
-    public function removeAddon($class_name)
1475
-    {
1476
-        $class_name = str_replace('\\', '_', $class_name);
1477
-        unset($this->addons->{$class_name});
1478
-    }
1479
-
1480
-
1481
-    /**
1482
-     * Gets the addon by its name/slug (not classname. For that, just
1483
-     * use the get_addon() method above
1484
-     *
1485
-     * @param string $name
1486
-     * @return EE_Addon
1487
-     */
1488
-    public function get_addon_by_name($name)
1489
-    {
1490
-        foreach ($this->addons as $addon) {
1491
-            if ($addon->name() === $name) {
1492
-                return $addon;
1493
-            }
1494
-        }
1495
-        return null;
1496
-    }
1497
-
1498
-
1499
-    /**
1500
-     * Gets an array of all the registered addons, where the keys are their names.
1501
-     * (ie, what each returns for their name() function)
1502
-     * They're already available on EE_Registry::instance()->addons as properties,
1503
-     * where each property's name is the addon's classname,
1504
-     * So if you just want to get the addon by classname,
1505
-     * OR use the get_addon() method above.
1506
-     * PLEASE  NOTE:
1507
-     * addons with Fully Qualified Class Names
1508
-     * have had the namespace separators converted to underscores,
1509
-     * so a classname like Fully\Qualified\ClassName
1510
-     * would have been converted to Fully_Qualified_ClassName
1511
-     *
1512
-     * @return EE_Addon[] where the KEYS are the addon's name()
1513
-     */
1514
-    public function get_addons_by_name()
1515
-    {
1516
-        $addons = array();
1517
-        foreach ($this->addons as $addon) {
1518
-            $addons[ $addon->name() ] = $addon;
1519
-        }
1520
-        return $addons;
1521
-    }
1522
-
1523
-
1524
-    /**
1525
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
1526
-     * a stale copy of it around
1527
-     *
1528
-     * @param string $model_name
1529
-     * @return \EEM_Base
1530
-     * @throws \EE_Error
1531
-     */
1532
-    public function reset_model($model_name)
1533
-    {
1534
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
1535
-            ? "EEM_{$model_name}"
1536
-            : $model_name;
1537
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
1538
-            return null;
1539
-        }
1540
-        //get that model reset it and make sure we nuke the old reference to it
1541
-        if ($this->LIB->{$model_class_name} instanceof $model_class_name
1542
-            && is_callable(
1543
-                array($model_class_name, 'reset')
1544
-            )) {
1545
-            $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
1546
-        } else {
1547
-            throw new EE_Error(
1548
-                sprintf(
1549
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
1550
-                    $model_name
1551
-                )
1552
-            );
1553
-        }
1554
-        return $this->LIB->{$model_class_name};
1555
-    }
1556
-
1557
-
1558
-    /**
1559
-     * Resets the registry.
1560
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
1561
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
1562
-     * - $_dependency_map
1563
-     * - $_class_abbreviations
1564
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
1565
-     * - $REQ:  Still on the same request so no need to change.
1566
-     * - $CAP: There is no site specific state in the EE_Capability class.
1567
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
1568
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
1569
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
1570
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
1571
-     *             switch or on the restore.
1572
-     * - $modules
1573
-     * - $shortcodes
1574
-     * - $widgets
1575
-     *
1576
-     * @param boolean $hard             [deprecated]
1577
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
1578
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
1579
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
1580
-     * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
1581
-     *                                  client
1582
-     *                                  code instead can just change the model context to a different blog id if
1583
-     *                                  necessary
1584
-     * @return EE_Registry
1585
-     * @throws InvalidInterfaceException
1586
-     * @throws InvalidDataTypeException
1587
-     * @throws EE_Error
1588
-     * @throws ReflectionException
1589
-     * @throws InvalidArgumentException
1590
-     */
1591
-    public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
1592
-    {
1593
-        $instance            = self::instance();
1594
-        $instance->_cache_on = true;
1595
-        // reset some "special" classes
1596
-        EEH_Activation::reset();
1597
-        $hard                     = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
1598
-        $instance->CFG            = EE_Config::reset($hard, $reinstantiate);
1599
-        $instance->CART           = null;
1600
-        $instance->MRM            = null;
1601
-        $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
1602
-        //messages reset
1603
-        EED_Messages::reset();
1604
-        //handle of objects cached on LIB
1605
-        foreach (array('LIB', 'modules') as $cache) {
1606
-            foreach ($instance->{$cache} as $class_name => $class) {
1607
-                if (self::_reset_and_unset_object($class, $reset_models)) {
1608
-                    unset($instance->{$cache}->{$class_name});
1609
-                }
1610
-            }
1611
-        }
1612
-        return $instance;
1613
-    }
1614
-
1615
-
1616
-    /**
1617
-     * if passed object implements ResettableInterface, then call it's reset() method
1618
-     * if passed object implements InterminableInterface, then return false,
1619
-     * to indicate that it should NOT be cleared from the Registry cache
1620
-     *
1621
-     * @param      $object
1622
-     * @param bool $reset_models
1623
-     * @return bool returns true if cached object should be unset
1624
-     */
1625
-    private static function _reset_and_unset_object($object, $reset_models)
1626
-    {
1627
-        if (! is_object($object)) {
1628
-            // don't unset anything that's not an object
1629
-            return false;
1630
-        }
1631
-        if ($object instanceof EED_Module) {
1632
-            $object::reset();
1633
-            // don't unset modules
1634
-            return false;
1635
-        }
1636
-        if ($object instanceof ResettableInterface) {
1637
-            if ($object instanceof EEM_Base) {
1638
-                if ($reset_models) {
1639
-                    $object->reset();
1640
-                    return true;
1641
-                }
1642
-                return false;
1643
-            }
1644
-            $object->reset();
1645
-            return true;
1646
-        }
1647
-        if (! $object instanceof InterminableInterface) {
1648
-            return true;
1649
-        }
1650
-        return false;
1651
-    }
1652
-
1653
-
1654
-    /**
1655
-     * Gets all the custom post type models defined
1656
-     *
1657
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
1658
-     */
1659
-    public function cpt_models()
1660
-    {
1661
-        $cpt_models = array();
1662
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
1663
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
1664
-                $cpt_models[ $short_name ] = $classname;
1665
-            }
1666
-        }
1667
-        return $cpt_models;
1668
-    }
1669
-
1670
-
1671
-    /**
1672
-     * @return \EE_Config
1673
-     */
1674
-    public static function CFG()
1675
-    {
1676
-        return self::instance()->CFG;
1677
-    }
1678
-
1679
-
1680
-    /**
1681
-     * @deprecated $VID:$
1682
-     * @param string $class_name
1683
-     * @return ReflectionClass
1684
-     * @throws ReflectionException
1685
-     * @throws InvalidDataTypeException
1686
-     */
1687
-    public function get_ReflectionClass($class_name)
1688
-    {
1689
-        return $this->mirror->getReflectionClass($class_name);
1690
-    }
30
+	/**
31
+	 * @var EE_Registry $_instance
32
+	 */
33
+	private static $_instance;
34
+
35
+	/**
36
+	 * @var EE_Dependency_Map $_dependency_map
37
+	 */
38
+	protected $_dependency_map;
39
+
40
+	/**
41
+	 * @var Mirror
42
+	 */
43
+	private $mirror;
44
+
45
+	/**
46
+	 * @var ClassInterfaceCache $class_cache
47
+	 */
48
+	private $class_cache;
49
+
50
+	/**
51
+	 * @var array $_class_abbreviations
52
+	 */
53
+	protected $_class_abbreviations = array();
54
+
55
+	/**
56
+	 * @var CommandBusInterface $BUS
57
+	 */
58
+	public $BUS;
59
+
60
+	/**
61
+	 * @var EE_Cart $CART
62
+	 */
63
+	public $CART;
64
+
65
+	/**
66
+	 * @var EE_Config $CFG
67
+	 */
68
+	public $CFG;
69
+
70
+	/**
71
+	 * @var EE_Network_Config $NET_CFG
72
+	 */
73
+	public $NET_CFG;
74
+
75
+	/**
76
+	 * StdClass object for storing library classes in
77
+	 *
78
+	 * @var RegistryContainer $LIB
79
+	 */
80
+	public $LIB;
81
+
82
+	/**
83
+	 * @var EE_Request_Handler $REQ
84
+	 */
85
+	public $REQ;
86
+
87
+	/**
88
+	 * @var EE_Session $SSN
89
+	 */
90
+	public $SSN;
91
+
92
+	/**
93
+	 * @since 4.5.0
94
+	 * @var EE_Capabilities $CAP
95
+	 */
96
+	public $CAP;
97
+
98
+	/**
99
+	 * @since 4.9.0
100
+	 * @var EE_Message_Resource_Manager $MRM
101
+	 */
102
+	public $MRM;
103
+
104
+	/**
105
+	 * @var Registry $AssetsRegistry
106
+	 */
107
+	public $AssetsRegistry;
108
+
109
+	/**
110
+	 * StdClass object for holding addons which have registered themselves to work with EE core
111
+	 *
112
+	 * @var EE_Addon[] $addons
113
+	 */
114
+	public $addons;
115
+
116
+	/**
117
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
118
+	 *
119
+	 * @var EEM_Base[] $models
120
+	 */
121
+	public $models = array();
122
+
123
+	/**
124
+	 * @var EED_Module[] $modules
125
+	 */
126
+	public $modules;
127
+
128
+	/**
129
+	 * @var EES_Shortcode[] $shortcodes
130
+	 */
131
+	public $shortcodes;
132
+
133
+	/**
134
+	 * @var WP_Widget[] $widgets
135
+	 */
136
+	public $widgets;
137
+
138
+	/**
139
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
140
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
141
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
142
+	 * classnames (eg "EEM_Event")
143
+	 *
144
+	 * @var array $non_abstract_db_models
145
+	 */
146
+	public $non_abstract_db_models = array();
147
+
148
+	/**
149
+	 * internationalization for JS strings
150
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
151
+	 *    in js file:  var translatedString = eei18n.string_key;
152
+	 *
153
+	 * @var array $i18n_js_strings
154
+	 */
155
+	public static $i18n_js_strings = array();
156
+
157
+	/**
158
+	 * $main_file - path to espresso.php
159
+	 *
160
+	 * @var array $main_file
161
+	 */
162
+	public $main_file;
163
+
164
+	/**
165
+	 * array of ReflectionClass objects where the key is the class name
166
+	 *
167
+	 * @deprecated $VID:$
168
+	 * @var ReflectionClass[] $_reflectors
169
+	 */
170
+	public $_reflectors;
171
+
172
+	/**
173
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
174
+	 *
175
+	 * @var boolean $_cache_on
176
+	 */
177
+	protected $_cache_on = true;
178
+
179
+	/**
180
+	 * @var ObjectIdentifier
181
+	 */
182
+	private $object_identifier;
183
+
184
+
185
+	/**
186
+	 * @singleton method used to instantiate class object
187
+	 * @param EE_Dependency_Map|null   $dependency_map
188
+	 * @param Mirror|null              $mirror
189
+	 * @param ClassInterfaceCache|null $class_cache
190
+	 * @param ObjectIdentifier|null    $object_identifier
191
+	 * @return EE_Registry instance
192
+	 */
193
+	public static function instance(
194
+		EE_Dependency_Map $dependency_map = null,
195
+		Mirror $mirror = null,
196
+		ClassInterfaceCache $class_cache = null,
197
+		ObjectIdentifier $object_identifier = null
198
+	) {
199
+		// check if class object is instantiated
200
+		if (
201
+			! self::$_instance instanceof EE_Registry
202
+			&& $dependency_map instanceof EE_Dependency_Map
203
+			&& $mirror instanceof Mirror
204
+			&& $class_cache instanceof ClassInterfaceCache
205
+			&& $object_identifier instanceof ObjectIdentifier
206
+		) {
207
+			self::$_instance = new self(
208
+				$dependency_map,
209
+				$mirror,
210
+				$class_cache,
211
+				$object_identifier
212
+			);
213
+		}
214
+		return self::$_instance;
215
+	}
216
+
217
+
218
+	/**
219
+	 * protected constructor to prevent direct creation
220
+	 *
221
+	 * @Constructor
222
+	 * @param  EE_Dependency_Map  $dependency_map
223
+	 * @param Mirror              $mirror
224
+	 * @param ClassInterfaceCache $class_cache
225
+	 * @param ObjectIdentifier    $object_identifier
226
+	 */
227
+	protected function __construct(
228
+		EE_Dependency_Map $dependency_map,
229
+		Mirror $mirror,
230
+		ClassInterfaceCache $class_cache,
231
+		ObjectIdentifier $object_identifier
232
+	) {
233
+		$this->_dependency_map   = $dependency_map;
234
+		$this->mirror            = $mirror;
235
+		$this->class_cache       = $class_cache;
236
+		$this->object_identifier = $object_identifier;
237
+		// $registry_container = new RegistryContainer();
238
+		$this->LIB        = new RegistryContainer();
239
+		$this->addons     = new RegistryContainer();
240
+		$this->modules    = new RegistryContainer();
241
+		$this->shortcodes = new RegistryContainer();
242
+		$this->widgets    = new RegistryContainer();
243
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
244
+	}
245
+
246
+
247
+	/**
248
+	 * initialize
249
+	 *
250
+	 * @throws OutOfBoundsException
251
+	 * @throws InvalidArgumentException
252
+	 * @throws InvalidInterfaceException
253
+	 * @throws InvalidDataTypeException
254
+	 * @throws EE_Error
255
+	 * @throws ReflectionException
256
+	 */
257
+	public function initialize()
258
+	{
259
+		$this->_class_abbreviations = apply_filters(
260
+			'FHEE__EE_Registry____construct___class_abbreviations',
261
+			array(
262
+				'EE_Config'                                       => 'CFG',
263
+				'EE_Session'                                      => 'SSN',
264
+				'EE_Capabilities'                                 => 'CAP',
265
+				'EE_Cart'                                         => 'CART',
266
+				'EE_Network_Config'                               => 'NET_CFG',
267
+				'EE_Request_Handler'                              => 'REQ',
268
+				'EE_Message_Resource_Manager'                     => 'MRM',
269
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
270
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
271
+			)
272
+		);
273
+		$this->load_core('Base', array(), true);
274
+		// add our request and response objects to the cache
275
+		$request_loader = $this->_dependency_map->class_loader(
276
+			'EventEspresso\core\services\request\Request'
277
+		);
278
+		$this->_set_cached_class(
279
+			$request_loader(),
280
+			'EventEspresso\core\services\request\Request'
281
+		);
282
+		$response_loader = $this->_dependency_map->class_loader(
283
+			'EventEspresso\core\services\request\Response'
284
+		);
285
+		$this->_set_cached_class(
286
+			$response_loader(),
287
+			'EventEspresso\core\services\request\Response'
288
+		);
289
+		add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init'));
290
+	}
291
+
292
+
293
+	/**
294
+	 * @return void
295
+	 */
296
+	public function init()
297
+	{
298
+		// Get current page protocol
299
+		$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
300
+		// Output admin-ajax.php URL with same protocol as current page
301
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
302
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false;
303
+	}
304
+
305
+
306
+	/**
307
+	 * localize_i18n_js_strings
308
+	 *
309
+	 * @return string
310
+	 */
311
+	public static function localize_i18n_js_strings()
312
+	{
313
+		$i18n_js_strings = (array) self::$i18n_js_strings;
314
+		foreach ($i18n_js_strings as $key => $value) {
315
+			if (is_scalar($value)) {
316
+				$i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
317
+			}
318
+		}
319
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
320
+	}
321
+
322
+
323
+	/**
324
+	 * @param mixed string | EED_Module $module
325
+	 * @throws OutOfBoundsException
326
+	 * @throws InvalidArgumentException
327
+	 * @throws InvalidInterfaceException
328
+	 * @throws InvalidDataTypeException
329
+	 * @throws EE_Error
330
+	 * @throws ReflectionException
331
+	 */
332
+	public function add_module($module)
333
+	{
334
+		if ($module instanceof EED_Module) {
335
+			$module_class                   = get_class($module);
336
+			$this->modules->{$module_class} = $module;
337
+		} else {
338
+			if (! class_exists('EE_Module_Request_Router', false)) {
339
+				$this->load_core('Module_Request_Router');
340
+			}
341
+			EE_Module_Request_Router::module_factory($module);
342
+		}
343
+	}
344
+
345
+
346
+	/**
347
+	 * @param string $module_name
348
+	 * @return mixed EED_Module | NULL
349
+	 */
350
+	public function get_module($module_name = '')
351
+	{
352
+		return isset($this->modules->{$module_name})
353
+			? $this->modules->{$module_name}
354
+			: null;
355
+	}
356
+
357
+
358
+	/**
359
+	 * loads core classes - must be singletons
360
+	 *
361
+	 * @param string $class_name - simple class name ie: session
362
+	 * @param mixed  $arguments
363
+	 * @param bool   $load_only
364
+	 * @return mixed
365
+	 * @throws InvalidInterfaceException
366
+	 * @throws InvalidDataTypeException
367
+	 * @throws EE_Error
368
+	 * @throws ReflectionException
369
+	 * @throws InvalidArgumentException
370
+	 */
371
+	public function load_core($class_name, $arguments = array(), $load_only = false)
372
+	{
373
+		$core_paths = apply_filters(
374
+			'FHEE__EE_Registry__load_core__core_paths',
375
+			array(
376
+				EE_CORE,
377
+				EE_ADMIN,
378
+				EE_CPTS,
379
+				EE_CORE . 'data_migration_scripts' . DS,
380
+				EE_CORE . 'capabilities' . DS,
381
+				EE_CORE . 'request_stack' . DS,
382
+				EE_CORE . 'middleware' . DS,
383
+			)
384
+		);
385
+		// retrieve instantiated class
386
+		return $this->_load(
387
+			$core_paths,
388
+			'EE_',
389
+			$class_name,
390
+			'core',
391
+			$arguments,
392
+			false,
393
+			true,
394
+			$load_only
395
+		);
396
+	}
397
+
398
+
399
+	/**
400
+	 * loads service classes
401
+	 *
402
+	 * @param string $class_name - simple class name ie: session
403
+	 * @param mixed  $arguments
404
+	 * @param bool   $load_only
405
+	 * @return mixed
406
+	 * @throws InvalidInterfaceException
407
+	 * @throws InvalidDataTypeException
408
+	 * @throws EE_Error
409
+	 * @throws ReflectionException
410
+	 * @throws InvalidArgumentException
411
+	 */
412
+	public function load_service($class_name, $arguments = array(), $load_only = false)
413
+	{
414
+		$service_paths = apply_filters(
415
+			'FHEE__EE_Registry__load_service__service_paths',
416
+			array(
417
+				EE_CORE . 'services' . DS,
418
+			)
419
+		);
420
+		// retrieve instantiated class
421
+		return $this->_load(
422
+			$service_paths,
423
+			'EE_',
424
+			$class_name,
425
+			'class',
426
+			$arguments,
427
+			false,
428
+			true,
429
+			$load_only
430
+		);
431
+	}
432
+
433
+
434
+	/**
435
+	 * loads data_migration_scripts
436
+	 *
437
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
438
+	 * @param mixed  $arguments
439
+	 * @return EE_Data_Migration_Script_Base|mixed
440
+	 * @throws InvalidInterfaceException
441
+	 * @throws InvalidDataTypeException
442
+	 * @throws EE_Error
443
+	 * @throws ReflectionException
444
+	 * @throws InvalidArgumentException
445
+	 */
446
+	public function load_dms($class_name, $arguments = array())
447
+	{
448
+		// retrieve instantiated class
449
+		return $this->_load(
450
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
451
+			'EE_DMS_',
452
+			$class_name,
453
+			'dms',
454
+			$arguments,
455
+			false,
456
+			false
457
+		);
458
+	}
459
+
460
+
461
+	/**
462
+	 * loads object creating classes - must be singletons
463
+	 *
464
+	 * @param string $class_name - simple class name ie: attendee
465
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
466
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
467
+	 *                           instantiate
468
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
469
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
470
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
471
+	 *                           (default)
472
+	 * @return EE_Base_Class | bool
473
+	 * @throws InvalidInterfaceException
474
+	 * @throws InvalidDataTypeException
475
+	 * @throws EE_Error
476
+	 * @throws ReflectionException
477
+	 * @throws InvalidArgumentException
478
+	 */
479
+	public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false)
480
+	{
481
+		$paths = apply_filters(
482
+			'FHEE__EE_Registry__load_class__paths', array(
483
+				EE_CORE,
484
+				EE_CLASSES,
485
+				EE_BUSINESS,
486
+			)
487
+		);
488
+		// retrieve instantiated class
489
+		return $this->_load(
490
+			$paths,
491
+			'EE_',
492
+			$class_name,
493
+			'class',
494
+			$arguments,
495
+			$from_db,
496
+			$cache,
497
+			$load_only
498
+		);
499
+	}
500
+
501
+
502
+	/**
503
+	 * loads helper classes - must be singletons
504
+	 *
505
+	 * @param string $class_name - simple class name ie: price
506
+	 * @param mixed  $arguments
507
+	 * @param bool   $load_only
508
+	 * @return EEH_Base | bool
509
+	 * @throws InvalidInterfaceException
510
+	 * @throws InvalidDataTypeException
511
+	 * @throws EE_Error
512
+	 * @throws ReflectionException
513
+	 * @throws InvalidArgumentException
514
+	 */
515
+	public function load_helper($class_name, $arguments = array(), $load_only = true)
516
+	{
517
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
518
+		$helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS));
519
+		// retrieve instantiated class
520
+		return $this->_load(
521
+			$helper_paths,
522
+			'EEH_',
523
+			$class_name,
524
+			'helper',
525
+			$arguments,
526
+			false,
527
+			true,
528
+			$load_only
529
+		);
530
+	}
531
+
532
+
533
+	/**
534
+	 * loads core classes - must be singletons
535
+	 *
536
+	 * @param string $class_name - simple class name ie: session
537
+	 * @param mixed  $arguments
538
+	 * @param bool   $load_only
539
+	 * @param bool   $cache      whether to cache the object or not.
540
+	 * @return mixed
541
+	 * @throws InvalidInterfaceException
542
+	 * @throws InvalidDataTypeException
543
+	 * @throws EE_Error
544
+	 * @throws ReflectionException
545
+	 * @throws InvalidArgumentException
546
+	 */
547
+	public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true)
548
+	{
549
+		$paths = array(
550
+			EE_LIBRARIES,
551
+			EE_LIBRARIES . 'messages' . DS,
552
+			EE_LIBRARIES . 'shortcodes' . DS,
553
+			EE_LIBRARIES . 'qtips' . DS,
554
+			EE_LIBRARIES . 'payment_methods' . DS,
555
+		);
556
+		// retrieve instantiated class
557
+		return $this->_load(
558
+			$paths,
559
+			'EE_',
560
+			$class_name,
561
+			'lib',
562
+			$arguments,
563
+			false,
564
+			$cache,
565
+			$load_only
566
+		);
567
+	}
568
+
569
+
570
+	/**
571
+	 * loads model classes - must be singletons
572
+	 *
573
+	 * @param string $class_name - simple class name ie: price
574
+	 * @param mixed  $arguments
575
+	 * @param bool   $load_only
576
+	 * @return EEM_Base | bool
577
+	 * @throws InvalidInterfaceException
578
+	 * @throws InvalidDataTypeException
579
+	 * @throws EE_Error
580
+	 * @throws ReflectionException
581
+	 * @throws InvalidArgumentException
582
+	 */
583
+	public function load_model($class_name, $arguments = array(), $load_only = false)
584
+	{
585
+		$paths = apply_filters(
586
+			'FHEE__EE_Registry__load_model__paths', array(
587
+				EE_MODELS,
588
+				EE_CORE,
589
+			)
590
+		);
591
+		// retrieve instantiated class
592
+		return $this->_load(
593
+			$paths,
594
+			'EEM_',
595
+			$class_name,
596
+			'model',
597
+			$arguments,
598
+			false,
599
+			true,
600
+			$load_only
601
+		);
602
+	}
603
+
604
+
605
+	/**
606
+	 * loads model classes - must be singletons
607
+	 *
608
+	 * @param string $class_name - simple class name ie: price
609
+	 * @param mixed  $arguments
610
+	 * @param bool   $load_only
611
+	 * @return mixed | bool
612
+	 * @throws InvalidInterfaceException
613
+	 * @throws InvalidDataTypeException
614
+	 * @throws EE_Error
615
+	 * @throws ReflectionException
616
+	 * @throws InvalidArgumentException
617
+	 */
618
+	public function load_model_class($class_name, $arguments = array(), $load_only = true)
619
+	{
620
+		$paths = array(
621
+			EE_MODELS . 'fields' . DS,
622
+			EE_MODELS . 'helpers' . DS,
623
+			EE_MODELS . 'relations' . DS,
624
+			EE_MODELS . 'strategies' . DS,
625
+		);
626
+		// retrieve instantiated class
627
+		return $this->_load(
628
+			$paths,
629
+			'EE_',
630
+			$class_name,
631
+			'',
632
+			$arguments,
633
+			false,
634
+			true,
635
+			$load_only
636
+		);
637
+	}
638
+
639
+
640
+	/**
641
+	 * Determines if $model_name is the name of an actual EE model.
642
+	 *
643
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
644
+	 * @return boolean
645
+	 */
646
+	public function is_model_name($model_name)
647
+	{
648
+		return isset($this->models[ $model_name ]);
649
+	}
650
+
651
+
652
+	/**
653
+	 * generic class loader
654
+	 *
655
+	 * @param string $path_to_file - directory path to file location, not including filename
656
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
657
+	 * @param string $type         - file type - core? class? helper? model?
658
+	 * @param mixed  $arguments
659
+	 * @param bool   $load_only
660
+	 * @return mixed
661
+	 * @throws InvalidInterfaceException
662
+	 * @throws InvalidDataTypeException
663
+	 * @throws EE_Error
664
+	 * @throws ReflectionException
665
+	 * @throws InvalidArgumentException
666
+	 */
667
+	public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true)
668
+	{
669
+		// retrieve instantiated class
670
+		return $this->_load(
671
+			$path_to_file,
672
+			'',
673
+			$file_name,
674
+			$type,
675
+			$arguments,
676
+			false,
677
+			true,
678
+			$load_only
679
+		);
680
+	}
681
+
682
+
683
+	/**
684
+	 * @param string $path_to_file - directory path to file location, not including filename
685
+	 * @param string $class_name   - full class name  ie:  My_Class
686
+	 * @param string $type         - file type - core? class? helper? model?
687
+	 * @param mixed  $arguments
688
+	 * @param bool   $load_only
689
+	 * @return bool|EE_Addon|object
690
+	 * @throws InvalidInterfaceException
691
+	 * @throws InvalidDataTypeException
692
+	 * @throws EE_Error
693
+	 * @throws ReflectionException
694
+	 * @throws InvalidArgumentException
695
+	 */
696
+	public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false)
697
+	{
698
+		// retrieve instantiated class
699
+		return $this->_load(
700
+			$path_to_file,
701
+			'addon',
702
+			$class_name,
703
+			$type,
704
+			$arguments,
705
+			false,
706
+			true,
707
+			$load_only
708
+		);
709
+	}
710
+
711
+
712
+	/**
713
+	 * instantiates, caches, and automatically resolves dependencies
714
+	 * for classes that use a Fully Qualified Class Name.
715
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
716
+	 * then you need to use one of the existing load_*() methods
717
+	 * which can resolve the classname and filepath from the passed arguments
718
+	 *
719
+	 * @param bool|string $class_name   Fully Qualified Class Name
720
+	 * @param array       $arguments    an argument, or array of arguments to pass to the class upon instantiation
721
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
722
+	 * @param bool        $from_db      some classes are instantiated from the db
723
+	 *                                  and thus call a different method to instantiate
724
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
725
+	 * @param bool|string $addon        if true, will cache the object in the EE_Registry->$addons array
726
+	 * @return bool|null|mixed          null = failure to load or instantiate class object.
727
+	 *                                  object = class loaded and instantiated successfully.
728
+	 *                                  bool = fail or success when $load_only is true
729
+	 * @throws InvalidInterfaceException
730
+	 * @throws InvalidDataTypeException
731
+	 * @throws EE_Error
732
+	 * @throws ReflectionException
733
+	 * @throws InvalidArgumentException
734
+	 */
735
+	public function create(
736
+		$class_name = false,
737
+		$arguments = array(),
738
+		$cache = false,
739
+		$from_db = false,
740
+		$load_only = false,
741
+		$addon = false
742
+	) {
743
+		$class_name   = ltrim($class_name, '\\');
744
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
745
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
746
+		// if a non-FQCN was passed, then
747
+		// verifyClassExists() might return an object
748
+		// or it could return null if the class just could not be found anywhere
749
+		if ($class_exists instanceof $class_name || $class_exists === null) {
750
+			// either way, return the results
751
+			return $class_exists;
752
+		}
753
+		$class_name = $class_exists;
754
+		// if we're only loading the class and it already exists, then let's just return true immediately
755
+		if ($load_only) {
756
+			return true;
757
+		}
758
+		$addon = $addon ? 'addon' : '';
759
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
760
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
761
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
762
+		if ($this->_cache_on && $cache && ! $load_only) {
763
+			// return object if it's already cached
764
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
765
+			if ($cached_class !== null) {
766
+				return $cached_class;
767
+			}
768
+		}// obtain the loader method from the dependency map
769
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
770
+		if ($loader instanceof Closure) {
771
+			$class_obj = $loader($arguments);
772
+		} else {
773
+			if ($loader && method_exists($this, $loader)) {
774
+				$class_obj = $this->{$loader}($class_name, $arguments);
775
+			} else {
776
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
777
+			}
778
+		}
779
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
780
+			// save it for later... kinda like gum  { : $
781
+			$this->_set_cached_class(
782
+				$class_obj,
783
+				$class_name,
784
+				$addon,
785
+				$from_db,
786
+				$arguments
787
+			);
788
+		}
789
+		$this->_cache_on = true;
790
+		return $class_obj;
791
+	}
792
+
793
+
794
+	/**
795
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
796
+	 *
797
+	 * @param string|object $class_name
798
+	 * @param array         $arguments
799
+	 * @param int           $attempt
800
+	 * @return mixed
801
+	 */
802
+	private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1)
803
+	{
804
+		if (is_object($class_name) || class_exists($class_name)) {
805
+			return $class_name;
806
+		}
807
+		switch ($attempt) {
808
+			case 1:
809
+				// if it's a FQCN then maybe the class is registered with a preceding \
810
+				$class_name = strpos($class_name, '\\') !== false
811
+					? '\\' . ltrim($class_name, '\\')
812
+					: $class_name;
813
+				break;
814
+			case 2:
815
+				//
816
+				$loader = $this->_dependency_map->class_loader($class_name);
817
+				if ($loader && method_exists($this, $loader)) {
818
+					return $this->{$loader}($class_name, $arguments);
819
+				}
820
+				break;
821
+			case 3:
822
+			default;
823
+				return null;
824
+		}
825
+		$attempt++;
826
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
827
+	}
828
+
829
+
830
+	/**
831
+	 * instantiates, caches, and injects dependencies for classes
832
+	 *
833
+	 * @param array       $file_paths   an array of paths to folders to look in
834
+	 * @param string      $class_prefix EE  or EEM or... ???
835
+	 * @param bool|string $class_name   $class name
836
+	 * @param string      $type         file type - core? class? helper? model?
837
+	 * @param mixed       $arguments    an argument or array of arguments to pass to the class upon instantiation
838
+	 * @param bool        $from_db      some classes are instantiated from the db
839
+	 *                                  and thus call a different method to instantiate
840
+	 * @param bool        $cache        whether to cache the instantiated object for reuse
841
+	 * @param bool        $load_only    if true, will only load the file, but will NOT instantiate an object
842
+	 * @return bool|null|object null = failure to load or instantiate class object.
843
+	 *                                  object = class loaded and instantiated successfully.
844
+	 *                                  bool = fail or success when $load_only is true
845
+	 * @throws EE_Error
846
+	 * @throws ReflectionException
847
+	 * @throws InvalidInterfaceException
848
+	 * @throws InvalidDataTypeException
849
+	 * @throws InvalidArgumentException
850
+	 */
851
+	protected function _load(
852
+		$file_paths = array(),
853
+		$class_prefix = 'EE_',
854
+		$class_name = false,
855
+		$type = 'class',
856
+		$arguments = array(),
857
+		$from_db = false,
858
+		$cache = true,
859
+		$load_only = false
860
+	) {
861
+		$class_name = ltrim($class_name, '\\');
862
+		// strip php file extension
863
+		$class_name = str_replace('.php', '', trim($class_name));
864
+		// does the class have a prefix ?
865
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
866
+			// make sure $class_prefix is uppercase
867
+			$class_prefix = strtoupper(trim($class_prefix));
868
+			// add class prefix ONCE!!!
869
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
870
+		}
871
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
872
+		$class_exists = class_exists($class_name, false);
873
+		// if we're only loading the class and it already exists, then let's just return true immediately
874
+		if ($load_only && $class_exists) {
875
+			return true;
876
+		}
877
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
878
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
879
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
880
+		if ($this->_cache_on && $cache && ! $load_only) {
881
+			// return object if it's already cached
882
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
883
+			if ($cached_class !== null) {
884
+				return $cached_class;
885
+			}
886
+		}
887
+		// if the class doesn't already exist.. then we need to try and find the file and load it
888
+		if (! $class_exists) {
889
+			// get full path to file
890
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
891
+			// load the file
892
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
893
+			// if we are only loading a file but NOT instantiating an object
894
+			// then return boolean for whether class was loaded or not
895
+			if ($load_only) {
896
+				return $loaded;
897
+			}
898
+			// if an object was expected but loading failed, then return nothing
899
+			if (! $loaded) {
900
+				return null;
901
+			}
902
+		}
903
+		// instantiate the requested object
904
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
905
+		if ($this->_cache_on && $cache) {
906
+			// save it for later... kinda like gum  { : $
907
+			$this->_set_cached_class(
908
+				$class_obj,
909
+				$class_name,
910
+				$class_prefix,
911
+				$from_db,
912
+				$arguments
913
+			);
914
+		}
915
+		$this->_cache_on = true;
916
+		return $class_obj;
917
+	}
918
+
919
+
920
+	/**
921
+	 * @param string $class_name
922
+	 * @param string $default have to specify something, but not anything that will conflict
923
+	 * @return mixed|string
924
+	 */
925
+	protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
926
+	{
927
+		return isset($this->_class_abbreviations[ $class_name ])
928
+			? $this->_class_abbreviations[ $class_name ]
929
+			: $default;
930
+	}
931
+
932
+
933
+	/**
934
+	 * attempts to find a cached version of the requested class
935
+	 * by looking in the following places:
936
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
937
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
938
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
939
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
940
+	 *
941
+	 * @param string $class_name
942
+	 * @param string $class_prefix
943
+	 * @param array  $arguments
944
+	 * @return mixed
945
+	 */
946
+	protected function _get_cached_class(
947
+		$class_name,
948
+		$class_prefix = '',
949
+		$arguments = array()
950
+	) {
951
+		if ($class_name === 'EE_Registry') {
952
+			return $this;
953
+		}
954
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
955
+		// check if class has already been loaded, and return it if it has been
956
+		if (isset($this->{$class_abbreviation})) {
957
+			return $this->{$class_abbreviation};
958
+		}
959
+		$class_name = str_replace('\\', '_', $class_name);
960
+		if (isset ($this->{$class_name})) {
961
+			return $this->{$class_name};
962
+		}
963
+		if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) {
964
+			return $this->addons->{$class_name};
965
+		}
966
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
967
+		if (isset($this->LIB->{$object_identifier})) {
968
+			return $this->LIB->{$object_identifier};
969
+		}
970
+		foreach ($this->LIB as $key => $object) {
971
+			if (
972
+				// request does not contain new arguments and therefore no args identifier
973
+				! $this->object_identifier->hasArguments($object_identifier)
974
+				// but previously cached class with args was found
975
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
976
+			) {
977
+				return $object;
978
+			}
979
+		}
980
+		return null;
981
+	}
982
+
983
+
984
+	/**
985
+	 * removes a cached version of the requested class
986
+	 *
987
+	 * @param string  $class_name
988
+	 * @param boolean $addon
989
+	 * @param array   $arguments
990
+	 * @return boolean
991
+	 */
992
+	public function clear_cached_class(
993
+		$class_name,
994
+		$addon = false,
995
+		$arguments = array()
996
+	) {
997
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
998
+		// check if class has already been loaded, and return it if it has been
999
+		if (isset($this->{$class_abbreviation})) {
1000
+			$this->{$class_abbreviation} = null;
1001
+			return true;
1002
+		}
1003
+		$class_name = str_replace('\\', '_', $class_name);
1004
+		if (isset($this->{$class_name})) {
1005
+			$this->{$class_name} = null;
1006
+			return true;
1007
+		}
1008
+		if ($addon && isset($this->addons->{$class_name})) {
1009
+			unset($this->addons->{$class_name});
1010
+			return true;
1011
+		}
1012
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
1013
+		if (isset($this->LIB->{$class_name})) {
1014
+			unset($this->LIB->{$class_name});
1015
+			return true;
1016
+		}
1017
+		return false;
1018
+	}
1019
+
1020
+
1021
+	/**
1022
+	 * _set_cached_class
1023
+	 * attempts to cache the instantiated class locally
1024
+	 * in one of the following places, in the following order:
1025
+	 *        $this->{class_abbreviation}   ie:    $this->CART
1026
+	 *        $this->{$class_name}          ie:    $this->Some_Class
1027
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
1028
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
1029
+	 *
1030
+	 * @param object $class_obj
1031
+	 * @param string $class_name
1032
+	 * @param string $class_prefix
1033
+	 * @param bool   $from_db
1034
+	 * @param array  $arguments
1035
+	 * @return void
1036
+	 */
1037
+	protected function _set_cached_class(
1038
+		$class_obj,
1039
+		$class_name,
1040
+		$class_prefix = '',
1041
+		$from_db = false,
1042
+		$arguments = array()
1043
+	) {
1044
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
1045
+			return;
1046
+		}
1047
+		// return newly instantiated class
1048
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
1049
+		if ($class_abbreviation) {
1050
+			$this->{$class_abbreviation} = $class_obj;
1051
+			return;
1052
+		}
1053
+		$class_name = str_replace('\\', '_', $class_name);
1054
+		if (property_exists($this, $class_name)) {
1055
+			$this->{$class_name} = $class_obj;
1056
+			return;
1057
+		}
1058
+		if ($class_prefix === 'addon') {
1059
+			$this->addons->{$class_name} = $class_obj;
1060
+			return;
1061
+		}
1062
+		if (! $from_db) {
1063
+			$class_name               = $this->object_identifier->getIdentifier($class_name, $arguments);
1064
+			$this->LIB->{$class_name} = $class_obj;
1065
+		}
1066
+	}
1067
+
1068
+
1069
+	/**
1070
+	 * attempts to find a full valid filepath for the requested class.
1071
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
1072
+	 * then returns that path if the target file has been found and is readable
1073
+	 *
1074
+	 * @param string $class_name
1075
+	 * @param string $type
1076
+	 * @param array  $file_paths
1077
+	 * @return string | bool
1078
+	 */
1079
+	protected function _resolve_path($class_name, $type = '', $file_paths = array())
1080
+	{
1081
+		// make sure $file_paths is an array
1082
+		$file_paths = is_array($file_paths)
1083
+			? $file_paths
1084
+			: array($file_paths);
1085
+		// cycle thru paths
1086
+		foreach ($file_paths as $key => $file_path) {
1087
+			// convert all separators to proper DS, if no filepath, then use EE_CLASSES
1088
+			$file_path = $file_path
1089
+				? str_replace(array('/', '\\'), DS, $file_path)
1090
+				: EE_CLASSES;
1091
+			// prep file type
1092
+			$type = ! empty($type)
1093
+				? trim($type, '.') . '.'
1094
+				: '';
1095
+			// build full file path
1096
+			$file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
1097
+			//does the file exist and can be read ?
1098
+			if (is_readable($file_paths[ $key ])) {
1099
+				return $file_paths[ $key ];
1100
+			}
1101
+		}
1102
+		return false;
1103
+	}
1104
+
1105
+
1106
+	/**
1107
+	 * basically just performs a require_once()
1108
+	 * but with some error handling
1109
+	 *
1110
+	 * @param  string $path
1111
+	 * @param  string $class_name
1112
+	 * @param  string $type
1113
+	 * @param  array  $file_paths
1114
+	 * @return bool
1115
+	 * @throws EE_Error
1116
+	 * @throws ReflectionException
1117
+	 */
1118
+	protected function _require_file($path, $class_name, $type = '', $file_paths = array())
1119
+	{
1120
+		$this->resolve_legacy_class_parent($class_name);
1121
+		// don't give up! you gotta...
1122
+		try {
1123
+			//does the file exist and can it be read ?
1124
+			if (! $path) {
1125
+				// just in case the file has already been autoloaded,
1126
+				// but discrepancies in the naming schema are preventing it from
1127
+				// being loaded via one of the EE_Registry::load_*() methods,
1128
+				// then let's try one last hail mary before throwing an exception
1129
+				// and call class_exists() again, but with autoloading turned ON
1130
+				if (class_exists($class_name)) {
1131
+					return true;
1132
+				}
1133
+				// so sorry, can't find the file
1134
+				throw new EE_Error (
1135
+					sprintf(
1136
+						esc_html__(
1137
+							'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',
1138
+							'event_espresso'
1139
+						),
1140
+						trim($type, '.'),
1141
+						$class_name,
1142
+						'<br />' . implode(',<br />', $file_paths)
1143
+					)
1144
+				);
1145
+			}
1146
+			// get the file
1147
+			require_once($path);
1148
+			// if the class isn't already declared somewhere
1149
+			if (class_exists($class_name, false) === false) {
1150
+				// so sorry, not a class
1151
+				throw new EE_Error(
1152
+					sprintf(
1153
+						esc_html__(
1154
+							'The %s file %s does not appear to contain the %s Class.',
1155
+							'event_espresso'
1156
+						),
1157
+						$type,
1158
+						$path,
1159
+						$class_name
1160
+					)
1161
+				);
1162
+			}
1163
+		} catch (EE_Error $e) {
1164
+			$e->get_error();
1165
+			return false;
1166
+		}
1167
+		return true;
1168
+	}
1169
+
1170
+
1171
+	/**
1172
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
1173
+	 * before their class declaration in order to ensure that the parent class was loaded.
1174
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
1175
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
1176
+	 *
1177
+	 * @param string $class_name
1178
+	 */
1179
+	protected function resolve_legacy_class_parent($class_name = '')
1180
+	{
1181
+		try {
1182
+			$legacy_parent_class_map = array(
1183
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
1184
+			);
1185
+			if (isset($legacy_parent_class_map[ $class_name ])) {
1186
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
1187
+			}
1188
+		} catch (Exception $exception) {
1189
+		}
1190
+	}
1191
+
1192
+
1193
+	/**
1194
+	 * _create_object
1195
+	 * Attempts to instantiate the requested class via any of the
1196
+	 * commonly used instantiation methods employed throughout EE.
1197
+	 * The priority for instantiation is as follows:
1198
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
1199
+	 *        - model objects via their 'new_instance_from_db' method
1200
+	 *        - model objects via their 'new_instance' method
1201
+	 *        - "singleton" classes" via their 'instance' method
1202
+	 *    - standard instantiable classes via their __constructor
1203
+	 * Prior to instantiation, if the classname exists in the dependency_map,
1204
+	 * then the constructor for the requested class will be examined to determine
1205
+	 * if any dependencies exist, and if they can be injected.
1206
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
1207
+	 *
1208
+	 * @param string $class_name
1209
+	 * @param array  $arguments
1210
+	 * @param string $type
1211
+	 * @param bool   $from_db
1212
+	 * @return null|object|bool
1213
+	 * @throws InvalidArgumentException
1214
+	 * @throws InvalidInterfaceException
1215
+	 * @throws EE_Error
1216
+	 * @throws ReflectionException
1217
+	 * @throws InvalidDataTypeException
1218
+	 */
1219
+	protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false)
1220
+	{
1221
+		// create reflection
1222
+		$reflector = $this->mirror->getReflectionClass($class_name);
1223
+		// make sure arguments are an array
1224
+		$arguments = is_array($arguments)
1225
+			? $arguments
1226
+			: array($arguments);
1227
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
1228
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
1229
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
1230
+			? $arguments
1231
+			: array($arguments);
1232
+		// attempt to inject dependencies ?
1233
+		if ($this->_dependency_map->has($class_name)) {
1234
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
1235
+		}
1236
+		// instantiate the class if possible
1237
+		if ($reflector->isAbstract()) {
1238
+			// nothing to instantiate, loading file was enough
1239
+			// does not throw an exception so $instantiation_mode is unused
1240
+			// $instantiation_mode = "1) no constructor abstract class";
1241
+			return true;
1242
+		}
1243
+		if (
1244
+			empty($arguments)
1245
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
1246
+			&& $reflector->isInstantiable()
1247
+		) {
1248
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
1249
+			// $instantiation_mode = "2) no constructor but instantiable";
1250
+			return $reflector->newInstance();
1251
+		}
1252
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
1253
+			// $instantiation_mode = "3) new_instance_from_db()";
1254
+			return call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments);
1255
+		}
1256
+		if (method_exists($class_name, 'new_instance')) {
1257
+			// $instantiation_mode = "4) new_instance()";
1258
+			return call_user_func_array(array($class_name, 'new_instance'), $arguments);
1259
+		}
1260
+		if (method_exists($class_name, 'instance')) {
1261
+			// $instantiation_mode = "5) instance()";
1262
+			return call_user_func_array(array($class_name, 'instance'), $arguments);
1263
+		}
1264
+		if ($reflector->isInstantiable()) {
1265
+			// $instantiation_mode = "6) constructor";
1266
+			return $reflector->newInstanceArgs($arguments);
1267
+		}
1268
+		// heh ? something's not right !
1269
+		throw new EE_Error(
1270
+			sprintf(
1271
+				__('The %s file %s could not be instantiated.', 'event_espresso'),
1272
+				$type,
1273
+				$class_name
1274
+			)
1275
+		);
1276
+	}
1277
+
1278
+
1279
+	/**
1280
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
1281
+	 * @param array $array
1282
+	 * @return bool
1283
+	 */
1284
+	protected function _array_is_numerically_and_sequentially_indexed(array $array)
1285
+	{
1286
+		return ! empty($array)
1287
+			? array_keys($array) === range(0, count($array) - 1)
1288
+			: true;
1289
+	}
1290
+
1291
+
1292
+	/**
1293
+	 * _resolve_dependencies
1294
+	 * examines the constructor for the requested class to determine
1295
+	 * if any dependencies exist, and if they can be injected.
1296
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
1297
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
1298
+	 * For example:
1299
+	 *        if attempting to load a class "Foo" with the following constructor:
1300
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
1301
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
1302
+	 *        but only IF they are NOT already present in the incoming arguments array,
1303
+	 *        and the correct classes can be loaded
1304
+	 *
1305
+	 * @param ReflectionClass $reflector
1306
+	 * @param string          $class_name
1307
+	 * @param array           $arguments
1308
+	 * @return array
1309
+	 * @throws InvalidArgumentException
1310
+	 * @throws InvalidDataTypeException
1311
+	 * @throws InvalidInterfaceException
1312
+	 * @throws ReflectionException
1313
+	 */
1314
+	protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, array $arguments = array())
1315
+	{
1316
+		// let's examine the constructor
1317
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
1318
+		// whu? huh? nothing?
1319
+		if (! $constructor) {
1320
+			return $arguments;
1321
+		}
1322
+		// get constructor parameters
1323
+		$params = $this->mirror->getParametersFromReflection($reflector);
1324
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
1325
+		$argument_keys = array_keys($arguments);
1326
+		// now loop thru all of the constructors expected parameters
1327
+		foreach ($params as $index => $param) {
1328
+			// is this a dependency for a specific class ?
1329
+			$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
1330
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
1331
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
1332
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
1333
+				: $param_class;
1334
+			if (
1335
+				// param is not even a class
1336
+				$param_class === null
1337
+				// and something already exists in the incoming arguments for this param
1338
+				&& array_key_exists($index, $argument_keys)
1339
+				&& array_key_exists($argument_keys[ $index ], $arguments)
1340
+			) {
1341
+				// so let's skip this argument and move on to the next
1342
+				continue;
1343
+			}
1344
+			if (
1345
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
1346
+				$param_class !== null
1347
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
1348
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
1349
+			) {
1350
+				// skip this argument and move on to the next
1351
+				continue;
1352
+			}
1353
+			if (
1354
+				// parameter is type hinted as a class, and should be injected
1355
+				$param_class !== null
1356
+				&& $this->_dependency_map->has_dependency_for_class($class_name, $param_class)
1357
+			) {
1358
+				$arguments = $this->_resolve_dependency(
1359
+					$class_name,
1360
+					$param_class,
1361
+					$arguments,
1362
+					$index
1363
+				);
1364
+			} else {
1365
+				$arguments[ $index ] = $this->mirror->getParameterDefaultValue(
1366
+					$param,
1367
+					$class_name,
1368
+					$index
1369
+				);
1370
+			}
1371
+		}
1372
+		return $arguments;
1373
+	}
1374
+
1375
+
1376
+	/**
1377
+	 * @param string $class_name
1378
+	 * @param string $param_class
1379
+	 * @param array  $arguments
1380
+	 * @param mixed  $index
1381
+	 * @return array
1382
+	 * @throws InvalidArgumentException
1383
+	 * @throws InvalidInterfaceException
1384
+	 * @throws InvalidDataTypeException
1385
+	 */
1386
+	protected function _resolve_dependency($class_name, $param_class, $arguments, $index)
1387
+	{
1388
+		$dependency = null;
1389
+		// should dependency be loaded from cache ?
1390
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
1391
+			$class_name,
1392
+			$param_class
1393
+		);
1394
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
1395
+		// we might have a dependency...
1396
+		// let's MAYBE try and find it in our cache if that's what's been requested
1397
+		$cached_class = $cache_on
1398
+			? $this->_get_cached_class($param_class)
1399
+			: null;
1400
+		// and grab it if it exists
1401
+		if ($cached_class instanceof $param_class) {
1402
+			$dependency = $cached_class;
1403
+		} elseif ($param_class !== $class_name) {
1404
+			// obtain the loader method from the dependency map
1405
+			$loader = $this->_dependency_map->class_loader($param_class);
1406
+			// is loader a custom closure ?
1407
+			if ($loader instanceof Closure) {
1408
+				$dependency = $loader($arguments);
1409
+			} else {
1410
+				// set the cache on property for the recursive loading call
1411
+				$this->_cache_on = $cache_on;
1412
+				// if not, then let's try and load it via the registry
1413
+				if ($loader && method_exists($this, $loader)) {
1414
+					$dependency = $this->{$loader}($param_class);
1415
+				} else {
1416
+					$dependency = LoaderFactory::getLoader()->load(
1417
+						$param_class,
1418
+						array(),
1419
+						$cache_on
1420
+					);
1421
+				}
1422
+			}
1423
+		}
1424
+		// did we successfully find the correct dependency ?
1425
+		if ($dependency instanceof $param_class) {
1426
+			// then let's inject it into the incoming array of arguments at the correct location
1427
+			$arguments[ $index ] = $dependency;
1428
+		}
1429
+		return $arguments;
1430
+	}
1431
+
1432
+
1433
+	/**
1434
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
1435
+	 *
1436
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
1437
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
1438
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
1439
+	 * @param array  $arguments
1440
+	 * @return object
1441
+	 */
1442
+	public static function factory($classname, $arguments = array())
1443
+	{
1444
+		$loader = self::instance()->_dependency_map->class_loader($classname);
1445
+		if ($loader instanceof Closure) {
1446
+			return $loader($arguments);
1447
+		}
1448
+		if (method_exists(self::instance(), $loader)) {
1449
+			return self::instance()->{$loader}($classname, $arguments);
1450
+		}
1451
+		return null;
1452
+	}
1453
+
1454
+
1455
+	/**
1456
+	 * Gets the addon by its class name
1457
+	 *
1458
+	 * @param string $class_name
1459
+	 * @return EE_Addon
1460
+	 */
1461
+	public function getAddon($class_name)
1462
+	{
1463
+		$class_name = str_replace('\\', '_', $class_name);
1464
+		return $this->addons->{$class_name};
1465
+	}
1466
+
1467
+
1468
+	/**
1469
+	 * removes the addon from the internal cache
1470
+	 *
1471
+	 * @param string $class_name
1472
+	 * @return void
1473
+	 */
1474
+	public function removeAddon($class_name)
1475
+	{
1476
+		$class_name = str_replace('\\', '_', $class_name);
1477
+		unset($this->addons->{$class_name});
1478
+	}
1479
+
1480
+
1481
+	/**
1482
+	 * Gets the addon by its name/slug (not classname. For that, just
1483
+	 * use the get_addon() method above
1484
+	 *
1485
+	 * @param string $name
1486
+	 * @return EE_Addon
1487
+	 */
1488
+	public function get_addon_by_name($name)
1489
+	{
1490
+		foreach ($this->addons as $addon) {
1491
+			if ($addon->name() === $name) {
1492
+				return $addon;
1493
+			}
1494
+		}
1495
+		return null;
1496
+	}
1497
+
1498
+
1499
+	/**
1500
+	 * Gets an array of all the registered addons, where the keys are their names.
1501
+	 * (ie, what each returns for their name() function)
1502
+	 * They're already available on EE_Registry::instance()->addons as properties,
1503
+	 * where each property's name is the addon's classname,
1504
+	 * So if you just want to get the addon by classname,
1505
+	 * OR use the get_addon() method above.
1506
+	 * PLEASE  NOTE:
1507
+	 * addons with Fully Qualified Class Names
1508
+	 * have had the namespace separators converted to underscores,
1509
+	 * so a classname like Fully\Qualified\ClassName
1510
+	 * would have been converted to Fully_Qualified_ClassName
1511
+	 *
1512
+	 * @return EE_Addon[] where the KEYS are the addon's name()
1513
+	 */
1514
+	public function get_addons_by_name()
1515
+	{
1516
+		$addons = array();
1517
+		foreach ($this->addons as $addon) {
1518
+			$addons[ $addon->name() ] = $addon;
1519
+		}
1520
+		return $addons;
1521
+	}
1522
+
1523
+
1524
+	/**
1525
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
1526
+	 * a stale copy of it around
1527
+	 *
1528
+	 * @param string $model_name
1529
+	 * @return \EEM_Base
1530
+	 * @throws \EE_Error
1531
+	 */
1532
+	public function reset_model($model_name)
1533
+	{
1534
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
1535
+			? "EEM_{$model_name}"
1536
+			: $model_name;
1537
+		if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
1538
+			return null;
1539
+		}
1540
+		//get that model reset it and make sure we nuke the old reference to it
1541
+		if ($this->LIB->{$model_class_name} instanceof $model_class_name
1542
+			&& is_callable(
1543
+				array($model_class_name, 'reset')
1544
+			)) {
1545
+			$this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset();
1546
+		} else {
1547
+			throw new EE_Error(
1548
+				sprintf(
1549
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
1550
+					$model_name
1551
+				)
1552
+			);
1553
+		}
1554
+		return $this->LIB->{$model_class_name};
1555
+	}
1556
+
1557
+
1558
+	/**
1559
+	 * Resets the registry.
1560
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
1561
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
1562
+	 * - $_dependency_map
1563
+	 * - $_class_abbreviations
1564
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
1565
+	 * - $REQ:  Still on the same request so no need to change.
1566
+	 * - $CAP: There is no site specific state in the EE_Capability class.
1567
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
1568
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
1569
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
1570
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
1571
+	 *             switch or on the restore.
1572
+	 * - $modules
1573
+	 * - $shortcodes
1574
+	 * - $widgets
1575
+	 *
1576
+	 * @param boolean $hard             [deprecated]
1577
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
1578
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
1579
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
1580
+	 * @param   bool  $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
1581
+	 *                                  client
1582
+	 *                                  code instead can just change the model context to a different blog id if
1583
+	 *                                  necessary
1584
+	 * @return EE_Registry
1585
+	 * @throws InvalidInterfaceException
1586
+	 * @throws InvalidDataTypeException
1587
+	 * @throws EE_Error
1588
+	 * @throws ReflectionException
1589
+	 * @throws InvalidArgumentException
1590
+	 */
1591
+	public static function reset($hard = false, $reinstantiate = true, $reset_models = true)
1592
+	{
1593
+		$instance            = self::instance();
1594
+		$instance->_cache_on = true;
1595
+		// reset some "special" classes
1596
+		EEH_Activation::reset();
1597
+		$hard                     = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
1598
+		$instance->CFG            = EE_Config::reset($hard, $reinstantiate);
1599
+		$instance->CART           = null;
1600
+		$instance->MRM            = null;
1601
+		$instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry');
1602
+		//messages reset
1603
+		EED_Messages::reset();
1604
+		//handle of objects cached on LIB
1605
+		foreach (array('LIB', 'modules') as $cache) {
1606
+			foreach ($instance->{$cache} as $class_name => $class) {
1607
+				if (self::_reset_and_unset_object($class, $reset_models)) {
1608
+					unset($instance->{$cache}->{$class_name});
1609
+				}
1610
+			}
1611
+		}
1612
+		return $instance;
1613
+	}
1614
+
1615
+
1616
+	/**
1617
+	 * if passed object implements ResettableInterface, then call it's reset() method
1618
+	 * if passed object implements InterminableInterface, then return false,
1619
+	 * to indicate that it should NOT be cleared from the Registry cache
1620
+	 *
1621
+	 * @param      $object
1622
+	 * @param bool $reset_models
1623
+	 * @return bool returns true if cached object should be unset
1624
+	 */
1625
+	private static function _reset_and_unset_object($object, $reset_models)
1626
+	{
1627
+		if (! is_object($object)) {
1628
+			// don't unset anything that's not an object
1629
+			return false;
1630
+		}
1631
+		if ($object instanceof EED_Module) {
1632
+			$object::reset();
1633
+			// don't unset modules
1634
+			return false;
1635
+		}
1636
+		if ($object instanceof ResettableInterface) {
1637
+			if ($object instanceof EEM_Base) {
1638
+				if ($reset_models) {
1639
+					$object->reset();
1640
+					return true;
1641
+				}
1642
+				return false;
1643
+			}
1644
+			$object->reset();
1645
+			return true;
1646
+		}
1647
+		if (! $object instanceof InterminableInterface) {
1648
+			return true;
1649
+		}
1650
+		return false;
1651
+	}
1652
+
1653
+
1654
+	/**
1655
+	 * Gets all the custom post type models defined
1656
+	 *
1657
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
1658
+	 */
1659
+	public function cpt_models()
1660
+	{
1661
+		$cpt_models = array();
1662
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
1663
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
1664
+				$cpt_models[ $short_name ] = $classname;
1665
+			}
1666
+		}
1667
+		return $cpt_models;
1668
+	}
1669
+
1670
+
1671
+	/**
1672
+	 * @return \EE_Config
1673
+	 */
1674
+	public static function CFG()
1675
+	{
1676
+		return self::instance()->CFG;
1677
+	}
1678
+
1679
+
1680
+	/**
1681
+	 * @deprecated $VID:$
1682
+	 * @param string $class_name
1683
+	 * @return ReflectionClass
1684
+	 * @throws ReflectionException
1685
+	 * @throws InvalidDataTypeException
1686
+	 */
1687
+	public function get_ReflectionClass($class_name)
1688
+	{
1689
+		return $this->mirror->getReflectionClass($class_name);
1690
+	}
1691 1691
 }
1692 1692
 // End of file EE_Registry.core.php
1693 1693
 // Location: ./core/EE_Registry.core.php
Please login to merge, or discard this patch.
Spacing   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -313,10 +313,10 @@  discard block
 block discarded – undo
313 313
         $i18n_js_strings = (array) self::$i18n_js_strings;
314 314
         foreach ($i18n_js_strings as $key => $value) {
315 315
             if (is_scalar($value)) {
316
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
316
+                $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
317 317
             }
318 318
         }
319
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
319
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
320 320
     }
321 321
 
322 322
 
@@ -335,7 +335,7 @@  discard block
 block discarded – undo
335 335
             $module_class                   = get_class($module);
336 336
             $this->modules->{$module_class} = $module;
337 337
         } else {
338
-            if (! class_exists('EE_Module_Request_Router', false)) {
338
+            if ( ! class_exists('EE_Module_Request_Router', false)) {
339 339
                 $this->load_core('Module_Request_Router');
340 340
             }
341 341
             EE_Module_Request_Router::module_factory($module);
@@ -376,10 +376,10 @@  discard block
 block discarded – undo
376 376
                 EE_CORE,
377 377
                 EE_ADMIN,
378 378
                 EE_CPTS,
379
-                EE_CORE . 'data_migration_scripts' . DS,
380
-                EE_CORE . 'capabilities' . DS,
381
-                EE_CORE . 'request_stack' . DS,
382
-                EE_CORE . 'middleware' . DS,
379
+                EE_CORE.'data_migration_scripts'.DS,
380
+                EE_CORE.'capabilities'.DS,
381
+                EE_CORE.'request_stack'.DS,
382
+                EE_CORE.'middleware'.DS,
383 383
             )
384 384
         );
385 385
         // retrieve instantiated class
@@ -414,7 +414,7 @@  discard block
 block discarded – undo
414 414
         $service_paths = apply_filters(
415 415
             'FHEE__EE_Registry__load_service__service_paths',
416 416
             array(
417
-                EE_CORE . 'services' . DS,
417
+                EE_CORE.'services'.DS,
418 418
             )
419 419
         );
420 420
         // retrieve instantiated class
@@ -548,10 +548,10 @@  discard block
 block discarded – undo
548 548
     {
549 549
         $paths = array(
550 550
             EE_LIBRARIES,
551
-            EE_LIBRARIES . 'messages' . DS,
552
-            EE_LIBRARIES . 'shortcodes' . DS,
553
-            EE_LIBRARIES . 'qtips' . DS,
554
-            EE_LIBRARIES . 'payment_methods' . DS,
551
+            EE_LIBRARIES.'messages'.DS,
552
+            EE_LIBRARIES.'shortcodes'.DS,
553
+            EE_LIBRARIES.'qtips'.DS,
554
+            EE_LIBRARIES.'payment_methods'.DS,
555 555
         );
556 556
         // retrieve instantiated class
557 557
         return $this->_load(
@@ -618,10 +618,10 @@  discard block
 block discarded – undo
618 618
     public function load_model_class($class_name, $arguments = array(), $load_only = true)
619 619
     {
620 620
         $paths = array(
621
-            EE_MODELS . 'fields' . DS,
622
-            EE_MODELS . 'helpers' . DS,
623
-            EE_MODELS . 'relations' . DS,
624
-            EE_MODELS . 'strategies' . DS,
621
+            EE_MODELS.'fields'.DS,
622
+            EE_MODELS.'helpers'.DS,
623
+            EE_MODELS.'relations'.DS,
624
+            EE_MODELS.'strategies'.DS,
625 625
         );
626 626
         // retrieve instantiated class
627 627
         return $this->_load(
@@ -645,7 +645,7 @@  discard block
 block discarded – undo
645 645
      */
646 646
     public function is_model_name($model_name)
647 647
     {
648
-        return isset($this->models[ $model_name ]);
648
+        return isset($this->models[$model_name]);
649 649
     }
650 650
 
651 651
 
@@ -766,7 +766,7 @@  discard block
 block discarded – undo
766 766
                 return $cached_class;
767 767
             }
768 768
         }// obtain the loader method from the dependency map
769
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
769
+        $loader = $this->_dependency_map->class_loader($class_name); // instantiate the requested object
770 770
         if ($loader instanceof Closure) {
771 771
             $class_obj = $loader($arguments);
772 772
         } else {
@@ -808,7 +808,7 @@  discard block
 block discarded – undo
808 808
             case 1:
809 809
                 // if it's a FQCN then maybe the class is registered with a preceding \
810 810
                 $class_name = strpos($class_name, '\\') !== false
811
-                    ? '\\' . ltrim($class_name, '\\')
811
+                    ? '\\'.ltrim($class_name, '\\')
812 812
                     : $class_name;
813 813
                 break;
814 814
             case 2:
@@ -862,11 +862,11 @@  discard block
 block discarded – undo
862 862
         // strip php file extension
863 863
         $class_name = str_replace('.php', '', trim($class_name));
864 864
         // does the class have a prefix ?
865
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
865
+        if ( ! empty($class_prefix) && $class_prefix !== 'addon') {
866 866
             // make sure $class_prefix is uppercase
867 867
             $class_prefix = strtoupper(trim($class_prefix));
868 868
             // add class prefix ONCE!!!
869
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
869
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
870 870
         }
871 871
         $class_name   = $this->class_cache->getFqnForAlias($class_name);
872 872
         $class_exists = class_exists($class_name, false);
@@ -885,7 +885,7 @@  discard block
 block discarded – undo
885 885
             }
886 886
         }
887 887
         // if the class doesn't already exist.. then we need to try and find the file and load it
888
-        if (! $class_exists) {
888
+        if ( ! $class_exists) {
889 889
             // get full path to file
890 890
             $path = $this->_resolve_path($class_name, $type, $file_paths);
891 891
             // load the file
@@ -896,7 +896,7 @@  discard block
 block discarded – undo
896 896
                 return $loaded;
897 897
             }
898 898
             // if an object was expected but loading failed, then return nothing
899
-            if (! $loaded) {
899
+            if ( ! $loaded) {
900 900
                 return null;
901 901
             }
902 902
         }
@@ -924,8 +924,8 @@  discard block
 block discarded – undo
924 924
      */
925 925
     protected function get_class_abbreviation($class_name, $default = 'FANCY_BATMAN_PANTS')
926 926
     {
927
-        return isset($this->_class_abbreviations[ $class_name ])
928
-            ? $this->_class_abbreviations[ $class_name ]
927
+        return isset($this->_class_abbreviations[$class_name])
928
+            ? $this->_class_abbreviations[$class_name]
929 929
             : $default;
930 930
     }
931 931
 
@@ -1059,7 +1059,7 @@  discard block
 block discarded – undo
1059 1059
             $this->addons->{$class_name} = $class_obj;
1060 1060
             return;
1061 1061
         }
1062
-        if (! $from_db) {
1062
+        if ( ! $from_db) {
1063 1063
             $class_name               = $this->object_identifier->getIdentifier($class_name, $arguments);
1064 1064
             $this->LIB->{$class_name} = $class_obj;
1065 1065
         }
@@ -1090,13 +1090,13 @@  discard block
 block discarded – undo
1090 1090
                 : EE_CLASSES;
1091 1091
             // prep file type
1092 1092
             $type = ! empty($type)
1093
-                ? trim($type, '.') . '.'
1093
+                ? trim($type, '.').'.'
1094 1094
                 : '';
1095 1095
             // build full file path
1096
-            $file_paths[ $key ] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php';
1096
+            $file_paths[$key] = rtrim($file_path, DS).DS.$class_name.'.'.$type.'php';
1097 1097
             //does the file exist and can be read ?
1098
-            if (is_readable($file_paths[ $key ])) {
1099
-                return $file_paths[ $key ];
1098
+            if (is_readable($file_paths[$key])) {
1099
+                return $file_paths[$key];
1100 1100
             }
1101 1101
         }
1102 1102
         return false;
@@ -1121,7 +1121,7 @@  discard block
 block discarded – undo
1121 1121
         // don't give up! you gotta...
1122 1122
         try {
1123 1123
             //does the file exist and can it be read ?
1124
-            if (! $path) {
1124
+            if ( ! $path) {
1125 1125
                 // just in case the file has already been autoloaded,
1126 1126
                 // but discrepancies in the naming schema are preventing it from
1127 1127
                 // being loaded via one of the EE_Registry::load_*() methods,
@@ -1131,7 +1131,7 @@  discard block
 block discarded – undo
1131 1131
                     return true;
1132 1132
                 }
1133 1133
                 // so sorry, can't find the file
1134
-                throw new EE_Error (
1134
+                throw new EE_Error(
1135 1135
                     sprintf(
1136 1136
                         esc_html__(
1137 1137
                             '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',
@@ -1139,7 +1139,7 @@  discard block
 block discarded – undo
1139 1139
                         ),
1140 1140
                         trim($type, '.'),
1141 1141
                         $class_name,
1142
-                        '<br />' . implode(',<br />', $file_paths)
1142
+                        '<br />'.implode(',<br />', $file_paths)
1143 1143
                     )
1144 1144
                 );
1145 1145
             }
@@ -1182,8 +1182,8 @@  discard block
 block discarded – undo
1182 1182
             $legacy_parent_class_map = array(
1183 1183
                 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
1184 1184
             );
1185
-            if (isset($legacy_parent_class_map[ $class_name ])) {
1186
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
1185
+            if (isset($legacy_parent_class_map[$class_name])) {
1186
+                require_once EE_PLUGIN_DIR_PATH.$legacy_parent_class_map[$class_name];
1187 1187
             }
1188 1188
         } catch (Exception $exception) {
1189 1189
         }
@@ -1316,7 +1316,7 @@  discard block
 block discarded – undo
1316 1316
         // let's examine the constructor
1317 1317
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
1318 1318
         // whu? huh? nothing?
1319
-        if (! $constructor) {
1319
+        if ( ! $constructor) {
1320 1320
             return $arguments;
1321 1321
         }
1322 1322
         // get constructor parameters
@@ -1336,7 +1336,7 @@  discard block
 block discarded – undo
1336 1336
                 $param_class === null
1337 1337
                 // and something already exists in the incoming arguments for this param
1338 1338
                 && array_key_exists($index, $argument_keys)
1339
-                && array_key_exists($argument_keys[ $index ], $arguments)
1339
+                && array_key_exists($argument_keys[$index], $arguments)
1340 1340
             ) {
1341 1341
                 // so let's skip this argument and move on to the next
1342 1342
                 continue;
@@ -1344,8 +1344,8 @@  discard block
 block discarded – undo
1344 1344
             if (
1345 1345
                 // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
1346 1346
                 $param_class !== null
1347
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
1348
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
1347
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
1348
+                && $arguments[$argument_keys[$index]] instanceof $param_class
1349 1349
             ) {
1350 1350
                 // skip this argument and move on to the next
1351 1351
                 continue;
@@ -1362,7 +1362,7 @@  discard block
 block discarded – undo
1362 1362
                     $index
1363 1363
                 );
1364 1364
             } else {
1365
-                $arguments[ $index ] = $this->mirror->getParameterDefaultValue(
1365
+                $arguments[$index] = $this->mirror->getParameterDefaultValue(
1366 1366
                     $param,
1367 1367
                     $class_name,
1368 1368
                     $index
@@ -1424,7 +1424,7 @@  discard block
 block discarded – undo
1424 1424
         // did we successfully find the correct dependency ?
1425 1425
         if ($dependency instanceof $param_class) {
1426 1426
             // then let's inject it into the incoming array of arguments at the correct location
1427
-            $arguments[ $index ] = $dependency;
1427
+            $arguments[$index] = $dependency;
1428 1428
         }
1429 1429
         return $arguments;
1430 1430
     }
@@ -1515,7 +1515,7 @@  discard block
 block discarded – undo
1515 1515
     {
1516 1516
         $addons = array();
1517 1517
         foreach ($this->addons as $addon) {
1518
-            $addons[ $addon->name() ] = $addon;
1518
+            $addons[$addon->name()] = $addon;
1519 1519
         }
1520 1520
         return $addons;
1521 1521
     }
@@ -1534,7 +1534,7 @@  discard block
 block discarded – undo
1534 1534
         $model_class_name = strpos($model_name, 'EEM_') !== 0
1535 1535
             ? "EEM_{$model_name}"
1536 1536
             : $model_name;
1537
-        if (! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
1537
+        if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) {
1538 1538
             return null;
1539 1539
         }
1540 1540
         //get that model reset it and make sure we nuke the old reference to it
@@ -1624,7 +1624,7 @@  discard block
 block discarded – undo
1624 1624
      */
1625 1625
     private static function _reset_and_unset_object($object, $reset_models)
1626 1626
     {
1627
-        if (! is_object($object)) {
1627
+        if ( ! is_object($object)) {
1628 1628
             // don't unset anything that's not an object
1629 1629
             return false;
1630 1630
         }
@@ -1644,7 +1644,7 @@  discard block
 block discarded – undo
1644 1644
             $object->reset();
1645 1645
             return true;
1646 1646
         }
1647
-        if (! $object instanceof InterminableInterface) {
1647
+        if ( ! $object instanceof InterminableInterface) {
1648 1648
             return true;
1649 1649
         }
1650 1650
         return false;
@@ -1661,7 +1661,7 @@  discard block
 block discarded – undo
1661 1661
         $cpt_models = array();
1662 1662
         foreach ($this->non_abstract_db_models as $short_name => $classname) {
1663 1663
             if (is_subclass_of($classname, 'EEM_CPT_Base')) {
1664
-                $cpt_models[ $short_name ] = $classname;
1664
+                $cpt_models[$short_name] = $classname;
1665 1665
             }
1666 1666
         }
1667 1667
         return $cpt_models;
Please login to merge, or discard this patch.
core/services/loaders/ObjectIdentifier.php 2 patches
Indentation   +107 added lines, -107 removed lines patch added patch discarded remove patch
@@ -20,111 +20,111 @@
 block discarded – undo
20 20
 class ObjectIdentifier
21 21
 {
22 22
 
23
-    /**
24
-     * used to separate the FQCN from the class's arguments identifier
25
-     */
26
-    const DELIMITER = '____';
27
-
28
-    /**
29
-     * @var ClassInterfaceCache $class_cache
30
-     */
31
-    private $class_cache;
32
-
33
-
34
-    /**
35
-     * ObjectIdentifier constructor.
36
-     *
37
-     * @param ClassInterfaceCache $class_cache
38
-     */
39
-    public function __construct(ClassInterfaceCache $class_cache)
40
-    {
41
-        $this->class_cache = $class_cache;
42
-    }
43
-
44
-
45
-    /**
46
-     * Returns true if the supplied $object_identifier contains
47
-     * the delimiter used to separate an fqcn from the arguments hash
48
-     *
49
-     * @param string $object_identifier
50
-     * @return bool
51
-     */
52
-    public function hasArguments($object_identifier)
53
-    {
54
-        // type casting to bool instead of using strpos() !== false
55
-        // because an object identifier should never begin with the delimiter
56
-        // therefore the delimiter should NOT be found at position 0
57
-        return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
58
-    }
59
-
60
-
61
-    /**
62
-     * Returns true if the supplied FQCN equals the supplied $object_identifier
63
-     * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
64
-     * AND that $object_identifier is for an object with arguments.
65
-     * This allows a request for an object using a FQCN to match
66
-     * a previously instantiated object with arguments
67
-     * without having to know those arguments.
68
-     *
69
-     * @param string $fqcn
70
-     * @param string $object_identifier
71
-     * @return bool
72
-     */
73
-    public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
74
-    {
75
-        return $fqcn === $object_identifier
76
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
77
-    }
78
-
79
-
80
-    /**
81
-     * build a string representation of an object's FQCN and arguments
82
-     *
83
-     * @param string $fqcn
84
-     * @param array  $arguments
85
-     * @return string
86
-     */
87
-    public function getIdentifier($fqcn, array $arguments = array())
88
-    {
89
-        // only build identifier from arguments if class is not ReservedInstanceInterface
90
-        $identifier = ! $this->class_cache->hasInterface($fqcn,
91
-            'EventEspresso\core\interfaces\ReservedInstanceInterface')
92
-            ? $this->getIdentifierForArguments($arguments)
93
-            : '';
94
-        if (! empty($identifier)) {
95
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
96
-        }
97
-        return $fqcn;
98
-    }
99
-
100
-
101
-    /**
102
-     * build a string representation of a object's arguments
103
-     * (mostly because Closures can't be serialized)
104
-     *
105
-     * @param array $arguments
106
-     * @return string
107
-     */
108
-    protected function getIdentifierForArguments(array $arguments)
109
-    {
110
-        if (empty($arguments)) {
111
-            return '';
112
-        }
113
-        $identifier = '';
114
-        foreach ($arguments as $argument) {
115
-            switch (true) {
116
-                case is_object($argument) :
117
-                case $argument instanceof Closure :
118
-                    $identifier .= spl_object_hash($argument);
119
-                    break;
120
-                case is_array($argument) :
121
-                    $identifier .= $this->getIdentifierForArguments($argument);
122
-                    break;
123
-                default :
124
-                    $identifier .= $argument;
125
-                    break;
126
-            }
127
-        }
128
-        return $identifier;
129
-    }
23
+	/**
24
+	 * used to separate the FQCN from the class's arguments identifier
25
+	 */
26
+	const DELIMITER = '____';
27
+
28
+	/**
29
+	 * @var ClassInterfaceCache $class_cache
30
+	 */
31
+	private $class_cache;
32
+
33
+
34
+	/**
35
+	 * ObjectIdentifier constructor.
36
+	 *
37
+	 * @param ClassInterfaceCache $class_cache
38
+	 */
39
+	public function __construct(ClassInterfaceCache $class_cache)
40
+	{
41
+		$this->class_cache = $class_cache;
42
+	}
43
+
44
+
45
+	/**
46
+	 * Returns true if the supplied $object_identifier contains
47
+	 * the delimiter used to separate an fqcn from the arguments hash
48
+	 *
49
+	 * @param string $object_identifier
50
+	 * @return bool
51
+	 */
52
+	public function hasArguments($object_identifier)
53
+	{
54
+		// type casting to bool instead of using strpos() !== false
55
+		// because an object identifier should never begin with the delimiter
56
+		// therefore the delimiter should NOT be found at position 0
57
+		return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
58
+	}
59
+
60
+
61
+	/**
62
+	 * Returns true if the supplied FQCN equals the supplied $object_identifier
63
+	 * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
64
+	 * AND that $object_identifier is for an object with arguments.
65
+	 * This allows a request for an object using a FQCN to match
66
+	 * a previously instantiated object with arguments
67
+	 * without having to know those arguments.
68
+	 *
69
+	 * @param string $fqcn
70
+	 * @param string $object_identifier
71
+	 * @return bool
72
+	 */
73
+	public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
74
+	{
75
+		return $fqcn === $object_identifier
76
+			   || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
77
+	}
78
+
79
+
80
+	/**
81
+	 * build a string representation of an object's FQCN and arguments
82
+	 *
83
+	 * @param string $fqcn
84
+	 * @param array  $arguments
85
+	 * @return string
86
+	 */
87
+	public function getIdentifier($fqcn, array $arguments = array())
88
+	{
89
+		// only build identifier from arguments if class is not ReservedInstanceInterface
90
+		$identifier = ! $this->class_cache->hasInterface($fqcn,
91
+			'EventEspresso\core\interfaces\ReservedInstanceInterface')
92
+			? $this->getIdentifierForArguments($arguments)
93
+			: '';
94
+		if (! empty($identifier)) {
95
+			$fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
96
+		}
97
+		return $fqcn;
98
+	}
99
+
100
+
101
+	/**
102
+	 * build a string representation of a object's arguments
103
+	 * (mostly because Closures can't be serialized)
104
+	 *
105
+	 * @param array $arguments
106
+	 * @return string
107
+	 */
108
+	protected function getIdentifierForArguments(array $arguments)
109
+	{
110
+		if (empty($arguments)) {
111
+			return '';
112
+		}
113
+		$identifier = '';
114
+		foreach ($arguments as $argument) {
115
+			switch (true) {
116
+				case is_object($argument) :
117
+				case $argument instanceof Closure :
118
+					$identifier .= spl_object_hash($argument);
119
+					break;
120
+				case is_array($argument) :
121
+					$identifier .= $this->getIdentifierForArguments($argument);
122
+					break;
123
+				default :
124
+					$identifier .= $argument;
125
+					break;
126
+			}
127
+		}
128
+		return $identifier;
129
+	}
130 130
 }
131 131
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -73,7 +73,7 @@  discard block
 block discarded – undo
73 73
     public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
74 74
     {
75 75
         return $fqcn === $object_identifier
76
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
76
+               || strpos($object_identifier, $fqcn.ObjectIdentifier::DELIMITER) === 0;
77 77
     }
78 78
 
79 79
 
@@ -91,8 +91,8 @@  discard block
 block discarded – undo
91 91
             'EventEspresso\core\interfaces\ReservedInstanceInterface')
92 92
             ? $this->getIdentifierForArguments($arguments)
93 93
             : '';
94
-        if (! empty($identifier)) {
95
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
94
+        if ( ! empty($identifier)) {
95
+            $fqcn .= ObjectIdentifier::DELIMITER.md5($identifier);
96 96
         }
97 97
         return $fqcn;
98 98
     }
Please login to merge, or discard this patch.
core/services/loaders/CachingLoader.php 2 patches
Indentation   +141 added lines, -141 removed lines patch added patch discarded remove patch
@@ -21,147 +21,147 @@
 block discarded – undo
21 21
 class CachingLoader extends CachingLoaderDecorator
22 22
 {
23 23
 
24
-    /**
25
-     * @var string $identifier
26
-     */
27
-    protected $identifier;
28
-
29
-    /**
30
-     * @var CollectionInterface $cache
31
-     */
32
-    protected $cache;
33
-
34
-    /**
35
-     * @var ObjectIdentifier
36
-     */
37
-    private $object_identifier;
38
-
39
-
40
-    /**
41
-     * CachingLoader constructor.
42
-     *
43
-     * @param LoaderDecoratorInterface $loader
44
-     * @param CollectionInterface      $cache
45
-     * @param ObjectIdentifier         $object_identifier
46
-     * @param string                   $identifier
47
-     * @throws InvalidDataTypeException
48
-     */
49
-    public function __construct(
50
-        LoaderDecoratorInterface $loader,
51
-        CollectionInterface $cache,
52
-        ObjectIdentifier $object_identifier,
53
-        $identifier = ''
54
-    ) {
55
-        parent::__construct($loader);
56
-        $this->cache       = $cache;
57
-        $this->object_identifier = $object_identifier;
58
-        $this->setIdentifier($identifier);
59
-        if ($this->identifier !== '') {
60
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
61
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
62
-            // where "IDENTIFIER" = the string that was set during construction
63
-            add_action(
64
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
65
-                array($this, 'reset')
66
-            );
67
-        }
68
-        // to clear ALL caches, simply do the following:
69
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
70
-        add_action(
71
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
72
-            array($this, 'reset')
73
-        );
74
-    }
75
-
76
-
77
-    /**
78
-     * @return string
79
-     */
80
-    public function identifier()
81
-    {
82
-        return $this->identifier;
83
-    }
84
-
85
-
86
-    /**
87
-     * @param string $identifier
88
-     * @throws InvalidDataTypeException
89
-     */
90
-    private function setIdentifier($identifier)
91
-    {
92
-        if (! is_string($identifier)) {
93
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
94
-        }
95
-        $this->identifier = $identifier;
96
-    }
97
-
98
-
99
-    /**
100
-     * @param FullyQualifiedName|string $fqcn
101
-     * @param mixed                     $object
102
-     * @return bool
103
-     * @throws InvalidArgumentException
104
-     */
105
-    public function share($fqcn, $object)
106
-    {
107
-        if ($object instanceof $fqcn) {
108
-            return $this->cache->add($object, md5($fqcn));
109
-        }
110
-        throw new InvalidArgumentException(
111
-            sprintf(
112
-                esc_html__(
113
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
114
-                    'event_espresso'
115
-                ),
116
-                $fqcn
117
-            )
118
-        );
119
-    }
120
-
121
-
122
-    /**
123
-     * @param FullyQualifiedName|string $fqcn
124
-     * @param array                     $arguments
125
-     * @param bool                      $shared
126
-     * @param array                     $interfaces
127
-     * @return mixed
128
-     */
129
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
130
-    {
131
-        $fqcn = ltrim($fqcn, '\\');
132
-        // caching can be turned off via the following code:
133
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
134
-        if (
135
-            apply_filters(
136
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
137
-                false,
138
-                $this
139
-            )
140
-        ) {
141
-            // even though $shared might be true, caching could be bypassed for whatever reason,
142
-            // so we don't want the core loader to cache anything, therefore caching is turned off
143
-            return $this->loader->load($fqcn, $arguments, false);
144
-        }
145
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
146
-        if ($this->cache->has($object_identifier)) {
147
-            return $this->cache->get($object_identifier);
148
-        }
149
-        $object = $this->loader->load($fqcn, $arguments, $shared);
150
-        if ($object instanceof $fqcn) {
151
-            $this->cache->add($object, $object_identifier);
152
-        }
153
-        return $object;
154
-    }
155
-
156
-
157
-    /**
158
-     * empties cache and calls reset() on loader if method exists
159
-     */
160
-    public function reset()
161
-    {
162
-        $this->cache->trashAndDetachAll();
163
-        $this->loader->reset();
164
-    }
24
+	/**
25
+	 * @var string $identifier
26
+	 */
27
+	protected $identifier;
28
+
29
+	/**
30
+	 * @var CollectionInterface $cache
31
+	 */
32
+	protected $cache;
33
+
34
+	/**
35
+	 * @var ObjectIdentifier
36
+	 */
37
+	private $object_identifier;
38
+
39
+
40
+	/**
41
+	 * CachingLoader constructor.
42
+	 *
43
+	 * @param LoaderDecoratorInterface $loader
44
+	 * @param CollectionInterface      $cache
45
+	 * @param ObjectIdentifier         $object_identifier
46
+	 * @param string                   $identifier
47
+	 * @throws InvalidDataTypeException
48
+	 */
49
+	public function __construct(
50
+		LoaderDecoratorInterface $loader,
51
+		CollectionInterface $cache,
52
+		ObjectIdentifier $object_identifier,
53
+		$identifier = ''
54
+	) {
55
+		parent::__construct($loader);
56
+		$this->cache       = $cache;
57
+		$this->object_identifier = $object_identifier;
58
+		$this->setIdentifier($identifier);
59
+		if ($this->identifier !== '') {
60
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
61
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
62
+			// where "IDENTIFIER" = the string that was set during construction
63
+			add_action(
64
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
65
+				array($this, 'reset')
66
+			);
67
+		}
68
+		// to clear ALL caches, simply do the following:
69
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
70
+		add_action(
71
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
72
+			array($this, 'reset')
73
+		);
74
+	}
75
+
76
+
77
+	/**
78
+	 * @return string
79
+	 */
80
+	public function identifier()
81
+	{
82
+		return $this->identifier;
83
+	}
84
+
85
+
86
+	/**
87
+	 * @param string $identifier
88
+	 * @throws InvalidDataTypeException
89
+	 */
90
+	private function setIdentifier($identifier)
91
+	{
92
+		if (! is_string($identifier)) {
93
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
94
+		}
95
+		$this->identifier = $identifier;
96
+	}
97
+
98
+
99
+	/**
100
+	 * @param FullyQualifiedName|string $fqcn
101
+	 * @param mixed                     $object
102
+	 * @return bool
103
+	 * @throws InvalidArgumentException
104
+	 */
105
+	public function share($fqcn, $object)
106
+	{
107
+		if ($object instanceof $fqcn) {
108
+			return $this->cache->add($object, md5($fqcn));
109
+		}
110
+		throw new InvalidArgumentException(
111
+			sprintf(
112
+				esc_html__(
113
+					'The supplied class name "%1$s" must match the class of the supplied object.',
114
+					'event_espresso'
115
+				),
116
+				$fqcn
117
+			)
118
+		);
119
+	}
120
+
121
+
122
+	/**
123
+	 * @param FullyQualifiedName|string $fqcn
124
+	 * @param array                     $arguments
125
+	 * @param bool                      $shared
126
+	 * @param array                     $interfaces
127
+	 * @return mixed
128
+	 */
129
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
130
+	{
131
+		$fqcn = ltrim($fqcn, '\\');
132
+		// caching can be turned off via the following code:
133
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
134
+		if (
135
+			apply_filters(
136
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
137
+				false,
138
+				$this
139
+			)
140
+		) {
141
+			// even though $shared might be true, caching could be bypassed for whatever reason,
142
+			// so we don't want the core loader to cache anything, therefore caching is turned off
143
+			return $this->loader->load($fqcn, $arguments, false);
144
+		}
145
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
146
+		if ($this->cache->has($object_identifier)) {
147
+			return $this->cache->get($object_identifier);
148
+		}
149
+		$object = $this->loader->load($fqcn, $arguments, $shared);
150
+		if ($object instanceof $fqcn) {
151
+			$this->cache->add($object, $object_identifier);
152
+		}
153
+		return $object;
154
+	}
155
+
156
+
157
+	/**
158
+	 * empties cache and calls reset() on loader if method exists
159
+	 */
160
+	public function reset()
161
+	{
162
+		$this->cache->trashAndDetachAll();
163
+		$this->loader->reset();
164
+	}
165 165
 
166 166
 
167 167
 
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -53,7 +53,7 @@  discard block
 block discarded – undo
53 53
         $identifier = ''
54 54
     ) {
55 55
         parent::__construct($loader);
56
-        $this->cache       = $cache;
56
+        $this->cache = $cache;
57 57
         $this->object_identifier = $object_identifier;
58 58
         $this->setIdentifier($identifier);
59 59
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@  discard block
 block discarded – undo
89 89
      */
90 90
     private function setIdentifier($identifier)
91 91
     {
92
-        if (! is_string($identifier)) {
92
+        if ( ! is_string($identifier)) {
93 93
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
94 94
         }
95 95
         $this->identifier = $identifier;
Please login to merge, or discard this patch.
core/services/loaders/LoaderFactory.php 1 patch
Indentation   +39 added lines, -39 removed lines patch added patch discarded remove patch
@@ -80,47 +80,47 @@
 block discarded – undo
80 80
 class LoaderFactory
81 81
 {
82 82
 
83
-    /**
84
-     * @var LoaderInterface $loader ;
85
-     */
86
-    private static $loader;
83
+	/**
84
+	 * @var LoaderInterface $loader ;
85
+	 */
86
+	private static $loader;
87 87
 
88 88
 
89
-    /**
90
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
91
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
92
-     *                                              otherwise can be left null
93
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
94
-     * @param ObjectIdentifier|null    $object_identifier
95
-     * @return LoaderInterface
96
-     * @throws InvalidArgumentException
97
-     * @throws InvalidDataTypeException
98
-     * @throws InvalidInterfaceException
99
-     */
100
-    public static function getLoader(
101
-        $generator = null,
102
-        ClassInterfaceCache $class_cache = null,
103
-        ObjectIdentifier $object_identifier = null
104
-    ) {
105
-        if (
106
-            ! LoaderFactory::$loader instanceof LoaderInterface
107
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
108
-            && $class_cache instanceof ClassInterfaceCache
109
-            && $object_identifier instanceof ObjectIdentifier
110
-        ) {
111
-            $core_loader = new CoreLoader($generator);
112
-            LoaderFactory::$loader = new Loader(
113
-                $core_loader,
114
-                new CachingLoader(
115
-                    $core_loader,
116
-                    new LooseCollection(''),
117
-                    $object_identifier
118
-                ),
119
-                $class_cache
120
-            );
121
-        }
122
-        return LoaderFactory::$loader;
123
-    }
89
+	/**
90
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
91
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
92
+	 *                                              otherwise can be left null
93
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
94
+	 * @param ObjectIdentifier|null    $object_identifier
95
+	 * @return LoaderInterface
96
+	 * @throws InvalidArgumentException
97
+	 * @throws InvalidDataTypeException
98
+	 * @throws InvalidInterfaceException
99
+	 */
100
+	public static function getLoader(
101
+		$generator = null,
102
+		ClassInterfaceCache $class_cache = null,
103
+		ObjectIdentifier $object_identifier = null
104
+	) {
105
+		if (
106
+			! LoaderFactory::$loader instanceof LoaderInterface
107
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
108
+			&& $class_cache instanceof ClassInterfaceCache
109
+			&& $object_identifier instanceof ObjectIdentifier
110
+		) {
111
+			$core_loader = new CoreLoader($generator);
112
+			LoaderFactory::$loader = new Loader(
113
+				$core_loader,
114
+				new CachingLoader(
115
+					$core_loader,
116
+					new LooseCollection(''),
117
+					$object_identifier
118
+				),
119
+				$class_cache
120
+			);
121
+		}
122
+		return LoaderFactory::$loader;
123
+	}
124 124
 
125 125
 
126 126
 }
Please login to merge, or discard this patch.
core/services/bootstrap/BootstrapDependencyInjectionContainer.php 1 patch
Indentation   +121 added lines, -121 removed lines patch added patch discarded remove patch
@@ -29,126 +29,126 @@
 block discarded – undo
29 29
 class BootstrapDependencyInjectionContainer
30 30
 {
31 31
 
32
-    /**
33
-     * @var EE_Dependency_Map $dependency_map
34
-     */
35
-    protected $dependency_map;
36
-
37
-    /**
38
-     * @type LoaderInterface $loader
39
-     */
40
-    protected $loader;
41
-
42
-    /**
43
-     * @var EE_Registry $registry
44
-     */
45
-    protected $registry;
46
-
47
-    /**
48
-     * @var ClassInterfaceCache $class_cache
49
-     */
50
-    private $class_cache;
51
-
52
-    /**
53
-     * @var Mirror
54
-     */
55
-    private $mirror;
56
-
57
-    /**
58
-     * @var ObjectIdentifier
59
-     */
60
-    private $object_identifier;
61
-
62
-
63
-    /**
64
-     * Can't use this just yet until we exorcise some more of our singleton usage from core
65
-     */
66
-    public function buildDependencyInjectionContainer()
67
-    {
68
-        // build DI container
69
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
70
-        // $OpenCoffeeShop->addRecipes();
71
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
72
-    }
73
-
74
-
75
-    /**
76
-     * Setups  EE_Registry and EE_Dependency_Map
77
-     *
78
-     * @throws EE_Error
79
-     */
80
-    public function buildLegacyDependencyInjectionContainer()
81
-    {
82
-        $this->class_cache = new ClassInterfaceCache();
83
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
84
-        $this->mirror = new Mirror();
85
-        // EE_Dependency_Map: info about how to load classes required by other classes
86
-        espresso_load_required(
87
-            'EE_Dependency_Map',
88
-            EE_CORE . 'EE_Dependency_Map.core.php'
89
-        );
90
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
91
-        // EE_Registry: central repository for classes (legacy)
92
-        espresso_load_required(
93
-            'EE_Registry',
94
-            EE_CORE . 'EE_Registry.core.php'
95
-        );
96
-        $this->registry = EE_Registry::instance(
97
-            $this->dependency_map,
98
-            $this->mirror,
99
-            $this->class_cache,
100
-            $this->object_identifier
101
-        );
102
-
103
-    }
104
-
105
-
106
-    /**
107
-     * Performs initial setup for the generic Loader
108
-     *
109
-     * @throws InvalidDataTypeException
110
-     * @throws InvalidInterfaceException
111
-     * @throws InvalidArgumentException
112
-     */
113
-    public function buildLoader()
114
-    {
115
-        $this->loader = LoaderFactory::getLoader(
116
-            $this->registry,
117
-            $this->class_cache,
118
-            $this->object_identifier
119
-        );
120
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
121
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
122
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
123
-        $this->dependency_map->setLoader($this->loader);
124
-    }
125
-
126
-
127
-    /**
128
-     * @return EE_Dependency_Map
129
-     */
130
-    public function getDependencyMap()
131
-    {
132
-        return $this->dependency_map;
133
-    }
134
-
135
-
136
-    /**
137
-     * @return EE_Registry
138
-     */
139
-    public function getRegistry()
140
-    {
141
-        return $this->registry;
142
-    }
143
-
144
-
145
-
146
-    /**
147
-     * @return LoaderInterface
148
-     */
149
-    public function getLoader()
150
-    {
151
-        return $this->loader;
152
-    }
32
+	/**
33
+	 * @var EE_Dependency_Map $dependency_map
34
+	 */
35
+	protected $dependency_map;
36
+
37
+	/**
38
+	 * @type LoaderInterface $loader
39
+	 */
40
+	protected $loader;
41
+
42
+	/**
43
+	 * @var EE_Registry $registry
44
+	 */
45
+	protected $registry;
46
+
47
+	/**
48
+	 * @var ClassInterfaceCache $class_cache
49
+	 */
50
+	private $class_cache;
51
+
52
+	/**
53
+	 * @var Mirror
54
+	 */
55
+	private $mirror;
56
+
57
+	/**
58
+	 * @var ObjectIdentifier
59
+	 */
60
+	private $object_identifier;
61
+
62
+
63
+	/**
64
+	 * Can't use this just yet until we exorcise some more of our singleton usage from core
65
+	 */
66
+	public function buildDependencyInjectionContainer()
67
+	{
68
+		// build DI container
69
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
70
+		// $OpenCoffeeShop->addRecipes();
71
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
72
+	}
73
+
74
+
75
+	/**
76
+	 * Setups  EE_Registry and EE_Dependency_Map
77
+	 *
78
+	 * @throws EE_Error
79
+	 */
80
+	public function buildLegacyDependencyInjectionContainer()
81
+	{
82
+		$this->class_cache = new ClassInterfaceCache();
83
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
84
+		$this->mirror = new Mirror();
85
+		// EE_Dependency_Map: info about how to load classes required by other classes
86
+		espresso_load_required(
87
+			'EE_Dependency_Map',
88
+			EE_CORE . 'EE_Dependency_Map.core.php'
89
+		);
90
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
91
+		// EE_Registry: central repository for classes (legacy)
92
+		espresso_load_required(
93
+			'EE_Registry',
94
+			EE_CORE . 'EE_Registry.core.php'
95
+		);
96
+		$this->registry = EE_Registry::instance(
97
+			$this->dependency_map,
98
+			$this->mirror,
99
+			$this->class_cache,
100
+			$this->object_identifier
101
+		);
102
+
103
+	}
104
+
105
+
106
+	/**
107
+	 * Performs initial setup for the generic Loader
108
+	 *
109
+	 * @throws InvalidDataTypeException
110
+	 * @throws InvalidInterfaceException
111
+	 * @throws InvalidArgumentException
112
+	 */
113
+	public function buildLoader()
114
+	{
115
+		$this->loader = LoaderFactory::getLoader(
116
+			$this->registry,
117
+			$this->class_cache,
118
+			$this->object_identifier
119
+		);
120
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
121
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
122
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
123
+		$this->dependency_map->setLoader($this->loader);
124
+	}
125
+
126
+
127
+	/**
128
+	 * @return EE_Dependency_Map
129
+	 */
130
+	public function getDependencyMap()
131
+	{
132
+		return $this->dependency_map;
133
+	}
134
+
135
+
136
+	/**
137
+	 * @return EE_Registry
138
+	 */
139
+	public function getRegistry()
140
+	{
141
+		return $this->registry;
142
+	}
143
+
144
+
145
+
146
+	/**
147
+	 * @return LoaderInterface
148
+	 */
149
+	public function getLoader()
150
+	{
151
+		return $this->loader;
152
+	}
153 153
 
154 154
 }
Please login to merge, or discard this patch.
core/EE_Dependency_Map.core.php 1 patch
Indentation   +837 added lines, -837 removed lines patch added patch discarded remove patch
@@ -8,7 +8,7 @@  discard block
 block discarded – undo
8 8
 use EventEspresso\core\services\request\ResponseInterface;
9 9
 
10 10
 if (! defined('EVENT_ESPRESSO_VERSION')) {
11
-    exit('No direct script access allowed');
11
+	exit('No direct script access allowed');
12 12
 }
13 13
 
14 14
 
@@ -25,842 +25,842 @@  discard block
 block discarded – undo
25 25
 class EE_Dependency_Map
26 26
 {
27 27
 
28
-    /**
29
-     * This means that the requested class dependency is not present in the dependency map
30
-     */
31
-    const not_registered = 0;
32
-
33
-    /**
34
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
35
-     */
36
-    const load_new_object = 1;
37
-
38
-    /**
39
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
40
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
41
-     */
42
-    const load_from_cache = 2;
43
-
44
-    /**
45
-     * When registering a dependency,
46
-     * this indicates to keep any existing dependencies that already exist,
47
-     * and simply discard any new dependencies declared in the incoming data
48
-     */
49
-    const KEEP_EXISTING_DEPENDENCIES = 0;
50
-
51
-    /**
52
-     * When registering a dependency,
53
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
54
-     */
55
-    const OVERWRITE_DEPENDENCIES = 1;
56
-
57
-
58
-
59
-    /**
60
-     * @type EE_Dependency_Map $_instance
61
-     */
62
-    protected static $_instance;
63
-
64
-    /**
65
-     * @var ClassInterfaceCache $class_cache
66
-     */
67
-    private $class_cache;
68
-
69
-    /**
70
-     * @type RequestInterface $request
71
-     */
72
-    protected $request;
73
-
74
-    /**
75
-     * @type LegacyRequestInterface $legacy_request
76
-     */
77
-    protected $legacy_request;
78
-
79
-    /**
80
-     * @type ResponseInterface $response
81
-     */
82
-    protected $response;
83
-
84
-    /**
85
-     * @type LoaderInterface $loader
86
-     */
87
-    protected $loader;
88
-
89
-    /**
90
-     * @type array $_dependency_map
91
-     */
92
-    protected $_dependency_map = array();
93
-
94
-    /**
95
-     * @type array $_class_loaders
96
-     */
97
-    protected $_class_loaders = array();
98
-
99
-
100
-    /**
101
-     * EE_Dependency_Map constructor.
102
-     *
103
-     * @param ClassInterfaceCache $class_cache
104
-     */
105
-    protected function __construct(ClassInterfaceCache $class_cache)
106
-    {
107
-        $this->class_cache = $class_cache;
108
-        do_action('EE_Dependency_Map____construct', $this);
109
-    }
110
-
111
-
112
-    /**
113
-     * @return void
114
-     */
115
-    public function initialize()
116
-    {
117
-        $this->_register_core_dependencies();
118
-        $this->_register_core_class_loaders();
119
-        $this->_register_core_aliases();
120
-    }
121
-
122
-
123
-    /**
124
-     * @singleton method used to instantiate class object
125
-     * @param ClassInterfaceCache|null $class_cache
126
-     * @return EE_Dependency_Map
127
-     */
128
-    public static function instance(ClassInterfaceCache $class_cache = null) {
129
-        // check if class object is instantiated, and instantiated properly
130
-        if (
131
-            ! self::$_instance instanceof EE_Dependency_Map
132
-            && $class_cache instanceof ClassInterfaceCache
133
-        ) {
134
-            self::$_instance = new EE_Dependency_Map($class_cache);
135
-        }
136
-        return self::$_instance;
137
-    }
138
-
139
-
140
-    /**
141
-     * @param RequestInterface $request
142
-     */
143
-    public function setRequest(RequestInterface $request)
144
-    {
145
-        $this->request = $request;
146
-    }
147
-
148
-
149
-    /**
150
-     * @param LegacyRequestInterface $legacy_request
151
-     */
152
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
153
-    {
154
-        $this->legacy_request = $legacy_request;
155
-    }
156
-
157
-
158
-    /**
159
-     * @param ResponseInterface $response
160
-     */
161
-    public function setResponse(ResponseInterface $response)
162
-    {
163
-        $this->response = $response;
164
-    }
165
-
166
-
167
-
168
-    /**
169
-     * @param LoaderInterface $loader
170
-     */
171
-    public function setLoader(LoaderInterface $loader)
172
-    {
173
-        $this->loader = $loader;
174
-    }
175
-
176
-
177
-
178
-    /**
179
-     * @param string $class
180
-     * @param array  $dependencies
181
-     * @param int    $overwrite
182
-     * @return bool
183
-     */
184
-    public static function register_dependencies(
185
-        $class,
186
-        array $dependencies,
187
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
188
-    ) {
189
-        return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
190
-    }
191
-
192
-
193
-
194
-    /**
195
-     * Assigns an array of class names and corresponding load sources (new or cached)
196
-     * to the class specified by the first parameter.
197
-     * IMPORTANT !!!
198
-     * The order of elements in the incoming $dependencies array MUST match
199
-     * the order of the constructor parameters for the class in question.
200
-     * This is especially important when overriding any existing dependencies that are registered.
201
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
202
-     *
203
-     * @param string $class
204
-     * @param array  $dependencies
205
-     * @param int    $overwrite
206
-     * @return bool
207
-     */
208
-    public function registerDependencies(
209
-        $class,
210
-        array $dependencies,
211
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
212
-    ) {
213
-        $class = trim($class, '\\');
214
-        $registered = false;
215
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
216
-            self::$_instance->_dependency_map[ $class ] = array();
217
-        }
218
-        // we need to make sure that any aliases used when registering a dependency
219
-        // get resolved to the correct class name
220
-        foreach ($dependencies as $dependency => $load_source) {
221
-            $alias = self::$_instance->get_alias($dependency);
222
-            if (
223
-                $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
224
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
225
-            ) {
226
-                unset($dependencies[$dependency]);
227
-                $dependencies[$alias] = $load_source;
228
-                $registered = true;
229
-            }
230
-        }
231
-        // now add our two lists of dependencies together.
232
-        // using Union (+=) favours the arrays in precedence from left to right,
233
-        // so $dependencies is NOT overwritten because it is listed first
234
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
235
-        // Union is way faster than array_merge() but should be used with caution...
236
-        // especially with numerically indexed arrays
237
-        $dependencies += self::$_instance->_dependency_map[ $class ];
238
-        // now we need to ensure that the resulting dependencies
239
-        // array only has the entries that are required for the class
240
-        // so first count how many dependencies were originally registered for the class
241
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
242
-        // if that count is non-zero (meaning dependencies were already registered)
243
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
244
-            // then truncate the  final array to match that count
245
-            ? array_slice($dependencies, 0, $dependency_count)
246
-            // otherwise just take the incoming array because nothing previously existed
247
-            : $dependencies;
248
-        return $registered;
249
-    }
250
-
251
-
252
-
253
-    /**
254
-     * @param string $class_name
255
-     * @param string $loader
256
-     * @return bool
257
-     * @throws DomainException
258
-     */
259
-    public static function register_class_loader($class_name, $loader = 'load_core')
260
-    {
261
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
262
-            throw new DomainException(
263
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
264
-            );
265
-        }
266
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
267
-        if (
268
-            ! is_callable($loader)
269
-            && (
270
-                strpos($loader, 'load_') !== 0
271
-                || ! method_exists('EE_Registry', $loader)
272
-            )
273
-        ) {
274
-            throw new DomainException(
275
-                sprintf(
276
-                    esc_html__(
277
-                        '"%1$s" is not a valid loader method on EE_Registry.',
278
-                        'event_espresso'
279
-                    ),
280
-                    $loader
281
-                )
282
-            );
283
-        }
284
-        $class_name = self::$_instance->get_alias($class_name);
285
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
286
-            self::$_instance->_class_loaders[$class_name] = $loader;
287
-            return true;
288
-        }
289
-        return false;
290
-    }
291
-
292
-
293
-
294
-    /**
295
-     * @return array
296
-     */
297
-    public function dependency_map()
298
-    {
299
-        return $this->_dependency_map;
300
-    }
301
-
302
-
303
-
304
-    /**
305
-     * returns TRUE if dependency map contains a listing for the provided class name
306
-     *
307
-     * @param string $class_name
308
-     * @return boolean
309
-     */
310
-    public function has($class_name = '')
311
-    {
312
-        // all legacy models have the same dependencies
313
-        if (strpos($class_name, 'EEM_') === 0) {
314
-            $class_name = 'LEGACY_MODELS';
315
-        }
316
-        return isset($this->_dependency_map[$class_name]) ? true : false;
317
-    }
318
-
319
-
320
-
321
-    /**
322
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
323
-     *
324
-     * @param string $class_name
325
-     * @param string $dependency
326
-     * @return bool
327
-     */
328
-    public function has_dependency_for_class($class_name = '', $dependency = '')
329
-    {
330
-        // all legacy models have the same dependencies
331
-        if (strpos($class_name, 'EEM_') === 0) {
332
-            $class_name = 'LEGACY_MODELS';
333
-        }
334
-        $dependency = $this->get_alias($dependency);
335
-        return isset($this->_dependency_map[$class_name][$dependency])
336
-            ? true
337
-            : false;
338
-    }
339
-
340
-
341
-
342
-    /**
343
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
344
-     *
345
-     * @param string $class_name
346
-     * @param string $dependency
347
-     * @return int
348
-     */
349
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
350
-    {
351
-        // all legacy models have the same dependencies
352
-        if (strpos($class_name, 'EEM_') === 0) {
353
-            $class_name = 'LEGACY_MODELS';
354
-        }
355
-        $dependency = $this->get_alias($dependency);
356
-        return $this->has_dependency_for_class($class_name, $dependency)
357
-            ? $this->_dependency_map[$class_name][$dependency]
358
-            : EE_Dependency_Map::not_registered;
359
-    }
360
-
361
-
362
-
363
-    /**
364
-     * @param string $class_name
365
-     * @return string | Closure
366
-     */
367
-    public function class_loader($class_name)
368
-    {
369
-        // all legacy models use load_model()
370
-        if(strpos($class_name, 'EEM_') === 0){
371
-            return 'load_model';
372
-        }
373
-        $class_name = $this->get_alias($class_name);
374
-        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
375
-    }
376
-
377
-
378
-
379
-    /**
380
-     * @return array
381
-     */
382
-    public function class_loaders()
383
-    {
384
-        return $this->_class_loaders;
385
-    }
386
-
387
-
388
-
389
-    /**
390
-     * adds an alias for a classname
391
-     *
392
-     * @param string $fqcn      the class name that should be used (concrete class to replace interface)
393
-     * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
394
-     * @param string $for_class the class that has the dependency (is type hinting for the interface)
395
-     */
396
-    public function add_alias($fqcn, $alias, $for_class = '')
397
-    {
398
-        $this->class_cache->addAlias($alias, $fqcn, $for_class);
399
-    }
400
-
401
-
402
-
403
-    /**
404
-     * PLZ NOTE: a better name for this method would be is_alias()
405
-     * because it returns TRUE if the provided fully qualified name IS an alias
406
-     *
407
-     * @param string $fqn
408
-     * @param string $for_class
409
-     * @return bool
410
-     */
411
-    public function has_alias($fqn = '', $for_class = '')
412
-    {
413
-        return $this->class_cache->isAlias($fqn, $for_class);
414
-    }
415
-
416
-
417
-
418
-    /**
419
-     * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
420
-     * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
421
-     * functions recursively, so that multiple aliases can be used to drill down to a FQN
422
-     *  for example:
423
-     *      if the following two entries were added to the _aliases array:
424
-     *          array(
425
-     *              'interface_alias'           => 'some\namespace\interface'
426
-     *              'some\namespace\interface'  => 'some\namespace\classname'
427
-     *          )
428
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
429
-     *      to load an instance of 'some\namespace\classname'
430
-     *
431
-     * @param string $alias
432
-     * @param string $for_class
433
-     * @return string
434
-     */
435
-    public function get_alias($alias = '', $for_class = '')
436
-    {
437
-        return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
438
-    }
439
-
440
-
441
-
442
-    /**
443
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
444
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
445
-     * This is done by using the following class constants:
446
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
447
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
448
-     */
449
-    protected function _register_core_dependencies()
450
-    {
451
-        $this->_dependency_map = array(
452
-            'EE_Request_Handler'                                                                                          => array(
453
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
454
-            ),
455
-            'EE_System'                                                                                                   => array(
456
-                'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
457
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
458
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
459
-                'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
460
-            ),
461
-            'EE_Session'                                                                                                  => array(
462
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
463
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
464
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
465
-                'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
466
-            ),
467
-            'EE_Cart'                                                                                                     => array(
468
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
469
-            ),
470
-            'EE_Front_Controller'                                                                                         => array(
471
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
472
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
473
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
474
-            ),
475
-            'EE_Messenger_Collection_Loader'                                                                              => array(
476
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
477
-            ),
478
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
479
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
480
-            ),
481
-            'EE_Message_Resource_Manager'                                                                                 => array(
482
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
483
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
484
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
485
-            ),
486
-            'EE_Message_Factory'                                                                                          => array(
487
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
488
-            ),
489
-            'EE_messages'                                                                                                 => array(
490
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
491
-            ),
492
-            'EE_Messages_Generator'                                                                                       => array(
493
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
494
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
495
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
496
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
497
-            ),
498
-            'EE_Messages_Processor'                                                                                       => array(
499
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
500
-            ),
501
-            'EE_Messages_Queue'                                                                                           => array(
502
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
503
-            ),
504
-            'EE_Messages_Template_Defaults'                                                                               => array(
505
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
506
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
507
-            ),
508
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
509
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
510
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
511
-            ),
512
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
513
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
514
-            ),
515
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
516
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
517
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
518
-            ),
519
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
520
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
521
-            ),
522
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
523
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
524
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
525
-            ),
526
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
527
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
528
-            ),
529
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
530
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
531
-            ),
532
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
533
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
534
-            ),
535
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
536
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
537
-            ),
538
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
539
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
540
-            ),
541
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
542
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
543
-            ),
544
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
545
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
546
-            ),
547
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
548
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
549
-            ),
550
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
551
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
552
-            ),
553
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
554
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
555
-            ),
556
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
557
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
558
-            ),
559
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
560
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
561
-            ),
562
-            'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
563
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
564
-            ),
565
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
566
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
567
-            ),
568
-            'EE_Data_Migration_Class_Base'                                                                                => array(
569
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
570
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
571
-            ),
572
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
573
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
574
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
575
-            ),
576
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
577
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
578
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
579
-            ),
580
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
581
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
582
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
583
-            ),
584
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
585
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
586
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
587
-            ),
588
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
589
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
590
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
591
-            ),
592
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
593
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
594
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
595
-            ),
596
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
597
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
598
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
599
-            ),
600
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
601
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
602
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
603
-            ),
604
-            'EE_DMS_Core_4_9_0'                                                                                           => array(
605
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
606
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
607
-            ),
608
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
609
-                'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
610
-                'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
611
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
612
-            ),
613
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
614
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
615
-            ),
616
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
617
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
618
-            ),
619
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
620
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
621
-            ),
622
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
623
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
624
-            ),
625
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
626
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
627
-            ),
628
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
629
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
630
-            ),
631
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
632
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
633
-            ),
634
-            'EventEspresso\core\services\cache\BasicCacheManager'                        => array(
635
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
636
-            ),
637
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                  => array(
638
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
639
-            ),
640
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array(
641
-                'EE_Registration_Config'                                  => EE_Dependency_Map::load_from_cache,
642
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
643
-            ),
644
-            'EventEspresso\core\domain\values\EmailAddress'                              => array(
645
-                null,
646
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
647
-            ),
648
-            'EventEspresso\core\services\orm\ModelFieldFactory' => array(
649
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
650
-            ),
651
-            'LEGACY_MODELS'                                                   => array(
652
-                null,
653
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
654
-            ),
655
-            'EE_Module_Request_Router' => array(
656
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
657
-            ),
658
-            'EE_Registration_Processor' => array(
659
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
660
-            ),
661
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array(
662
-                null,
663
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
664
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
665
-            ),
666
-            'EE_Admin_Transactions_List_Table' => array(
667
-                null,
668
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
669
-            ),
670
-            'EventEspresso\core\domain\services\admin\ExitModal' => array(
671
-                'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache
672
-            ),
673
-            'EventEspresso\core\domain\services\admin\PluginUpsells' => array(
674
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
675
-            ),
676
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha' => array(
677
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
678
-                'EE_Session'             => EE_Dependency_Map::load_from_cache,
679
-            ),
680
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings' => array(
681
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
682
-            ),
683
-            'EventEspresso\core\services\loaders\ObjectIdentifier' => array(
684
-                'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
685
-            ),
686
-        );
687
-    }
688
-
689
-
690
-    /**
691
-     * Registers how core classes are loaded.
692
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
693
-     *        'EE_Request_Handler' => 'load_core'
694
-     *        'EE_Messages_Queue'  => 'load_lib'
695
-     *        'EEH_Debug_Tools'    => 'load_helper'
696
-     * or, if greater control is required, by providing a custom closure. For example:
697
-     *        'Some_Class' => function () {
698
-     *            return new Some_Class();
699
-     *        },
700
-     * This is required for instantiating dependencies
701
-     * where an interface has been type hinted in a class constructor. For example:
702
-     *        'Required_Interface' => function () {
703
-     *            return new A_Class_That_Implements_Required_Interface();
704
-     *        },
705
-     *
706
-     */
707
-    protected function _register_core_class_loaders()
708
-    {
709
-        //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
710
-        //be used in a closure.
711
-        $request = &$this->request;
712
-        $response = &$this->response;
713
-        $legacy_request = &$this->legacy_request;
714
-        // $loader = &$this->loader;
715
-        $this->_class_loaders = array(
716
-            //load_core
717
-            'EE_Capabilities'          => 'load_core',
718
-            'EE_Encryption'            => 'load_core',
719
-            'EE_Front_Controller'      => 'load_core',
720
-            'EE_Module_Request_Router' => 'load_core',
721
-            'EE_Registry'              => 'load_core',
722
-            'EE_Request'               => function () use (&$legacy_request) {
723
-                return $legacy_request;
724
-            },
725
-            'EventEspresso\core\services\request\Request' => function () use (&$request) {
726
-                return $request;
727
-            },
728
-            'EventEspresso\core\services\request\Response' => function () use (&$response) {
729
-                return $response;
730
-            },
731
-            'EE_Request_Handler'       => 'load_core',
732
-            'EE_Session'               => 'load_core',
733
-            'EE_Cron_Tasks'            => 'load_core',
734
-            'EE_System'                => 'load_core',
735
-            'EE_Maintenance_Mode'      => 'load_core',
736
-            'EE_Register_CPTs'         => 'load_core',
737
-            'EE_Admin'                 => 'load_core',
738
-            //load_lib
739
-            'EE_Message_Resource_Manager'          => 'load_lib',
740
-            'EE_Message_Type_Collection'           => 'load_lib',
741
-            'EE_Message_Type_Collection_Loader'    => 'load_lib',
742
-            'EE_Messenger_Collection'              => 'load_lib',
743
-            'EE_Messenger_Collection_Loader'       => 'load_lib',
744
-            'EE_Messages_Processor'                => 'load_lib',
745
-            'EE_Message_Repository'                => 'load_lib',
746
-            'EE_Messages_Queue'                    => 'load_lib',
747
-            'EE_Messages_Data_Handler_Collection'  => 'load_lib',
748
-            'EE_Message_Template_Group_Collection' => 'load_lib',
749
-            'EE_Payment_Method_Manager'            => 'load_lib',
750
-            'EE_Messages_Generator'                => function () {
751
-                return EE_Registry::instance()->load_lib(
752
-                    'Messages_Generator',
753
-                    array(),
754
-                    false,
755
-                    false
756
-                );
757
-            },
758
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
759
-                return EE_Registry::instance()->load_lib(
760
-                    'Messages_Template_Defaults',
761
-                    $arguments,
762
-                    false,
763
-                    false
764
-                );
765
-            },
766
-            //load_model
767
-            // 'EEM_Attendee'                         => 'load_model',
768
-            // 'EEM_Message_Template_Group'           => 'load_model',
769
-            // 'EEM_Message_Template'                 => 'load_model',
770
-            //load_helper
771
-            'EEH_Parse_Shortcodes'                 => function () {
772
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
773
-                    return new EEH_Parse_Shortcodes();
774
-                }
775
-                return null;
776
-            },
777
-            'EE_Template_Config'                   => function () {
778
-                return EE_Config::instance()->template_settings;
779
-            },
780
-            'EE_Currency_Config'                   => function () {
781
-                return EE_Config::instance()->currency;
782
-            },
783
-            'EE_Registration_Config'                   => function () {
784
-                return EE_Config::instance()->registration;
785
-            },
786
-            'EventEspresso\core\services\loaders\Loader' => function () {
787
-                return LoaderFactory::getLoader();
788
-            },
789
-            'EE_Base' => 'load_core',
790
-        );
791
-    }
792
-
793
-
794
-
795
-
796
-    /**
797
-     * can be used for supplying alternate names for classes,
798
-     * or for connecting interface names to instantiable classes
799
-     */
800
-    protected function _register_core_aliases()
801
-    {
802
-        $aliases = array(
803
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
804
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
805
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
806
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
807
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
808
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
809
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
810
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
811
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
812
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
813
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
814
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
815
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
816
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
817
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
818
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
819
-            'CreateTransactionCommandHandler'                                     => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
820
-            'CreateAttendeeCommandHandler'                                        => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
821
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
822
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
823
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
824
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
825
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
826
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
827
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
828
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
829
-            'CommandFactoryInterface'                                                     => 'EventEspresso\core\services\commands\CommandFactoryInterface',
830
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                => 'EventEspresso\core\services\commands\CommandFactory',
831
-            'EventEspresso\core\domain\services\session\SessionIdentifierInterface'       => 'EE_Session',
832
-            'EmailValidatorInterface'                                                     => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
833
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
834
-            'NoticeConverterInterface'                                            => 'EventEspresso\core\services\notices\NoticeConverterInterface',
835
-            'EventEspresso\core\services\notices\NoticeConverterInterface'        => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
836
-            'NoticesContainerInterface'                                           => 'EventEspresso\core\services\notices\NoticesContainerInterface',
837
-            'EventEspresso\core\services\notices\NoticesContainerInterface'       => 'EventEspresso\core\services\notices\NoticesContainer',
838
-            'EventEspresso\core\services\request\RequestInterface'                => 'EventEspresso\core\services\request\Request',
839
-            'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
840
-            'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
841
-        );
842
-        foreach ($aliases as $alias => $fqn) {
843
-            $this->class_cache->addAlias($fqn, $alias);
844
-        }
845
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
846
-            $this->class_cache->addAlias(
847
-                'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
848
-                'EventEspresso\core\services\notices\NoticeConverterInterface'
849
-            );
850
-        }
851
-    }
852
-
853
-
854
-
855
-    /**
856
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
857
-     * request Primarily used by unit tests.
858
-     */
859
-    public function reset()
860
-    {
861
-        $this->_register_core_class_loaders();
862
-        $this->_register_core_dependencies();
863
-    }
28
+	/**
29
+	 * This means that the requested class dependency is not present in the dependency map
30
+	 */
31
+	const not_registered = 0;
32
+
33
+	/**
34
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
35
+	 */
36
+	const load_new_object = 1;
37
+
38
+	/**
39
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
40
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
41
+	 */
42
+	const load_from_cache = 2;
43
+
44
+	/**
45
+	 * When registering a dependency,
46
+	 * this indicates to keep any existing dependencies that already exist,
47
+	 * and simply discard any new dependencies declared in the incoming data
48
+	 */
49
+	const KEEP_EXISTING_DEPENDENCIES = 0;
50
+
51
+	/**
52
+	 * When registering a dependency,
53
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
54
+	 */
55
+	const OVERWRITE_DEPENDENCIES = 1;
56
+
57
+
58
+
59
+	/**
60
+	 * @type EE_Dependency_Map $_instance
61
+	 */
62
+	protected static $_instance;
63
+
64
+	/**
65
+	 * @var ClassInterfaceCache $class_cache
66
+	 */
67
+	private $class_cache;
68
+
69
+	/**
70
+	 * @type RequestInterface $request
71
+	 */
72
+	protected $request;
73
+
74
+	/**
75
+	 * @type LegacyRequestInterface $legacy_request
76
+	 */
77
+	protected $legacy_request;
78
+
79
+	/**
80
+	 * @type ResponseInterface $response
81
+	 */
82
+	protected $response;
83
+
84
+	/**
85
+	 * @type LoaderInterface $loader
86
+	 */
87
+	protected $loader;
88
+
89
+	/**
90
+	 * @type array $_dependency_map
91
+	 */
92
+	protected $_dependency_map = array();
93
+
94
+	/**
95
+	 * @type array $_class_loaders
96
+	 */
97
+	protected $_class_loaders = array();
98
+
99
+
100
+	/**
101
+	 * EE_Dependency_Map constructor.
102
+	 *
103
+	 * @param ClassInterfaceCache $class_cache
104
+	 */
105
+	protected function __construct(ClassInterfaceCache $class_cache)
106
+	{
107
+		$this->class_cache = $class_cache;
108
+		do_action('EE_Dependency_Map____construct', $this);
109
+	}
110
+
111
+
112
+	/**
113
+	 * @return void
114
+	 */
115
+	public function initialize()
116
+	{
117
+		$this->_register_core_dependencies();
118
+		$this->_register_core_class_loaders();
119
+		$this->_register_core_aliases();
120
+	}
121
+
122
+
123
+	/**
124
+	 * @singleton method used to instantiate class object
125
+	 * @param ClassInterfaceCache|null $class_cache
126
+	 * @return EE_Dependency_Map
127
+	 */
128
+	public static function instance(ClassInterfaceCache $class_cache = null) {
129
+		// check if class object is instantiated, and instantiated properly
130
+		if (
131
+			! self::$_instance instanceof EE_Dependency_Map
132
+			&& $class_cache instanceof ClassInterfaceCache
133
+		) {
134
+			self::$_instance = new EE_Dependency_Map($class_cache);
135
+		}
136
+		return self::$_instance;
137
+	}
138
+
139
+
140
+	/**
141
+	 * @param RequestInterface $request
142
+	 */
143
+	public function setRequest(RequestInterface $request)
144
+	{
145
+		$this->request = $request;
146
+	}
147
+
148
+
149
+	/**
150
+	 * @param LegacyRequestInterface $legacy_request
151
+	 */
152
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
153
+	{
154
+		$this->legacy_request = $legacy_request;
155
+	}
156
+
157
+
158
+	/**
159
+	 * @param ResponseInterface $response
160
+	 */
161
+	public function setResponse(ResponseInterface $response)
162
+	{
163
+		$this->response = $response;
164
+	}
165
+
166
+
167
+
168
+	/**
169
+	 * @param LoaderInterface $loader
170
+	 */
171
+	public function setLoader(LoaderInterface $loader)
172
+	{
173
+		$this->loader = $loader;
174
+	}
175
+
176
+
177
+
178
+	/**
179
+	 * @param string $class
180
+	 * @param array  $dependencies
181
+	 * @param int    $overwrite
182
+	 * @return bool
183
+	 */
184
+	public static function register_dependencies(
185
+		$class,
186
+		array $dependencies,
187
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
188
+	) {
189
+		return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
190
+	}
191
+
192
+
193
+
194
+	/**
195
+	 * Assigns an array of class names and corresponding load sources (new or cached)
196
+	 * to the class specified by the first parameter.
197
+	 * IMPORTANT !!!
198
+	 * The order of elements in the incoming $dependencies array MUST match
199
+	 * the order of the constructor parameters for the class in question.
200
+	 * This is especially important when overriding any existing dependencies that are registered.
201
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
202
+	 *
203
+	 * @param string $class
204
+	 * @param array  $dependencies
205
+	 * @param int    $overwrite
206
+	 * @return bool
207
+	 */
208
+	public function registerDependencies(
209
+		$class,
210
+		array $dependencies,
211
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
212
+	) {
213
+		$class = trim($class, '\\');
214
+		$registered = false;
215
+		if (empty(self::$_instance->_dependency_map[ $class ])) {
216
+			self::$_instance->_dependency_map[ $class ] = array();
217
+		}
218
+		// we need to make sure that any aliases used when registering a dependency
219
+		// get resolved to the correct class name
220
+		foreach ($dependencies as $dependency => $load_source) {
221
+			$alias = self::$_instance->get_alias($dependency);
222
+			if (
223
+				$overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
224
+				|| ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
225
+			) {
226
+				unset($dependencies[$dependency]);
227
+				$dependencies[$alias] = $load_source;
228
+				$registered = true;
229
+			}
230
+		}
231
+		// now add our two lists of dependencies together.
232
+		// using Union (+=) favours the arrays in precedence from left to right,
233
+		// so $dependencies is NOT overwritten because it is listed first
234
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
235
+		// Union is way faster than array_merge() but should be used with caution...
236
+		// especially with numerically indexed arrays
237
+		$dependencies += self::$_instance->_dependency_map[ $class ];
238
+		// now we need to ensure that the resulting dependencies
239
+		// array only has the entries that are required for the class
240
+		// so first count how many dependencies were originally registered for the class
241
+		$dependency_count = count(self::$_instance->_dependency_map[ $class ]);
242
+		// if that count is non-zero (meaning dependencies were already registered)
243
+		self::$_instance->_dependency_map[ $class ] = $dependency_count
244
+			// then truncate the  final array to match that count
245
+			? array_slice($dependencies, 0, $dependency_count)
246
+			// otherwise just take the incoming array because nothing previously existed
247
+			: $dependencies;
248
+		return $registered;
249
+	}
250
+
251
+
252
+
253
+	/**
254
+	 * @param string $class_name
255
+	 * @param string $loader
256
+	 * @return bool
257
+	 * @throws DomainException
258
+	 */
259
+	public static function register_class_loader($class_name, $loader = 'load_core')
260
+	{
261
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
262
+			throw new DomainException(
263
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
264
+			);
265
+		}
266
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
267
+		if (
268
+			! is_callable($loader)
269
+			&& (
270
+				strpos($loader, 'load_') !== 0
271
+				|| ! method_exists('EE_Registry', $loader)
272
+			)
273
+		) {
274
+			throw new DomainException(
275
+				sprintf(
276
+					esc_html__(
277
+						'"%1$s" is not a valid loader method on EE_Registry.',
278
+						'event_espresso'
279
+					),
280
+					$loader
281
+				)
282
+			);
283
+		}
284
+		$class_name = self::$_instance->get_alias($class_name);
285
+		if (! isset(self::$_instance->_class_loaders[$class_name])) {
286
+			self::$_instance->_class_loaders[$class_name] = $loader;
287
+			return true;
288
+		}
289
+		return false;
290
+	}
291
+
292
+
293
+
294
+	/**
295
+	 * @return array
296
+	 */
297
+	public function dependency_map()
298
+	{
299
+		return $this->_dependency_map;
300
+	}
301
+
302
+
303
+
304
+	/**
305
+	 * returns TRUE if dependency map contains a listing for the provided class name
306
+	 *
307
+	 * @param string $class_name
308
+	 * @return boolean
309
+	 */
310
+	public function has($class_name = '')
311
+	{
312
+		// all legacy models have the same dependencies
313
+		if (strpos($class_name, 'EEM_') === 0) {
314
+			$class_name = 'LEGACY_MODELS';
315
+		}
316
+		return isset($this->_dependency_map[$class_name]) ? true : false;
317
+	}
318
+
319
+
320
+
321
+	/**
322
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
323
+	 *
324
+	 * @param string $class_name
325
+	 * @param string $dependency
326
+	 * @return bool
327
+	 */
328
+	public function has_dependency_for_class($class_name = '', $dependency = '')
329
+	{
330
+		// all legacy models have the same dependencies
331
+		if (strpos($class_name, 'EEM_') === 0) {
332
+			$class_name = 'LEGACY_MODELS';
333
+		}
334
+		$dependency = $this->get_alias($dependency);
335
+		return isset($this->_dependency_map[$class_name][$dependency])
336
+			? true
337
+			: false;
338
+	}
339
+
340
+
341
+
342
+	/**
343
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
344
+	 *
345
+	 * @param string $class_name
346
+	 * @param string $dependency
347
+	 * @return int
348
+	 */
349
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
350
+	{
351
+		// all legacy models have the same dependencies
352
+		if (strpos($class_name, 'EEM_') === 0) {
353
+			$class_name = 'LEGACY_MODELS';
354
+		}
355
+		$dependency = $this->get_alias($dependency);
356
+		return $this->has_dependency_for_class($class_name, $dependency)
357
+			? $this->_dependency_map[$class_name][$dependency]
358
+			: EE_Dependency_Map::not_registered;
359
+	}
360
+
361
+
362
+
363
+	/**
364
+	 * @param string $class_name
365
+	 * @return string | Closure
366
+	 */
367
+	public function class_loader($class_name)
368
+	{
369
+		// all legacy models use load_model()
370
+		if(strpos($class_name, 'EEM_') === 0){
371
+			return 'load_model';
372
+		}
373
+		$class_name = $this->get_alias($class_name);
374
+		return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
375
+	}
376
+
377
+
378
+
379
+	/**
380
+	 * @return array
381
+	 */
382
+	public function class_loaders()
383
+	{
384
+		return $this->_class_loaders;
385
+	}
386
+
387
+
388
+
389
+	/**
390
+	 * adds an alias for a classname
391
+	 *
392
+	 * @param string $fqcn      the class name that should be used (concrete class to replace interface)
393
+	 * @param string $alias     the class name that would be type hinted for (abstract parent or interface)
394
+	 * @param string $for_class the class that has the dependency (is type hinting for the interface)
395
+	 */
396
+	public function add_alias($fqcn, $alias, $for_class = '')
397
+	{
398
+		$this->class_cache->addAlias($alias, $fqcn, $for_class);
399
+	}
400
+
401
+
402
+
403
+	/**
404
+	 * PLZ NOTE: a better name for this method would be is_alias()
405
+	 * because it returns TRUE if the provided fully qualified name IS an alias
406
+	 *
407
+	 * @param string $fqn
408
+	 * @param string $for_class
409
+	 * @return bool
410
+	 */
411
+	public function has_alias($fqn = '', $for_class = '')
412
+	{
413
+		return $this->class_cache->isAlias($fqn, $for_class);
414
+	}
415
+
416
+
417
+
418
+	/**
419
+	 * PLZ NOTE: a better name for this method would be get_fqn_for_alias()
420
+	 * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias
421
+	 * functions recursively, so that multiple aliases can be used to drill down to a FQN
422
+	 *  for example:
423
+	 *      if the following two entries were added to the _aliases array:
424
+	 *          array(
425
+	 *              'interface_alias'           => 'some\namespace\interface'
426
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
427
+	 *          )
428
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
429
+	 *      to load an instance of 'some\namespace\classname'
430
+	 *
431
+	 * @param string $alias
432
+	 * @param string $for_class
433
+	 * @return string
434
+	 */
435
+	public function get_alias($alias = '', $for_class = '')
436
+	{
437
+		return (string) $this->class_cache->getFqnForAlias($alias, $for_class);
438
+	}
439
+
440
+
441
+
442
+	/**
443
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
444
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
445
+	 * This is done by using the following class constants:
446
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
447
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
448
+	 */
449
+	protected function _register_core_dependencies()
450
+	{
451
+		$this->_dependency_map = array(
452
+			'EE_Request_Handler'                                                                                          => array(
453
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
454
+			),
455
+			'EE_System'                                                                                                   => array(
456
+				'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
457
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
458
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
459
+				'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
460
+			),
461
+			'EE_Session'                                                                                                  => array(
462
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
463
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
464
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
465
+				'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
466
+			),
467
+			'EE_Cart'                                                                                                     => array(
468
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
469
+			),
470
+			'EE_Front_Controller'                                                                                         => array(
471
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
472
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
473
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
474
+			),
475
+			'EE_Messenger_Collection_Loader'                                                                              => array(
476
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
477
+			),
478
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
479
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
480
+			),
481
+			'EE_Message_Resource_Manager'                                                                                 => array(
482
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
483
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
484
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
485
+			),
486
+			'EE_Message_Factory'                                                                                          => array(
487
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
488
+			),
489
+			'EE_messages'                                                                                                 => array(
490
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
491
+			),
492
+			'EE_Messages_Generator'                                                                                       => array(
493
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
494
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
495
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
496
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
497
+			),
498
+			'EE_Messages_Processor'                                                                                       => array(
499
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
500
+			),
501
+			'EE_Messages_Queue'                                                                                           => array(
502
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
503
+			),
504
+			'EE_Messages_Template_Defaults'                                                                               => array(
505
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
506
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
507
+			),
508
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
509
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
510
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
511
+			),
512
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
513
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
514
+			),
515
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
516
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
517
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
518
+			),
519
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
520
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
521
+			),
522
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
523
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
524
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
525
+			),
526
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
527
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
528
+			),
529
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
530
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
531
+			),
532
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
533
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
534
+			),
535
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
536
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
537
+			),
538
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
539
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
540
+			),
541
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
542
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
543
+			),
544
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
545
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
546
+			),
547
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
548
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
549
+			),
550
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
551
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
552
+			),
553
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
554
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
555
+			),
556
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
557
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
558
+			),
559
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
560
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
561
+			),
562
+			'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
563
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
564
+			),
565
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
566
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
567
+			),
568
+			'EE_Data_Migration_Class_Base'                                                                                => array(
569
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
570
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
571
+			),
572
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
573
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
574
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
575
+			),
576
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
577
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
578
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
579
+			),
580
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
581
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
582
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
583
+			),
584
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
585
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
586
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
587
+			),
588
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
589
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
590
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
591
+			),
592
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
593
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
594
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
595
+			),
596
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
597
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
598
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
599
+			),
600
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
601
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
602
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
603
+			),
604
+			'EE_DMS_Core_4_9_0'                                                                                           => array(
605
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
606
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
607
+			),
608
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
609
+				'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
610
+				'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
611
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
612
+			),
613
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
614
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
615
+			),
616
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
617
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
618
+			),
619
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
620
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
621
+			),
622
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
623
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
624
+			),
625
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
626
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
627
+			),
628
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
629
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
630
+			),
631
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
632
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
633
+			),
634
+			'EventEspresso\core\services\cache\BasicCacheManager'                        => array(
635
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
636
+			),
637
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                  => array(
638
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
639
+			),
640
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array(
641
+				'EE_Registration_Config'                                  => EE_Dependency_Map::load_from_cache,
642
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
643
+			),
644
+			'EventEspresso\core\domain\values\EmailAddress'                              => array(
645
+				null,
646
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
647
+			),
648
+			'EventEspresso\core\services\orm\ModelFieldFactory' => array(
649
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
650
+			),
651
+			'LEGACY_MODELS'                                                   => array(
652
+				null,
653
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
654
+			),
655
+			'EE_Module_Request_Router' => array(
656
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
657
+			),
658
+			'EE_Registration_Processor' => array(
659
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
660
+			),
661
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array(
662
+				null,
663
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
664
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
665
+			),
666
+			'EE_Admin_Transactions_List_Table' => array(
667
+				null,
668
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
669
+			),
670
+			'EventEspresso\core\domain\services\admin\ExitModal' => array(
671
+				'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache
672
+			),
673
+			'EventEspresso\core\domain\services\admin\PluginUpsells' => array(
674
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
675
+			),
676
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha' => array(
677
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
678
+				'EE_Session'             => EE_Dependency_Map::load_from_cache,
679
+			),
680
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings' => array(
681
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
682
+			),
683
+			'EventEspresso\core\services\loaders\ObjectIdentifier' => array(
684
+				'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache,
685
+			),
686
+		);
687
+	}
688
+
689
+
690
+	/**
691
+	 * Registers how core classes are loaded.
692
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
693
+	 *        'EE_Request_Handler' => 'load_core'
694
+	 *        'EE_Messages_Queue'  => 'load_lib'
695
+	 *        'EEH_Debug_Tools'    => 'load_helper'
696
+	 * or, if greater control is required, by providing a custom closure. For example:
697
+	 *        'Some_Class' => function () {
698
+	 *            return new Some_Class();
699
+	 *        },
700
+	 * This is required for instantiating dependencies
701
+	 * where an interface has been type hinted in a class constructor. For example:
702
+	 *        'Required_Interface' => function () {
703
+	 *            return new A_Class_That_Implements_Required_Interface();
704
+	 *        },
705
+	 *
706
+	 */
707
+	protected function _register_core_class_loaders()
708
+	{
709
+		//for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
710
+		//be used in a closure.
711
+		$request = &$this->request;
712
+		$response = &$this->response;
713
+		$legacy_request = &$this->legacy_request;
714
+		// $loader = &$this->loader;
715
+		$this->_class_loaders = array(
716
+			//load_core
717
+			'EE_Capabilities'          => 'load_core',
718
+			'EE_Encryption'            => 'load_core',
719
+			'EE_Front_Controller'      => 'load_core',
720
+			'EE_Module_Request_Router' => 'load_core',
721
+			'EE_Registry'              => 'load_core',
722
+			'EE_Request'               => function () use (&$legacy_request) {
723
+				return $legacy_request;
724
+			},
725
+			'EventEspresso\core\services\request\Request' => function () use (&$request) {
726
+				return $request;
727
+			},
728
+			'EventEspresso\core\services\request\Response' => function () use (&$response) {
729
+				return $response;
730
+			},
731
+			'EE_Request_Handler'       => 'load_core',
732
+			'EE_Session'               => 'load_core',
733
+			'EE_Cron_Tasks'            => 'load_core',
734
+			'EE_System'                => 'load_core',
735
+			'EE_Maintenance_Mode'      => 'load_core',
736
+			'EE_Register_CPTs'         => 'load_core',
737
+			'EE_Admin'                 => 'load_core',
738
+			//load_lib
739
+			'EE_Message_Resource_Manager'          => 'load_lib',
740
+			'EE_Message_Type_Collection'           => 'load_lib',
741
+			'EE_Message_Type_Collection_Loader'    => 'load_lib',
742
+			'EE_Messenger_Collection'              => 'load_lib',
743
+			'EE_Messenger_Collection_Loader'       => 'load_lib',
744
+			'EE_Messages_Processor'                => 'load_lib',
745
+			'EE_Message_Repository'                => 'load_lib',
746
+			'EE_Messages_Queue'                    => 'load_lib',
747
+			'EE_Messages_Data_Handler_Collection'  => 'load_lib',
748
+			'EE_Message_Template_Group_Collection' => 'load_lib',
749
+			'EE_Payment_Method_Manager'            => 'load_lib',
750
+			'EE_Messages_Generator'                => function () {
751
+				return EE_Registry::instance()->load_lib(
752
+					'Messages_Generator',
753
+					array(),
754
+					false,
755
+					false
756
+				);
757
+			},
758
+			'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
759
+				return EE_Registry::instance()->load_lib(
760
+					'Messages_Template_Defaults',
761
+					$arguments,
762
+					false,
763
+					false
764
+				);
765
+			},
766
+			//load_model
767
+			// 'EEM_Attendee'                         => 'load_model',
768
+			// 'EEM_Message_Template_Group'           => 'load_model',
769
+			// 'EEM_Message_Template'                 => 'load_model',
770
+			//load_helper
771
+			'EEH_Parse_Shortcodes'                 => function () {
772
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
773
+					return new EEH_Parse_Shortcodes();
774
+				}
775
+				return null;
776
+			},
777
+			'EE_Template_Config'                   => function () {
778
+				return EE_Config::instance()->template_settings;
779
+			},
780
+			'EE_Currency_Config'                   => function () {
781
+				return EE_Config::instance()->currency;
782
+			},
783
+			'EE_Registration_Config'                   => function () {
784
+				return EE_Config::instance()->registration;
785
+			},
786
+			'EventEspresso\core\services\loaders\Loader' => function () {
787
+				return LoaderFactory::getLoader();
788
+			},
789
+			'EE_Base' => 'load_core',
790
+		);
791
+	}
792
+
793
+
794
+
795
+
796
+	/**
797
+	 * can be used for supplying alternate names for classes,
798
+	 * or for connecting interface names to instantiable classes
799
+	 */
800
+	protected function _register_core_aliases()
801
+	{
802
+		$aliases = array(
803
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
804
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
805
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
806
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
807
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
808
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
809
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
810
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
811
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
812
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
813
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
814
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
815
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
816
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
817
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
818
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
819
+			'CreateTransactionCommandHandler'                                     => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
820
+			'CreateAttendeeCommandHandler'                                        => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
821
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
822
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
823
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
824
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
825
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
826
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
827
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
828
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
829
+			'CommandFactoryInterface'                                                     => 'EventEspresso\core\services\commands\CommandFactoryInterface',
830
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                => 'EventEspresso\core\services\commands\CommandFactory',
831
+			'EventEspresso\core\domain\services\session\SessionIdentifierInterface'       => 'EE_Session',
832
+			'EmailValidatorInterface'                                                     => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
833
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
834
+			'NoticeConverterInterface'                                            => 'EventEspresso\core\services\notices\NoticeConverterInterface',
835
+			'EventEspresso\core\services\notices\NoticeConverterInterface'        => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
836
+			'NoticesContainerInterface'                                           => 'EventEspresso\core\services\notices\NoticesContainerInterface',
837
+			'EventEspresso\core\services\notices\NoticesContainerInterface'       => 'EventEspresso\core\services\notices\NoticesContainer',
838
+			'EventEspresso\core\services\request\RequestInterface'                => 'EventEspresso\core\services\request\Request',
839
+			'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
840
+			'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
841
+		);
842
+		foreach ($aliases as $alias => $fqn) {
843
+			$this->class_cache->addAlias($fqn, $alias);
844
+		}
845
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
846
+			$this->class_cache->addAlias(
847
+				'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices',
848
+				'EventEspresso\core\services\notices\NoticeConverterInterface'
849
+			);
850
+		}
851
+	}
852
+
853
+
854
+
855
+	/**
856
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
857
+	 * request Primarily used by unit tests.
858
+	 */
859
+	public function reset()
860
+	{
861
+		$this->_register_core_class_loaders();
862
+		$this->_register_core_dependencies();
863
+	}
864 864
 
865 865
 
866 866
 }
Please login to merge, or discard this patch.