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