eventespresso /
event-espresso-core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like EE_Registry often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use EE_Registry, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class EE_Registry |
||
| 17 | { |
||
| 18 | |||
| 19 | /** |
||
| 20 | * EE_Registry Object |
||
| 21 | * |
||
| 22 | * @var EE_Registry $_instance |
||
| 23 | * @access private |
||
| 24 | */ |
||
| 25 | private static $_instance = null; |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @var EE_Dependency_Map $_dependency_map |
||
| 29 | * @access protected |
||
| 30 | */ |
||
| 31 | protected $_dependency_map = null; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @var array $_class_abbreviations |
||
| 35 | * @access protected |
||
| 36 | */ |
||
| 37 | protected $_class_abbreviations = array(); |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @access public |
||
| 41 | * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS |
||
| 42 | */ |
||
| 43 | public $BUS; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * EE_Cart Object |
||
| 47 | * |
||
| 48 | * @access public |
||
| 49 | * @var EE_Cart $CART |
||
| 50 | */ |
||
| 51 | public $CART = null; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * EE_Config Object |
||
| 55 | * |
||
| 56 | * @access public |
||
| 57 | * @var EE_Config $CFG |
||
| 58 | */ |
||
| 59 | public $CFG = null; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * EE_Network_Config Object |
||
| 63 | * |
||
| 64 | * @access public |
||
| 65 | * @var EE_Network_Config $NET_CFG |
||
| 66 | */ |
||
| 67 | public $NET_CFG = null; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * StdClass object for storing library classes in |
||
| 71 | * |
||
| 72 | * @public LIB |
||
| 73 | * @var StdClass $LIB |
||
| 74 | */ |
||
| 75 | public $LIB = null; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * EE_Request_Handler Object |
||
| 79 | * |
||
| 80 | * @access public |
||
| 81 | * @var EE_Request_Handler $REQ |
||
| 82 | */ |
||
| 83 | public $REQ = null; |
||
| 84 | |||
| 85 | /** |
||
| 86 | * EE_Session Object |
||
| 87 | * |
||
| 88 | * @access public |
||
| 89 | * @var EE_Session $SSN |
||
| 90 | */ |
||
| 91 | public $SSN = null; |
||
| 92 | |||
| 93 | /** |
||
| 94 | * holds the ee capabilities object. |
||
| 95 | * |
||
| 96 | * @since 4.5.0 |
||
| 97 | * @var EE_Capabilities |
||
| 98 | */ |
||
| 99 | public $CAP = null; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * holds the EE_Message_Resource_Manager object. |
||
| 103 | * |
||
| 104 | * @since 4.9.0 |
||
| 105 | * @var EE_Message_Resource_Manager |
||
| 106 | */ |
||
| 107 | public $MRM = null; |
||
| 108 | |||
| 109 | |||
| 110 | /** |
||
| 111 | * Holds the Assets Registry instance |
||
| 112 | * @var Registry |
||
| 113 | */ |
||
| 114 | public $AssetsRegistry = null; |
||
| 115 | |||
| 116 | /** |
||
| 117 | * StdClass object for holding addons which have registered themselves to work with EE core |
||
| 118 | * |
||
| 119 | * @var StdClass |
||
| 120 | */ |
||
| 121 | public $addons = null; |
||
| 122 | |||
| 123 | /** |
||
| 124 | * $models |
||
| 125 | * @access public |
||
| 126 | * @var EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
||
| 127 | */ |
||
| 128 | public $models = array(); |
||
| 129 | |||
| 130 | /** |
||
| 131 | * $modules |
||
| 132 | * @access public |
||
| 133 | * @var EED_Module[] $modules |
||
| 134 | */ |
||
| 135 | public $modules = null; |
||
| 136 | |||
| 137 | /** |
||
| 138 | * $shortcodes |
||
| 139 | * @access public |
||
| 140 | * @var EES_Shortcode[] $shortcodes |
||
| 141 | */ |
||
| 142 | public $shortcodes = null; |
||
| 143 | |||
| 144 | /** |
||
| 145 | * $widgets |
||
| 146 | * @access public |
||
| 147 | * @var WP_Widget[] $widgets |
||
| 148 | */ |
||
| 149 | public $widgets = null; |
||
| 150 | |||
| 151 | /** |
||
| 152 | * $non_abstract_db_models |
||
| 153 | * @access public |
||
| 154 | * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models |
||
| 155 | * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
||
| 156 | * Keys are model "short names" (eg "Event") as used in model relations, and values are |
||
| 157 | * classnames (eg "EEM_Event") |
||
| 158 | */ |
||
| 159 | public $non_abstract_db_models = array(); |
||
| 160 | |||
| 161 | |||
| 162 | /** |
||
| 163 | * $i18n_js_strings - internationalization for JS strings |
||
| 164 | * usage: EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' ); |
||
| 165 | * in js file: var translatedString = eei18n.string_key; |
||
| 166 | * |
||
| 167 | * @access public |
||
| 168 | * @var array |
||
| 169 | */ |
||
| 170 | public static $i18n_js_strings = array(); |
||
| 171 | |||
| 172 | |||
| 173 | /** |
||
| 174 | * $main_file - path to espresso.php |
||
| 175 | * |
||
| 176 | * @access public |
||
| 177 | * @var array |
||
| 178 | */ |
||
| 179 | public $main_file; |
||
| 180 | |||
| 181 | /** |
||
| 182 | * array of ReflectionClass objects where the key is the class name |
||
| 183 | * |
||
| 184 | * @access public |
||
| 185 | * @var ReflectionClass[] |
||
| 186 | */ |
||
| 187 | public $_reflectors; |
||
| 188 | |||
| 189 | /** |
||
| 190 | * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
||
| 191 | * |
||
| 192 | * @access protected |
||
| 193 | * @var boolean $_cache_on |
||
| 194 | */ |
||
| 195 | protected $_cache_on = true; |
||
| 196 | |||
| 197 | |||
| 198 | |||
| 199 | /** |
||
| 200 | * @singleton method used to instantiate class object |
||
| 201 | * @access public |
||
| 202 | * @param \EE_Dependency_Map $dependency_map |
||
| 203 | * @return \EE_Registry instance |
||
| 204 | */ |
||
| 205 | public static function instance(\EE_Dependency_Map $dependency_map = null) |
||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | /** |
||
| 217 | *protected constructor to prevent direct creation |
||
| 218 | * |
||
| 219 | * @Constructor |
||
| 220 | * @access protected |
||
| 221 | * @param \EE_Dependency_Map $dependency_map |
||
| 222 | */ |
||
| 223 | protected function __construct(\EE_Dependency_Map $dependency_map) |
||
| 224 | { |
||
| 225 | $this->_dependency_map = $dependency_map; |
||
| 226 | $this->LIB = new stdClass(); |
||
| 227 | $this->addons = new stdClass(); |
||
| 228 | $this->modules = new stdClass(); |
||
| 229 | $this->shortcodes = new stdClass(); |
||
| 230 | $this->widgets = new stdClass(); |
||
| 231 | add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
||
| 232 | } |
||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | /** |
||
| 237 | * initialize |
||
| 238 | */ |
||
| 239 | public function initialize() |
||
| 240 | { |
||
| 241 | $this->_class_abbreviations = apply_filters( |
||
| 242 | 'FHEE__EE_Registry____construct___class_abbreviations', |
||
| 243 | array( |
||
| 244 | 'EE_Config' => 'CFG', |
||
| 245 | 'EE_Session' => 'SSN', |
||
| 246 | 'EE_Capabilities' => 'CAP', |
||
| 247 | 'EE_Cart' => 'CART', |
||
| 248 | 'EE_Network_Config' => 'NET_CFG', |
||
| 249 | 'EE_Request_Handler' => 'REQ', |
||
| 250 | 'EE_Message_Resource_Manager' => 'MRM', |
||
| 251 | 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
||
| 252 | 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
||
| 253 | ) |
||
| 254 | ); |
||
| 255 | $this->load_core('Base', array(), true); |
||
| 256 | // add our request and response objects to the cache |
||
| 257 | $request_loader = $this->_dependency_map->class_loader('EE_Request'); |
||
| 258 | $this->_set_cached_class( |
||
| 259 | $request_loader(), |
||
| 260 | 'EE_Request' |
||
| 261 | ); |
||
| 262 | $response_loader = $this->_dependency_map->class_loader('EE_Response'); |
||
| 263 | $this->_set_cached_class( |
||
| 264 | $response_loader(), |
||
| 265 | 'EE_Response' |
||
| 266 | ); |
||
| 267 | add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
||
| 268 | } |
||
| 269 | |||
| 270 | |||
| 271 | |||
| 272 | /** |
||
| 273 | * init |
||
| 274 | * |
||
| 275 | * @access public |
||
| 276 | * @return void |
||
| 277 | */ |
||
| 278 | public function init() |
||
| 279 | { |
||
| 280 | // Get current page protocol |
||
| 281 | $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
||
| 282 | // Output admin-ajax.php URL with same protocol as current page |
||
| 283 | self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
||
| 284 | self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
||
| 285 | } |
||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | /** |
||
| 290 | * localize_i18n_js_strings |
||
| 291 | * |
||
| 292 | * @return string |
||
| 293 | */ |
||
| 294 | public static function localize_i18n_js_strings() |
||
| 295 | { |
||
| 296 | $i18n_js_strings = (array)EE_Registry::$i18n_js_strings; |
||
| 297 | foreach ($i18n_js_strings as $key => $value) { |
||
| 298 | if (is_scalar($value)) { |
||
| 299 | $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
||
| 300 | } |
||
| 301 | } |
||
| 302 | return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
||
| 303 | } |
||
| 304 | |||
| 305 | |||
| 306 | |||
| 307 | /** |
||
| 308 | * @param mixed string | EED_Module $module |
||
| 309 | */ |
||
| 310 | public function add_module($module) |
||
| 311 | { |
||
| 312 | if ($module instanceof EED_Module) { |
||
| 313 | $module_class = get_class($module); |
||
| 314 | $this->modules->{$module_class} = $module; |
||
| 315 | } else { |
||
| 316 | if ( ! class_exists('EE_Module_Request_Router')) { |
||
| 317 | $this->load_core('Module_Request_Router'); |
||
| 318 | } |
||
| 319 | $this->modules->{$module} = EE_Module_Request_Router::module_factory($module); |
||
| 320 | } |
||
| 321 | } |
||
| 322 | |||
| 323 | |||
| 324 | |||
| 325 | /** |
||
| 326 | * @param string $module_name |
||
| 327 | * @return mixed EED_Module | NULL |
||
| 328 | */ |
||
| 329 | public function get_module($module_name = '') |
||
| 330 | { |
||
| 331 | return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null; |
||
| 332 | } |
||
| 333 | |||
| 334 | |||
| 335 | |||
| 336 | /** |
||
| 337 | * loads core classes - must be singletons |
||
| 338 | * |
||
| 339 | * @access public |
||
| 340 | * @param string $class_name - simple class name ie: session |
||
| 341 | * @param mixed $arguments |
||
| 342 | * @param bool $load_only |
||
| 343 | * @return mixed |
||
| 344 | */ |
||
| 345 | public function load_core($class_name, $arguments = array(), $load_only = false) |
||
| 346 | { |
||
| 347 | $core_paths = apply_filters( |
||
| 348 | 'FHEE__EE_Registry__load_core__core_paths', |
||
| 349 | array( |
||
| 350 | EE_CORE, |
||
| 351 | EE_ADMIN, |
||
| 352 | EE_CPTS, |
||
| 353 | EE_CORE . 'data_migration_scripts' . DS, |
||
| 354 | EE_CORE . 'request_stack' . DS, |
||
| 355 | EE_CORE . 'middleware' . DS, |
||
| 356 | ) |
||
| 357 | ); |
||
| 358 | // retrieve instantiated class |
||
| 359 | return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only); |
||
| 360 | } |
||
| 361 | |||
| 362 | |||
| 363 | |||
| 364 | /** |
||
| 365 | * loads service classes |
||
| 366 | * |
||
| 367 | * @access public |
||
| 368 | * @param string $class_name - simple class name ie: session |
||
| 369 | * @param mixed $arguments |
||
| 370 | * @param bool $load_only |
||
| 371 | * @return mixed |
||
| 372 | */ |
||
| 373 | public function load_service($class_name, $arguments = array(), $load_only = false) |
||
| 374 | { |
||
| 375 | $service_paths = apply_filters( |
||
| 376 | 'FHEE__EE_Registry__load_service__service_paths', |
||
| 377 | array( |
||
| 378 | EE_CORE . 'services' . DS, |
||
| 379 | ) |
||
| 380 | ); |
||
| 381 | // retrieve instantiated class |
||
| 382 | return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only); |
||
| 383 | } |
||
| 384 | |||
| 385 | |||
| 386 | |||
| 387 | /** |
||
| 388 | * loads data_migration_scripts |
||
| 389 | * |
||
| 390 | * @access public |
||
| 391 | * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
||
| 392 | * @param mixed $arguments |
||
| 393 | * @return EE_Data_Migration_Script_Base|mixed |
||
| 394 | */ |
||
| 395 | public function load_dms($class_name, $arguments = array()) |
||
| 396 | { |
||
| 397 | // retrieve instantiated class |
||
| 398 | return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false); |
||
| 399 | } |
||
| 400 | |||
| 401 | |||
| 402 | |||
| 403 | /** |
||
| 404 | * loads object creating classes - must be singletons |
||
| 405 | * |
||
| 406 | * @param string $class_name - simple class name ie: attendee |
||
| 407 | * @param mixed $arguments - an array of arguments to pass to the class |
||
| 408 | * @param bool $from_db - some classes are instantiated from the db and thus call a different method to instantiate |
||
| 409 | * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop) |
||
| 410 | * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate (default) |
||
| 411 | * @return EE_Base_Class | bool |
||
| 412 | */ |
||
| 413 | public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
||
| 414 | { |
||
| 415 | $paths = apply_filters('FHEE__EE_Registry__load_class__paths', array( |
||
| 416 | EE_CORE, |
||
| 417 | EE_CLASSES, |
||
| 418 | EE_BUSINESS, |
||
| 419 | )); |
||
| 420 | // retrieve instantiated class |
||
| 421 | return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only); |
||
| 422 | } |
||
| 423 | |||
| 424 | |||
| 425 | |||
| 426 | /** |
||
| 427 | * loads helper classes - must be singletons |
||
| 428 | * |
||
| 429 | * @param string $class_name - simple class name ie: price |
||
| 430 | * @param mixed $arguments |
||
| 431 | * @param bool $load_only |
||
| 432 | * @return EEH_Base | bool |
||
| 433 | */ |
||
| 434 | public function load_helper($class_name, $arguments = array(), $load_only = true) |
||
| 435 | { |
||
| 436 | // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
||
| 437 | $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
||
| 438 | // retrieve instantiated class |
||
| 439 | return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only); |
||
| 440 | } |
||
| 441 | |||
| 442 | |||
| 443 | |||
| 444 | /** |
||
| 445 | * loads core classes - must be singletons |
||
| 446 | * |
||
| 447 | * @access public |
||
| 448 | * @param string $class_name - simple class name ie: session |
||
| 449 | * @param mixed $arguments |
||
| 450 | * @param bool $load_only |
||
| 451 | * @param bool $cache whether to cache the object or not. |
||
| 452 | * @return mixed |
||
| 453 | */ |
||
| 454 | public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
||
| 455 | { |
||
| 456 | $paths = array( |
||
| 457 | EE_LIBRARIES, |
||
| 458 | EE_LIBRARIES . 'messages' . DS, |
||
| 459 | EE_LIBRARIES . 'shortcodes' . DS, |
||
| 460 | EE_LIBRARIES . 'qtips' . DS, |
||
| 461 | EE_LIBRARIES . 'payment_methods' . DS, |
||
| 462 | ); |
||
| 463 | // retrieve instantiated class |
||
| 464 | return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only); |
||
| 465 | } |
||
| 466 | |||
| 467 | |||
| 468 | |||
| 469 | /** |
||
| 470 | * loads model classes - must be singletons |
||
| 471 | * |
||
| 472 | * @param string $class_name - simple class name ie: price |
||
| 473 | * @param mixed $arguments |
||
| 474 | * @param bool $load_only |
||
| 475 | * @return EEM_Base | bool |
||
| 476 | */ |
||
| 477 | public function load_model($class_name, $arguments = array(), $load_only = false) |
||
| 478 | { |
||
| 479 | $paths = apply_filters('FHEE__EE_Registry__load_model__paths', array( |
||
| 480 | EE_MODELS, |
||
| 481 | EE_CORE, |
||
| 482 | )); |
||
| 483 | // retrieve instantiated class |
||
| 484 | return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only); |
||
| 485 | } |
||
| 486 | |||
| 487 | |||
| 488 | |||
| 489 | /** |
||
| 490 | * loads model classes - must be singletons |
||
| 491 | * |
||
| 492 | * @param string $class_name - simple class name ie: price |
||
| 493 | * @param mixed $arguments |
||
| 494 | * @param bool $load_only |
||
| 495 | * @return mixed | bool |
||
| 496 | */ |
||
| 497 | public function load_model_class($class_name, $arguments = array(), $load_only = true) |
||
| 498 | { |
||
| 499 | $paths = array( |
||
| 500 | EE_MODELS . 'fields' . DS, |
||
| 501 | EE_MODELS . 'helpers' . DS, |
||
| 502 | EE_MODELS . 'relations' . DS, |
||
| 503 | EE_MODELS . 'strategies' . DS, |
||
| 504 | ); |
||
| 505 | // retrieve instantiated class |
||
| 506 | return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only); |
||
| 507 | } |
||
| 508 | |||
| 509 | |||
| 510 | |||
| 511 | /** |
||
| 512 | * Determines if $model_name is the name of an actual EE model. |
||
| 513 | * |
||
| 514 | * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
||
| 515 | * @return boolean |
||
| 516 | */ |
||
| 517 | public function is_model_name($model_name) |
||
| 518 | { |
||
| 519 | return isset($this->models[$model_name]) ? true : false; |
||
| 520 | } |
||
| 521 | |||
| 522 | |||
| 523 | |||
| 524 | /** |
||
| 525 | * generic class loader |
||
| 526 | * |
||
| 527 | * @param string $path_to_file - directory path to file location, not including filename |
||
| 528 | * @param string $file_name - file name ie: my_file.php, including extension |
||
| 529 | * @param string $type - file type - core? class? helper? model? |
||
| 530 | * @param mixed $arguments |
||
| 531 | * @param bool $load_only |
||
| 532 | * @return mixed |
||
| 533 | */ |
||
| 534 | public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
||
| 535 | { |
||
| 536 | // retrieve instantiated class |
||
| 537 | return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only); |
||
| 538 | } |
||
| 539 | |||
| 540 | |||
| 541 | |||
| 542 | /** |
||
| 543 | * load_addon |
||
| 544 | * |
||
| 545 | * @param string $path_to_file - directory path to file location, not including filename |
||
| 546 | * @param string $class_name - full class name ie: My_Class |
||
| 547 | * @param string $type - file type - core? class? helper? model? |
||
| 548 | * @param mixed $arguments |
||
| 549 | * @param bool $load_only |
||
| 550 | * @return EE_Addon |
||
| 551 | */ |
||
| 552 | public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
||
| 553 | { |
||
| 554 | // retrieve instantiated class |
||
| 555 | return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only); |
||
| 556 | } |
||
| 557 | |||
| 558 | |||
| 559 | |||
| 560 | /** |
||
| 561 | * instantiates, caches, and automatically resolves dependencies |
||
| 562 | * for classes that use a Fully Qualified Class Name. |
||
| 563 | * if the class is not capable of being loaded using PSR-4 autoloading, |
||
| 564 | * then you need to use one of the existing load_*() methods |
||
| 565 | * which can resolve the classname and filepath from the passed arguments |
||
| 566 | * |
||
| 567 | * @param bool|string $class_name Fully Qualified Class Name |
||
| 568 | * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
||
| 569 | * @param bool $cache whether to cache the instantiated object for reuse |
||
| 570 | * @param bool $from_db some classes are instantiated from the db |
||
| 571 | * and thus call a different method to instantiate |
||
| 572 | * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
||
| 573 | * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
||
| 574 | * @return mixed null = failure to load or instantiate class object. |
||
| 575 | * object = class loaded and instantiated successfully. |
||
| 576 | * bool = fail or success when $load_only is true |
||
| 577 | * @throws EE_Error |
||
| 578 | */ |
||
| 579 | public function create( |
||
| 580 | $class_name = false, |
||
| 581 | $arguments = array(), |
||
| 582 | $cache = false, |
||
| 583 | $from_db = false, |
||
| 584 | $load_only = false, |
||
| 585 | $addon = false |
||
| 586 | ) { |
||
| 587 | $class_name = ltrim($class_name, '\\'); |
||
| 588 | $class_name = $this->_dependency_map->get_alias($class_name); |
||
| 589 | $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments); |
||
| 590 | // if a non-FQCN was passed, then verifyClassExists() might return an object |
||
| 591 | // or it could return null if the class just could not be found anywhere |
||
| 592 | if ($class_exists instanceof $class_name || $class_exists === null){ |
||
| 593 | // either way, return the results |
||
| 594 | return $class_exists; |
||
| 595 | } |
||
| 596 | $class_name = $class_exists; |
||
| 597 | // if we're only loading the class and it already exists, then let's just return true immediately |
||
| 598 | if ($load_only) { |
||
| 599 | return true; |
||
| 600 | } |
||
| 601 | $addon = $addon ? 'addon' : ''; |
||
| 602 | // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
||
| 603 | // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
||
| 604 | // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
||
| 605 | View Code Duplication | if ($this->_cache_on && $cache && ! $load_only) { |
|
| 606 | // return object if it's already cached |
||
| 607 | $cached_class = $this->_get_cached_class($class_name, $addon); |
||
| 608 | if ($cached_class !== null) { |
||
| 609 | return $cached_class; |
||
| 610 | } |
||
| 611 | } |
||
| 612 | // instantiate the requested object |
||
| 613 | $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
||
| 614 | // if caching is turned on OR this class is cached in a class property |
||
| 615 | if (($this->_cache_on && $cache) || isset($this->_class_abbreviations[ $class_name ])) { |
||
| 616 | // save it for later... kinda like gum { : $ |
||
| 617 | $this->_set_cached_class($class_obj, $class_name, $addon, $from_db); |
||
| 618 | } |
||
| 619 | $this->_cache_on = true; |
||
| 620 | return $class_obj; |
||
| 621 | } |
||
| 622 | |||
| 623 | |||
| 624 | |||
| 625 | /** |
||
| 626 | * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs |
||
| 627 | * |
||
| 628 | * @param string $class_name |
||
| 629 | * @param array $arguments |
||
| 630 | * @param int $attempt |
||
| 631 | * @return mixed |
||
| 632 | */ |
||
| 633 | private function loadOrVerifyClassExists($class_name, array $arguments, $attempt = 1) { |
||
| 634 | if (is_object($class_name) || class_exists($class_name)) { |
||
| 635 | return $class_name; |
||
| 636 | } |
||
| 637 | switch ($attempt) { |
||
| 638 | case 1: |
||
| 639 | // if it's a FQCN then maybe the class is registered with a preceding \ |
||
| 640 | $class_name = strpos($class_name, '\\') !== false |
||
| 641 | ? '\\' . ltrim($class_name, '\\') |
||
| 642 | : $class_name; |
||
| 643 | break; |
||
| 644 | case 2: |
||
| 645 | // |
||
| 646 | $loader = $this->_dependency_map->class_loader($class_name); |
||
| 647 | if ($loader && method_exists($this, $loader)) { |
||
| 648 | return $this->{$loader}($class_name, $arguments); |
||
| 649 | } |
||
| 650 | break; |
||
| 651 | case 3: |
||
| 652 | default; |
||
| 653 | return null; |
||
| 654 | } |
||
| 655 | $attempt++; |
||
| 656 | return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt); |
||
| 657 | } |
||
| 658 | |||
| 659 | |||
| 660 | |||
| 661 | /** |
||
| 662 | * instantiates, caches, and injects dependencies for classes |
||
| 663 | * |
||
| 664 | * @param array $file_paths an array of paths to folders to look in |
||
| 665 | * @param string $class_prefix EE or EEM or... ??? |
||
| 666 | * @param bool|string $class_name $class name |
||
| 667 | * @param string $type file type - core? class? helper? model? |
||
| 668 | * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
||
| 669 | * @param bool $from_db some classes are instantiated from the db |
||
| 670 | * and thus call a different method to instantiate |
||
| 671 | * @param bool $cache whether to cache the instantiated object for reuse |
||
| 672 | * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
||
| 673 | * @return bool|null|object null = failure to load or instantiate class object. |
||
| 674 | * object = class loaded and instantiated successfully. |
||
| 675 | * bool = fail or success when $load_only is true |
||
| 676 | * @throws EE_Error |
||
| 677 | */ |
||
| 678 | protected function _load( |
||
| 735 | |||
| 736 | |||
| 737 | |||
| 738 | |||
| 739 | /** |
||
| 740 | * _get_cached_class |
||
| 741 | * attempts to find a cached version of the requested class |
||
| 742 | * by looking in the following places: |
||
| 743 | * $this->{$class_abbreviation} ie: $this->CART |
||
| 744 | * $this->{$class_name} ie: $this->Some_Class |
||
| 745 | * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
||
| 746 | * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
||
| 747 | * |
||
| 748 | * @access protected |
||
| 749 | * @param string $class_name |
||
| 750 | * @param string $class_prefix |
||
| 751 | * @return mixed |
||
| 752 | */ |
||
| 753 | protected function _get_cached_class($class_name, $class_prefix = '') |
||
| 775 | |||
| 776 | |||
| 777 | |||
| 778 | /** |
||
| 779 | * removes a cached version of the requested class |
||
| 780 | * |
||
| 781 | * @param string $class_name |
||
| 782 | * @param boolean $addon |
||
| 783 | * @return boolean |
||
| 784 | */ |
||
| 785 | public function clear_cached_class($class_name, $addon = false) |
||
| 811 | |||
| 812 | |||
| 813 | /** |
||
| 814 | * _resolve_path |
||
| 815 | * attempts to find a full valid filepath for the requested class. |
||
| 816 | * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
||
| 817 | * then returns that path if the target file has been found and is readable |
||
| 818 | * |
||
| 819 | * @access protected |
||
| 820 | * @param string $class_name |
||
| 821 | * @param string $type |
||
| 822 | * @param array $file_paths |
||
| 823 | * @return string | bool |
||
| 824 | */ |
||
| 825 | protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
||
| 844 | |||
| 845 | |||
| 846 | |||
| 847 | /** |
||
| 848 | * _require_file |
||
| 849 | * basically just performs a require_once() |
||
| 850 | * but with some error handling |
||
| 851 | * |
||
| 852 | * @access protected |
||
| 853 | * @param string $path |
||
| 854 | * @param string $class_name |
||
| 855 | * @param string $type |
||
| 856 | * @param array $file_paths |
||
| 857 | * @return boolean |
||
| 858 | * @throws \EE_Error |
||
| 859 | */ |
||
| 860 | protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
||
| 896 | |||
| 897 | |||
| 898 | |||
| 899 | /** |
||
| 900 | * _create_object |
||
| 901 | * Attempts to instantiate the requested class via any of the |
||
| 902 | * commonly used instantiation methods employed throughout EE. |
||
| 903 | * The priority for instantiation is as follows: |
||
| 904 | * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
||
| 905 | * - model objects via their 'new_instance_from_db' method |
||
| 906 | * - model objects via their 'new_instance' method |
||
| 907 | * - "singleton" classes" via their 'instance' method |
||
| 908 | * - standard instantiable classes via their __constructor |
||
| 909 | * Prior to instantiation, if the classname exists in the dependency_map, |
||
| 910 | * then the constructor for the requested class will be examined to determine |
||
| 911 | * if any dependencies exist, and if they can be injected. |
||
| 912 | * If so, then those classes will be added to the array of arguments passed to the constructor |
||
| 913 | * |
||
| 914 | * @access protected |
||
| 915 | * @param string $class_name |
||
| 916 | * @param array $arguments |
||
| 917 | * @param string $type |
||
| 918 | * @param bool $from_db |
||
| 919 | * @return null | object |
||
| 920 | * @throws \EE_Error |
||
| 921 | */ |
||
| 922 | protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
||
| 989 | |||
| 990 | |||
| 991 | |||
| 992 | /** |
||
| 993 | * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
||
| 994 | * @param array $array |
||
| 995 | * @return bool |
||
| 996 | */ |
||
| 997 | protected function _array_is_numerically_and_sequentially_indexed(array $array) |
||
| 1001 | |||
| 1002 | |||
| 1003 | |||
| 1004 | /** |
||
| 1005 | * getReflectionClass |
||
| 1006 | * checks if a ReflectionClass object has already been generated for a class |
||
| 1007 | * and returns that instead of creating a new one |
||
| 1008 | * |
||
| 1009 | * @access public |
||
| 1010 | * @param string $class_name |
||
| 1011 | * @return ReflectionClass |
||
| 1012 | */ |
||
| 1013 | View Code Duplication | public function get_ReflectionClass($class_name) |
|
| 1023 | |||
| 1024 | |||
| 1025 | |||
| 1026 | /** |
||
| 1027 | * _resolve_dependencies |
||
| 1028 | * examines the constructor for the requested class to determine |
||
| 1029 | * if any dependencies exist, and if they can be injected. |
||
| 1030 | * If so, then those classes will be added to the array of arguments passed to the constructor |
||
| 1031 | * PLZ NOTE: this is achieved by type hinting the constructor params |
||
| 1032 | * For example: |
||
| 1033 | * if attempting to load a class "Foo" with the following constructor: |
||
| 1034 | * __construct( Bar $bar_class, Fighter $grohl_class ) |
||
| 1035 | * then $bar_class and $grohl_class will be added to the $arguments array, |
||
| 1036 | * but only IF they are NOT already present in the incoming arguments array, |
||
| 1037 | * and the correct classes can be loaded |
||
| 1038 | * |
||
| 1039 | * @access protected |
||
| 1040 | * @param ReflectionClass $reflector |
||
| 1041 | * @param string $class_name |
||
| 1042 | * @param array $arguments |
||
| 1043 | * @return array |
||
| 1044 | * @throws \ReflectionException |
||
| 1045 | */ |
||
| 1046 | protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array()) |
||
| 1106 | |||
| 1107 | |||
| 1108 | |||
| 1109 | /** |
||
| 1110 | * @access protected |
||
| 1111 | * @param string $class_name |
||
| 1112 | * @param string $param_class |
||
| 1113 | * @param array $arguments |
||
| 1114 | * @param mixed $index |
||
| 1115 | * @return array |
||
| 1116 | */ |
||
| 1117 | protected function _resolve_dependency($class_name, $param_class, $arguments, $index) |
||
| 1159 | |||
| 1160 | |||
| 1161 | |||
| 1162 | /** |
||
| 1163 | * _set_cached_class |
||
| 1164 | * attempts to cache the instantiated class locally |
||
| 1165 | * in one of the following places, in the following order: |
||
| 1166 | * $this->{class_abbreviation} ie: $this->CART |
||
| 1167 | * $this->{$class_name} ie: $this->Some_Class |
||
| 1168 | * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
||
| 1169 | * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
||
| 1170 | * |
||
| 1171 | * @access protected |
||
| 1172 | * @param object $class_obj |
||
| 1173 | * @param string $class_name |
||
| 1174 | * @param string $class_prefix |
||
| 1175 | * @param bool $from_db |
||
| 1176 | * @return void |
||
| 1177 | */ |
||
| 1178 | protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false) |
||
| 1202 | |||
| 1203 | |||
| 1204 | |||
| 1205 | /** |
||
| 1206 | * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
||
| 1207 | * |
||
| 1208 | * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
||
| 1209 | * in the EE_Dependency_Map::$_class_loaders array, |
||
| 1210 | * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
||
| 1211 | * @param array $arguments |
||
| 1212 | * @return object |
||
| 1213 | */ |
||
| 1214 | public static function factory($classname, $arguments = array()) |
||
| 1225 | |||
| 1226 | |||
| 1227 | |||
| 1228 | /** |
||
| 1229 | * Gets the addon by its name/slug (not classname. For that, just |
||
| 1230 | * use the classname as the property name on EE_Config::instance()->addons) |
||
| 1231 | * |
||
| 1232 | * @param string $name |
||
| 1233 | * @return EE_Addon |
||
| 1234 | */ |
||
| 1235 | public function get_addon_by_name($name) |
||
| 1244 | |||
| 1245 | |||
| 1246 | |||
| 1247 | /** |
||
| 1248 | * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is |
||
| 1249 | * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname} |
||
| 1250 | * |
||
| 1251 | * @return EE_Addon[] where the KEYS are the addon's name() |
||
| 1252 | */ |
||
| 1253 | public function get_addons_by_name() |
||
| 1261 | |||
| 1262 | |||
| 1263 | |||
| 1264 | /** |
||
| 1265 | * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
||
| 1266 | * a stale copy of it around |
||
| 1267 | * |
||
| 1268 | * @param string $model_name |
||
| 1269 | * @return \EEM_Base |
||
| 1270 | * @throws \EE_Error |
||
| 1271 | */ |
||
| 1272 | public function reset_model($model_name) |
||
| 1286 | |||
| 1287 | |||
| 1288 | |||
| 1289 | /** |
||
| 1290 | * Resets the registry. |
||
| 1291 | * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog |
||
| 1292 | * is used in a multisite install. Here is a list of things that are NOT reset. |
||
| 1293 | * - $_dependency_map |
||
| 1294 | * - $_class_abbreviations |
||
| 1295 | * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
||
| 1296 | * - $REQ: Still on the same request so no need to change. |
||
| 1297 | * - $CAP: There is no site specific state in the EE_Capability class. |
||
| 1298 | * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session |
||
| 1299 | * can be active in a single request. Resetting could resolve in "headers already sent" errors. |
||
| 1300 | * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
||
| 1301 | * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
||
| 1302 | * switch or on the restore. |
||
| 1303 | * - $modules |
||
| 1304 | * - $shortcodes |
||
| 1305 | * - $widgets |
||
| 1306 | * |
||
| 1307 | * @param boolean $hard whether to reset data in the database too, or just refresh |
||
| 1308 | * the Registry to its state at the beginning of the request |
||
| 1309 | * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
||
| 1310 | * or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN |
||
| 1311 | * currently reinstantiate the singletons at the moment) |
||
| 1312 | * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so client |
||
| 1313 | * code instead can just change the model context to a different blog id if necessary |
||
| 1314 | * @return EE_Registry |
||
| 1315 | */ |
||
| 1316 | public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
||
| 1337 | |||
| 1338 | |||
| 1339 | |||
| 1340 | /** |
||
| 1341 | * @override magic methods |
||
| 1342 | * @return void |
||
| 1343 | */ |
||
| 1344 | public final function __destruct() |
||
| 1347 | |||
| 1348 | |||
| 1349 | |||
| 1350 | /** |
||
| 1351 | * @param $a |
||
| 1352 | * @param $b |
||
| 1353 | */ |
||
| 1354 | public final function __call($a, $b) |
||
| 1357 | |||
| 1358 | |||
| 1359 | |||
| 1360 | /** |
||
| 1361 | * @param $a |
||
| 1362 | */ |
||
| 1363 | public final function __get($a) |
||
| 1366 | |||
| 1367 | |||
| 1368 | |||
| 1369 | /** |
||
| 1370 | * @param $a |
||
| 1371 | * @param $b |
||
| 1372 | */ |
||
| 1373 | public final function __set($a, $b) |
||
| 1376 | |||
| 1377 | |||
| 1378 | |||
| 1379 | /** |
||
| 1380 | * @param $a |
||
| 1381 | */ |
||
| 1382 | public final function __isset($a) |
||
| 1385 | |||
| 1386 | |||
| 1387 | |||
| 1388 | /** |
||
| 1389 | * @param $a |
||
| 1390 | */ |
||
| 1391 | public final function __unset($a) |
||
| 1394 | |||
| 1395 | |||
| 1396 | |||
| 1397 | /** |
||
| 1398 | * @return array |
||
| 1399 | */ |
||
| 1400 | public final function __sleep() |
||
| 1404 | |||
| 1405 | |||
| 1406 | |||
| 1407 | public final function __wakeup() |
||
| 1410 | |||
| 1411 | |||
| 1412 | |||
| 1413 | /** |
||
| 1414 | * @return string |
||
| 1415 | */ |
||
| 1416 | public final function __toString() |
||
| 1420 | |||
| 1421 | |||
| 1422 | |||
| 1423 | public final function __invoke() |
||
| 1426 | |||
| 1427 | |||
| 1428 | |||
| 1429 | public final static function __set_state($array = array()) |
||
| 1433 | |||
| 1434 | |||
| 1435 | |||
| 1436 | public final function __clone() |
||
| 1439 | |||
| 1440 | |||
| 1441 | |||
| 1442 | /** |
||
| 1443 | * @param $a |
||
| 1444 | * @param $b |
||
| 1445 | */ |
||
| 1446 | public final static function __callStatic($a, $b) |
||
| 1449 | |||
| 1450 | |||
| 1451 | |||
| 1452 | /** |
||
| 1453 | * Gets all the custom post type models defined |
||
| 1454 | * |
||
| 1455 | * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
||
| 1456 | */ |
||
| 1457 | public function cpt_models() |
||
| 1467 | |||
| 1468 | |||
| 1469 | |||
| 1470 | /** |
||
| 1471 | * @return \EE_Config |
||
| 1472 | */ |
||
| 1473 | public static function CFG() |
||
| 1477 | |||
| 1478 | |||
| 1479 | } |
||
| 1480 | // End of file EE_Registry.core.php |
||
| 1481 | // Location: ./core/EE_Registry.core.php |
||
| 1482 |
Loading history...
It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null.
We recommend to add an additional type check (or disallow null for the parameter):