@@ -14,15 +14,15 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class EspressoEventEditorEdit extends RouteMatchSpecification |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * returns true if current request matches specification |
|
| 19 | - * |
|
| 20 | - * @since $VID:$ |
|
| 21 | - * @return boolean |
|
| 22 | - */ |
|
| 23 | - public function isMatchingRoute() |
|
| 24 | - { |
|
| 25 | - return $this->request->getRequestParam('page') === 'espresso_events' |
|
| 26 | - && $this->request->getRequestParam('action') === 'edit'; |
|
| 27 | - } |
|
| 17 | + /** |
|
| 18 | + * returns true if current request matches specification |
|
| 19 | + * |
|
| 20 | + * @since $VID:$ |
|
| 21 | + * @return boolean |
|
| 22 | + */ |
|
| 23 | + public function isMatchingRoute() |
|
| 24 | + { |
|
| 25 | + return $this->request->getRequestParam('page') === 'espresso_events' |
|
| 26 | + && $this->request->getRequestParam('action') === 'edit'; |
|
| 27 | + } |
|
| 28 | 28 | } |
@@ -27,1292 +27,1292 @@ |
||
| 27 | 27 | final class EE_System implements ResettableInterface |
| 28 | 28 | { |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
| 32 | - * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
| 33 | - */ |
|
| 34 | - const req_type_normal = 0; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * Indicates this is a brand new installation of EE so we should install |
|
| 38 | - * tables and default data etc |
|
| 39 | - */ |
|
| 40 | - const req_type_new_activation = 1; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
| 44 | - * and we just exited maintenance mode). We MUST check the database is setup properly |
|
| 45 | - * and that default data is setup too |
|
| 46 | - */ |
|
| 47 | - const req_type_reactivation = 2; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * indicates that EE has been upgraded since its previous request. |
|
| 51 | - * We may have data migration scripts to call and will want to trigger maintenance mode |
|
| 52 | - */ |
|
| 53 | - const req_type_upgrade = 3; |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
| 57 | - */ |
|
| 58 | - const req_type_downgrade = 4; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * @deprecated since version 4.6.0.dev.006 |
|
| 62 | - * Now whenever a new_activation is detected the request type is still just |
|
| 63 | - * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
| 64 | - * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
| 65 | - * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
| 66 | - * (Specifically, when the migration manager indicates migrations are finished |
|
| 67 | - * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
| 68 | - */ |
|
| 69 | - const req_type_activation_but_not_installed = 5; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
| 73 | - */ |
|
| 74 | - const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * @var EE_System $_instance |
|
| 78 | - */ |
|
| 79 | - private static $_instance; |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @var EE_Registry $registry |
|
| 83 | - */ |
|
| 84 | - private $registry; |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * @var LoaderInterface $loader |
|
| 88 | - */ |
|
| 89 | - private $loader; |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * @var EE_Capabilities $capabilities |
|
| 93 | - */ |
|
| 94 | - private $capabilities; |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * @var RequestInterface $request |
|
| 98 | - */ |
|
| 99 | - private $request; |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * @var EE_Maintenance_Mode $maintenance_mode |
|
| 103 | - */ |
|
| 104 | - private $maintenance_mode; |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
| 108 | - * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
| 109 | - * |
|
| 110 | - * @var int $_req_type |
|
| 111 | - */ |
|
| 112 | - private $_req_type; |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * Whether or not there was a non-micro version change in EE core version during this request |
|
| 116 | - * |
|
| 117 | - * @var boolean $_major_version_change |
|
| 118 | - */ |
|
| 119 | - private $_major_version_change = false; |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * A Context DTO dedicated solely to identifying the current request type. |
|
| 123 | - * |
|
| 124 | - * @var RequestTypeContextCheckerInterface $request_type |
|
| 125 | - */ |
|
| 126 | - private $request_type; |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * @singleton method used to instantiate class object |
|
| 131 | - * @param EE_Registry|null $registry |
|
| 132 | - * @param LoaderInterface|null $loader |
|
| 133 | - * @param RequestInterface|null $request |
|
| 134 | - * @param EE_Maintenance_Mode|null $maintenance_mode |
|
| 135 | - * @return EE_System |
|
| 136 | - */ |
|
| 137 | - public static function instance( |
|
| 138 | - EE_Registry $registry = null, |
|
| 139 | - LoaderInterface $loader = null, |
|
| 140 | - RequestInterface $request = null, |
|
| 141 | - EE_Maintenance_Mode $maintenance_mode = null |
|
| 142 | - ) { |
|
| 143 | - // check if class object is instantiated |
|
| 144 | - if (! self::$_instance instanceof EE_System) { |
|
| 145 | - self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
| 146 | - } |
|
| 147 | - return self::$_instance; |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * resets the instance and returns it |
|
| 153 | - * |
|
| 154 | - * @return EE_System |
|
| 155 | - */ |
|
| 156 | - public static function reset() |
|
| 157 | - { |
|
| 158 | - self::$_instance->_req_type = null; |
|
| 159 | - // make sure none of the old hooks are left hanging around |
|
| 160 | - remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
| 161 | - // we need to reset the migration manager in order for it to detect DMSs properly |
|
| 162 | - EE_Data_Migration_Manager::reset(); |
|
| 163 | - self::instance()->detect_activations_or_upgrades(); |
|
| 164 | - self::instance()->perform_activations_upgrades_and_migrations(); |
|
| 165 | - return self::instance(); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * sets hooks for running rest of system |
|
| 171 | - * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
| 172 | - * starting EE Addons from any other point may lead to problems |
|
| 173 | - * |
|
| 174 | - * @param EE_Registry $registry |
|
| 175 | - * @param LoaderInterface $loader |
|
| 176 | - * @param RequestInterface $request |
|
| 177 | - * @param EE_Maintenance_Mode $maintenance_mode |
|
| 178 | - */ |
|
| 179 | - private function __construct( |
|
| 180 | - EE_Registry $registry, |
|
| 181 | - LoaderInterface $loader, |
|
| 182 | - RequestInterface $request, |
|
| 183 | - EE_Maintenance_Mode $maintenance_mode |
|
| 184 | - ) { |
|
| 185 | - $this->registry = $registry; |
|
| 186 | - $this->loader = $loader; |
|
| 187 | - $this->request = $request; |
|
| 188 | - $this->maintenance_mode = $maintenance_mode; |
|
| 189 | - do_action('AHEE__EE_System__construct__begin', $this); |
|
| 190 | - add_action( |
|
| 191 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 192 | - array($this, 'loadCapabilities'), |
|
| 193 | - 5 |
|
| 194 | - ); |
|
| 195 | - add_action( |
|
| 196 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 197 | - array($this, 'loadCommandBus'), |
|
| 198 | - 7 |
|
| 199 | - ); |
|
| 200 | - add_action( |
|
| 201 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 202 | - array($this, 'loadPluginApi'), |
|
| 203 | - 9 |
|
| 204 | - ); |
|
| 205 | - // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
| 206 | - add_action( |
|
| 207 | - 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 208 | - array($this, 'load_espresso_addons') |
|
| 209 | - ); |
|
| 210 | - // when an ee addon is activated, we want to call the core hook(s) again |
|
| 211 | - // because the newly-activated addon didn't get a chance to run at all |
|
| 212 | - add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
| 213 | - // detect whether install or upgrade |
|
| 214 | - add_action( |
|
| 215 | - 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
| 216 | - array($this, 'detect_activations_or_upgrades'), |
|
| 217 | - 3 |
|
| 218 | - ); |
|
| 219 | - // load EE_Config, EE_Textdomain, etc |
|
| 220 | - add_action( |
|
| 221 | - 'AHEE__EE_Bootstrap__load_core_configuration', |
|
| 222 | - array($this, 'load_core_configuration'), |
|
| 223 | - 5 |
|
| 224 | - ); |
|
| 225 | - // load specifications for matching routes to current request |
|
| 226 | - add_action( |
|
| 227 | - 'AHEE__EE_Bootstrap__load_core_configuration', |
|
| 228 | - array($this, 'loadRouteMatchSpecifications') |
|
| 229 | - ); |
|
| 230 | - // load EE_Config, EE_Textdomain, etc |
|
| 231 | - add_action( |
|
| 232 | - 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
| 233 | - array($this, 'register_shortcodes_modules_and_widgets'), |
|
| 234 | - 7 |
|
| 235 | - ); |
|
| 236 | - // you wanna get going? I wanna get going... let's get going! |
|
| 237 | - add_action( |
|
| 238 | - 'AHEE__EE_Bootstrap__brew_espresso', |
|
| 239 | - array($this, 'brew_espresso'), |
|
| 240 | - 9 |
|
| 241 | - ); |
|
| 242 | - // other housekeeping |
|
| 243 | - // exclude EE critical pages from wp_list_pages |
|
| 244 | - add_filter( |
|
| 245 | - 'wp_list_pages_excludes', |
|
| 246 | - array($this, 'remove_pages_from_wp_list_pages'), |
|
| 247 | - 10 |
|
| 248 | - ); |
|
| 249 | - // ALL EE Addons should use the following hook point to attach their initial setup too |
|
| 250 | - // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
| 251 | - do_action('AHEE__EE_System__construct__complete', $this); |
|
| 252 | - } |
|
| 253 | - |
|
| 254 | - |
|
| 255 | - /** |
|
| 256 | - * load and setup EE_Capabilities |
|
| 257 | - * |
|
| 258 | - * @return void |
|
| 259 | - * @throws EE_Error |
|
| 260 | - */ |
|
| 261 | - public function loadCapabilities() |
|
| 262 | - { |
|
| 263 | - $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
| 264 | - add_action( |
|
| 265 | - 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
| 266 | - function () { |
|
| 267 | - LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
| 268 | - } |
|
| 269 | - ); |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - |
|
| 273 | - /** |
|
| 274 | - * create and cache the CommandBus, and also add middleware |
|
| 275 | - * The CapChecker middleware requires the use of EE_Capabilities |
|
| 276 | - * which is why we need to load the CommandBus after Caps are set up |
|
| 277 | - * |
|
| 278 | - * @return void |
|
| 279 | - * @throws EE_Error |
|
| 280 | - */ |
|
| 281 | - public function loadCommandBus() |
|
| 282 | - { |
|
| 283 | - $this->loader->getShared( |
|
| 284 | - 'CommandBusInterface', |
|
| 285 | - array( |
|
| 286 | - null, |
|
| 287 | - apply_filters( |
|
| 288 | - 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
| 289 | - array( |
|
| 290 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
| 291 | - $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
| 292 | - ) |
|
| 293 | - ), |
|
| 294 | - ) |
|
| 295 | - ); |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - |
|
| 299 | - /** |
|
| 300 | - * @return void |
|
| 301 | - * @throws EE_Error |
|
| 302 | - */ |
|
| 303 | - public function loadPluginApi() |
|
| 304 | - { |
|
| 305 | - // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
| 306 | - // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
| 307 | - EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
| 308 | - $this->loader->getShared('EE_Request_Handler'); |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - |
|
| 312 | - /** |
|
| 313 | - * @param string $addon_name |
|
| 314 | - * @param string $version_constant |
|
| 315 | - * @param string $min_version_required |
|
| 316 | - * @param string $load_callback |
|
| 317 | - * @param string $plugin_file_constant |
|
| 318 | - * @return void |
|
| 319 | - */ |
|
| 320 | - private function deactivateIncompatibleAddon( |
|
| 321 | - $addon_name, |
|
| 322 | - $version_constant, |
|
| 323 | - $min_version_required, |
|
| 324 | - $load_callback, |
|
| 325 | - $plugin_file_constant |
|
| 326 | - ) { |
|
| 327 | - if (! defined($version_constant)) { |
|
| 328 | - return; |
|
| 329 | - } |
|
| 330 | - $addon_version = constant($version_constant); |
|
| 331 | - if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
| 332 | - remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
| 333 | - if (! function_exists('deactivate_plugins')) { |
|
| 334 | - require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 335 | - } |
|
| 336 | - deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
| 337 | - unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
| 338 | - EE_Error::add_error( |
|
| 339 | - sprintf( |
|
| 340 | - esc_html__( |
|
| 341 | - 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
| 342 | - 'event_espresso' |
|
| 343 | - ), |
|
| 344 | - $addon_name, |
|
| 345 | - $min_version_required |
|
| 346 | - ), |
|
| 347 | - __FILE__, |
|
| 348 | - __FUNCTION__ . "({$addon_name})", |
|
| 349 | - __LINE__ |
|
| 350 | - ); |
|
| 351 | - EE_Error::get_notices(false, true); |
|
| 352 | - } |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * load_espresso_addons |
|
| 358 | - * allow addons to load first so that they can set hooks for running DMS's, etc |
|
| 359 | - * this is hooked into both: |
|
| 360 | - * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
| 361 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
| 362 | - * and the WP 'activate_plugin' hook point |
|
| 363 | - * |
|
| 364 | - * @access public |
|
| 365 | - * @return void |
|
| 366 | - */ |
|
| 367 | - public function load_espresso_addons() |
|
| 368 | - { |
|
| 369 | - $this->deactivateIncompatibleAddon( |
|
| 370 | - 'Wait Lists', |
|
| 371 | - 'EE_WAIT_LISTS_VERSION', |
|
| 372 | - '1.0.0.beta.074', |
|
| 373 | - 'load_espresso_wait_lists', |
|
| 374 | - 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
| 375 | - ); |
|
| 376 | - $this->deactivateIncompatibleAddon( |
|
| 377 | - 'Automated Upcoming Event Notifications', |
|
| 378 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
| 379 | - '1.0.0.beta.091', |
|
| 380 | - 'load_espresso_automated_upcoming_event_notification', |
|
| 381 | - 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
| 382 | - ); |
|
| 383 | - do_action('AHEE__EE_System__load_espresso_addons'); |
|
| 384 | - // if the WP API basic auth plugin isn't already loaded, load it now. |
|
| 385 | - // We want it for mobile apps. Just include the entire plugin |
|
| 386 | - // also, don't load the basic auth when a plugin is getting activated, because |
|
| 387 | - // it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
| 388 | - // and causes a fatal error |
|
| 389 | - if ($this->request->getRequestParam('activate') !== 'true' |
|
| 390 | - && ! function_exists('json_basic_auth_handler') |
|
| 391 | - && ! function_exists('json_basic_auth_error') |
|
| 392 | - && ! in_array( |
|
| 393 | - $this->request->getRequestParam('action'), |
|
| 394 | - array('activate', 'activate-selected'), |
|
| 395 | - true |
|
| 396 | - ) |
|
| 397 | - ) { |
|
| 398 | - include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
| 399 | - } |
|
| 400 | - do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
| 401 | - } |
|
| 402 | - |
|
| 403 | - |
|
| 404 | - /** |
|
| 405 | - * detect_activations_or_upgrades |
|
| 406 | - * Checks for activation or upgrade of core first; |
|
| 407 | - * then also checks if any registered addons have been activated or upgraded |
|
| 408 | - * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
| 409 | - * which runs during the WP 'plugins_loaded' action at priority 3 |
|
| 410 | - * |
|
| 411 | - * @access public |
|
| 412 | - * @return void |
|
| 413 | - */ |
|
| 414 | - public function detect_activations_or_upgrades() |
|
| 415 | - { |
|
| 416 | - // first off: let's make sure to handle core |
|
| 417 | - $this->detect_if_activation_or_upgrade(); |
|
| 418 | - foreach ($this->registry->addons as $addon) { |
|
| 419 | - if ($addon instanceof EE_Addon) { |
|
| 420 | - // detect teh request type for that addon |
|
| 421 | - $addon->detect_activation_or_upgrade(); |
|
| 422 | - } |
|
| 423 | - } |
|
| 424 | - } |
|
| 425 | - |
|
| 426 | - |
|
| 427 | - /** |
|
| 428 | - * detect_if_activation_or_upgrade |
|
| 429 | - * Takes care of detecting whether this is a brand new install or code upgrade, |
|
| 430 | - * and either setting up the DB or setting up maintenance mode etc. |
|
| 431 | - * |
|
| 432 | - * @access public |
|
| 433 | - * @return void |
|
| 434 | - */ |
|
| 435 | - public function detect_if_activation_or_upgrade() |
|
| 436 | - { |
|
| 437 | - do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
| 438 | - // check if db has been updated, or if its a brand-new installation |
|
| 439 | - $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
| 440 | - $request_type = $this->detect_req_type($espresso_db_update); |
|
| 441 | - // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
| 442 | - switch ($request_type) { |
|
| 443 | - case EE_System::req_type_new_activation: |
|
| 444 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
| 445 | - $this->_handle_core_version_change($espresso_db_update); |
|
| 446 | - break; |
|
| 447 | - case EE_System::req_type_reactivation: |
|
| 448 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
| 449 | - $this->_handle_core_version_change($espresso_db_update); |
|
| 450 | - break; |
|
| 451 | - case EE_System::req_type_upgrade: |
|
| 452 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
| 453 | - // migrations may be required now that we've upgraded |
|
| 454 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
| 455 | - $this->_handle_core_version_change($espresso_db_update); |
|
| 456 | - break; |
|
| 457 | - case EE_System::req_type_downgrade: |
|
| 458 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
| 459 | - // its possible migrations are no longer required |
|
| 460 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
| 461 | - $this->_handle_core_version_change($espresso_db_update); |
|
| 462 | - break; |
|
| 463 | - case EE_System::req_type_normal: |
|
| 464 | - default: |
|
| 465 | - break; |
|
| 466 | - } |
|
| 467 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
| 468 | - } |
|
| 469 | - |
|
| 470 | - |
|
| 471 | - /** |
|
| 472 | - * Updates the list of installed versions and sets hooks for |
|
| 473 | - * initializing the database later during the request |
|
| 474 | - * |
|
| 475 | - * @param array $espresso_db_update |
|
| 476 | - */ |
|
| 477 | - private function _handle_core_version_change($espresso_db_update) |
|
| 478 | - { |
|
| 479 | - $this->update_list_of_installed_versions($espresso_db_update); |
|
| 480 | - // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
| 481 | - add_action( |
|
| 482 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
| 483 | - array($this, 'initialize_db_if_no_migrations_required') |
|
| 484 | - ); |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - |
|
| 488 | - /** |
|
| 489 | - * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
| 490 | - * information about what versions of EE have been installed and activated, |
|
| 491 | - * NOT necessarily the state of the database |
|
| 492 | - * |
|
| 493 | - * @param mixed $espresso_db_update the value of the WordPress option. |
|
| 494 | - * If not supplied, fetches it from the options table |
|
| 495 | - * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
| 496 | - */ |
|
| 497 | - private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
| 498 | - { |
|
| 499 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
| 500 | - if (! $espresso_db_update) { |
|
| 501 | - $espresso_db_update = get_option('espresso_db_update'); |
|
| 502 | - } |
|
| 503 | - // check that option is an array |
|
| 504 | - if (! is_array($espresso_db_update)) { |
|
| 505 | - // if option is FALSE, then it never existed |
|
| 506 | - if ($espresso_db_update === false) { |
|
| 507 | - // make $espresso_db_update an array and save option with autoload OFF |
|
| 508 | - $espresso_db_update = array(); |
|
| 509 | - add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
| 510 | - } else { |
|
| 511 | - // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
| 512 | - $espresso_db_update = array($espresso_db_update => array()); |
|
| 513 | - update_option('espresso_db_update', $espresso_db_update); |
|
| 514 | - } |
|
| 515 | - } else { |
|
| 516 | - $corrected_db_update = array(); |
|
| 517 | - // if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
| 518 | - foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
| 519 | - if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
| 520 | - // the key is an int, and the value IS NOT an array |
|
| 521 | - // so it must be numerically-indexed, where values are versions installed... |
|
| 522 | - // fix it! |
|
| 523 | - $version_string = $should_be_array; |
|
| 524 | - $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
| 525 | - } else { |
|
| 526 | - // ok it checks out |
|
| 527 | - $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
| 528 | - } |
|
| 529 | - } |
|
| 530 | - $espresso_db_update = $corrected_db_update; |
|
| 531 | - update_option('espresso_db_update', $espresso_db_update); |
|
| 532 | - } |
|
| 533 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
| 534 | - return $espresso_db_update; |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - |
|
| 538 | - /** |
|
| 539 | - * Does the traditional work of setting up the plugin's database and adding default data. |
|
| 540 | - * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
| 541 | - * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
| 542 | - * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
| 543 | - * so that it will be done when migrations are finished |
|
| 544 | - * |
|
| 545 | - * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
| 546 | - * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
| 547 | - * This is a resource-intensive job |
|
| 548 | - * so we prefer to only do it when necessary |
|
| 549 | - * @return void |
|
| 550 | - * @throws EE_Error |
|
| 551 | - */ |
|
| 552 | - public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
| 553 | - { |
|
| 554 | - $request_type = $this->detect_req_type(); |
|
| 555 | - // only initialize system if we're not in maintenance mode. |
|
| 556 | - if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
| 557 | - /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
| 558 | - $rewrite_rules = $this->loader->getShared( |
|
| 559 | - 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
| 560 | - ); |
|
| 561 | - $rewrite_rules->flush(); |
|
| 562 | - if ($verify_schema) { |
|
| 563 | - EEH_Activation::initialize_db_and_folders(); |
|
| 564 | - } |
|
| 565 | - EEH_Activation::initialize_db_content(); |
|
| 566 | - EEH_Activation::system_initialization(); |
|
| 567 | - if ($initialize_addons_too) { |
|
| 568 | - $this->initialize_addons(); |
|
| 569 | - } |
|
| 570 | - } else { |
|
| 571 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
| 572 | - } |
|
| 573 | - if ($request_type === EE_System::req_type_new_activation |
|
| 574 | - || $request_type === EE_System::req_type_reactivation |
|
| 575 | - || ( |
|
| 576 | - $request_type === EE_System::req_type_upgrade |
|
| 577 | - && $this->is_major_version_change() |
|
| 578 | - ) |
|
| 579 | - ) { |
|
| 580 | - add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
| 581 | - } |
|
| 582 | - } |
|
| 583 | - |
|
| 584 | - |
|
| 585 | - /** |
|
| 586 | - * Initializes the db for all registered addons |
|
| 587 | - * |
|
| 588 | - * @throws EE_Error |
|
| 589 | - */ |
|
| 590 | - public function initialize_addons() |
|
| 591 | - { |
|
| 592 | - // foreach registered addon, make sure its db is up-to-date too |
|
| 593 | - foreach ($this->registry->addons as $addon) { |
|
| 594 | - if ($addon instanceof EE_Addon) { |
|
| 595 | - $addon->initialize_db_if_no_migrations_required(); |
|
| 596 | - } |
|
| 597 | - } |
|
| 598 | - } |
|
| 599 | - |
|
| 600 | - |
|
| 601 | - /** |
|
| 602 | - * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
| 603 | - * |
|
| 604 | - * @param array $version_history |
|
| 605 | - * @param string $current_version_to_add version to be added to the version history |
|
| 606 | - * @return boolean success as to whether or not this option was changed |
|
| 607 | - */ |
|
| 608 | - public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
| 609 | - { |
|
| 610 | - if (! $version_history) { |
|
| 611 | - $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
| 612 | - } |
|
| 613 | - if ($current_version_to_add === null) { |
|
| 614 | - $current_version_to_add = espresso_version(); |
|
| 615 | - } |
|
| 616 | - $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
| 617 | - // re-save |
|
| 618 | - return update_option('espresso_db_update', $version_history); |
|
| 619 | - } |
|
| 620 | - |
|
| 621 | - |
|
| 622 | - /** |
|
| 623 | - * Detects if the current version indicated in the has existed in the list of |
|
| 624 | - * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
| 625 | - * |
|
| 626 | - * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
| 627 | - * If not supplied, fetches it from the options table. |
|
| 628 | - * Also, caches its result so later parts of the code can also know whether |
|
| 629 | - * there's been an update or not. This way we can add the current version to |
|
| 630 | - * espresso_db_update, but still know if this is a new install or not |
|
| 631 | - * @return int one of the constants on EE_System::req_type_ |
|
| 632 | - */ |
|
| 633 | - public function detect_req_type($espresso_db_update = null) |
|
| 634 | - { |
|
| 635 | - if ($this->_req_type === null) { |
|
| 636 | - $espresso_db_update = ! empty($espresso_db_update) |
|
| 637 | - ? $espresso_db_update |
|
| 638 | - : $this->fix_espresso_db_upgrade_option(); |
|
| 639 | - $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
| 640 | - $espresso_db_update, |
|
| 641 | - 'ee_espresso_activation', |
|
| 642 | - espresso_version() |
|
| 643 | - ); |
|
| 644 | - $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
| 645 | - $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
| 646 | - } |
|
| 647 | - return $this->_req_type; |
|
| 648 | - } |
|
| 649 | - |
|
| 650 | - |
|
| 651 | - /** |
|
| 652 | - * Returns whether or not there was a non-micro version change (ie, change in either |
|
| 653 | - * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
| 654 | - * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
| 655 | - * |
|
| 656 | - * @param $activation_history |
|
| 657 | - * @return bool |
|
| 658 | - */ |
|
| 659 | - private function _detect_major_version_change($activation_history) |
|
| 660 | - { |
|
| 661 | - $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
| 662 | - $previous_version_parts = explode('.', $previous_version); |
|
| 663 | - $current_version_parts = explode('.', espresso_version()); |
|
| 664 | - return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
| 665 | - && ($previous_version_parts[0] !== $current_version_parts[0] |
|
| 666 | - || $previous_version_parts[1] !== $current_version_parts[1] |
|
| 667 | - ); |
|
| 668 | - } |
|
| 669 | - |
|
| 670 | - |
|
| 671 | - /** |
|
| 672 | - * Returns true if either the major or minor version of EE changed during this request. |
|
| 673 | - * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
| 674 | - * |
|
| 675 | - * @return bool |
|
| 676 | - */ |
|
| 677 | - public function is_major_version_change() |
|
| 678 | - { |
|
| 679 | - return $this->_major_version_change; |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
| 685 | - * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
| 686 | - * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
| 687 | - * just activated to (for core that will always be espresso_version()) |
|
| 688 | - * |
|
| 689 | - * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
| 690 | - * ee plugin. for core that's 'espresso_db_update' |
|
| 691 | - * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
| 692 | - * indicate that this plugin was just activated |
|
| 693 | - * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
| 694 | - * espresso_version()) |
|
| 695 | - * @return int one of the constants on EE_System::req_type_* |
|
| 696 | - */ |
|
| 697 | - public static function detect_req_type_given_activation_history( |
|
| 698 | - $activation_history_for_addon, |
|
| 699 | - $activation_indicator_option_name, |
|
| 700 | - $version_to_upgrade_to |
|
| 701 | - ) { |
|
| 702 | - $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
| 703 | - if ($activation_history_for_addon) { |
|
| 704 | - // it exists, so this isn't a completely new install |
|
| 705 | - // check if this version already in that list of previously installed versions |
|
| 706 | - if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
| 707 | - // it a version we haven't seen before |
|
| 708 | - if ($version_is_higher === 1) { |
|
| 709 | - $req_type = EE_System::req_type_upgrade; |
|
| 710 | - } else { |
|
| 711 | - $req_type = EE_System::req_type_downgrade; |
|
| 712 | - } |
|
| 713 | - delete_option($activation_indicator_option_name); |
|
| 714 | - } else { |
|
| 715 | - // its not an update. maybe a reactivation? |
|
| 716 | - if (get_option($activation_indicator_option_name, false)) { |
|
| 717 | - if ($version_is_higher === -1) { |
|
| 718 | - $req_type = EE_System::req_type_downgrade; |
|
| 719 | - } elseif ($version_is_higher === 0) { |
|
| 720 | - // we've seen this version before, but it's an activation. must be a reactivation |
|
| 721 | - $req_type = EE_System::req_type_reactivation; |
|
| 722 | - } else {// $version_is_higher === 1 |
|
| 723 | - $req_type = EE_System::req_type_upgrade; |
|
| 724 | - } |
|
| 725 | - delete_option($activation_indicator_option_name); |
|
| 726 | - } else { |
|
| 727 | - // we've seen this version before and the activation indicate doesn't show it was just activated |
|
| 728 | - if ($version_is_higher === -1) { |
|
| 729 | - $req_type = EE_System::req_type_downgrade; |
|
| 730 | - } elseif ($version_is_higher === 0) { |
|
| 731 | - // we've seen this version before and it's not an activation. its normal request |
|
| 732 | - $req_type = EE_System::req_type_normal; |
|
| 733 | - } else {// $version_is_higher === 1 |
|
| 734 | - $req_type = EE_System::req_type_upgrade; |
|
| 735 | - } |
|
| 736 | - } |
|
| 737 | - } |
|
| 738 | - } else { |
|
| 739 | - // brand new install |
|
| 740 | - $req_type = EE_System::req_type_new_activation; |
|
| 741 | - delete_option($activation_indicator_option_name); |
|
| 742 | - } |
|
| 743 | - return $req_type; |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - |
|
| 747 | - /** |
|
| 748 | - * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
| 749 | - * the $activation_history_for_addon |
|
| 750 | - * |
|
| 751 | - * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
| 752 | - * sometimes containing 'unknown-date' |
|
| 753 | - * @param string $version_to_upgrade_to (current version) |
|
| 754 | - * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
| 755 | - * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
| 756 | - * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
| 757 | - * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
| 758 | - */ |
|
| 759 | - private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
| 760 | - { |
|
| 761 | - // find the most recently-activated version |
|
| 762 | - $most_recently_active_version = |
|
| 763 | - EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
| 764 | - return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
| 765 | - } |
|
| 766 | - |
|
| 767 | - |
|
| 768 | - /** |
|
| 769 | - * Gets the most recently active version listed in the activation history, |
|
| 770 | - * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
| 771 | - * |
|
| 772 | - * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
| 773 | - * sometimes containing 'unknown-date' |
|
| 774 | - * @return string |
|
| 775 | - */ |
|
| 776 | - private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
| 777 | - { |
|
| 778 | - $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
| 779 | - $most_recently_active_version = '0.0.0.dev.000'; |
|
| 780 | - if (is_array($activation_history)) { |
|
| 781 | - foreach ($activation_history as $version => $times_activated) { |
|
| 782 | - // check there is a record of when this version was activated. Otherwise, |
|
| 783 | - // mark it as unknown |
|
| 784 | - if (! $times_activated) { |
|
| 785 | - $times_activated = array('unknown-date'); |
|
| 786 | - } |
|
| 787 | - if (is_string($times_activated)) { |
|
| 788 | - $times_activated = array($times_activated); |
|
| 789 | - } |
|
| 790 | - foreach ($times_activated as $an_activation) { |
|
| 791 | - if ($an_activation !== 'unknown-date' |
|
| 792 | - && $an_activation |
|
| 793 | - > $most_recently_active_version_activation) { |
|
| 794 | - $most_recently_active_version = $version; |
|
| 795 | - $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
| 796 | - ? '1970-01-01 00:00:00' |
|
| 797 | - : $an_activation; |
|
| 798 | - } |
|
| 799 | - } |
|
| 800 | - } |
|
| 801 | - } |
|
| 802 | - return $most_recently_active_version; |
|
| 803 | - } |
|
| 804 | - |
|
| 805 | - |
|
| 806 | - /** |
|
| 807 | - * This redirects to the about EE page after activation |
|
| 808 | - * |
|
| 809 | - * @return void |
|
| 810 | - */ |
|
| 811 | - public function redirect_to_about_ee() |
|
| 812 | - { |
|
| 813 | - $notices = EE_Error::get_notices(false); |
|
| 814 | - // if current user is an admin and it's not an ajax or rest request |
|
| 815 | - if (! isset($notices['errors']) |
|
| 816 | - && $this->request->isAdmin() |
|
| 817 | - && apply_filters( |
|
| 818 | - 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
| 819 | - $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
| 820 | - ) |
|
| 821 | - ) { |
|
| 822 | - $query_params = array('page' => 'espresso_about'); |
|
| 823 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
| 824 | - $query_params['new_activation'] = true; |
|
| 825 | - } |
|
| 826 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
| 827 | - $query_params['reactivation'] = true; |
|
| 828 | - } |
|
| 829 | - $url = add_query_arg($query_params, admin_url('admin.php')); |
|
| 830 | - wp_safe_redirect($url); |
|
| 831 | - exit(); |
|
| 832 | - } |
|
| 833 | - } |
|
| 834 | - |
|
| 835 | - |
|
| 836 | - /** |
|
| 837 | - * load_core_configuration |
|
| 838 | - * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
| 839 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
| 840 | - * |
|
| 841 | - * @return void |
|
| 842 | - * @throws ReflectionException |
|
| 843 | - * @throws Exception |
|
| 844 | - */ |
|
| 845 | - public function load_core_configuration() |
|
| 846 | - { |
|
| 847 | - do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
| 848 | - $this->loader->getShared('EE_Load_Textdomain'); |
|
| 849 | - // load textdomain |
|
| 850 | - EE_Load_Textdomain::load_textdomain(); |
|
| 851 | - // load and setup EE_Config and EE_Network_Config |
|
| 852 | - $config = $this->loader->getShared('EE_Config'); |
|
| 853 | - $this->loader->getShared('EE_Network_Config'); |
|
| 854 | - // setup autoloaders |
|
| 855 | - // enable logging? |
|
| 856 | - if ($config->admin->use_full_logging) { |
|
| 857 | - $this->loader->getShared('EE_Log'); |
|
| 858 | - } |
|
| 859 | - // check for activation errors |
|
| 860 | - $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
| 861 | - if ($activation_errors) { |
|
| 862 | - EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
| 863 | - update_option('ee_plugin_activation_errors', false); |
|
| 864 | - } |
|
| 865 | - // get model names |
|
| 866 | - $this->_parse_model_names(); |
|
| 867 | - // load caf stuff a chance to play during the activation process too. |
|
| 868 | - $this->_maybe_brew_regular(); |
|
| 869 | - // configure custom post type definitions |
|
| 870 | - $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'); |
|
| 871 | - $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'); |
|
| 872 | - do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
| 873 | - } |
|
| 874 | - |
|
| 875 | - |
|
| 876 | - /** |
|
| 877 | - * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
| 878 | - * |
|
| 879 | - * @return void |
|
| 880 | - * @throws ReflectionException |
|
| 881 | - */ |
|
| 882 | - private function _parse_model_names() |
|
| 883 | - { |
|
| 884 | - // get all the files in the EE_MODELS folder that end in .model.php |
|
| 885 | - $models = glob(EE_MODELS . '*.model.php'); |
|
| 886 | - $model_names = array(); |
|
| 887 | - $non_abstract_db_models = array(); |
|
| 888 | - foreach ($models as $model) { |
|
| 889 | - // get model classname |
|
| 890 | - $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
| 891 | - $short_name = str_replace('EEM_', '', $classname); |
|
| 892 | - $reflectionClass = new ReflectionClass($classname); |
|
| 893 | - if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
| 894 | - $non_abstract_db_models[ $short_name ] = $classname; |
|
| 895 | - } |
|
| 896 | - $model_names[ $short_name ] = $classname; |
|
| 897 | - } |
|
| 898 | - $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
| 899 | - $this->registry->non_abstract_db_models = apply_filters( |
|
| 900 | - 'FHEE__EE_System__parse_implemented_model_names', |
|
| 901 | - $non_abstract_db_models |
|
| 902 | - ); |
|
| 903 | - } |
|
| 904 | - |
|
| 905 | - |
|
| 906 | - /** |
|
| 907 | - * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
| 908 | - * that need to be setup before our EE_System launches. |
|
| 909 | - * |
|
| 910 | - * @return void |
|
| 911 | - * @throws DomainException |
|
| 912 | - * @throws InvalidArgumentException |
|
| 913 | - * @throws InvalidDataTypeException |
|
| 914 | - * @throws InvalidInterfaceException |
|
| 915 | - * @throws InvalidClassException |
|
| 916 | - * @throws InvalidFilePathException |
|
| 917 | - */ |
|
| 918 | - private function _maybe_brew_regular() |
|
| 919 | - { |
|
| 920 | - /** @var Domain $domain */ |
|
| 921 | - $domain = DomainFactory::getShared( |
|
| 922 | - new FullyQualifiedName( |
|
| 923 | - 'EventEspresso\core\domain\Domain' |
|
| 924 | - ), |
|
| 925 | - array( |
|
| 926 | - new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
| 927 | - Version::fromString(espresso_version()), |
|
| 928 | - ) |
|
| 929 | - ); |
|
| 930 | - if ($domain->isCaffeinated()) { |
|
| 931 | - require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
| 932 | - } |
|
| 933 | - } |
|
| 934 | - |
|
| 935 | - |
|
| 936 | - /** |
|
| 937 | - * @since $VID:$ |
|
| 938 | - * @throws Exception |
|
| 939 | - */ |
|
| 940 | - public function loadRouteMatchSpecifications() |
|
| 941 | - { |
|
| 942 | - try { |
|
| 943 | - $this->loader->getShared( |
|
| 944 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' |
|
| 945 | - ); |
|
| 946 | - } catch (Exception $exception) { |
|
| 947 | - new ExceptionStackTraceDisplay($exception); |
|
| 948 | - } |
|
| 949 | - do_action('AHEE__EE_System__loadRouteMatchSpecifications'); |
|
| 950 | - } |
|
| 951 | - |
|
| 952 | - |
|
| 953 | - /** |
|
| 954 | - * register_shortcodes_modules_and_widgets |
|
| 955 | - * generate lists of shortcodes and modules, then verify paths and classes |
|
| 956 | - * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
| 957 | - * which runs during the WP 'plugins_loaded' action at priority 7 |
|
| 958 | - * |
|
| 959 | - * @access public |
|
| 960 | - * @return void |
|
| 961 | - * @throws Exception |
|
| 962 | - */ |
|
| 963 | - public function register_shortcodes_modules_and_widgets() |
|
| 964 | - { |
|
| 965 | - if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) { |
|
| 966 | - try { |
|
| 967 | - // load, register, and add shortcodes the new way |
|
| 968 | - $this->loader->getShared( |
|
| 969 | - 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
| 970 | - array( |
|
| 971 | - // and the old way, but we'll put it under control of the new system |
|
| 972 | - EE_Config::getLegacyShortcodesManager(), |
|
| 973 | - ) |
|
| 974 | - ); |
|
| 975 | - } catch (Exception $exception) { |
|
| 976 | - new ExceptionStackTraceDisplay($exception); |
|
| 977 | - } |
|
| 978 | - } |
|
| 979 | - do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
| 980 | - // check for addons using old hook point |
|
| 981 | - if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
| 982 | - $this->_incompatible_addon_error(); |
|
| 983 | - } |
|
| 984 | - } |
|
| 985 | - |
|
| 986 | - |
|
| 987 | - /** |
|
| 988 | - * _incompatible_addon_error |
|
| 989 | - * |
|
| 990 | - * @access public |
|
| 991 | - * @return void |
|
| 992 | - */ |
|
| 993 | - private function _incompatible_addon_error() |
|
| 994 | - { |
|
| 995 | - // get array of classes hooking into here |
|
| 996 | - $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
| 997 | - 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
| 998 | - ); |
|
| 999 | - if (! empty($class_names)) { |
|
| 1000 | - $msg = __( |
|
| 1001 | - 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
| 1002 | - 'event_espresso' |
|
| 1003 | - ); |
|
| 1004 | - $msg .= '<ul>'; |
|
| 1005 | - foreach ($class_names as $class_name) { |
|
| 1006 | - $msg .= '<li><b>Event Espresso - ' |
|
| 1007 | - . str_replace( |
|
| 1008 | - array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), |
|
| 1009 | - '', |
|
| 1010 | - $class_name |
|
| 1011 | - ) . '</b></li>'; |
|
| 1012 | - } |
|
| 1013 | - $msg .= '</ul>'; |
|
| 1014 | - $msg .= __( |
|
| 1015 | - 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
| 1016 | - 'event_espresso' |
|
| 1017 | - ); |
|
| 1018 | - // save list of incompatible addons to wp-options for later use |
|
| 1019 | - add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
| 1020 | - if (is_admin()) { |
|
| 1021 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1022 | - } |
|
| 1023 | - } |
|
| 1024 | - } |
|
| 1025 | - |
|
| 1026 | - |
|
| 1027 | - /** |
|
| 1028 | - * brew_espresso |
|
| 1029 | - * begins the process of setting hooks for initializing EE in the correct order |
|
| 1030 | - * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
| 1031 | - * which runs during the WP 'plugins_loaded' action at priority 9 |
|
| 1032 | - * |
|
| 1033 | - * @return void |
|
| 1034 | - */ |
|
| 1035 | - public function brew_espresso() |
|
| 1036 | - { |
|
| 1037 | - do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
| 1038 | - // load some final core systems |
|
| 1039 | - add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
| 1040 | - add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
| 1041 | - add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
| 1042 | - add_action('init', array($this, 'load_controllers'), 7); |
|
| 1043 | - add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
| 1044 | - add_action('init', array($this, 'initialize'), 10); |
|
| 1045 | - add_action('init', array($this, 'initialize_last'), 100); |
|
| 1046 | - if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
| 1047 | - // pew pew pew |
|
| 1048 | - $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
| 1049 | - do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
| 1050 | - } |
|
| 1051 | - do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
| 1052 | - } |
|
| 1053 | - |
|
| 1054 | - |
|
| 1055 | - /** |
|
| 1056 | - * set_hooks_for_core |
|
| 1057 | - * |
|
| 1058 | - * @access public |
|
| 1059 | - * @return void |
|
| 1060 | - * @throws EE_Error |
|
| 1061 | - */ |
|
| 1062 | - public function set_hooks_for_core() |
|
| 1063 | - { |
|
| 1064 | - $this->_deactivate_incompatible_addons(); |
|
| 1065 | - do_action('AHEE__EE_System__set_hooks_for_core'); |
|
| 1066 | - $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
| 1067 | - // caps need to be initialized on every request so that capability maps are set. |
|
| 1068 | - // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
| 1069 | - $this->registry->CAP->init_caps(); |
|
| 1070 | - } |
|
| 1071 | - |
|
| 1072 | - |
|
| 1073 | - /** |
|
| 1074 | - * Using the information gathered in EE_System::_incompatible_addon_error, |
|
| 1075 | - * deactivates any addons considered incompatible with the current version of EE |
|
| 1076 | - */ |
|
| 1077 | - private function _deactivate_incompatible_addons() |
|
| 1078 | - { |
|
| 1079 | - $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
| 1080 | - if (! empty($incompatible_addons)) { |
|
| 1081 | - $active_plugins = get_option('active_plugins', array()); |
|
| 1082 | - foreach ($active_plugins as $active_plugin) { |
|
| 1083 | - foreach ($incompatible_addons as $incompatible_addon) { |
|
| 1084 | - if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
| 1085 | - unset($_GET['activate']); |
|
| 1086 | - espresso_deactivate_plugin($active_plugin); |
|
| 1087 | - } |
|
| 1088 | - } |
|
| 1089 | - } |
|
| 1090 | - } |
|
| 1091 | - } |
|
| 1092 | - |
|
| 1093 | - |
|
| 1094 | - /** |
|
| 1095 | - * perform_activations_upgrades_and_migrations |
|
| 1096 | - * |
|
| 1097 | - * @access public |
|
| 1098 | - * @return void |
|
| 1099 | - */ |
|
| 1100 | - public function perform_activations_upgrades_and_migrations() |
|
| 1101 | - { |
|
| 1102 | - do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
| 1103 | - } |
|
| 1104 | - |
|
| 1105 | - |
|
| 1106 | - /** |
|
| 1107 | - * @return void |
|
| 1108 | - * @throws DomainException |
|
| 1109 | - */ |
|
| 1110 | - public function load_CPTs_and_session() |
|
| 1111 | - { |
|
| 1112 | - do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
| 1113 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */ |
|
| 1114 | - $register_custom_taxonomies = $this->loader->getShared( |
|
| 1115 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' |
|
| 1116 | - ); |
|
| 1117 | - $register_custom_taxonomies->registerCustomTaxonomies(); |
|
| 1118 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */ |
|
| 1119 | - $register_custom_post_types = $this->loader->getShared( |
|
| 1120 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' |
|
| 1121 | - ); |
|
| 1122 | - $register_custom_post_types->registerCustomPostTypes(); |
|
| 1123 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */ |
|
| 1124 | - $register_custom_taxonomy_terms = $this->loader->getShared( |
|
| 1125 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms' |
|
| 1126 | - ); |
|
| 1127 | - $register_custom_taxonomy_terms->registerCustomTaxonomyTerms(); |
|
| 1128 | - // load legacy Custom Post Types and Taxonomies |
|
| 1129 | - $this->loader->getShared('EE_Register_CPTs'); |
|
| 1130 | - do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
| 1131 | - } |
|
| 1132 | - |
|
| 1133 | - |
|
| 1134 | - /** |
|
| 1135 | - * load_controllers |
|
| 1136 | - * this is the best place to load any additional controllers that needs access to EE core. |
|
| 1137 | - * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
| 1138 | - * time |
|
| 1139 | - * |
|
| 1140 | - * @access public |
|
| 1141 | - * @return void |
|
| 1142 | - */ |
|
| 1143 | - public function load_controllers() |
|
| 1144 | - { |
|
| 1145 | - do_action('AHEE__EE_System__load_controllers__start'); |
|
| 1146 | - // let's get it started |
|
| 1147 | - if (! $this->maintenance_mode->level() |
|
| 1148 | - && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
| 1149 | - ) { |
|
| 1150 | - do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
| 1151 | - $this->loader->getShared('EE_Front_Controller'); |
|
| 1152 | - } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
| 1153 | - do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
| 1154 | - $this->loader->getShared('EE_Admin'); |
|
| 1155 | - } |
|
| 1156 | - do_action('AHEE__EE_System__load_controllers__complete'); |
|
| 1157 | - } |
|
| 1158 | - |
|
| 1159 | - |
|
| 1160 | - /** |
|
| 1161 | - * core_loaded_and_ready |
|
| 1162 | - * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
| 1163 | - * |
|
| 1164 | - * @access public |
|
| 1165 | - * @return void |
|
| 1166 | - * @throws Exception |
|
| 1167 | - */ |
|
| 1168 | - public function core_loaded_and_ready() |
|
| 1169 | - { |
|
| 1170 | - if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
| 1171 | - try { |
|
| 1172 | - $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
| 1173 | - $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager'); |
|
| 1174 | - if (function_exists('register_block_type')) { |
|
| 1175 | - $this->loader->getShared( |
|
| 1176 | - 'EventEspresso\core\services\editor\BlockRegistrationManager' |
|
| 1177 | - ); |
|
| 1178 | - } |
|
| 1179 | - } catch (Exception $exception) { |
|
| 1180 | - new ExceptionStackTraceDisplay($exception); |
|
| 1181 | - } |
|
| 1182 | - } |
|
| 1183 | - if ($this->request->isAdmin() |
|
| 1184 | - || $this->request->isEeAjax() |
|
| 1185 | - || $this->request->isFrontend() |
|
| 1186 | - ) { |
|
| 1187 | - $this->loader->getShared('EE_Session'); |
|
| 1188 | - } |
|
| 1189 | - // integrate WP_Query with the EE models |
|
| 1190 | - $this->loader->getShared('EE_CPT_Strategy'); |
|
| 1191 | - do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
| 1192 | - // always load template tags, because it's faster than checking if it's a front-end request, and many page |
|
| 1193 | - // builders require these even on the front-end |
|
| 1194 | - require_once EE_PUBLIC . 'template_tags.php'; |
|
| 1195 | - do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
| 1196 | - } |
|
| 1197 | - |
|
| 1198 | - |
|
| 1199 | - /** |
|
| 1200 | - * initialize |
|
| 1201 | - * this is the best place to begin initializing client code |
|
| 1202 | - * |
|
| 1203 | - * @access public |
|
| 1204 | - * @return void |
|
| 1205 | - */ |
|
| 1206 | - public function initialize() |
|
| 1207 | - { |
|
| 1208 | - do_action('AHEE__EE_System__initialize'); |
|
| 1209 | - } |
|
| 1210 | - |
|
| 1211 | - |
|
| 1212 | - /** |
|
| 1213 | - * initialize_last |
|
| 1214 | - * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
| 1215 | - * initialize has done so |
|
| 1216 | - * |
|
| 1217 | - * @access public |
|
| 1218 | - * @return void |
|
| 1219 | - */ |
|
| 1220 | - public function initialize_last() |
|
| 1221 | - { |
|
| 1222 | - do_action('AHEE__EE_System__initialize_last'); |
|
| 1223 | - /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
| 1224 | - $rewrite_rules = $this->loader->getShared( |
|
| 1225 | - 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
| 1226 | - ); |
|
| 1227 | - $rewrite_rules->flushRewriteRules(); |
|
| 1228 | - add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
| 1229 | - if (($this->request->isAjax() || $this->request->isAdmin()) |
|
| 1230 | - && $this->maintenance_mode->models_can_query()) { |
|
| 1231 | - $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager'); |
|
| 1232 | - $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager'); |
|
| 1233 | - } |
|
| 1234 | - } |
|
| 1235 | - |
|
| 1236 | - |
|
| 1237 | - /** |
|
| 1238 | - * @return void |
|
| 1239 | - * @throws EE_Error |
|
| 1240 | - */ |
|
| 1241 | - public function addEspressoToolbar() |
|
| 1242 | - { |
|
| 1243 | - $this->loader->getShared( |
|
| 1244 | - 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
| 1245 | - array($this->registry->CAP) |
|
| 1246 | - ); |
|
| 1247 | - } |
|
| 1248 | - |
|
| 1249 | - |
|
| 1250 | - /** |
|
| 1251 | - * do_not_cache |
|
| 1252 | - * sets no cache headers and defines no cache constants for WP plugins |
|
| 1253 | - * |
|
| 1254 | - * @access public |
|
| 1255 | - * @return void |
|
| 1256 | - */ |
|
| 1257 | - public static function do_not_cache() |
|
| 1258 | - { |
|
| 1259 | - // set no cache constants |
|
| 1260 | - if (! defined('DONOTCACHEPAGE')) { |
|
| 1261 | - define('DONOTCACHEPAGE', true); |
|
| 1262 | - } |
|
| 1263 | - if (! defined('DONOTCACHCEOBJECT')) { |
|
| 1264 | - define('DONOTCACHCEOBJECT', true); |
|
| 1265 | - } |
|
| 1266 | - if (! defined('DONOTCACHEDB')) { |
|
| 1267 | - define('DONOTCACHEDB', true); |
|
| 1268 | - } |
|
| 1269 | - // add no cache headers |
|
| 1270 | - add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
| 1271 | - // plus a little extra for nginx and Google Chrome |
|
| 1272 | - add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
| 1273 | - // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
| 1274 | - remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
| 1275 | - } |
|
| 1276 | - |
|
| 1277 | - |
|
| 1278 | - /** |
|
| 1279 | - * extra_nocache_headers |
|
| 1280 | - * |
|
| 1281 | - * @access public |
|
| 1282 | - * @param $headers |
|
| 1283 | - * @return array |
|
| 1284 | - */ |
|
| 1285 | - public static function extra_nocache_headers($headers) |
|
| 1286 | - { |
|
| 1287 | - // for NGINX |
|
| 1288 | - $headers['X-Accel-Expires'] = 0; |
|
| 1289 | - // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
| 1290 | - $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
| 1291 | - return $headers; |
|
| 1292 | - } |
|
| 1293 | - |
|
| 1294 | - |
|
| 1295 | - /** |
|
| 1296 | - * nocache_headers |
|
| 1297 | - * |
|
| 1298 | - * @access public |
|
| 1299 | - * @return void |
|
| 1300 | - */ |
|
| 1301 | - public static function nocache_headers() |
|
| 1302 | - { |
|
| 1303 | - nocache_headers(); |
|
| 1304 | - } |
|
| 1305 | - |
|
| 1306 | - |
|
| 1307 | - /** |
|
| 1308 | - * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
| 1309 | - * never returned with the function. |
|
| 1310 | - * |
|
| 1311 | - * @param array $exclude_array any existing pages being excluded are in this array. |
|
| 1312 | - * @return array |
|
| 1313 | - */ |
|
| 1314 | - public function remove_pages_from_wp_list_pages($exclude_array) |
|
| 1315 | - { |
|
| 1316 | - return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
| 1317 | - } |
|
| 30 | + /** |
|
| 31 | + * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation. |
|
| 32 | + * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc |
|
| 33 | + */ |
|
| 34 | + const req_type_normal = 0; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * Indicates this is a brand new installation of EE so we should install |
|
| 38 | + * tables and default data etc |
|
| 39 | + */ |
|
| 40 | + const req_type_new_activation = 1; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * we've detected that EE has been reactivated (or EE was activated during maintenance mode, |
|
| 44 | + * and we just exited maintenance mode). We MUST check the database is setup properly |
|
| 45 | + * and that default data is setup too |
|
| 46 | + */ |
|
| 47 | + const req_type_reactivation = 2; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * indicates that EE has been upgraded since its previous request. |
|
| 51 | + * We may have data migration scripts to call and will want to trigger maintenance mode |
|
| 52 | + */ |
|
| 53 | + const req_type_upgrade = 3; |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * TODO will detect that EE has been DOWNGRADED. We probably don't want to run in this case... |
|
| 57 | + */ |
|
| 58 | + const req_type_downgrade = 4; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * @deprecated since version 4.6.0.dev.006 |
|
| 62 | + * Now whenever a new_activation is detected the request type is still just |
|
| 63 | + * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode |
|
| 64 | + * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required |
|
| 65 | + * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode. |
|
| 66 | + * (Specifically, when the migration manager indicates migrations are finished |
|
| 67 | + * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called) |
|
| 68 | + */ |
|
| 69 | + const req_type_activation_but_not_installed = 5; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * option prefix for recording the activation history (like core's "espresso_db_update") of addons |
|
| 73 | + */ |
|
| 74 | + const addon_activation_history_option_prefix = 'ee_addon_activation_history_'; |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * @var EE_System $_instance |
|
| 78 | + */ |
|
| 79 | + private static $_instance; |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @var EE_Registry $registry |
|
| 83 | + */ |
|
| 84 | + private $registry; |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * @var LoaderInterface $loader |
|
| 88 | + */ |
|
| 89 | + private $loader; |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * @var EE_Capabilities $capabilities |
|
| 93 | + */ |
|
| 94 | + private $capabilities; |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * @var RequestInterface $request |
|
| 98 | + */ |
|
| 99 | + private $request; |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * @var EE_Maintenance_Mode $maintenance_mode |
|
| 103 | + */ |
|
| 104 | + private $maintenance_mode; |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*. |
|
| 108 | + * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request. |
|
| 109 | + * |
|
| 110 | + * @var int $_req_type |
|
| 111 | + */ |
|
| 112 | + private $_req_type; |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * Whether or not there was a non-micro version change in EE core version during this request |
|
| 116 | + * |
|
| 117 | + * @var boolean $_major_version_change |
|
| 118 | + */ |
|
| 119 | + private $_major_version_change = false; |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * A Context DTO dedicated solely to identifying the current request type. |
|
| 123 | + * |
|
| 124 | + * @var RequestTypeContextCheckerInterface $request_type |
|
| 125 | + */ |
|
| 126 | + private $request_type; |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * @singleton method used to instantiate class object |
|
| 131 | + * @param EE_Registry|null $registry |
|
| 132 | + * @param LoaderInterface|null $loader |
|
| 133 | + * @param RequestInterface|null $request |
|
| 134 | + * @param EE_Maintenance_Mode|null $maintenance_mode |
|
| 135 | + * @return EE_System |
|
| 136 | + */ |
|
| 137 | + public static function instance( |
|
| 138 | + EE_Registry $registry = null, |
|
| 139 | + LoaderInterface $loader = null, |
|
| 140 | + RequestInterface $request = null, |
|
| 141 | + EE_Maintenance_Mode $maintenance_mode = null |
|
| 142 | + ) { |
|
| 143 | + // check if class object is instantiated |
|
| 144 | + if (! self::$_instance instanceof EE_System) { |
|
| 145 | + self::$_instance = new self($registry, $loader, $request, $maintenance_mode); |
|
| 146 | + } |
|
| 147 | + return self::$_instance; |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * resets the instance and returns it |
|
| 153 | + * |
|
| 154 | + * @return EE_System |
|
| 155 | + */ |
|
| 156 | + public static function reset() |
|
| 157 | + { |
|
| 158 | + self::$_instance->_req_type = null; |
|
| 159 | + // make sure none of the old hooks are left hanging around |
|
| 160 | + remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
| 161 | + // we need to reset the migration manager in order for it to detect DMSs properly |
|
| 162 | + EE_Data_Migration_Manager::reset(); |
|
| 163 | + self::instance()->detect_activations_or_upgrades(); |
|
| 164 | + self::instance()->perform_activations_upgrades_and_migrations(); |
|
| 165 | + return self::instance(); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * sets hooks for running rest of system |
|
| 171 | + * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point |
|
| 172 | + * starting EE Addons from any other point may lead to problems |
|
| 173 | + * |
|
| 174 | + * @param EE_Registry $registry |
|
| 175 | + * @param LoaderInterface $loader |
|
| 176 | + * @param RequestInterface $request |
|
| 177 | + * @param EE_Maintenance_Mode $maintenance_mode |
|
| 178 | + */ |
|
| 179 | + private function __construct( |
|
| 180 | + EE_Registry $registry, |
|
| 181 | + LoaderInterface $loader, |
|
| 182 | + RequestInterface $request, |
|
| 183 | + EE_Maintenance_Mode $maintenance_mode |
|
| 184 | + ) { |
|
| 185 | + $this->registry = $registry; |
|
| 186 | + $this->loader = $loader; |
|
| 187 | + $this->request = $request; |
|
| 188 | + $this->maintenance_mode = $maintenance_mode; |
|
| 189 | + do_action('AHEE__EE_System__construct__begin', $this); |
|
| 190 | + add_action( |
|
| 191 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 192 | + array($this, 'loadCapabilities'), |
|
| 193 | + 5 |
|
| 194 | + ); |
|
| 195 | + add_action( |
|
| 196 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 197 | + array($this, 'loadCommandBus'), |
|
| 198 | + 7 |
|
| 199 | + ); |
|
| 200 | + add_action( |
|
| 201 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 202 | + array($this, 'loadPluginApi'), |
|
| 203 | + 9 |
|
| 204 | + ); |
|
| 205 | + // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc |
|
| 206 | + add_action( |
|
| 207 | + 'AHEE__EE_Bootstrap__load_espresso_addons', |
|
| 208 | + array($this, 'load_espresso_addons') |
|
| 209 | + ); |
|
| 210 | + // when an ee addon is activated, we want to call the core hook(s) again |
|
| 211 | + // because the newly-activated addon didn't get a chance to run at all |
|
| 212 | + add_action('activate_plugin', array($this, 'load_espresso_addons'), 1); |
|
| 213 | + // detect whether install or upgrade |
|
| 214 | + add_action( |
|
| 215 | + 'AHEE__EE_Bootstrap__detect_activations_or_upgrades', |
|
| 216 | + array($this, 'detect_activations_or_upgrades'), |
|
| 217 | + 3 |
|
| 218 | + ); |
|
| 219 | + // load EE_Config, EE_Textdomain, etc |
|
| 220 | + add_action( |
|
| 221 | + 'AHEE__EE_Bootstrap__load_core_configuration', |
|
| 222 | + array($this, 'load_core_configuration'), |
|
| 223 | + 5 |
|
| 224 | + ); |
|
| 225 | + // load specifications for matching routes to current request |
|
| 226 | + add_action( |
|
| 227 | + 'AHEE__EE_Bootstrap__load_core_configuration', |
|
| 228 | + array($this, 'loadRouteMatchSpecifications') |
|
| 229 | + ); |
|
| 230 | + // load EE_Config, EE_Textdomain, etc |
|
| 231 | + add_action( |
|
| 232 | + 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets', |
|
| 233 | + array($this, 'register_shortcodes_modules_and_widgets'), |
|
| 234 | + 7 |
|
| 235 | + ); |
|
| 236 | + // you wanna get going? I wanna get going... let's get going! |
|
| 237 | + add_action( |
|
| 238 | + 'AHEE__EE_Bootstrap__brew_espresso', |
|
| 239 | + array($this, 'brew_espresso'), |
|
| 240 | + 9 |
|
| 241 | + ); |
|
| 242 | + // other housekeeping |
|
| 243 | + // exclude EE critical pages from wp_list_pages |
|
| 244 | + add_filter( |
|
| 245 | + 'wp_list_pages_excludes', |
|
| 246 | + array($this, 'remove_pages_from_wp_list_pages'), |
|
| 247 | + 10 |
|
| 248 | + ); |
|
| 249 | + // ALL EE Addons should use the following hook point to attach their initial setup too |
|
| 250 | + // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads |
|
| 251 | + do_action('AHEE__EE_System__construct__complete', $this); |
|
| 252 | + } |
|
| 253 | + |
|
| 254 | + |
|
| 255 | + /** |
|
| 256 | + * load and setup EE_Capabilities |
|
| 257 | + * |
|
| 258 | + * @return void |
|
| 259 | + * @throws EE_Error |
|
| 260 | + */ |
|
| 261 | + public function loadCapabilities() |
|
| 262 | + { |
|
| 263 | + $this->capabilities = $this->loader->getShared('EE_Capabilities'); |
|
| 264 | + add_action( |
|
| 265 | + 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
| 266 | + function () { |
|
| 267 | + LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager'); |
|
| 268 | + } |
|
| 269 | + ); |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + |
|
| 273 | + /** |
|
| 274 | + * create and cache the CommandBus, and also add middleware |
|
| 275 | + * The CapChecker middleware requires the use of EE_Capabilities |
|
| 276 | + * which is why we need to load the CommandBus after Caps are set up |
|
| 277 | + * |
|
| 278 | + * @return void |
|
| 279 | + * @throws EE_Error |
|
| 280 | + */ |
|
| 281 | + public function loadCommandBus() |
|
| 282 | + { |
|
| 283 | + $this->loader->getShared( |
|
| 284 | + 'CommandBusInterface', |
|
| 285 | + array( |
|
| 286 | + null, |
|
| 287 | + apply_filters( |
|
| 288 | + 'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware', |
|
| 289 | + array( |
|
| 290 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'), |
|
| 291 | + $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'), |
|
| 292 | + ) |
|
| 293 | + ), |
|
| 294 | + ) |
|
| 295 | + ); |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + |
|
| 299 | + /** |
|
| 300 | + * @return void |
|
| 301 | + * @throws EE_Error |
|
| 302 | + */ |
|
| 303 | + public function loadPluginApi() |
|
| 304 | + { |
|
| 305 | + // set autoloaders for all of the classes implementing EEI_Plugin_API |
|
| 306 | + // which provide helpers for EE plugin authors to more easily register certain components with EE. |
|
| 307 | + EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api'); |
|
| 308 | + $this->loader->getShared('EE_Request_Handler'); |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + |
|
| 312 | + /** |
|
| 313 | + * @param string $addon_name |
|
| 314 | + * @param string $version_constant |
|
| 315 | + * @param string $min_version_required |
|
| 316 | + * @param string $load_callback |
|
| 317 | + * @param string $plugin_file_constant |
|
| 318 | + * @return void |
|
| 319 | + */ |
|
| 320 | + private function deactivateIncompatibleAddon( |
|
| 321 | + $addon_name, |
|
| 322 | + $version_constant, |
|
| 323 | + $min_version_required, |
|
| 324 | + $load_callback, |
|
| 325 | + $plugin_file_constant |
|
| 326 | + ) { |
|
| 327 | + if (! defined($version_constant)) { |
|
| 328 | + return; |
|
| 329 | + } |
|
| 330 | + $addon_version = constant($version_constant); |
|
| 331 | + if ($addon_version && version_compare($addon_version, $min_version_required, '<')) { |
|
| 332 | + remove_action('AHEE__EE_System__load_espresso_addons', $load_callback); |
|
| 333 | + if (! function_exists('deactivate_plugins')) { |
|
| 334 | + require_once ABSPATH . 'wp-admin/includes/plugin.php'; |
|
| 335 | + } |
|
| 336 | + deactivate_plugins(plugin_basename(constant($plugin_file_constant))); |
|
| 337 | + unset($_GET['activate'], $_REQUEST['activate'], $_GET['activate-multi'], $_REQUEST['activate-multi']); |
|
| 338 | + EE_Error::add_error( |
|
| 339 | + sprintf( |
|
| 340 | + esc_html__( |
|
| 341 | + 'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.', |
|
| 342 | + 'event_espresso' |
|
| 343 | + ), |
|
| 344 | + $addon_name, |
|
| 345 | + $min_version_required |
|
| 346 | + ), |
|
| 347 | + __FILE__, |
|
| 348 | + __FUNCTION__ . "({$addon_name})", |
|
| 349 | + __LINE__ |
|
| 350 | + ); |
|
| 351 | + EE_Error::get_notices(false, true); |
|
| 352 | + } |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * load_espresso_addons |
|
| 358 | + * allow addons to load first so that they can set hooks for running DMS's, etc |
|
| 359 | + * this is hooked into both: |
|
| 360 | + * 'AHEE__EE_Bootstrap__load_core_configuration' |
|
| 361 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
| 362 | + * and the WP 'activate_plugin' hook point |
|
| 363 | + * |
|
| 364 | + * @access public |
|
| 365 | + * @return void |
|
| 366 | + */ |
|
| 367 | + public function load_espresso_addons() |
|
| 368 | + { |
|
| 369 | + $this->deactivateIncompatibleAddon( |
|
| 370 | + 'Wait Lists', |
|
| 371 | + 'EE_WAIT_LISTS_VERSION', |
|
| 372 | + '1.0.0.beta.074', |
|
| 373 | + 'load_espresso_wait_lists', |
|
| 374 | + 'EE_WAIT_LISTS_PLUGIN_FILE' |
|
| 375 | + ); |
|
| 376 | + $this->deactivateIncompatibleAddon( |
|
| 377 | + 'Automated Upcoming Event Notifications', |
|
| 378 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION', |
|
| 379 | + '1.0.0.beta.091', |
|
| 380 | + 'load_espresso_automated_upcoming_event_notification', |
|
| 381 | + 'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE' |
|
| 382 | + ); |
|
| 383 | + do_action('AHEE__EE_System__load_espresso_addons'); |
|
| 384 | + // if the WP API basic auth plugin isn't already loaded, load it now. |
|
| 385 | + // We want it for mobile apps. Just include the entire plugin |
|
| 386 | + // also, don't load the basic auth when a plugin is getting activated, because |
|
| 387 | + // it could be the basic auth plugin, and it doesn't check if its methods are already defined |
|
| 388 | + // and causes a fatal error |
|
| 389 | + if ($this->request->getRequestParam('activate') !== 'true' |
|
| 390 | + && ! function_exists('json_basic_auth_handler') |
|
| 391 | + && ! function_exists('json_basic_auth_error') |
|
| 392 | + && ! in_array( |
|
| 393 | + $this->request->getRequestParam('action'), |
|
| 394 | + array('activate', 'activate-selected'), |
|
| 395 | + true |
|
| 396 | + ) |
|
| 397 | + ) { |
|
| 398 | + include_once EE_THIRD_PARTY . 'wp-api-basic-auth' . DS . 'basic-auth.php'; |
|
| 399 | + } |
|
| 400 | + do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
| 401 | + } |
|
| 402 | + |
|
| 403 | + |
|
| 404 | + /** |
|
| 405 | + * detect_activations_or_upgrades |
|
| 406 | + * Checks for activation or upgrade of core first; |
|
| 407 | + * then also checks if any registered addons have been activated or upgraded |
|
| 408 | + * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
| 409 | + * which runs during the WP 'plugins_loaded' action at priority 3 |
|
| 410 | + * |
|
| 411 | + * @access public |
|
| 412 | + * @return void |
|
| 413 | + */ |
|
| 414 | + public function detect_activations_or_upgrades() |
|
| 415 | + { |
|
| 416 | + // first off: let's make sure to handle core |
|
| 417 | + $this->detect_if_activation_or_upgrade(); |
|
| 418 | + foreach ($this->registry->addons as $addon) { |
|
| 419 | + if ($addon instanceof EE_Addon) { |
|
| 420 | + // detect teh request type for that addon |
|
| 421 | + $addon->detect_activation_or_upgrade(); |
|
| 422 | + } |
|
| 423 | + } |
|
| 424 | + } |
|
| 425 | + |
|
| 426 | + |
|
| 427 | + /** |
|
| 428 | + * detect_if_activation_or_upgrade |
|
| 429 | + * Takes care of detecting whether this is a brand new install or code upgrade, |
|
| 430 | + * and either setting up the DB or setting up maintenance mode etc. |
|
| 431 | + * |
|
| 432 | + * @access public |
|
| 433 | + * @return void |
|
| 434 | + */ |
|
| 435 | + public function detect_if_activation_or_upgrade() |
|
| 436 | + { |
|
| 437 | + do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
| 438 | + // check if db has been updated, or if its a brand-new installation |
|
| 439 | + $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
| 440 | + $request_type = $this->detect_req_type($espresso_db_update); |
|
| 441 | + // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
| 442 | + switch ($request_type) { |
|
| 443 | + case EE_System::req_type_new_activation: |
|
| 444 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
| 445 | + $this->_handle_core_version_change($espresso_db_update); |
|
| 446 | + break; |
|
| 447 | + case EE_System::req_type_reactivation: |
|
| 448 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
| 449 | + $this->_handle_core_version_change($espresso_db_update); |
|
| 450 | + break; |
|
| 451 | + case EE_System::req_type_upgrade: |
|
| 452 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
| 453 | + // migrations may be required now that we've upgraded |
|
| 454 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
| 455 | + $this->_handle_core_version_change($espresso_db_update); |
|
| 456 | + break; |
|
| 457 | + case EE_System::req_type_downgrade: |
|
| 458 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
| 459 | + // its possible migrations are no longer required |
|
| 460 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
| 461 | + $this->_handle_core_version_change($espresso_db_update); |
|
| 462 | + break; |
|
| 463 | + case EE_System::req_type_normal: |
|
| 464 | + default: |
|
| 465 | + break; |
|
| 466 | + } |
|
| 467 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
| 468 | + } |
|
| 469 | + |
|
| 470 | + |
|
| 471 | + /** |
|
| 472 | + * Updates the list of installed versions and sets hooks for |
|
| 473 | + * initializing the database later during the request |
|
| 474 | + * |
|
| 475 | + * @param array $espresso_db_update |
|
| 476 | + */ |
|
| 477 | + private function _handle_core_version_change($espresso_db_update) |
|
| 478 | + { |
|
| 479 | + $this->update_list_of_installed_versions($espresso_db_update); |
|
| 480 | + // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
| 481 | + add_action( |
|
| 482 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
| 483 | + array($this, 'initialize_db_if_no_migrations_required') |
|
| 484 | + ); |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + |
|
| 488 | + /** |
|
| 489 | + * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
| 490 | + * information about what versions of EE have been installed and activated, |
|
| 491 | + * NOT necessarily the state of the database |
|
| 492 | + * |
|
| 493 | + * @param mixed $espresso_db_update the value of the WordPress option. |
|
| 494 | + * If not supplied, fetches it from the options table |
|
| 495 | + * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
| 496 | + */ |
|
| 497 | + private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
| 498 | + { |
|
| 499 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
| 500 | + if (! $espresso_db_update) { |
|
| 501 | + $espresso_db_update = get_option('espresso_db_update'); |
|
| 502 | + } |
|
| 503 | + // check that option is an array |
|
| 504 | + if (! is_array($espresso_db_update)) { |
|
| 505 | + // if option is FALSE, then it never existed |
|
| 506 | + if ($espresso_db_update === false) { |
|
| 507 | + // make $espresso_db_update an array and save option with autoload OFF |
|
| 508 | + $espresso_db_update = array(); |
|
| 509 | + add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
| 510 | + } else { |
|
| 511 | + // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
| 512 | + $espresso_db_update = array($espresso_db_update => array()); |
|
| 513 | + update_option('espresso_db_update', $espresso_db_update); |
|
| 514 | + } |
|
| 515 | + } else { |
|
| 516 | + $corrected_db_update = array(); |
|
| 517 | + // if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
| 518 | + foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
| 519 | + if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
| 520 | + // the key is an int, and the value IS NOT an array |
|
| 521 | + // so it must be numerically-indexed, where values are versions installed... |
|
| 522 | + // fix it! |
|
| 523 | + $version_string = $should_be_array; |
|
| 524 | + $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
| 525 | + } else { |
|
| 526 | + // ok it checks out |
|
| 527 | + $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
| 528 | + } |
|
| 529 | + } |
|
| 530 | + $espresso_db_update = $corrected_db_update; |
|
| 531 | + update_option('espresso_db_update', $espresso_db_update); |
|
| 532 | + } |
|
| 533 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
| 534 | + return $espresso_db_update; |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + |
|
| 538 | + /** |
|
| 539 | + * Does the traditional work of setting up the plugin's database and adding default data. |
|
| 540 | + * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
| 541 | + * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
| 542 | + * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
| 543 | + * so that it will be done when migrations are finished |
|
| 544 | + * |
|
| 545 | + * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
| 546 | + * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
| 547 | + * This is a resource-intensive job |
|
| 548 | + * so we prefer to only do it when necessary |
|
| 549 | + * @return void |
|
| 550 | + * @throws EE_Error |
|
| 551 | + */ |
|
| 552 | + public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
| 553 | + { |
|
| 554 | + $request_type = $this->detect_req_type(); |
|
| 555 | + // only initialize system if we're not in maintenance mode. |
|
| 556 | + if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
| 557 | + /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
| 558 | + $rewrite_rules = $this->loader->getShared( |
|
| 559 | + 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
| 560 | + ); |
|
| 561 | + $rewrite_rules->flush(); |
|
| 562 | + if ($verify_schema) { |
|
| 563 | + EEH_Activation::initialize_db_and_folders(); |
|
| 564 | + } |
|
| 565 | + EEH_Activation::initialize_db_content(); |
|
| 566 | + EEH_Activation::system_initialization(); |
|
| 567 | + if ($initialize_addons_too) { |
|
| 568 | + $this->initialize_addons(); |
|
| 569 | + } |
|
| 570 | + } else { |
|
| 571 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
| 572 | + } |
|
| 573 | + if ($request_type === EE_System::req_type_new_activation |
|
| 574 | + || $request_type === EE_System::req_type_reactivation |
|
| 575 | + || ( |
|
| 576 | + $request_type === EE_System::req_type_upgrade |
|
| 577 | + && $this->is_major_version_change() |
|
| 578 | + ) |
|
| 579 | + ) { |
|
| 580 | + add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
| 581 | + } |
|
| 582 | + } |
|
| 583 | + |
|
| 584 | + |
|
| 585 | + /** |
|
| 586 | + * Initializes the db for all registered addons |
|
| 587 | + * |
|
| 588 | + * @throws EE_Error |
|
| 589 | + */ |
|
| 590 | + public function initialize_addons() |
|
| 591 | + { |
|
| 592 | + // foreach registered addon, make sure its db is up-to-date too |
|
| 593 | + foreach ($this->registry->addons as $addon) { |
|
| 594 | + if ($addon instanceof EE_Addon) { |
|
| 595 | + $addon->initialize_db_if_no_migrations_required(); |
|
| 596 | + } |
|
| 597 | + } |
|
| 598 | + } |
|
| 599 | + |
|
| 600 | + |
|
| 601 | + /** |
|
| 602 | + * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
| 603 | + * |
|
| 604 | + * @param array $version_history |
|
| 605 | + * @param string $current_version_to_add version to be added to the version history |
|
| 606 | + * @return boolean success as to whether or not this option was changed |
|
| 607 | + */ |
|
| 608 | + public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
| 609 | + { |
|
| 610 | + if (! $version_history) { |
|
| 611 | + $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
| 612 | + } |
|
| 613 | + if ($current_version_to_add === null) { |
|
| 614 | + $current_version_to_add = espresso_version(); |
|
| 615 | + } |
|
| 616 | + $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
| 617 | + // re-save |
|
| 618 | + return update_option('espresso_db_update', $version_history); |
|
| 619 | + } |
|
| 620 | + |
|
| 621 | + |
|
| 622 | + /** |
|
| 623 | + * Detects if the current version indicated in the has existed in the list of |
|
| 624 | + * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
| 625 | + * |
|
| 626 | + * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
| 627 | + * If not supplied, fetches it from the options table. |
|
| 628 | + * Also, caches its result so later parts of the code can also know whether |
|
| 629 | + * there's been an update or not. This way we can add the current version to |
|
| 630 | + * espresso_db_update, but still know if this is a new install or not |
|
| 631 | + * @return int one of the constants on EE_System::req_type_ |
|
| 632 | + */ |
|
| 633 | + public function detect_req_type($espresso_db_update = null) |
|
| 634 | + { |
|
| 635 | + if ($this->_req_type === null) { |
|
| 636 | + $espresso_db_update = ! empty($espresso_db_update) |
|
| 637 | + ? $espresso_db_update |
|
| 638 | + : $this->fix_espresso_db_upgrade_option(); |
|
| 639 | + $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
| 640 | + $espresso_db_update, |
|
| 641 | + 'ee_espresso_activation', |
|
| 642 | + espresso_version() |
|
| 643 | + ); |
|
| 644 | + $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
| 645 | + $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
| 646 | + } |
|
| 647 | + return $this->_req_type; |
|
| 648 | + } |
|
| 649 | + |
|
| 650 | + |
|
| 651 | + /** |
|
| 652 | + * Returns whether or not there was a non-micro version change (ie, change in either |
|
| 653 | + * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
| 654 | + * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
| 655 | + * |
|
| 656 | + * @param $activation_history |
|
| 657 | + * @return bool |
|
| 658 | + */ |
|
| 659 | + private function _detect_major_version_change($activation_history) |
|
| 660 | + { |
|
| 661 | + $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
| 662 | + $previous_version_parts = explode('.', $previous_version); |
|
| 663 | + $current_version_parts = explode('.', espresso_version()); |
|
| 664 | + return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
| 665 | + && ($previous_version_parts[0] !== $current_version_parts[0] |
|
| 666 | + || $previous_version_parts[1] !== $current_version_parts[1] |
|
| 667 | + ); |
|
| 668 | + } |
|
| 669 | + |
|
| 670 | + |
|
| 671 | + /** |
|
| 672 | + * Returns true if either the major or minor version of EE changed during this request. |
|
| 673 | + * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
| 674 | + * |
|
| 675 | + * @return bool |
|
| 676 | + */ |
|
| 677 | + public function is_major_version_change() |
|
| 678 | + { |
|
| 679 | + return $this->_major_version_change; |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
| 685 | + * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
| 686 | + * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
| 687 | + * just activated to (for core that will always be espresso_version()) |
|
| 688 | + * |
|
| 689 | + * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
| 690 | + * ee plugin. for core that's 'espresso_db_update' |
|
| 691 | + * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
| 692 | + * indicate that this plugin was just activated |
|
| 693 | + * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
| 694 | + * espresso_version()) |
|
| 695 | + * @return int one of the constants on EE_System::req_type_* |
|
| 696 | + */ |
|
| 697 | + public static function detect_req_type_given_activation_history( |
|
| 698 | + $activation_history_for_addon, |
|
| 699 | + $activation_indicator_option_name, |
|
| 700 | + $version_to_upgrade_to |
|
| 701 | + ) { |
|
| 702 | + $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
| 703 | + if ($activation_history_for_addon) { |
|
| 704 | + // it exists, so this isn't a completely new install |
|
| 705 | + // check if this version already in that list of previously installed versions |
|
| 706 | + if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
| 707 | + // it a version we haven't seen before |
|
| 708 | + if ($version_is_higher === 1) { |
|
| 709 | + $req_type = EE_System::req_type_upgrade; |
|
| 710 | + } else { |
|
| 711 | + $req_type = EE_System::req_type_downgrade; |
|
| 712 | + } |
|
| 713 | + delete_option($activation_indicator_option_name); |
|
| 714 | + } else { |
|
| 715 | + // its not an update. maybe a reactivation? |
|
| 716 | + if (get_option($activation_indicator_option_name, false)) { |
|
| 717 | + if ($version_is_higher === -1) { |
|
| 718 | + $req_type = EE_System::req_type_downgrade; |
|
| 719 | + } elseif ($version_is_higher === 0) { |
|
| 720 | + // we've seen this version before, but it's an activation. must be a reactivation |
|
| 721 | + $req_type = EE_System::req_type_reactivation; |
|
| 722 | + } else {// $version_is_higher === 1 |
|
| 723 | + $req_type = EE_System::req_type_upgrade; |
|
| 724 | + } |
|
| 725 | + delete_option($activation_indicator_option_name); |
|
| 726 | + } else { |
|
| 727 | + // we've seen this version before and the activation indicate doesn't show it was just activated |
|
| 728 | + if ($version_is_higher === -1) { |
|
| 729 | + $req_type = EE_System::req_type_downgrade; |
|
| 730 | + } elseif ($version_is_higher === 0) { |
|
| 731 | + // we've seen this version before and it's not an activation. its normal request |
|
| 732 | + $req_type = EE_System::req_type_normal; |
|
| 733 | + } else {// $version_is_higher === 1 |
|
| 734 | + $req_type = EE_System::req_type_upgrade; |
|
| 735 | + } |
|
| 736 | + } |
|
| 737 | + } |
|
| 738 | + } else { |
|
| 739 | + // brand new install |
|
| 740 | + $req_type = EE_System::req_type_new_activation; |
|
| 741 | + delete_option($activation_indicator_option_name); |
|
| 742 | + } |
|
| 743 | + return $req_type; |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + |
|
| 747 | + /** |
|
| 748 | + * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
| 749 | + * the $activation_history_for_addon |
|
| 750 | + * |
|
| 751 | + * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
| 752 | + * sometimes containing 'unknown-date' |
|
| 753 | + * @param string $version_to_upgrade_to (current version) |
|
| 754 | + * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
| 755 | + * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
| 756 | + * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
| 757 | + * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
| 758 | + */ |
|
| 759 | + private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
| 760 | + { |
|
| 761 | + // find the most recently-activated version |
|
| 762 | + $most_recently_active_version = |
|
| 763 | + EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
| 764 | + return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
| 765 | + } |
|
| 766 | + |
|
| 767 | + |
|
| 768 | + /** |
|
| 769 | + * Gets the most recently active version listed in the activation history, |
|
| 770 | + * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
| 771 | + * |
|
| 772 | + * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
| 773 | + * sometimes containing 'unknown-date' |
|
| 774 | + * @return string |
|
| 775 | + */ |
|
| 776 | + private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
| 777 | + { |
|
| 778 | + $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
| 779 | + $most_recently_active_version = '0.0.0.dev.000'; |
|
| 780 | + if (is_array($activation_history)) { |
|
| 781 | + foreach ($activation_history as $version => $times_activated) { |
|
| 782 | + // check there is a record of when this version was activated. Otherwise, |
|
| 783 | + // mark it as unknown |
|
| 784 | + if (! $times_activated) { |
|
| 785 | + $times_activated = array('unknown-date'); |
|
| 786 | + } |
|
| 787 | + if (is_string($times_activated)) { |
|
| 788 | + $times_activated = array($times_activated); |
|
| 789 | + } |
|
| 790 | + foreach ($times_activated as $an_activation) { |
|
| 791 | + if ($an_activation !== 'unknown-date' |
|
| 792 | + && $an_activation |
|
| 793 | + > $most_recently_active_version_activation) { |
|
| 794 | + $most_recently_active_version = $version; |
|
| 795 | + $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
| 796 | + ? '1970-01-01 00:00:00' |
|
| 797 | + : $an_activation; |
|
| 798 | + } |
|
| 799 | + } |
|
| 800 | + } |
|
| 801 | + } |
|
| 802 | + return $most_recently_active_version; |
|
| 803 | + } |
|
| 804 | + |
|
| 805 | + |
|
| 806 | + /** |
|
| 807 | + * This redirects to the about EE page after activation |
|
| 808 | + * |
|
| 809 | + * @return void |
|
| 810 | + */ |
|
| 811 | + public function redirect_to_about_ee() |
|
| 812 | + { |
|
| 813 | + $notices = EE_Error::get_notices(false); |
|
| 814 | + // if current user is an admin and it's not an ajax or rest request |
|
| 815 | + if (! isset($notices['errors']) |
|
| 816 | + && $this->request->isAdmin() |
|
| 817 | + && apply_filters( |
|
| 818 | + 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
| 819 | + $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
| 820 | + ) |
|
| 821 | + ) { |
|
| 822 | + $query_params = array('page' => 'espresso_about'); |
|
| 823 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
| 824 | + $query_params['new_activation'] = true; |
|
| 825 | + } |
|
| 826 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
| 827 | + $query_params['reactivation'] = true; |
|
| 828 | + } |
|
| 829 | + $url = add_query_arg($query_params, admin_url('admin.php')); |
|
| 830 | + wp_safe_redirect($url); |
|
| 831 | + exit(); |
|
| 832 | + } |
|
| 833 | + } |
|
| 834 | + |
|
| 835 | + |
|
| 836 | + /** |
|
| 837 | + * load_core_configuration |
|
| 838 | + * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
| 839 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
| 840 | + * |
|
| 841 | + * @return void |
|
| 842 | + * @throws ReflectionException |
|
| 843 | + * @throws Exception |
|
| 844 | + */ |
|
| 845 | + public function load_core_configuration() |
|
| 846 | + { |
|
| 847 | + do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
| 848 | + $this->loader->getShared('EE_Load_Textdomain'); |
|
| 849 | + // load textdomain |
|
| 850 | + EE_Load_Textdomain::load_textdomain(); |
|
| 851 | + // load and setup EE_Config and EE_Network_Config |
|
| 852 | + $config = $this->loader->getShared('EE_Config'); |
|
| 853 | + $this->loader->getShared('EE_Network_Config'); |
|
| 854 | + // setup autoloaders |
|
| 855 | + // enable logging? |
|
| 856 | + if ($config->admin->use_full_logging) { |
|
| 857 | + $this->loader->getShared('EE_Log'); |
|
| 858 | + } |
|
| 859 | + // check for activation errors |
|
| 860 | + $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
| 861 | + if ($activation_errors) { |
|
| 862 | + EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
| 863 | + update_option('ee_plugin_activation_errors', false); |
|
| 864 | + } |
|
| 865 | + // get model names |
|
| 866 | + $this->_parse_model_names(); |
|
| 867 | + // load caf stuff a chance to play during the activation process too. |
|
| 868 | + $this->_maybe_brew_regular(); |
|
| 869 | + // configure custom post type definitions |
|
| 870 | + $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'); |
|
| 871 | + $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'); |
|
| 872 | + do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
| 873 | + } |
|
| 874 | + |
|
| 875 | + |
|
| 876 | + /** |
|
| 877 | + * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
| 878 | + * |
|
| 879 | + * @return void |
|
| 880 | + * @throws ReflectionException |
|
| 881 | + */ |
|
| 882 | + private function _parse_model_names() |
|
| 883 | + { |
|
| 884 | + // get all the files in the EE_MODELS folder that end in .model.php |
|
| 885 | + $models = glob(EE_MODELS . '*.model.php'); |
|
| 886 | + $model_names = array(); |
|
| 887 | + $non_abstract_db_models = array(); |
|
| 888 | + foreach ($models as $model) { |
|
| 889 | + // get model classname |
|
| 890 | + $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
| 891 | + $short_name = str_replace('EEM_', '', $classname); |
|
| 892 | + $reflectionClass = new ReflectionClass($classname); |
|
| 893 | + if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
| 894 | + $non_abstract_db_models[ $short_name ] = $classname; |
|
| 895 | + } |
|
| 896 | + $model_names[ $short_name ] = $classname; |
|
| 897 | + } |
|
| 898 | + $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
| 899 | + $this->registry->non_abstract_db_models = apply_filters( |
|
| 900 | + 'FHEE__EE_System__parse_implemented_model_names', |
|
| 901 | + $non_abstract_db_models |
|
| 902 | + ); |
|
| 903 | + } |
|
| 904 | + |
|
| 905 | + |
|
| 906 | + /** |
|
| 907 | + * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
| 908 | + * that need to be setup before our EE_System launches. |
|
| 909 | + * |
|
| 910 | + * @return void |
|
| 911 | + * @throws DomainException |
|
| 912 | + * @throws InvalidArgumentException |
|
| 913 | + * @throws InvalidDataTypeException |
|
| 914 | + * @throws InvalidInterfaceException |
|
| 915 | + * @throws InvalidClassException |
|
| 916 | + * @throws InvalidFilePathException |
|
| 917 | + */ |
|
| 918 | + private function _maybe_brew_regular() |
|
| 919 | + { |
|
| 920 | + /** @var Domain $domain */ |
|
| 921 | + $domain = DomainFactory::getShared( |
|
| 922 | + new FullyQualifiedName( |
|
| 923 | + 'EventEspresso\core\domain\Domain' |
|
| 924 | + ), |
|
| 925 | + array( |
|
| 926 | + new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
| 927 | + Version::fromString(espresso_version()), |
|
| 928 | + ) |
|
| 929 | + ); |
|
| 930 | + if ($domain->isCaffeinated()) { |
|
| 931 | + require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
| 932 | + } |
|
| 933 | + } |
|
| 934 | + |
|
| 935 | + |
|
| 936 | + /** |
|
| 937 | + * @since $VID:$ |
|
| 938 | + * @throws Exception |
|
| 939 | + */ |
|
| 940 | + public function loadRouteMatchSpecifications() |
|
| 941 | + { |
|
| 942 | + try { |
|
| 943 | + $this->loader->getShared( |
|
| 944 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' |
|
| 945 | + ); |
|
| 946 | + } catch (Exception $exception) { |
|
| 947 | + new ExceptionStackTraceDisplay($exception); |
|
| 948 | + } |
|
| 949 | + do_action('AHEE__EE_System__loadRouteMatchSpecifications'); |
|
| 950 | + } |
|
| 951 | + |
|
| 952 | + |
|
| 953 | + /** |
|
| 954 | + * register_shortcodes_modules_and_widgets |
|
| 955 | + * generate lists of shortcodes and modules, then verify paths and classes |
|
| 956 | + * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
| 957 | + * which runs during the WP 'plugins_loaded' action at priority 7 |
|
| 958 | + * |
|
| 959 | + * @access public |
|
| 960 | + * @return void |
|
| 961 | + * @throws Exception |
|
| 962 | + */ |
|
| 963 | + public function register_shortcodes_modules_and_widgets() |
|
| 964 | + { |
|
| 965 | + if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) { |
|
| 966 | + try { |
|
| 967 | + // load, register, and add shortcodes the new way |
|
| 968 | + $this->loader->getShared( |
|
| 969 | + 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
| 970 | + array( |
|
| 971 | + // and the old way, but we'll put it under control of the new system |
|
| 972 | + EE_Config::getLegacyShortcodesManager(), |
|
| 973 | + ) |
|
| 974 | + ); |
|
| 975 | + } catch (Exception $exception) { |
|
| 976 | + new ExceptionStackTraceDisplay($exception); |
|
| 977 | + } |
|
| 978 | + } |
|
| 979 | + do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
| 980 | + // check for addons using old hook point |
|
| 981 | + if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
| 982 | + $this->_incompatible_addon_error(); |
|
| 983 | + } |
|
| 984 | + } |
|
| 985 | + |
|
| 986 | + |
|
| 987 | + /** |
|
| 988 | + * _incompatible_addon_error |
|
| 989 | + * |
|
| 990 | + * @access public |
|
| 991 | + * @return void |
|
| 992 | + */ |
|
| 993 | + private function _incompatible_addon_error() |
|
| 994 | + { |
|
| 995 | + // get array of classes hooking into here |
|
| 996 | + $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
| 997 | + 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
| 998 | + ); |
|
| 999 | + if (! empty($class_names)) { |
|
| 1000 | + $msg = __( |
|
| 1001 | + 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
| 1002 | + 'event_espresso' |
|
| 1003 | + ); |
|
| 1004 | + $msg .= '<ul>'; |
|
| 1005 | + foreach ($class_names as $class_name) { |
|
| 1006 | + $msg .= '<li><b>Event Espresso - ' |
|
| 1007 | + . str_replace( |
|
| 1008 | + array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), |
|
| 1009 | + '', |
|
| 1010 | + $class_name |
|
| 1011 | + ) . '</b></li>'; |
|
| 1012 | + } |
|
| 1013 | + $msg .= '</ul>'; |
|
| 1014 | + $msg .= __( |
|
| 1015 | + 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
| 1016 | + 'event_espresso' |
|
| 1017 | + ); |
|
| 1018 | + // save list of incompatible addons to wp-options for later use |
|
| 1019 | + add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
| 1020 | + if (is_admin()) { |
|
| 1021 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1022 | + } |
|
| 1023 | + } |
|
| 1024 | + } |
|
| 1025 | + |
|
| 1026 | + |
|
| 1027 | + /** |
|
| 1028 | + * brew_espresso |
|
| 1029 | + * begins the process of setting hooks for initializing EE in the correct order |
|
| 1030 | + * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
| 1031 | + * which runs during the WP 'plugins_loaded' action at priority 9 |
|
| 1032 | + * |
|
| 1033 | + * @return void |
|
| 1034 | + */ |
|
| 1035 | + public function brew_espresso() |
|
| 1036 | + { |
|
| 1037 | + do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
| 1038 | + // load some final core systems |
|
| 1039 | + add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
| 1040 | + add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
| 1041 | + add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
| 1042 | + add_action('init', array($this, 'load_controllers'), 7); |
|
| 1043 | + add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
| 1044 | + add_action('init', array($this, 'initialize'), 10); |
|
| 1045 | + add_action('init', array($this, 'initialize_last'), 100); |
|
| 1046 | + if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
| 1047 | + // pew pew pew |
|
| 1048 | + $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
| 1049 | + do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
| 1050 | + } |
|
| 1051 | + do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
| 1052 | + } |
|
| 1053 | + |
|
| 1054 | + |
|
| 1055 | + /** |
|
| 1056 | + * set_hooks_for_core |
|
| 1057 | + * |
|
| 1058 | + * @access public |
|
| 1059 | + * @return void |
|
| 1060 | + * @throws EE_Error |
|
| 1061 | + */ |
|
| 1062 | + public function set_hooks_for_core() |
|
| 1063 | + { |
|
| 1064 | + $this->_deactivate_incompatible_addons(); |
|
| 1065 | + do_action('AHEE__EE_System__set_hooks_for_core'); |
|
| 1066 | + $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
| 1067 | + // caps need to be initialized on every request so that capability maps are set. |
|
| 1068 | + // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
| 1069 | + $this->registry->CAP->init_caps(); |
|
| 1070 | + } |
|
| 1071 | + |
|
| 1072 | + |
|
| 1073 | + /** |
|
| 1074 | + * Using the information gathered in EE_System::_incompatible_addon_error, |
|
| 1075 | + * deactivates any addons considered incompatible with the current version of EE |
|
| 1076 | + */ |
|
| 1077 | + private function _deactivate_incompatible_addons() |
|
| 1078 | + { |
|
| 1079 | + $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
| 1080 | + if (! empty($incompatible_addons)) { |
|
| 1081 | + $active_plugins = get_option('active_plugins', array()); |
|
| 1082 | + foreach ($active_plugins as $active_plugin) { |
|
| 1083 | + foreach ($incompatible_addons as $incompatible_addon) { |
|
| 1084 | + if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
| 1085 | + unset($_GET['activate']); |
|
| 1086 | + espresso_deactivate_plugin($active_plugin); |
|
| 1087 | + } |
|
| 1088 | + } |
|
| 1089 | + } |
|
| 1090 | + } |
|
| 1091 | + } |
|
| 1092 | + |
|
| 1093 | + |
|
| 1094 | + /** |
|
| 1095 | + * perform_activations_upgrades_and_migrations |
|
| 1096 | + * |
|
| 1097 | + * @access public |
|
| 1098 | + * @return void |
|
| 1099 | + */ |
|
| 1100 | + public function perform_activations_upgrades_and_migrations() |
|
| 1101 | + { |
|
| 1102 | + do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
| 1103 | + } |
|
| 1104 | + |
|
| 1105 | + |
|
| 1106 | + /** |
|
| 1107 | + * @return void |
|
| 1108 | + * @throws DomainException |
|
| 1109 | + */ |
|
| 1110 | + public function load_CPTs_and_session() |
|
| 1111 | + { |
|
| 1112 | + do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
| 1113 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */ |
|
| 1114 | + $register_custom_taxonomies = $this->loader->getShared( |
|
| 1115 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' |
|
| 1116 | + ); |
|
| 1117 | + $register_custom_taxonomies->registerCustomTaxonomies(); |
|
| 1118 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */ |
|
| 1119 | + $register_custom_post_types = $this->loader->getShared( |
|
| 1120 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' |
|
| 1121 | + ); |
|
| 1122 | + $register_custom_post_types->registerCustomPostTypes(); |
|
| 1123 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */ |
|
| 1124 | + $register_custom_taxonomy_terms = $this->loader->getShared( |
|
| 1125 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms' |
|
| 1126 | + ); |
|
| 1127 | + $register_custom_taxonomy_terms->registerCustomTaxonomyTerms(); |
|
| 1128 | + // load legacy Custom Post Types and Taxonomies |
|
| 1129 | + $this->loader->getShared('EE_Register_CPTs'); |
|
| 1130 | + do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
| 1131 | + } |
|
| 1132 | + |
|
| 1133 | + |
|
| 1134 | + /** |
|
| 1135 | + * load_controllers |
|
| 1136 | + * this is the best place to load any additional controllers that needs access to EE core. |
|
| 1137 | + * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
| 1138 | + * time |
|
| 1139 | + * |
|
| 1140 | + * @access public |
|
| 1141 | + * @return void |
|
| 1142 | + */ |
|
| 1143 | + public function load_controllers() |
|
| 1144 | + { |
|
| 1145 | + do_action('AHEE__EE_System__load_controllers__start'); |
|
| 1146 | + // let's get it started |
|
| 1147 | + if (! $this->maintenance_mode->level() |
|
| 1148 | + && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
| 1149 | + ) { |
|
| 1150 | + do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
| 1151 | + $this->loader->getShared('EE_Front_Controller'); |
|
| 1152 | + } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
| 1153 | + do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
| 1154 | + $this->loader->getShared('EE_Admin'); |
|
| 1155 | + } |
|
| 1156 | + do_action('AHEE__EE_System__load_controllers__complete'); |
|
| 1157 | + } |
|
| 1158 | + |
|
| 1159 | + |
|
| 1160 | + /** |
|
| 1161 | + * core_loaded_and_ready |
|
| 1162 | + * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
| 1163 | + * |
|
| 1164 | + * @access public |
|
| 1165 | + * @return void |
|
| 1166 | + * @throws Exception |
|
| 1167 | + */ |
|
| 1168 | + public function core_loaded_and_ready() |
|
| 1169 | + { |
|
| 1170 | + if ($this->request->isAdmin() || $this->request->isFrontend() || $this->request->isIframe()) { |
|
| 1171 | + try { |
|
| 1172 | + $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
| 1173 | + $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager'); |
|
| 1174 | + if (function_exists('register_block_type')) { |
|
| 1175 | + $this->loader->getShared( |
|
| 1176 | + 'EventEspresso\core\services\editor\BlockRegistrationManager' |
|
| 1177 | + ); |
|
| 1178 | + } |
|
| 1179 | + } catch (Exception $exception) { |
|
| 1180 | + new ExceptionStackTraceDisplay($exception); |
|
| 1181 | + } |
|
| 1182 | + } |
|
| 1183 | + if ($this->request->isAdmin() |
|
| 1184 | + || $this->request->isEeAjax() |
|
| 1185 | + || $this->request->isFrontend() |
|
| 1186 | + ) { |
|
| 1187 | + $this->loader->getShared('EE_Session'); |
|
| 1188 | + } |
|
| 1189 | + // integrate WP_Query with the EE models |
|
| 1190 | + $this->loader->getShared('EE_CPT_Strategy'); |
|
| 1191 | + do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
| 1192 | + // always load template tags, because it's faster than checking if it's a front-end request, and many page |
|
| 1193 | + // builders require these even on the front-end |
|
| 1194 | + require_once EE_PUBLIC . 'template_tags.php'; |
|
| 1195 | + do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
| 1196 | + } |
|
| 1197 | + |
|
| 1198 | + |
|
| 1199 | + /** |
|
| 1200 | + * initialize |
|
| 1201 | + * this is the best place to begin initializing client code |
|
| 1202 | + * |
|
| 1203 | + * @access public |
|
| 1204 | + * @return void |
|
| 1205 | + */ |
|
| 1206 | + public function initialize() |
|
| 1207 | + { |
|
| 1208 | + do_action('AHEE__EE_System__initialize'); |
|
| 1209 | + } |
|
| 1210 | + |
|
| 1211 | + |
|
| 1212 | + /** |
|
| 1213 | + * initialize_last |
|
| 1214 | + * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
| 1215 | + * initialize has done so |
|
| 1216 | + * |
|
| 1217 | + * @access public |
|
| 1218 | + * @return void |
|
| 1219 | + */ |
|
| 1220 | + public function initialize_last() |
|
| 1221 | + { |
|
| 1222 | + do_action('AHEE__EE_System__initialize_last'); |
|
| 1223 | + /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
| 1224 | + $rewrite_rules = $this->loader->getShared( |
|
| 1225 | + 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
| 1226 | + ); |
|
| 1227 | + $rewrite_rules->flushRewriteRules(); |
|
| 1228 | + add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
| 1229 | + if (($this->request->isAjax() || $this->request->isAdmin()) |
|
| 1230 | + && $this->maintenance_mode->models_can_query()) { |
|
| 1231 | + $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager'); |
|
| 1232 | + $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager'); |
|
| 1233 | + } |
|
| 1234 | + } |
|
| 1235 | + |
|
| 1236 | + |
|
| 1237 | + /** |
|
| 1238 | + * @return void |
|
| 1239 | + * @throws EE_Error |
|
| 1240 | + */ |
|
| 1241 | + public function addEspressoToolbar() |
|
| 1242 | + { |
|
| 1243 | + $this->loader->getShared( |
|
| 1244 | + 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
| 1245 | + array($this->registry->CAP) |
|
| 1246 | + ); |
|
| 1247 | + } |
|
| 1248 | + |
|
| 1249 | + |
|
| 1250 | + /** |
|
| 1251 | + * do_not_cache |
|
| 1252 | + * sets no cache headers and defines no cache constants for WP plugins |
|
| 1253 | + * |
|
| 1254 | + * @access public |
|
| 1255 | + * @return void |
|
| 1256 | + */ |
|
| 1257 | + public static function do_not_cache() |
|
| 1258 | + { |
|
| 1259 | + // set no cache constants |
|
| 1260 | + if (! defined('DONOTCACHEPAGE')) { |
|
| 1261 | + define('DONOTCACHEPAGE', true); |
|
| 1262 | + } |
|
| 1263 | + if (! defined('DONOTCACHCEOBJECT')) { |
|
| 1264 | + define('DONOTCACHCEOBJECT', true); |
|
| 1265 | + } |
|
| 1266 | + if (! defined('DONOTCACHEDB')) { |
|
| 1267 | + define('DONOTCACHEDB', true); |
|
| 1268 | + } |
|
| 1269 | + // add no cache headers |
|
| 1270 | + add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
| 1271 | + // plus a little extra for nginx and Google Chrome |
|
| 1272 | + add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
| 1273 | + // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
| 1274 | + remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
| 1275 | + } |
|
| 1276 | + |
|
| 1277 | + |
|
| 1278 | + /** |
|
| 1279 | + * extra_nocache_headers |
|
| 1280 | + * |
|
| 1281 | + * @access public |
|
| 1282 | + * @param $headers |
|
| 1283 | + * @return array |
|
| 1284 | + */ |
|
| 1285 | + public static function extra_nocache_headers($headers) |
|
| 1286 | + { |
|
| 1287 | + // for NGINX |
|
| 1288 | + $headers['X-Accel-Expires'] = 0; |
|
| 1289 | + // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
| 1290 | + $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
| 1291 | + return $headers; |
|
| 1292 | + } |
|
| 1293 | + |
|
| 1294 | + |
|
| 1295 | + /** |
|
| 1296 | + * nocache_headers |
|
| 1297 | + * |
|
| 1298 | + * @access public |
|
| 1299 | + * @return void |
|
| 1300 | + */ |
|
| 1301 | + public static function nocache_headers() |
|
| 1302 | + { |
|
| 1303 | + nocache_headers(); |
|
| 1304 | + } |
|
| 1305 | + |
|
| 1306 | + |
|
| 1307 | + /** |
|
| 1308 | + * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
| 1309 | + * never returned with the function. |
|
| 1310 | + * |
|
| 1311 | + * @param array $exclude_array any existing pages being excluded are in this array. |
|
| 1312 | + * @return array |
|
| 1313 | + */ |
|
| 1314 | + public function remove_pages_from_wp_list_pages($exclude_array) |
|
| 1315 | + { |
|
| 1316 | + return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
| 1317 | + } |
|
| 1318 | 1318 | } |
@@ -20,1028 +20,1028 @@ |
||
| 20 | 20 | class EE_Dependency_Map |
| 21 | 21 | { |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * This means that the requested class dependency is not present in the dependency map |
|
| 25 | - */ |
|
| 26 | - const not_registered = 0; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class. |
|
| 30 | - */ |
|
| 31 | - const load_new_object = 1; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * This instructs class loaders to return a previously instantiated and cached object for the requested class. |
|
| 35 | - * IF a previously instantiated object does not exist, a new one will be created and added to the cache. |
|
| 36 | - */ |
|
| 37 | - const load_from_cache = 2; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * When registering a dependency, |
|
| 41 | - * this indicates to keep any existing dependencies that already exist, |
|
| 42 | - * and simply discard any new dependencies declared in the incoming data |
|
| 43 | - */ |
|
| 44 | - const KEEP_EXISTING_DEPENDENCIES = 0; |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * When registering a dependency, |
|
| 48 | - * this indicates to overwrite any existing dependencies that already exist using the incoming data |
|
| 49 | - */ |
|
| 50 | - const OVERWRITE_DEPENDENCIES = 1; |
|
| 51 | - |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * @type EE_Dependency_Map $_instance |
|
| 55 | - */ |
|
| 56 | - protected static $_instance; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * @var ClassInterfaceCache $class_cache |
|
| 60 | - */ |
|
| 61 | - private $class_cache; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * @type RequestInterface $request |
|
| 65 | - */ |
|
| 66 | - protected $request; |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * @type LegacyRequestInterface $legacy_request |
|
| 70 | - */ |
|
| 71 | - protected $legacy_request; |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * @type ResponseInterface $response |
|
| 75 | - */ |
|
| 76 | - protected $response; |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * @type LoaderInterface $loader |
|
| 80 | - */ |
|
| 81 | - protected $loader; |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @type array $_dependency_map |
|
| 85 | - */ |
|
| 86 | - protected $_dependency_map = array(); |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * @type array $_class_loaders |
|
| 90 | - */ |
|
| 91 | - protected $_class_loaders = array(); |
|
| 92 | - |
|
| 93 | - |
|
| 94 | - /** |
|
| 95 | - * EE_Dependency_Map constructor. |
|
| 96 | - * |
|
| 97 | - * @param ClassInterfaceCache $class_cache |
|
| 98 | - */ |
|
| 99 | - protected function __construct(ClassInterfaceCache $class_cache) |
|
| 100 | - { |
|
| 101 | - $this->class_cache = $class_cache; |
|
| 102 | - do_action('EE_Dependency_Map____construct', $this); |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * @return void |
|
| 108 | - */ |
|
| 109 | - public function initialize() |
|
| 110 | - { |
|
| 111 | - $this->_register_core_dependencies(); |
|
| 112 | - $this->_register_core_class_loaders(); |
|
| 113 | - $this->_register_core_aliases(); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * @singleton method used to instantiate class object |
|
| 119 | - * @param ClassInterfaceCache|null $class_cache |
|
| 120 | - * @return EE_Dependency_Map |
|
| 121 | - */ |
|
| 122 | - public static function instance(ClassInterfaceCache $class_cache = null) |
|
| 123 | - { |
|
| 124 | - // check if class object is instantiated, and instantiated properly |
|
| 125 | - if (! self::$_instance instanceof EE_Dependency_Map |
|
| 126 | - && $class_cache instanceof ClassInterfaceCache |
|
| 127 | - ) { |
|
| 128 | - self::$_instance = new EE_Dependency_Map($class_cache); |
|
| 129 | - } |
|
| 130 | - return self::$_instance; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * @param RequestInterface $request |
|
| 136 | - */ |
|
| 137 | - public function setRequest(RequestInterface $request) |
|
| 138 | - { |
|
| 139 | - $this->request = $request; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @param LegacyRequestInterface $legacy_request |
|
| 145 | - */ |
|
| 146 | - public function setLegacyRequest(LegacyRequestInterface $legacy_request) |
|
| 147 | - { |
|
| 148 | - $this->legacy_request = $legacy_request; |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * @param ResponseInterface $response |
|
| 154 | - */ |
|
| 155 | - public function setResponse(ResponseInterface $response) |
|
| 156 | - { |
|
| 157 | - $this->response = $response; |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * @param LoaderInterface $loader |
|
| 163 | - */ |
|
| 164 | - public function setLoader(LoaderInterface $loader) |
|
| 165 | - { |
|
| 166 | - $this->loader = $loader; |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * @param string $class |
|
| 172 | - * @param array $dependencies |
|
| 173 | - * @param int $overwrite |
|
| 174 | - * @return bool |
|
| 175 | - */ |
|
| 176 | - public static function register_dependencies( |
|
| 177 | - $class, |
|
| 178 | - array $dependencies, |
|
| 179 | - $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 180 | - ) { |
|
| 181 | - return self::$_instance->registerDependencies($class, $dependencies, $overwrite); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * Assigns an array of class names and corresponding load sources (new or cached) |
|
| 187 | - * to the class specified by the first parameter. |
|
| 188 | - * IMPORTANT !!! |
|
| 189 | - * The order of elements in the incoming $dependencies array MUST match |
|
| 190 | - * the order of the constructor parameters for the class in question. |
|
| 191 | - * This is especially important when overriding any existing dependencies that are registered. |
|
| 192 | - * the third parameter controls whether any duplicate dependencies are overwritten or not. |
|
| 193 | - * |
|
| 194 | - * @param string $class |
|
| 195 | - * @param array $dependencies |
|
| 196 | - * @param int $overwrite |
|
| 197 | - * @return bool |
|
| 198 | - */ |
|
| 199 | - public function registerDependencies( |
|
| 200 | - $class, |
|
| 201 | - array $dependencies, |
|
| 202 | - $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 203 | - ) { |
|
| 204 | - $class = trim($class, '\\'); |
|
| 205 | - $registered = false; |
|
| 206 | - if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
| 207 | - self::$_instance->_dependency_map[ $class ] = array(); |
|
| 208 | - } |
|
| 209 | - // we need to make sure that any aliases used when registering a dependency |
|
| 210 | - // get resolved to the correct class name |
|
| 211 | - foreach ($dependencies as $dependency => $load_source) { |
|
| 212 | - $alias = self::$_instance->getFqnForAlias($dependency); |
|
| 213 | - if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
|
| 214 | - || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
| 215 | - ) { |
|
| 216 | - unset($dependencies[ $dependency ]); |
|
| 217 | - $dependencies[ $alias ] = $load_source; |
|
| 218 | - $registered = true; |
|
| 219 | - } |
|
| 220 | - } |
|
| 221 | - // now add our two lists of dependencies together. |
|
| 222 | - // using Union (+=) favours the arrays in precedence from left to right, |
|
| 223 | - // so $dependencies is NOT overwritten because it is listed first |
|
| 224 | - // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
|
| 225 | - // Union is way faster than array_merge() but should be used with caution... |
|
| 226 | - // especially with numerically indexed arrays |
|
| 227 | - $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
| 228 | - // now we need to ensure that the resulting dependencies |
|
| 229 | - // array only has the entries that are required for the class |
|
| 230 | - // so first count how many dependencies were originally registered for the class |
|
| 231 | - $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
| 232 | - // if that count is non-zero (meaning dependencies were already registered) |
|
| 233 | - self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
| 234 | - // then truncate the final array to match that count |
|
| 235 | - ? array_slice($dependencies, 0, $dependency_count) |
|
| 236 | - // otherwise just take the incoming array because nothing previously existed |
|
| 237 | - : $dependencies; |
|
| 238 | - return $registered; |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - /** |
|
| 243 | - * @param string $class_name |
|
| 244 | - * @param string $loader |
|
| 245 | - * @return bool |
|
| 246 | - * @throws DomainException |
|
| 247 | - */ |
|
| 248 | - public static function register_class_loader($class_name, $loader = 'load_core') |
|
| 249 | - { |
|
| 250 | - if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 251 | - throw new DomainException( |
|
| 252 | - esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
|
| 253 | - ); |
|
| 254 | - } |
|
| 255 | - // check that loader is callable or method starts with "load_" and exists in EE_Registry |
|
| 256 | - if (! is_callable($loader) |
|
| 257 | - && ( |
|
| 258 | - strpos($loader, 'load_') !== 0 |
|
| 259 | - || ! method_exists('EE_Registry', $loader) |
|
| 260 | - ) |
|
| 261 | - ) { |
|
| 262 | - throw new DomainException( |
|
| 263 | - sprintf( |
|
| 264 | - esc_html__( |
|
| 265 | - '"%1$s" is not a valid loader method on EE_Registry.', |
|
| 266 | - 'event_espresso' |
|
| 267 | - ), |
|
| 268 | - $loader |
|
| 269 | - ) |
|
| 270 | - ); |
|
| 271 | - } |
|
| 272 | - $class_name = self::$_instance->getFqnForAlias($class_name); |
|
| 273 | - if (! isset(self::$_instance->_class_loaders[ $class_name ])) { |
|
| 274 | - self::$_instance->_class_loaders[ $class_name ] = $loader; |
|
| 275 | - return true; |
|
| 276 | - } |
|
| 277 | - return false; |
|
| 278 | - } |
|
| 279 | - |
|
| 280 | - |
|
| 281 | - /** |
|
| 282 | - * @return array |
|
| 283 | - */ |
|
| 284 | - public function dependency_map() |
|
| 285 | - { |
|
| 286 | - return $this->_dependency_map; |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - |
|
| 290 | - /** |
|
| 291 | - * returns TRUE if dependency map contains a listing for the provided class name |
|
| 292 | - * |
|
| 293 | - * @param string $class_name |
|
| 294 | - * @return boolean |
|
| 295 | - */ |
|
| 296 | - public function has($class_name = '') |
|
| 297 | - { |
|
| 298 | - // all legacy models have the same dependencies |
|
| 299 | - if (strpos($class_name, 'EEM_') === 0) { |
|
| 300 | - $class_name = 'LEGACY_MODELS'; |
|
| 301 | - } |
|
| 302 | - return isset($this->_dependency_map[ $class_name ]) ? true : false; |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - |
|
| 306 | - /** |
|
| 307 | - * returns TRUE if dependency map contains a listing for the provided class name AND dependency |
|
| 308 | - * |
|
| 309 | - * @param string $class_name |
|
| 310 | - * @param string $dependency |
|
| 311 | - * @return bool |
|
| 312 | - */ |
|
| 313 | - public function has_dependency_for_class($class_name = '', $dependency = '') |
|
| 314 | - { |
|
| 315 | - // all legacy models have the same dependencies |
|
| 316 | - if (strpos($class_name, 'EEM_') === 0) { |
|
| 317 | - $class_name = 'LEGACY_MODELS'; |
|
| 318 | - } |
|
| 319 | - $dependency = $this->getFqnForAlias($dependency, $class_name); |
|
| 320 | - return isset($this->_dependency_map[ $class_name ][ $dependency ]) |
|
| 321 | - ? true |
|
| 322 | - : false; |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - |
|
| 326 | - /** |
|
| 327 | - * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned |
|
| 328 | - * |
|
| 329 | - * @param string $class_name |
|
| 330 | - * @param string $dependency |
|
| 331 | - * @return int |
|
| 332 | - */ |
|
| 333 | - public function loading_strategy_for_class_dependency($class_name = '', $dependency = '') |
|
| 334 | - { |
|
| 335 | - // all legacy models have the same dependencies |
|
| 336 | - if (strpos($class_name, 'EEM_') === 0) { |
|
| 337 | - $class_name = 'LEGACY_MODELS'; |
|
| 338 | - } |
|
| 339 | - $dependency = $this->getFqnForAlias($dependency); |
|
| 340 | - return $this->has_dependency_for_class($class_name, $dependency) |
|
| 341 | - ? $this->_dependency_map[ $class_name ][ $dependency ] |
|
| 342 | - : EE_Dependency_Map::not_registered; |
|
| 343 | - } |
|
| 344 | - |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * @param string $class_name |
|
| 348 | - * @return string | Closure |
|
| 349 | - */ |
|
| 350 | - public function class_loader($class_name) |
|
| 351 | - { |
|
| 352 | - // all legacy models use load_model() |
|
| 353 | - if (strpos($class_name, 'EEM_') === 0) { |
|
| 354 | - return 'load_model'; |
|
| 355 | - } |
|
| 356 | - // EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc |
|
| 357 | - // perform strpos() first to avoid loading regex every time we load a class |
|
| 358 | - if (strpos($class_name, 'EE_CPT_') === 0 |
|
| 359 | - && preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name) |
|
| 360 | - ) { |
|
| 361 | - return 'load_core'; |
|
| 362 | - } |
|
| 363 | - $class_name = $this->getFqnForAlias($class_name); |
|
| 364 | - return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : ''; |
|
| 365 | - } |
|
| 366 | - |
|
| 367 | - |
|
| 368 | - /** |
|
| 369 | - * @return array |
|
| 370 | - */ |
|
| 371 | - public function class_loaders() |
|
| 372 | - { |
|
| 373 | - return $this->_class_loaders; |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - |
|
| 377 | - /** |
|
| 378 | - * adds an alias for a classname |
|
| 379 | - * |
|
| 380 | - * @param string $fqcn the class name that should be used (concrete class to replace interface) |
|
| 381 | - * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
| 382 | - * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
| 383 | - */ |
|
| 384 | - public function add_alias($fqcn, $alias, $for_class = '') |
|
| 385 | - { |
|
| 386 | - $this->class_cache->addAlias($fqcn, $alias, $for_class); |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - |
|
| 390 | - /** |
|
| 391 | - * Returns TRUE if the provided fully qualified name IS an alias |
|
| 392 | - * WHY? |
|
| 393 | - * Because if a class is type hinting for a concretion, |
|
| 394 | - * then why would we need to find another class to supply it? |
|
| 395 | - * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`, |
|
| 396 | - * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`. |
|
| 397 | - * Don't go looking for some substitute. |
|
| 398 | - * Whereas if a class is type hinting for an interface... |
|
| 399 | - * then we need to find an actual class to use. |
|
| 400 | - * So the interface IS the alias for some other FQN, |
|
| 401 | - * and we need to find out if `Fully/Qualified/Namespace/SomeInterface` |
|
| 402 | - * represents some other class. |
|
| 403 | - * |
|
| 404 | - * @param string $fqn |
|
| 405 | - * @param string $for_class |
|
| 406 | - * @return bool |
|
| 407 | - */ |
|
| 408 | - public function isAlias($fqn = '', $for_class = '') |
|
| 409 | - { |
|
| 410 | - return $this->class_cache->isAlias($fqn, $for_class); |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - |
|
| 414 | - /** |
|
| 415 | - * Returns a FQN for provided alias if one exists, otherwise returns the original $alias |
|
| 416 | - * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
| 417 | - * for example: |
|
| 418 | - * if the following two entries were added to the _aliases array: |
|
| 419 | - * array( |
|
| 420 | - * 'interface_alias' => 'some\namespace\interface' |
|
| 421 | - * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 422 | - * ) |
|
| 423 | - * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
| 424 | - * to load an instance of 'some\namespace\classname' |
|
| 425 | - * |
|
| 426 | - * @param string $alias |
|
| 427 | - * @param string $for_class |
|
| 428 | - * @return string |
|
| 429 | - */ |
|
| 430 | - public function getFqnForAlias($alias = '', $for_class = '') |
|
| 431 | - { |
|
| 432 | - return (string) $this->class_cache->getFqnForAlias($alias, $for_class); |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - |
|
| 436 | - /** |
|
| 437 | - * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache, |
|
| 438 | - * if one exists, or whether a new object should be generated every time the requested class is loaded. |
|
| 439 | - * This is done by using the following class constants: |
|
| 440 | - * EE_Dependency_Map::load_from_cache - loads previously instantiated object |
|
| 441 | - * EE_Dependency_Map::load_new_object - generates a new object every time |
|
| 442 | - */ |
|
| 443 | - protected function _register_core_dependencies() |
|
| 444 | - { |
|
| 445 | - $this->_dependency_map = array( |
|
| 446 | - 'EE_Request_Handler' => array( |
|
| 447 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 448 | - ), |
|
| 449 | - 'EE_System' => array( |
|
| 450 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 451 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 452 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 453 | - 'EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache, |
|
| 454 | - ), |
|
| 455 | - 'EE_Session' => array( |
|
| 456 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 457 | - 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
| 458 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 459 | - 'EE_Encryption' => EE_Dependency_Map::load_from_cache, |
|
| 460 | - ), |
|
| 461 | - 'EE_Cart' => array( |
|
| 462 | - 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 463 | - ), |
|
| 464 | - 'EE_Front_Controller' => array( |
|
| 465 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 466 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 467 | - 'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache, |
|
| 468 | - ), |
|
| 469 | - 'EE_Messenger_Collection_Loader' => array( |
|
| 470 | - 'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object, |
|
| 471 | - ), |
|
| 472 | - 'EE_Message_Type_Collection_Loader' => array( |
|
| 473 | - 'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object, |
|
| 474 | - ), |
|
| 475 | - 'EE_Message_Resource_Manager' => array( |
|
| 476 | - 'EE_Messenger_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 477 | - 'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 478 | - 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 479 | - ), |
|
| 480 | - 'EE_Message_Factory' => array( |
|
| 481 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 482 | - ), |
|
| 483 | - 'EE_messages' => array( |
|
| 484 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 485 | - ), |
|
| 486 | - 'EE_Messages_Generator' => array( |
|
| 487 | - 'EE_Messages_Queue' => EE_Dependency_Map::load_new_object, |
|
| 488 | - 'EE_Messages_Data_Handler_Collection' => EE_Dependency_Map::load_new_object, |
|
| 489 | - 'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object, |
|
| 490 | - 'EEH_Parse_Shortcodes' => EE_Dependency_Map::load_from_cache, |
|
| 491 | - ), |
|
| 492 | - 'EE_Messages_Processor' => array( |
|
| 493 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 494 | - ), |
|
| 495 | - 'EE_Messages_Queue' => array( |
|
| 496 | - 'EE_Message_Repository' => EE_Dependency_Map::load_new_object, |
|
| 497 | - ), |
|
| 498 | - 'EE_Messages_Template_Defaults' => array( |
|
| 499 | - 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 500 | - 'EEM_Message_Template' => EE_Dependency_Map::load_from_cache, |
|
| 501 | - ), |
|
| 502 | - 'EE_Message_To_Generate_From_Request' => array( |
|
| 503 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 504 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 505 | - ), |
|
| 506 | - 'EventEspresso\core\services\commands\CommandBus' => array( |
|
| 507 | - 'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache, |
|
| 508 | - ), |
|
| 509 | - 'EventEspresso\services\commands\CommandHandler' => array( |
|
| 510 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 511 | - 'CommandBusInterface' => EE_Dependency_Map::load_from_cache, |
|
| 512 | - ), |
|
| 513 | - 'EventEspresso\core\services\commands\CommandHandlerManager' => array( |
|
| 514 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 515 | - ), |
|
| 516 | - 'EventEspresso\core\services\commands\CompositeCommandHandler' => array( |
|
| 517 | - 'EventEspresso\core\services\commands\CommandBus' => EE_Dependency_Map::load_from_cache, |
|
| 518 | - 'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache, |
|
| 519 | - ), |
|
| 520 | - 'EventEspresso\core\services\commands\CommandFactory' => array( |
|
| 521 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 522 | - ), |
|
| 523 | - 'EventEspresso\core\services\commands\middleware\CapChecker' => array( |
|
| 524 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
| 525 | - ), |
|
| 526 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => array( |
|
| 527 | - 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 528 | - ), |
|
| 529 | - 'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker' => array( |
|
| 530 | - 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 531 | - ), |
|
| 532 | - 'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler' => array( |
|
| 533 | - 'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 534 | - ), |
|
| 535 | - 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler' => array( |
|
| 536 | - 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 537 | - ), |
|
| 538 | - 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler' => array( |
|
| 539 | - 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 540 | - ), |
|
| 541 | - 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler' => array( |
|
| 542 | - 'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 543 | - ), |
|
| 544 | - 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array( |
|
| 545 | - 'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 546 | - ), |
|
| 547 | - 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler' => array( |
|
| 548 | - 'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 549 | - ), |
|
| 550 | - 'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler' => array( |
|
| 551 | - 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 552 | - ), |
|
| 553 | - 'EventEspresso\core\domain\services\registration\CancelRegistrationService' => array( |
|
| 554 | - 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 555 | - ), |
|
| 556 | - 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler' => array( |
|
| 557 | - 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 558 | - ), |
|
| 559 | - 'EventEspresso\core\services\database\TableManager' => array( |
|
| 560 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 561 | - ), |
|
| 562 | - 'EE_Data_Migration_Class_Base' => array( |
|
| 563 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 564 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 565 | - ), |
|
| 566 | - 'EE_DMS_Core_4_1_0' => array( |
|
| 567 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 568 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 569 | - ), |
|
| 570 | - 'EE_DMS_Core_4_2_0' => array( |
|
| 571 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 572 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 573 | - ), |
|
| 574 | - 'EE_DMS_Core_4_3_0' => array( |
|
| 575 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 576 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 577 | - ), |
|
| 578 | - 'EE_DMS_Core_4_4_0' => array( |
|
| 579 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 580 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 581 | - ), |
|
| 582 | - 'EE_DMS_Core_4_5_0' => array( |
|
| 583 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 584 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 585 | - ), |
|
| 586 | - 'EE_DMS_Core_4_6_0' => array( |
|
| 587 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 588 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 589 | - ), |
|
| 590 | - 'EE_DMS_Core_4_7_0' => array( |
|
| 591 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 592 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 593 | - ), |
|
| 594 | - 'EE_DMS_Core_4_8_0' => array( |
|
| 595 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 596 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 597 | - ), |
|
| 598 | - 'EE_DMS_Core_4_9_0' => array( |
|
| 599 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 600 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 601 | - ), |
|
| 602 | - 'EventEspresso\core\services\assets\I18nRegistry' => array( |
|
| 603 | - array(), |
|
| 604 | - 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 605 | - ), |
|
| 606 | - 'EventEspresso\core\services\assets\Registry' => array( |
|
| 607 | - 'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache, |
|
| 608 | - 'EventEspresso\core\services\assets\I18nRegistry' => EE_Dependency_Map::load_from_cache, |
|
| 609 | - ), |
|
| 610 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled' => array( |
|
| 611 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 612 | - ), |
|
| 613 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout' => array( |
|
| 614 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 615 | - ), |
|
| 616 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees' => array( |
|
| 617 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 618 | - ), |
|
| 619 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoEvents' => array( |
|
| 620 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 621 | - ), |
|
| 622 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou' => array( |
|
| 623 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 624 | - ), |
|
| 625 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector' => array( |
|
| 626 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 627 | - ), |
|
| 628 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage' => array( |
|
| 629 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 630 | - ), |
|
| 631 | - 'EventEspresso\core\services\cache\BasicCacheManager' => array( |
|
| 632 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 633 | - ), |
|
| 634 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => array( |
|
| 635 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 636 | - ), |
|
| 637 | - 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array( |
|
| 638 | - 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
| 639 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 640 | - ), |
|
| 641 | - 'EventEspresso\core\domain\values\EmailAddress' => array( |
|
| 642 | - null, |
|
| 643 | - 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache, |
|
| 644 | - ), |
|
| 645 | - 'EventEspresso\core\services\orm\ModelFieldFactory' => array( |
|
| 646 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 647 | - ), |
|
| 648 | - 'LEGACY_MODELS' => array( |
|
| 649 | - null, |
|
| 650 | - 'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache, |
|
| 651 | - ), |
|
| 652 | - 'EE_Module_Request_Router' => array( |
|
| 653 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 654 | - ), |
|
| 655 | - 'EE_Registration_Processor' => array( |
|
| 656 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 657 | - ), |
|
| 658 | - 'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array( |
|
| 659 | - null, |
|
| 660 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
| 661 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 662 | - ), |
|
| 663 | - 'EventEspresso\core\services\licensing\LicenseService' => array( |
|
| 664 | - 'EventEspresso\core\domain\services\pue\Stats' => EE_Dependency_Map::load_from_cache, |
|
| 665 | - 'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache, |
|
| 666 | - ), |
|
| 667 | - 'EE_Admin_Transactions_List_Table' => array( |
|
| 668 | - null, |
|
| 669 | - 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
| 670 | - ), |
|
| 671 | - 'EventEspresso\core\domain\services\pue\Stats' => array( |
|
| 672 | - 'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache, |
|
| 673 | - 'EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache, |
|
| 674 | - 'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache, |
|
| 675 | - ), |
|
| 676 | - 'EventEspresso\core\domain\services\pue\Config' => array( |
|
| 677 | - 'EE_Network_Config' => EE_Dependency_Map::load_from_cache, |
|
| 678 | - 'EE_Config' => EE_Dependency_Map::load_from_cache, |
|
| 679 | - ), |
|
| 680 | - 'EventEspresso\core\domain\services\pue\StatsGatherer' => array( |
|
| 681 | - 'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache, |
|
| 682 | - 'EEM_Event' => EE_Dependency_Map::load_from_cache, |
|
| 683 | - 'EEM_Datetime' => EE_Dependency_Map::load_from_cache, |
|
| 684 | - 'EEM_Ticket' => EE_Dependency_Map::load_from_cache, |
|
| 685 | - 'EEM_Registration' => EE_Dependency_Map::load_from_cache, |
|
| 686 | - 'EEM_Transaction' => EE_Dependency_Map::load_from_cache, |
|
| 687 | - 'EE_Config' => EE_Dependency_Map::load_from_cache, |
|
| 688 | - ), |
|
| 689 | - 'EventEspresso\core\domain\services\admin\ExitModal' => array( |
|
| 690 | - 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache, |
|
| 691 | - ), |
|
| 692 | - 'EventEspresso\core\domain\services\admin\PluginUpsells' => array( |
|
| 693 | - 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 694 | - ), |
|
| 695 | - 'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha' => array( |
|
| 696 | - 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
| 697 | - 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 698 | - ), |
|
| 699 | - 'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings' => array( |
|
| 700 | - 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
| 701 | - ), |
|
| 702 | - 'EventEspresso\modules\ticket_selector\ProcessTicketSelector' => array( |
|
| 703 | - 'EE_Core_Config' => EE_Dependency_Map::load_from_cache, |
|
| 704 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 705 | - 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 706 | - 'EEM_Ticket' => EE_Dependency_Map::load_from_cache, |
|
| 707 | - 'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache, |
|
| 708 | - ), |
|
| 709 | - 'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => array( |
|
| 710 | - 'EEM_Datetime' => EE_Dependency_Map::load_from_cache, |
|
| 711 | - ), |
|
| 712 | - 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => array( |
|
| 713 | - 'EE_Core_Config' => EE_Dependency_Map::load_from_cache, |
|
| 714 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 715 | - ), |
|
| 716 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' => array( |
|
| 717 | - 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 718 | - ), |
|
| 719 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' => array( |
|
| 720 | - 'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 721 | - ), |
|
| 722 | - 'EE_CPT_Strategy' => array( |
|
| 723 | - 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 724 | - 'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 725 | - ), |
|
| 726 | - 'EventEspresso\core\services\loaders\ObjectIdentifier' => array( |
|
| 727 | - 'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache, |
|
| 728 | - ), |
|
| 729 | - 'EventEspresso\core\domain\services\assets\CoreAssetManager' => array( |
|
| 730 | - 'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache, |
|
| 731 | - 'EE_Currency_Config' => EE_Dependency_Map::load_from_cache, |
|
| 732 | - 'EE_Template_Config' => EE_Dependency_Map::load_from_cache, |
|
| 733 | - 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 734 | - 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache, |
|
| 735 | - ), |
|
| 736 | - 'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array( |
|
| 737 | - 'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache, |
|
| 738 | - 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache |
|
| 739 | - ), |
|
| 740 | - 'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array( |
|
| 741 | - 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 742 | - ), |
|
| 743 | - 'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array( |
|
| 744 | - 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 745 | - 'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache |
|
| 746 | - ), |
|
| 747 | - 'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array( |
|
| 748 | - 'EEM_Checkin' => EE_Dependency_Map::load_from_cache, |
|
| 749 | - ), |
|
| 750 | - 'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array( |
|
| 751 | - 'EEM_Registration' => EE_Dependency_Map::load_from_cache, |
|
| 752 | - ), |
|
| 753 | - 'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array( |
|
| 754 | - 'EEM_Transaction' => EE_Dependency_Map::load_from_cache, |
|
| 755 | - ), |
|
| 756 | - 'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array( |
|
| 757 | - 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 758 | - ), |
|
| 759 | - 'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array( |
|
| 760 | - 'EEM_Answer' => EE_Dependency_Map::load_from_cache, |
|
| 761 | - 'EEM_Question' => EE_Dependency_Map::load_from_cache, |
|
| 762 | - ), |
|
| 763 | - 'EventEspresso\core\CPTs\CptQueryModifier' => array( |
|
| 764 | - null, |
|
| 765 | - null, |
|
| 766 | - null, |
|
| 767 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 768 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 769 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 770 | - ), |
|
| 771 | - 'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler' => array( |
|
| 772 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 773 | - 'EE_Config' => EE_Dependency_Map::load_from_cache |
|
| 774 | - ), |
|
| 775 | - 'EventEspresso\core\services\editor\BlockRegistrationManager' => array( |
|
| 776 | - 'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache, |
|
| 777 | - 'EventEspresso\core\domain\entities\editor\BlockCollection' => EE_Dependency_Map::load_from_cache, |
|
| 778 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache, |
|
| 779 | - 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 780 | - ), |
|
| 781 | - 'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => array( |
|
| 782 | - 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 783 | - 'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache, |
|
| 784 | - 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache, |
|
| 785 | - ), |
|
| 786 | - 'EventEspresso\core\domain\entities\editor\blocks\widgets\EventAttendees' => array( |
|
| 787 | - 'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => self::load_from_cache, |
|
| 788 | - ), |
|
| 789 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => array( |
|
| 790 | - 'EventEspresso\core\services\container\Mirror' => EE_Dependency_Map::load_from_cache, |
|
| 791 | - 'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache, |
|
| 792 | - 'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache, |
|
| 793 | - ), |
|
| 794 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => array( |
|
| 795 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache, |
|
| 796 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 797 | - ), |
|
| 798 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => array( |
|
| 799 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache, |
|
| 800 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => EE_Dependency_Map::load_from_cache, |
|
| 801 | - ), |
|
| 802 | - ); |
|
| 803 | - } |
|
| 804 | - |
|
| 805 | - |
|
| 806 | - /** |
|
| 807 | - * Registers how core classes are loaded. |
|
| 808 | - * This can either be done by simply providing the name of one of the EE_Registry loader methods such as: |
|
| 809 | - * 'EE_Request_Handler' => 'load_core' |
|
| 810 | - * 'EE_Messages_Queue' => 'load_lib' |
|
| 811 | - * 'EEH_Debug_Tools' => 'load_helper' |
|
| 812 | - * or, if greater control is required, by providing a custom closure. For example: |
|
| 813 | - * 'Some_Class' => function () { |
|
| 814 | - * return new Some_Class(); |
|
| 815 | - * }, |
|
| 816 | - * This is required for instantiating dependencies |
|
| 817 | - * where an interface has been type hinted in a class constructor. For example: |
|
| 818 | - * 'Required_Interface' => function () { |
|
| 819 | - * return new A_Class_That_Implements_Required_Interface(); |
|
| 820 | - * }, |
|
| 821 | - */ |
|
| 822 | - protected function _register_core_class_loaders() |
|
| 823 | - { |
|
| 824 | - // for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot |
|
| 825 | - // be used in a closure. |
|
| 826 | - $request = &$this->request; |
|
| 827 | - $response = &$this->response; |
|
| 828 | - $legacy_request = &$this->legacy_request; |
|
| 829 | - $self = &$this; |
|
| 830 | - // $loader = &$this->loader; |
|
| 831 | - $this->_class_loaders = array( |
|
| 832 | - // load_core |
|
| 833 | - 'EE_Dependency_Map' => function () use (&$self) { |
|
| 834 | - return $self; |
|
| 835 | - }, |
|
| 836 | - 'EE_Capabilities' => 'load_core', |
|
| 837 | - 'EE_Encryption' => 'load_core', |
|
| 838 | - 'EE_Front_Controller' => 'load_core', |
|
| 839 | - 'EE_Module_Request_Router' => 'load_core', |
|
| 840 | - 'EE_Registry' => 'load_core', |
|
| 841 | - 'EE_Request' => function () use (&$legacy_request) { |
|
| 842 | - return $legacy_request; |
|
| 843 | - }, |
|
| 844 | - 'EventEspresso\core\services\request\Request' => function () use (&$request) { |
|
| 845 | - return $request; |
|
| 846 | - }, |
|
| 847 | - 'EventEspresso\core\services\request\Response' => function () use (&$response) { |
|
| 848 | - return $response; |
|
| 849 | - }, |
|
| 850 | - 'EE_Base' => 'load_core', |
|
| 851 | - 'EE_Request_Handler' => 'load_core', |
|
| 852 | - 'EE_Session' => 'load_core', |
|
| 853 | - 'EE_Cron_Tasks' => 'load_core', |
|
| 854 | - 'EE_System' => 'load_core', |
|
| 855 | - 'EE_Maintenance_Mode' => 'load_core', |
|
| 856 | - 'EE_Register_CPTs' => 'load_core', |
|
| 857 | - 'EE_Admin' => 'load_core', |
|
| 858 | - 'EE_CPT_Strategy' => 'load_core', |
|
| 859 | - // load_lib |
|
| 860 | - 'EE_Message_Resource_Manager' => 'load_lib', |
|
| 861 | - 'EE_Message_Type_Collection' => 'load_lib', |
|
| 862 | - 'EE_Message_Type_Collection_Loader' => 'load_lib', |
|
| 863 | - 'EE_Messenger_Collection' => 'load_lib', |
|
| 864 | - 'EE_Messenger_Collection_Loader' => 'load_lib', |
|
| 865 | - 'EE_Messages_Processor' => 'load_lib', |
|
| 866 | - 'EE_Message_Repository' => 'load_lib', |
|
| 867 | - 'EE_Messages_Queue' => 'load_lib', |
|
| 868 | - 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
|
| 869 | - 'EE_Message_Template_Group_Collection' => 'load_lib', |
|
| 870 | - 'EE_Payment_Method_Manager' => 'load_lib', |
|
| 871 | - 'EE_Messages_Generator' => function () { |
|
| 872 | - return EE_Registry::instance()->load_lib( |
|
| 873 | - 'Messages_Generator', |
|
| 874 | - array(), |
|
| 875 | - false, |
|
| 876 | - false |
|
| 877 | - ); |
|
| 878 | - }, |
|
| 879 | - 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
| 880 | - return EE_Registry::instance()->load_lib( |
|
| 881 | - 'Messages_Template_Defaults', |
|
| 882 | - $arguments, |
|
| 883 | - false, |
|
| 884 | - false |
|
| 885 | - ); |
|
| 886 | - }, |
|
| 887 | - // load_helper |
|
| 888 | - 'EEH_Parse_Shortcodes' => function () { |
|
| 889 | - if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
|
| 890 | - return new EEH_Parse_Shortcodes(); |
|
| 891 | - } |
|
| 892 | - return null; |
|
| 893 | - }, |
|
| 894 | - 'EE_Template_Config' => function () { |
|
| 895 | - return EE_Config::instance()->template_settings; |
|
| 896 | - }, |
|
| 897 | - 'EE_Currency_Config' => function () { |
|
| 898 | - return EE_Config::instance()->currency; |
|
| 899 | - }, |
|
| 900 | - 'EE_Registration_Config' => function () { |
|
| 901 | - return EE_Config::instance()->registration; |
|
| 902 | - }, |
|
| 903 | - 'EE_Core_Config' => function () { |
|
| 904 | - return EE_Config::instance()->core; |
|
| 905 | - }, |
|
| 906 | - 'EventEspresso\core\services\loaders\Loader' => function () { |
|
| 907 | - return LoaderFactory::getLoader(); |
|
| 908 | - }, |
|
| 909 | - 'EE_Network_Config' => function () { |
|
| 910 | - return EE_Network_Config::instance(); |
|
| 911 | - }, |
|
| 912 | - 'EE_Config' => function () { |
|
| 913 | - return EE_Config::instance(); |
|
| 914 | - }, |
|
| 915 | - 'EventEspresso\core\domain\Domain' => function () { |
|
| 916 | - return DomainFactory::getEventEspressoCoreDomain(); |
|
| 917 | - }, |
|
| 918 | - 'EE_Admin_Config' => function () { |
|
| 919 | - return EE_Config::instance()->admin; |
|
| 920 | - }, |
|
| 921 | - ); |
|
| 922 | - } |
|
| 923 | - |
|
| 924 | - |
|
| 925 | - /** |
|
| 926 | - * can be used for supplying alternate names for classes, |
|
| 927 | - * or for connecting interface names to instantiable classes |
|
| 928 | - */ |
|
| 929 | - protected function _register_core_aliases() |
|
| 930 | - { |
|
| 931 | - $aliases = array( |
|
| 932 | - 'CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBusInterface', |
|
| 933 | - 'EventEspresso\core\services\commands\CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBus', |
|
| 934 | - 'CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
| 935 | - 'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
| 936 | - 'CapChecker' => 'EventEspresso\core\services\commands\middleware\CapChecker', |
|
| 937 | - 'AddActionHook' => 'EventEspresso\core\services\commands\middleware\AddActionHook', |
|
| 938 | - 'CapabilitiesChecker' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 939 | - 'CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface', |
|
| 940 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 941 | - 'CreateRegistrationService' => 'EventEspresso\core\domain\services\registration\CreateRegistrationService', |
|
| 942 | - 'CreateRegistrationCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
| 943 | - 'CopyRegistrationDetailsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand', |
|
| 944 | - 'CopyRegistrationPaymentsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand', |
|
| 945 | - 'CancelRegistrationAndTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler', |
|
| 946 | - 'UpdateRegistrationAndTransactionAfterChangeCommandHandler' => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler', |
|
| 947 | - 'CreateTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand', |
|
| 948 | - 'CreateTransactionCommandHandler' => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler', |
|
| 949 | - 'CreateAttendeeCommandHandler' => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler', |
|
| 950 | - 'TableManager' => 'EventEspresso\core\services\database\TableManager', |
|
| 951 | - 'TableAnalysis' => 'EventEspresso\core\services\database\TableAnalysis', |
|
| 952 | - 'EspressoShortcode' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 953 | - 'ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 954 | - 'EventEspresso\core\services\shortcodes\ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 955 | - 'EventEspresso\core\services\cache\CacheStorageInterface' => 'EventEspresso\core\services\cache\TransientCacheStorage', |
|
| 956 | - 'LoaderInterface' => 'EventEspresso\core\services\loaders\LoaderInterface', |
|
| 957 | - 'EventEspresso\core\services\loaders\LoaderInterface' => 'EventEspresso\core\services\loaders\Loader', |
|
| 958 | - 'CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactoryInterface', |
|
| 959 | - 'EventEspresso\core\services\commands\CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactory', |
|
| 960 | - 'EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface', |
|
| 961 | - 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService', |
|
| 962 | - 'NoticeConverterInterface' => 'EventEspresso\core\services\notices\NoticeConverterInterface', |
|
| 963 | - 'EventEspresso\core\services\notices\NoticeConverterInterface' => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors', |
|
| 964 | - 'NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainerInterface', |
|
| 965 | - 'EventEspresso\core\services\notices\NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainer', |
|
| 966 | - 'EventEspresso\core\services\request\RequestInterface' => 'EventEspresso\core\services\request\Request', |
|
| 967 | - 'EventEspresso\core\services\request\ResponseInterface' => 'EventEspresso\core\services\request\Response', |
|
| 968 | - 'EventEspresso\core\domain\DomainInterface' => 'EventEspresso\core\domain\Domain', |
|
| 969 | - ); |
|
| 970 | - foreach ($aliases as $alias => $fqn) { |
|
| 971 | - if (is_array($fqn)) { |
|
| 972 | - foreach ($fqn as $class => $for_class) { |
|
| 973 | - $this->class_cache->addAlias($class, $alias, $for_class); |
|
| 974 | - } |
|
| 975 | - continue; |
|
| 976 | - } |
|
| 977 | - $this->class_cache->addAlias($fqn, $alias); |
|
| 978 | - } |
|
| 979 | - if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
| 980 | - $this->class_cache->addAlias( |
|
| 981 | - 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices', |
|
| 982 | - 'EventEspresso\core\services\notices\NoticeConverterInterface' |
|
| 983 | - ); |
|
| 984 | - } |
|
| 985 | - } |
|
| 986 | - |
|
| 987 | - |
|
| 988 | - /** |
|
| 989 | - * This is used to reset the internal map and class_loaders to their original default state at the beginning of the |
|
| 990 | - * request Primarily used by unit tests. |
|
| 991 | - */ |
|
| 992 | - public function reset() |
|
| 993 | - { |
|
| 994 | - $this->_register_core_class_loaders(); |
|
| 995 | - $this->_register_core_dependencies(); |
|
| 996 | - } |
|
| 997 | - |
|
| 998 | - |
|
| 999 | - /** |
|
| 1000 | - * PLZ NOTE: a better name for this method would be is_alias() |
|
| 1001 | - * because it returns TRUE if the provided fully qualified name IS an alias |
|
| 1002 | - * WHY? |
|
| 1003 | - * Because if a class is type hinting for a concretion, |
|
| 1004 | - * then why would we need to find another class to supply it? |
|
| 1005 | - * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`, |
|
| 1006 | - * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`. |
|
| 1007 | - * Don't go looking for some substitute. |
|
| 1008 | - * Whereas if a class is type hinting for an interface... |
|
| 1009 | - * then we need to find an actual class to use. |
|
| 1010 | - * So the interface IS the alias for some other FQN, |
|
| 1011 | - * and we need to find out if `Fully/Qualified/Namespace/SomeInterface` |
|
| 1012 | - * represents some other class. |
|
| 1013 | - * |
|
| 1014 | - * @deprecated 4.9.62.p |
|
| 1015 | - * @param string $fqn |
|
| 1016 | - * @param string $for_class |
|
| 1017 | - * @return bool |
|
| 1018 | - */ |
|
| 1019 | - public function has_alias($fqn = '', $for_class = '') |
|
| 1020 | - { |
|
| 1021 | - return $this->isAlias($fqn, $for_class); |
|
| 1022 | - } |
|
| 1023 | - |
|
| 1024 | - |
|
| 1025 | - /** |
|
| 1026 | - * PLZ NOTE: a better name for this method would be get_fqn_for_alias() |
|
| 1027 | - * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias |
|
| 1028 | - * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
| 1029 | - * for example: |
|
| 1030 | - * if the following two entries were added to the _aliases array: |
|
| 1031 | - * array( |
|
| 1032 | - * 'interface_alias' => 'some\namespace\interface' |
|
| 1033 | - * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 1034 | - * ) |
|
| 1035 | - * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
| 1036 | - * to load an instance of 'some\namespace\classname' |
|
| 1037 | - * |
|
| 1038 | - * @deprecated 4.9.62.p |
|
| 1039 | - * @param string $alias |
|
| 1040 | - * @param string $for_class |
|
| 1041 | - * @return string |
|
| 1042 | - */ |
|
| 1043 | - public function get_alias($alias = '', $for_class = '') |
|
| 1044 | - { |
|
| 1045 | - return $this->getFqnForAlias($alias, $for_class); |
|
| 1046 | - } |
|
| 23 | + /** |
|
| 24 | + * This means that the requested class dependency is not present in the dependency map |
|
| 25 | + */ |
|
| 26 | + const not_registered = 0; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class. |
|
| 30 | + */ |
|
| 31 | + const load_new_object = 1; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * This instructs class loaders to return a previously instantiated and cached object for the requested class. |
|
| 35 | + * IF a previously instantiated object does not exist, a new one will be created and added to the cache. |
|
| 36 | + */ |
|
| 37 | + const load_from_cache = 2; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * When registering a dependency, |
|
| 41 | + * this indicates to keep any existing dependencies that already exist, |
|
| 42 | + * and simply discard any new dependencies declared in the incoming data |
|
| 43 | + */ |
|
| 44 | + const KEEP_EXISTING_DEPENDENCIES = 0; |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * When registering a dependency, |
|
| 48 | + * this indicates to overwrite any existing dependencies that already exist using the incoming data |
|
| 49 | + */ |
|
| 50 | + const OVERWRITE_DEPENDENCIES = 1; |
|
| 51 | + |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * @type EE_Dependency_Map $_instance |
|
| 55 | + */ |
|
| 56 | + protected static $_instance; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * @var ClassInterfaceCache $class_cache |
|
| 60 | + */ |
|
| 61 | + private $class_cache; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * @type RequestInterface $request |
|
| 65 | + */ |
|
| 66 | + protected $request; |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * @type LegacyRequestInterface $legacy_request |
|
| 70 | + */ |
|
| 71 | + protected $legacy_request; |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * @type ResponseInterface $response |
|
| 75 | + */ |
|
| 76 | + protected $response; |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * @type LoaderInterface $loader |
|
| 80 | + */ |
|
| 81 | + protected $loader; |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @type array $_dependency_map |
|
| 85 | + */ |
|
| 86 | + protected $_dependency_map = array(); |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * @type array $_class_loaders |
|
| 90 | + */ |
|
| 91 | + protected $_class_loaders = array(); |
|
| 92 | + |
|
| 93 | + |
|
| 94 | + /** |
|
| 95 | + * EE_Dependency_Map constructor. |
|
| 96 | + * |
|
| 97 | + * @param ClassInterfaceCache $class_cache |
|
| 98 | + */ |
|
| 99 | + protected function __construct(ClassInterfaceCache $class_cache) |
|
| 100 | + { |
|
| 101 | + $this->class_cache = $class_cache; |
|
| 102 | + do_action('EE_Dependency_Map____construct', $this); |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * @return void |
|
| 108 | + */ |
|
| 109 | + public function initialize() |
|
| 110 | + { |
|
| 111 | + $this->_register_core_dependencies(); |
|
| 112 | + $this->_register_core_class_loaders(); |
|
| 113 | + $this->_register_core_aliases(); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * @singleton method used to instantiate class object |
|
| 119 | + * @param ClassInterfaceCache|null $class_cache |
|
| 120 | + * @return EE_Dependency_Map |
|
| 121 | + */ |
|
| 122 | + public static function instance(ClassInterfaceCache $class_cache = null) |
|
| 123 | + { |
|
| 124 | + // check if class object is instantiated, and instantiated properly |
|
| 125 | + if (! self::$_instance instanceof EE_Dependency_Map |
|
| 126 | + && $class_cache instanceof ClassInterfaceCache |
|
| 127 | + ) { |
|
| 128 | + self::$_instance = new EE_Dependency_Map($class_cache); |
|
| 129 | + } |
|
| 130 | + return self::$_instance; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * @param RequestInterface $request |
|
| 136 | + */ |
|
| 137 | + public function setRequest(RequestInterface $request) |
|
| 138 | + { |
|
| 139 | + $this->request = $request; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @param LegacyRequestInterface $legacy_request |
|
| 145 | + */ |
|
| 146 | + public function setLegacyRequest(LegacyRequestInterface $legacy_request) |
|
| 147 | + { |
|
| 148 | + $this->legacy_request = $legacy_request; |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * @param ResponseInterface $response |
|
| 154 | + */ |
|
| 155 | + public function setResponse(ResponseInterface $response) |
|
| 156 | + { |
|
| 157 | + $this->response = $response; |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * @param LoaderInterface $loader |
|
| 163 | + */ |
|
| 164 | + public function setLoader(LoaderInterface $loader) |
|
| 165 | + { |
|
| 166 | + $this->loader = $loader; |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * @param string $class |
|
| 172 | + * @param array $dependencies |
|
| 173 | + * @param int $overwrite |
|
| 174 | + * @return bool |
|
| 175 | + */ |
|
| 176 | + public static function register_dependencies( |
|
| 177 | + $class, |
|
| 178 | + array $dependencies, |
|
| 179 | + $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 180 | + ) { |
|
| 181 | + return self::$_instance->registerDependencies($class, $dependencies, $overwrite); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * Assigns an array of class names and corresponding load sources (new or cached) |
|
| 187 | + * to the class specified by the first parameter. |
|
| 188 | + * IMPORTANT !!! |
|
| 189 | + * The order of elements in the incoming $dependencies array MUST match |
|
| 190 | + * the order of the constructor parameters for the class in question. |
|
| 191 | + * This is especially important when overriding any existing dependencies that are registered. |
|
| 192 | + * the third parameter controls whether any duplicate dependencies are overwritten or not. |
|
| 193 | + * |
|
| 194 | + * @param string $class |
|
| 195 | + * @param array $dependencies |
|
| 196 | + * @param int $overwrite |
|
| 197 | + * @return bool |
|
| 198 | + */ |
|
| 199 | + public function registerDependencies( |
|
| 200 | + $class, |
|
| 201 | + array $dependencies, |
|
| 202 | + $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 203 | + ) { |
|
| 204 | + $class = trim($class, '\\'); |
|
| 205 | + $registered = false; |
|
| 206 | + if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
| 207 | + self::$_instance->_dependency_map[ $class ] = array(); |
|
| 208 | + } |
|
| 209 | + // we need to make sure that any aliases used when registering a dependency |
|
| 210 | + // get resolved to the correct class name |
|
| 211 | + foreach ($dependencies as $dependency => $load_source) { |
|
| 212 | + $alias = self::$_instance->getFqnForAlias($dependency); |
|
| 213 | + if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
|
| 214 | + || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
| 215 | + ) { |
|
| 216 | + unset($dependencies[ $dependency ]); |
|
| 217 | + $dependencies[ $alias ] = $load_source; |
|
| 218 | + $registered = true; |
|
| 219 | + } |
|
| 220 | + } |
|
| 221 | + // now add our two lists of dependencies together. |
|
| 222 | + // using Union (+=) favours the arrays in precedence from left to right, |
|
| 223 | + // so $dependencies is NOT overwritten because it is listed first |
|
| 224 | + // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
|
| 225 | + // Union is way faster than array_merge() but should be used with caution... |
|
| 226 | + // especially with numerically indexed arrays |
|
| 227 | + $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
| 228 | + // now we need to ensure that the resulting dependencies |
|
| 229 | + // array only has the entries that are required for the class |
|
| 230 | + // so first count how many dependencies were originally registered for the class |
|
| 231 | + $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
| 232 | + // if that count is non-zero (meaning dependencies were already registered) |
|
| 233 | + self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
| 234 | + // then truncate the final array to match that count |
|
| 235 | + ? array_slice($dependencies, 0, $dependency_count) |
|
| 236 | + // otherwise just take the incoming array because nothing previously existed |
|
| 237 | + : $dependencies; |
|
| 238 | + return $registered; |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + /** |
|
| 243 | + * @param string $class_name |
|
| 244 | + * @param string $loader |
|
| 245 | + * @return bool |
|
| 246 | + * @throws DomainException |
|
| 247 | + */ |
|
| 248 | + public static function register_class_loader($class_name, $loader = 'load_core') |
|
| 249 | + { |
|
| 250 | + if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 251 | + throw new DomainException( |
|
| 252 | + esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
|
| 253 | + ); |
|
| 254 | + } |
|
| 255 | + // check that loader is callable or method starts with "load_" and exists in EE_Registry |
|
| 256 | + if (! is_callable($loader) |
|
| 257 | + && ( |
|
| 258 | + strpos($loader, 'load_') !== 0 |
|
| 259 | + || ! method_exists('EE_Registry', $loader) |
|
| 260 | + ) |
|
| 261 | + ) { |
|
| 262 | + throw new DomainException( |
|
| 263 | + sprintf( |
|
| 264 | + esc_html__( |
|
| 265 | + '"%1$s" is not a valid loader method on EE_Registry.', |
|
| 266 | + 'event_espresso' |
|
| 267 | + ), |
|
| 268 | + $loader |
|
| 269 | + ) |
|
| 270 | + ); |
|
| 271 | + } |
|
| 272 | + $class_name = self::$_instance->getFqnForAlias($class_name); |
|
| 273 | + if (! isset(self::$_instance->_class_loaders[ $class_name ])) { |
|
| 274 | + self::$_instance->_class_loaders[ $class_name ] = $loader; |
|
| 275 | + return true; |
|
| 276 | + } |
|
| 277 | + return false; |
|
| 278 | + } |
|
| 279 | + |
|
| 280 | + |
|
| 281 | + /** |
|
| 282 | + * @return array |
|
| 283 | + */ |
|
| 284 | + public function dependency_map() |
|
| 285 | + { |
|
| 286 | + return $this->_dependency_map; |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + |
|
| 290 | + /** |
|
| 291 | + * returns TRUE if dependency map contains a listing for the provided class name |
|
| 292 | + * |
|
| 293 | + * @param string $class_name |
|
| 294 | + * @return boolean |
|
| 295 | + */ |
|
| 296 | + public function has($class_name = '') |
|
| 297 | + { |
|
| 298 | + // all legacy models have the same dependencies |
|
| 299 | + if (strpos($class_name, 'EEM_') === 0) { |
|
| 300 | + $class_name = 'LEGACY_MODELS'; |
|
| 301 | + } |
|
| 302 | + return isset($this->_dependency_map[ $class_name ]) ? true : false; |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + |
|
| 306 | + /** |
|
| 307 | + * returns TRUE if dependency map contains a listing for the provided class name AND dependency |
|
| 308 | + * |
|
| 309 | + * @param string $class_name |
|
| 310 | + * @param string $dependency |
|
| 311 | + * @return bool |
|
| 312 | + */ |
|
| 313 | + public function has_dependency_for_class($class_name = '', $dependency = '') |
|
| 314 | + { |
|
| 315 | + // all legacy models have the same dependencies |
|
| 316 | + if (strpos($class_name, 'EEM_') === 0) { |
|
| 317 | + $class_name = 'LEGACY_MODELS'; |
|
| 318 | + } |
|
| 319 | + $dependency = $this->getFqnForAlias($dependency, $class_name); |
|
| 320 | + return isset($this->_dependency_map[ $class_name ][ $dependency ]) |
|
| 321 | + ? true |
|
| 322 | + : false; |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + |
|
| 326 | + /** |
|
| 327 | + * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned |
|
| 328 | + * |
|
| 329 | + * @param string $class_name |
|
| 330 | + * @param string $dependency |
|
| 331 | + * @return int |
|
| 332 | + */ |
|
| 333 | + public function loading_strategy_for_class_dependency($class_name = '', $dependency = '') |
|
| 334 | + { |
|
| 335 | + // all legacy models have the same dependencies |
|
| 336 | + if (strpos($class_name, 'EEM_') === 0) { |
|
| 337 | + $class_name = 'LEGACY_MODELS'; |
|
| 338 | + } |
|
| 339 | + $dependency = $this->getFqnForAlias($dependency); |
|
| 340 | + return $this->has_dependency_for_class($class_name, $dependency) |
|
| 341 | + ? $this->_dependency_map[ $class_name ][ $dependency ] |
|
| 342 | + : EE_Dependency_Map::not_registered; |
|
| 343 | + } |
|
| 344 | + |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * @param string $class_name |
|
| 348 | + * @return string | Closure |
|
| 349 | + */ |
|
| 350 | + public function class_loader($class_name) |
|
| 351 | + { |
|
| 352 | + // all legacy models use load_model() |
|
| 353 | + if (strpos($class_name, 'EEM_') === 0) { |
|
| 354 | + return 'load_model'; |
|
| 355 | + } |
|
| 356 | + // EE_CPT_*_Strategy classes like EE_CPT_Event_Strategy, EE_CPT_Venue_Strategy, etc |
|
| 357 | + // perform strpos() first to avoid loading regex every time we load a class |
|
| 358 | + if (strpos($class_name, 'EE_CPT_') === 0 |
|
| 359 | + && preg_match('/^EE_CPT_([a-zA-Z]+)_Strategy$/', $class_name) |
|
| 360 | + ) { |
|
| 361 | + return 'load_core'; |
|
| 362 | + } |
|
| 363 | + $class_name = $this->getFqnForAlias($class_name); |
|
| 364 | + return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : ''; |
|
| 365 | + } |
|
| 366 | + |
|
| 367 | + |
|
| 368 | + /** |
|
| 369 | + * @return array |
|
| 370 | + */ |
|
| 371 | + public function class_loaders() |
|
| 372 | + { |
|
| 373 | + return $this->_class_loaders; |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + |
|
| 377 | + /** |
|
| 378 | + * adds an alias for a classname |
|
| 379 | + * |
|
| 380 | + * @param string $fqcn the class name that should be used (concrete class to replace interface) |
|
| 381 | + * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
| 382 | + * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
| 383 | + */ |
|
| 384 | + public function add_alias($fqcn, $alias, $for_class = '') |
|
| 385 | + { |
|
| 386 | + $this->class_cache->addAlias($fqcn, $alias, $for_class); |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + |
|
| 390 | + /** |
|
| 391 | + * Returns TRUE if the provided fully qualified name IS an alias |
|
| 392 | + * WHY? |
|
| 393 | + * Because if a class is type hinting for a concretion, |
|
| 394 | + * then why would we need to find another class to supply it? |
|
| 395 | + * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`, |
|
| 396 | + * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`. |
|
| 397 | + * Don't go looking for some substitute. |
|
| 398 | + * Whereas if a class is type hinting for an interface... |
|
| 399 | + * then we need to find an actual class to use. |
|
| 400 | + * So the interface IS the alias for some other FQN, |
|
| 401 | + * and we need to find out if `Fully/Qualified/Namespace/SomeInterface` |
|
| 402 | + * represents some other class. |
|
| 403 | + * |
|
| 404 | + * @param string $fqn |
|
| 405 | + * @param string $for_class |
|
| 406 | + * @return bool |
|
| 407 | + */ |
|
| 408 | + public function isAlias($fqn = '', $for_class = '') |
|
| 409 | + { |
|
| 410 | + return $this->class_cache->isAlias($fqn, $for_class); |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + |
|
| 414 | + /** |
|
| 415 | + * Returns a FQN for provided alias if one exists, otherwise returns the original $alias |
|
| 416 | + * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
| 417 | + * for example: |
|
| 418 | + * if the following two entries were added to the _aliases array: |
|
| 419 | + * array( |
|
| 420 | + * 'interface_alias' => 'some\namespace\interface' |
|
| 421 | + * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 422 | + * ) |
|
| 423 | + * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
| 424 | + * to load an instance of 'some\namespace\classname' |
|
| 425 | + * |
|
| 426 | + * @param string $alias |
|
| 427 | + * @param string $for_class |
|
| 428 | + * @return string |
|
| 429 | + */ |
|
| 430 | + public function getFqnForAlias($alias = '', $for_class = '') |
|
| 431 | + { |
|
| 432 | + return (string) $this->class_cache->getFqnForAlias($alias, $for_class); |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + |
|
| 436 | + /** |
|
| 437 | + * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache, |
|
| 438 | + * if one exists, or whether a new object should be generated every time the requested class is loaded. |
|
| 439 | + * This is done by using the following class constants: |
|
| 440 | + * EE_Dependency_Map::load_from_cache - loads previously instantiated object |
|
| 441 | + * EE_Dependency_Map::load_new_object - generates a new object every time |
|
| 442 | + */ |
|
| 443 | + protected function _register_core_dependencies() |
|
| 444 | + { |
|
| 445 | + $this->_dependency_map = array( |
|
| 446 | + 'EE_Request_Handler' => array( |
|
| 447 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 448 | + ), |
|
| 449 | + 'EE_System' => array( |
|
| 450 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 451 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 452 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 453 | + 'EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache, |
|
| 454 | + ), |
|
| 455 | + 'EE_Session' => array( |
|
| 456 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 457 | + 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
| 458 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 459 | + 'EE_Encryption' => EE_Dependency_Map::load_from_cache, |
|
| 460 | + ), |
|
| 461 | + 'EE_Cart' => array( |
|
| 462 | + 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 463 | + ), |
|
| 464 | + 'EE_Front_Controller' => array( |
|
| 465 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 466 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 467 | + 'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache, |
|
| 468 | + ), |
|
| 469 | + 'EE_Messenger_Collection_Loader' => array( |
|
| 470 | + 'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object, |
|
| 471 | + ), |
|
| 472 | + 'EE_Message_Type_Collection_Loader' => array( |
|
| 473 | + 'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object, |
|
| 474 | + ), |
|
| 475 | + 'EE_Message_Resource_Manager' => array( |
|
| 476 | + 'EE_Messenger_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 477 | + 'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 478 | + 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 479 | + ), |
|
| 480 | + 'EE_Message_Factory' => array( |
|
| 481 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 482 | + ), |
|
| 483 | + 'EE_messages' => array( |
|
| 484 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 485 | + ), |
|
| 486 | + 'EE_Messages_Generator' => array( |
|
| 487 | + 'EE_Messages_Queue' => EE_Dependency_Map::load_new_object, |
|
| 488 | + 'EE_Messages_Data_Handler_Collection' => EE_Dependency_Map::load_new_object, |
|
| 489 | + 'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object, |
|
| 490 | + 'EEH_Parse_Shortcodes' => EE_Dependency_Map::load_from_cache, |
|
| 491 | + ), |
|
| 492 | + 'EE_Messages_Processor' => array( |
|
| 493 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 494 | + ), |
|
| 495 | + 'EE_Messages_Queue' => array( |
|
| 496 | + 'EE_Message_Repository' => EE_Dependency_Map::load_new_object, |
|
| 497 | + ), |
|
| 498 | + 'EE_Messages_Template_Defaults' => array( |
|
| 499 | + 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 500 | + 'EEM_Message_Template' => EE_Dependency_Map::load_from_cache, |
|
| 501 | + ), |
|
| 502 | + 'EE_Message_To_Generate_From_Request' => array( |
|
| 503 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 504 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 505 | + ), |
|
| 506 | + 'EventEspresso\core\services\commands\CommandBus' => array( |
|
| 507 | + 'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache, |
|
| 508 | + ), |
|
| 509 | + 'EventEspresso\services\commands\CommandHandler' => array( |
|
| 510 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 511 | + 'CommandBusInterface' => EE_Dependency_Map::load_from_cache, |
|
| 512 | + ), |
|
| 513 | + 'EventEspresso\core\services\commands\CommandHandlerManager' => array( |
|
| 514 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 515 | + ), |
|
| 516 | + 'EventEspresso\core\services\commands\CompositeCommandHandler' => array( |
|
| 517 | + 'EventEspresso\core\services\commands\CommandBus' => EE_Dependency_Map::load_from_cache, |
|
| 518 | + 'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache, |
|
| 519 | + ), |
|
| 520 | + 'EventEspresso\core\services\commands\CommandFactory' => array( |
|
| 521 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 522 | + ), |
|
| 523 | + 'EventEspresso\core\services\commands\middleware\CapChecker' => array( |
|
| 524 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
| 525 | + ), |
|
| 526 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => array( |
|
| 527 | + 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 528 | + ), |
|
| 529 | + 'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker' => array( |
|
| 530 | + 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 531 | + ), |
|
| 532 | + 'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler' => array( |
|
| 533 | + 'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 534 | + ), |
|
| 535 | + 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler' => array( |
|
| 536 | + 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 537 | + ), |
|
| 538 | + 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler' => array( |
|
| 539 | + 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 540 | + ), |
|
| 541 | + 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler' => array( |
|
| 542 | + 'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 543 | + ), |
|
| 544 | + 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array( |
|
| 545 | + 'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 546 | + ), |
|
| 547 | + 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler' => array( |
|
| 548 | + 'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 549 | + ), |
|
| 550 | + 'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler' => array( |
|
| 551 | + 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 552 | + ), |
|
| 553 | + 'EventEspresso\core\domain\services\registration\CancelRegistrationService' => array( |
|
| 554 | + 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 555 | + ), |
|
| 556 | + 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler' => array( |
|
| 557 | + 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 558 | + ), |
|
| 559 | + 'EventEspresso\core\services\database\TableManager' => array( |
|
| 560 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 561 | + ), |
|
| 562 | + 'EE_Data_Migration_Class_Base' => array( |
|
| 563 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 564 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 565 | + ), |
|
| 566 | + 'EE_DMS_Core_4_1_0' => array( |
|
| 567 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 568 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 569 | + ), |
|
| 570 | + 'EE_DMS_Core_4_2_0' => array( |
|
| 571 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 572 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 573 | + ), |
|
| 574 | + 'EE_DMS_Core_4_3_0' => array( |
|
| 575 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 576 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 577 | + ), |
|
| 578 | + 'EE_DMS_Core_4_4_0' => array( |
|
| 579 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 580 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 581 | + ), |
|
| 582 | + 'EE_DMS_Core_4_5_0' => array( |
|
| 583 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 584 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 585 | + ), |
|
| 586 | + 'EE_DMS_Core_4_6_0' => array( |
|
| 587 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 588 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 589 | + ), |
|
| 590 | + 'EE_DMS_Core_4_7_0' => array( |
|
| 591 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 592 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 593 | + ), |
|
| 594 | + 'EE_DMS_Core_4_8_0' => array( |
|
| 595 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 596 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 597 | + ), |
|
| 598 | + 'EE_DMS_Core_4_9_0' => array( |
|
| 599 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 600 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 601 | + ), |
|
| 602 | + 'EventEspresso\core\services\assets\I18nRegistry' => array( |
|
| 603 | + array(), |
|
| 604 | + 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 605 | + ), |
|
| 606 | + 'EventEspresso\core\services\assets\Registry' => array( |
|
| 607 | + 'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache, |
|
| 608 | + 'EventEspresso\core\services\assets\I18nRegistry' => EE_Dependency_Map::load_from_cache, |
|
| 609 | + ), |
|
| 610 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled' => array( |
|
| 611 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 612 | + ), |
|
| 613 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout' => array( |
|
| 614 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 615 | + ), |
|
| 616 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees' => array( |
|
| 617 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 618 | + ), |
|
| 619 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoEvents' => array( |
|
| 620 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 621 | + ), |
|
| 622 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou' => array( |
|
| 623 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 624 | + ), |
|
| 625 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector' => array( |
|
| 626 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 627 | + ), |
|
| 628 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage' => array( |
|
| 629 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 630 | + ), |
|
| 631 | + 'EventEspresso\core\services\cache\BasicCacheManager' => array( |
|
| 632 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 633 | + ), |
|
| 634 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => array( |
|
| 635 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 636 | + ), |
|
| 637 | + 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array( |
|
| 638 | + 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
| 639 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 640 | + ), |
|
| 641 | + 'EventEspresso\core\domain\values\EmailAddress' => array( |
|
| 642 | + null, |
|
| 643 | + 'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache, |
|
| 644 | + ), |
|
| 645 | + 'EventEspresso\core\services\orm\ModelFieldFactory' => array( |
|
| 646 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 647 | + ), |
|
| 648 | + 'LEGACY_MODELS' => array( |
|
| 649 | + null, |
|
| 650 | + 'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache, |
|
| 651 | + ), |
|
| 652 | + 'EE_Module_Request_Router' => array( |
|
| 653 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 654 | + ), |
|
| 655 | + 'EE_Registration_Processor' => array( |
|
| 656 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 657 | + ), |
|
| 658 | + 'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array( |
|
| 659 | + null, |
|
| 660 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
| 661 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 662 | + ), |
|
| 663 | + 'EventEspresso\core\services\licensing\LicenseService' => array( |
|
| 664 | + 'EventEspresso\core\domain\services\pue\Stats' => EE_Dependency_Map::load_from_cache, |
|
| 665 | + 'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache, |
|
| 666 | + ), |
|
| 667 | + 'EE_Admin_Transactions_List_Table' => array( |
|
| 668 | + null, |
|
| 669 | + 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache, |
|
| 670 | + ), |
|
| 671 | + 'EventEspresso\core\domain\services\pue\Stats' => array( |
|
| 672 | + 'EventEspresso\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache, |
|
| 673 | + 'EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache, |
|
| 674 | + 'EventEspresso\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache, |
|
| 675 | + ), |
|
| 676 | + 'EventEspresso\core\domain\services\pue\Config' => array( |
|
| 677 | + 'EE_Network_Config' => EE_Dependency_Map::load_from_cache, |
|
| 678 | + 'EE_Config' => EE_Dependency_Map::load_from_cache, |
|
| 679 | + ), |
|
| 680 | + 'EventEspresso\core\domain\services\pue\StatsGatherer' => array( |
|
| 681 | + 'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache, |
|
| 682 | + 'EEM_Event' => EE_Dependency_Map::load_from_cache, |
|
| 683 | + 'EEM_Datetime' => EE_Dependency_Map::load_from_cache, |
|
| 684 | + 'EEM_Ticket' => EE_Dependency_Map::load_from_cache, |
|
| 685 | + 'EEM_Registration' => EE_Dependency_Map::load_from_cache, |
|
| 686 | + 'EEM_Transaction' => EE_Dependency_Map::load_from_cache, |
|
| 687 | + 'EE_Config' => EE_Dependency_Map::load_from_cache, |
|
| 688 | + ), |
|
| 689 | + 'EventEspresso\core\domain\services\admin\ExitModal' => array( |
|
| 690 | + 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache, |
|
| 691 | + ), |
|
| 692 | + 'EventEspresso\core\domain\services\admin\PluginUpsells' => array( |
|
| 693 | + 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 694 | + ), |
|
| 695 | + 'EventEspresso\caffeinated\modules\recaptcha_invisible\InvisibleRecaptcha' => array( |
|
| 696 | + 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
| 697 | + 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 698 | + ), |
|
| 699 | + 'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings' => array( |
|
| 700 | + 'EE_Registration_Config' => EE_Dependency_Map::load_from_cache, |
|
| 701 | + ), |
|
| 702 | + 'EventEspresso\modules\ticket_selector\ProcessTicketSelector' => array( |
|
| 703 | + 'EE_Core_Config' => EE_Dependency_Map::load_from_cache, |
|
| 704 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 705 | + 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 706 | + 'EEM_Ticket' => EE_Dependency_Map::load_from_cache, |
|
| 707 | + 'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => EE_Dependency_Map::load_from_cache, |
|
| 708 | + ), |
|
| 709 | + 'EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker' => array( |
|
| 710 | + 'EEM_Datetime' => EE_Dependency_Map::load_from_cache, |
|
| 711 | + ), |
|
| 712 | + 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => array( |
|
| 713 | + 'EE_Core_Config' => EE_Dependency_Map::load_from_cache, |
|
| 714 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 715 | + ), |
|
| 716 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' => array( |
|
| 717 | + 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 718 | + ), |
|
| 719 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' => array( |
|
| 720 | + 'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 721 | + ), |
|
| 722 | + 'EE_CPT_Strategy' => array( |
|
| 723 | + 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 724 | + 'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions' => EE_Dependency_Map::load_from_cache, |
|
| 725 | + ), |
|
| 726 | + 'EventEspresso\core\services\loaders\ObjectIdentifier' => array( |
|
| 727 | + 'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache, |
|
| 728 | + ), |
|
| 729 | + 'EventEspresso\core\domain\services\assets\CoreAssetManager' => array( |
|
| 730 | + 'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache, |
|
| 731 | + 'EE_Currency_Config' => EE_Dependency_Map::load_from_cache, |
|
| 732 | + 'EE_Template_Config' => EE_Dependency_Map::load_from_cache, |
|
| 733 | + 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 734 | + 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache, |
|
| 735 | + ), |
|
| 736 | + 'EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy' => array( |
|
| 737 | + 'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache, |
|
| 738 | + 'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache |
|
| 739 | + ), |
|
| 740 | + 'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendee' => array( |
|
| 741 | + 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 742 | + ), |
|
| 743 | + 'EventEspresso\core\domain\services\admin\privacy\export\ExportAttendeeBillingData' => array( |
|
| 744 | + 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 745 | + 'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache |
|
| 746 | + ), |
|
| 747 | + 'EventEspresso\core\domain\services\admin\privacy\export\ExportCheckins' => array( |
|
| 748 | + 'EEM_Checkin' => EE_Dependency_Map::load_from_cache, |
|
| 749 | + ), |
|
| 750 | + 'EventEspresso\core\domain\services\admin\privacy\export\ExportRegistration' => array( |
|
| 751 | + 'EEM_Registration' => EE_Dependency_Map::load_from_cache, |
|
| 752 | + ), |
|
| 753 | + 'EventEspresso\core\domain\services\admin\privacy\export\ExportTransaction' => array( |
|
| 754 | + 'EEM_Transaction' => EE_Dependency_Map::load_from_cache, |
|
| 755 | + ), |
|
| 756 | + 'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAttendeeData' => array( |
|
| 757 | + 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 758 | + ), |
|
| 759 | + 'EventEspresso\core\domain\services\admin\privacy\erasure\EraseAnswers' => array( |
|
| 760 | + 'EEM_Answer' => EE_Dependency_Map::load_from_cache, |
|
| 761 | + 'EEM_Question' => EE_Dependency_Map::load_from_cache, |
|
| 762 | + ), |
|
| 763 | + 'EventEspresso\core\CPTs\CptQueryModifier' => array( |
|
| 764 | + null, |
|
| 765 | + null, |
|
| 766 | + null, |
|
| 767 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 768 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 769 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 770 | + ), |
|
| 771 | + 'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler' => array( |
|
| 772 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 773 | + 'EE_Config' => EE_Dependency_Map::load_from_cache |
|
| 774 | + ), |
|
| 775 | + 'EventEspresso\core\services\editor\BlockRegistrationManager' => array( |
|
| 776 | + 'EventEspresso\core\services\assets\BlockAssetManagerCollection' => EE_Dependency_Map::load_from_cache, |
|
| 777 | + 'EventEspresso\core\domain\entities\editor\BlockCollection' => EE_Dependency_Map::load_from_cache, |
|
| 778 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => EE_Dependency_Map::load_from_cache, |
|
| 779 | + 'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache, |
|
| 780 | + ), |
|
| 781 | + 'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => array( |
|
| 782 | + 'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache, |
|
| 783 | + 'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_from_cache, |
|
| 784 | + 'EventEspresso\core\services\assets\Registry' => EE_Dependency_Map::load_from_cache, |
|
| 785 | + ), |
|
| 786 | + 'EventEspresso\core\domain\entities\editor\blocks\widgets\EventAttendees' => array( |
|
| 787 | + 'EventEspresso\core\domain\entities\editor\blocks\CoreBlocksAssetManager' => self::load_from_cache, |
|
| 788 | + ), |
|
| 789 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => array( |
|
| 790 | + 'EventEspresso\core\services\container\Mirror' => EE_Dependency_Map::load_from_cache, |
|
| 791 | + 'EventEspresso\core\services\loaders\ClassInterfaceCache' => EE_Dependency_Map::load_from_cache, |
|
| 792 | + 'EE_Dependency_Map' => EE_Dependency_Map::load_from_cache, |
|
| 793 | + ), |
|
| 794 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => array( |
|
| 795 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationDependencyResolver' => EE_Dependency_Map::load_from_cache, |
|
| 796 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 797 | + ), |
|
| 798 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' => array( |
|
| 799 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationCollection' => EE_Dependency_Map::load_from_cache, |
|
| 800 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory' => EE_Dependency_Map::load_from_cache, |
|
| 801 | + ), |
|
| 802 | + ); |
|
| 803 | + } |
|
| 804 | + |
|
| 805 | + |
|
| 806 | + /** |
|
| 807 | + * Registers how core classes are loaded. |
|
| 808 | + * This can either be done by simply providing the name of one of the EE_Registry loader methods such as: |
|
| 809 | + * 'EE_Request_Handler' => 'load_core' |
|
| 810 | + * 'EE_Messages_Queue' => 'load_lib' |
|
| 811 | + * 'EEH_Debug_Tools' => 'load_helper' |
|
| 812 | + * or, if greater control is required, by providing a custom closure. For example: |
|
| 813 | + * 'Some_Class' => function () { |
|
| 814 | + * return new Some_Class(); |
|
| 815 | + * }, |
|
| 816 | + * This is required for instantiating dependencies |
|
| 817 | + * where an interface has been type hinted in a class constructor. For example: |
|
| 818 | + * 'Required_Interface' => function () { |
|
| 819 | + * return new A_Class_That_Implements_Required_Interface(); |
|
| 820 | + * }, |
|
| 821 | + */ |
|
| 822 | + protected function _register_core_class_loaders() |
|
| 823 | + { |
|
| 824 | + // for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot |
|
| 825 | + // be used in a closure. |
|
| 826 | + $request = &$this->request; |
|
| 827 | + $response = &$this->response; |
|
| 828 | + $legacy_request = &$this->legacy_request; |
|
| 829 | + $self = &$this; |
|
| 830 | + // $loader = &$this->loader; |
|
| 831 | + $this->_class_loaders = array( |
|
| 832 | + // load_core |
|
| 833 | + 'EE_Dependency_Map' => function () use (&$self) { |
|
| 834 | + return $self; |
|
| 835 | + }, |
|
| 836 | + 'EE_Capabilities' => 'load_core', |
|
| 837 | + 'EE_Encryption' => 'load_core', |
|
| 838 | + 'EE_Front_Controller' => 'load_core', |
|
| 839 | + 'EE_Module_Request_Router' => 'load_core', |
|
| 840 | + 'EE_Registry' => 'load_core', |
|
| 841 | + 'EE_Request' => function () use (&$legacy_request) { |
|
| 842 | + return $legacy_request; |
|
| 843 | + }, |
|
| 844 | + 'EventEspresso\core\services\request\Request' => function () use (&$request) { |
|
| 845 | + return $request; |
|
| 846 | + }, |
|
| 847 | + 'EventEspresso\core\services\request\Response' => function () use (&$response) { |
|
| 848 | + return $response; |
|
| 849 | + }, |
|
| 850 | + 'EE_Base' => 'load_core', |
|
| 851 | + 'EE_Request_Handler' => 'load_core', |
|
| 852 | + 'EE_Session' => 'load_core', |
|
| 853 | + 'EE_Cron_Tasks' => 'load_core', |
|
| 854 | + 'EE_System' => 'load_core', |
|
| 855 | + 'EE_Maintenance_Mode' => 'load_core', |
|
| 856 | + 'EE_Register_CPTs' => 'load_core', |
|
| 857 | + 'EE_Admin' => 'load_core', |
|
| 858 | + 'EE_CPT_Strategy' => 'load_core', |
|
| 859 | + // load_lib |
|
| 860 | + 'EE_Message_Resource_Manager' => 'load_lib', |
|
| 861 | + 'EE_Message_Type_Collection' => 'load_lib', |
|
| 862 | + 'EE_Message_Type_Collection_Loader' => 'load_lib', |
|
| 863 | + 'EE_Messenger_Collection' => 'load_lib', |
|
| 864 | + 'EE_Messenger_Collection_Loader' => 'load_lib', |
|
| 865 | + 'EE_Messages_Processor' => 'load_lib', |
|
| 866 | + 'EE_Message_Repository' => 'load_lib', |
|
| 867 | + 'EE_Messages_Queue' => 'load_lib', |
|
| 868 | + 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
|
| 869 | + 'EE_Message_Template_Group_Collection' => 'load_lib', |
|
| 870 | + 'EE_Payment_Method_Manager' => 'load_lib', |
|
| 871 | + 'EE_Messages_Generator' => function () { |
|
| 872 | + return EE_Registry::instance()->load_lib( |
|
| 873 | + 'Messages_Generator', |
|
| 874 | + array(), |
|
| 875 | + false, |
|
| 876 | + false |
|
| 877 | + ); |
|
| 878 | + }, |
|
| 879 | + 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
| 880 | + return EE_Registry::instance()->load_lib( |
|
| 881 | + 'Messages_Template_Defaults', |
|
| 882 | + $arguments, |
|
| 883 | + false, |
|
| 884 | + false |
|
| 885 | + ); |
|
| 886 | + }, |
|
| 887 | + // load_helper |
|
| 888 | + 'EEH_Parse_Shortcodes' => function () { |
|
| 889 | + if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
|
| 890 | + return new EEH_Parse_Shortcodes(); |
|
| 891 | + } |
|
| 892 | + return null; |
|
| 893 | + }, |
|
| 894 | + 'EE_Template_Config' => function () { |
|
| 895 | + return EE_Config::instance()->template_settings; |
|
| 896 | + }, |
|
| 897 | + 'EE_Currency_Config' => function () { |
|
| 898 | + return EE_Config::instance()->currency; |
|
| 899 | + }, |
|
| 900 | + 'EE_Registration_Config' => function () { |
|
| 901 | + return EE_Config::instance()->registration; |
|
| 902 | + }, |
|
| 903 | + 'EE_Core_Config' => function () { |
|
| 904 | + return EE_Config::instance()->core; |
|
| 905 | + }, |
|
| 906 | + 'EventEspresso\core\services\loaders\Loader' => function () { |
|
| 907 | + return LoaderFactory::getLoader(); |
|
| 908 | + }, |
|
| 909 | + 'EE_Network_Config' => function () { |
|
| 910 | + return EE_Network_Config::instance(); |
|
| 911 | + }, |
|
| 912 | + 'EE_Config' => function () { |
|
| 913 | + return EE_Config::instance(); |
|
| 914 | + }, |
|
| 915 | + 'EventEspresso\core\domain\Domain' => function () { |
|
| 916 | + return DomainFactory::getEventEspressoCoreDomain(); |
|
| 917 | + }, |
|
| 918 | + 'EE_Admin_Config' => function () { |
|
| 919 | + return EE_Config::instance()->admin; |
|
| 920 | + }, |
|
| 921 | + ); |
|
| 922 | + } |
|
| 923 | + |
|
| 924 | + |
|
| 925 | + /** |
|
| 926 | + * can be used for supplying alternate names for classes, |
|
| 927 | + * or for connecting interface names to instantiable classes |
|
| 928 | + */ |
|
| 929 | + protected function _register_core_aliases() |
|
| 930 | + { |
|
| 931 | + $aliases = array( |
|
| 932 | + 'CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBusInterface', |
|
| 933 | + 'EventEspresso\core\services\commands\CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBus', |
|
| 934 | + 'CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
| 935 | + 'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
| 936 | + 'CapChecker' => 'EventEspresso\core\services\commands\middleware\CapChecker', |
|
| 937 | + 'AddActionHook' => 'EventEspresso\core\services\commands\middleware\AddActionHook', |
|
| 938 | + 'CapabilitiesChecker' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 939 | + 'CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface', |
|
| 940 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 941 | + 'CreateRegistrationService' => 'EventEspresso\core\domain\services\registration\CreateRegistrationService', |
|
| 942 | + 'CreateRegistrationCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
| 943 | + 'CopyRegistrationDetailsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand', |
|
| 944 | + 'CopyRegistrationPaymentsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand', |
|
| 945 | + 'CancelRegistrationAndTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler', |
|
| 946 | + 'UpdateRegistrationAndTransactionAfterChangeCommandHandler' => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler', |
|
| 947 | + 'CreateTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand', |
|
| 948 | + 'CreateTransactionCommandHandler' => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler', |
|
| 949 | + 'CreateAttendeeCommandHandler' => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler', |
|
| 950 | + 'TableManager' => 'EventEspresso\core\services\database\TableManager', |
|
| 951 | + 'TableAnalysis' => 'EventEspresso\core\services\database\TableAnalysis', |
|
| 952 | + 'EspressoShortcode' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 953 | + 'ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 954 | + 'EventEspresso\core\services\shortcodes\ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 955 | + 'EventEspresso\core\services\cache\CacheStorageInterface' => 'EventEspresso\core\services\cache\TransientCacheStorage', |
|
| 956 | + 'LoaderInterface' => 'EventEspresso\core\services\loaders\LoaderInterface', |
|
| 957 | + 'EventEspresso\core\services\loaders\LoaderInterface' => 'EventEspresso\core\services\loaders\Loader', |
|
| 958 | + 'CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactoryInterface', |
|
| 959 | + 'EventEspresso\core\services\commands\CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactory', |
|
| 960 | + 'EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface', |
|
| 961 | + 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService', |
|
| 962 | + 'NoticeConverterInterface' => 'EventEspresso\core\services\notices\NoticeConverterInterface', |
|
| 963 | + 'EventEspresso\core\services\notices\NoticeConverterInterface' => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors', |
|
| 964 | + 'NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainerInterface', |
|
| 965 | + 'EventEspresso\core\services\notices\NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainer', |
|
| 966 | + 'EventEspresso\core\services\request\RequestInterface' => 'EventEspresso\core\services\request\Request', |
|
| 967 | + 'EventEspresso\core\services\request\ResponseInterface' => 'EventEspresso\core\services\request\Response', |
|
| 968 | + 'EventEspresso\core\domain\DomainInterface' => 'EventEspresso\core\domain\Domain', |
|
| 969 | + ); |
|
| 970 | + foreach ($aliases as $alias => $fqn) { |
|
| 971 | + if (is_array($fqn)) { |
|
| 972 | + foreach ($fqn as $class => $for_class) { |
|
| 973 | + $this->class_cache->addAlias($class, $alias, $for_class); |
|
| 974 | + } |
|
| 975 | + continue; |
|
| 976 | + } |
|
| 977 | + $this->class_cache->addAlias($fqn, $alias); |
|
| 978 | + } |
|
| 979 | + if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
| 980 | + $this->class_cache->addAlias( |
|
| 981 | + 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices', |
|
| 982 | + 'EventEspresso\core\services\notices\NoticeConverterInterface' |
|
| 983 | + ); |
|
| 984 | + } |
|
| 985 | + } |
|
| 986 | + |
|
| 987 | + |
|
| 988 | + /** |
|
| 989 | + * This is used to reset the internal map and class_loaders to their original default state at the beginning of the |
|
| 990 | + * request Primarily used by unit tests. |
|
| 991 | + */ |
|
| 992 | + public function reset() |
|
| 993 | + { |
|
| 994 | + $this->_register_core_class_loaders(); |
|
| 995 | + $this->_register_core_dependencies(); |
|
| 996 | + } |
|
| 997 | + |
|
| 998 | + |
|
| 999 | + /** |
|
| 1000 | + * PLZ NOTE: a better name for this method would be is_alias() |
|
| 1001 | + * because it returns TRUE if the provided fully qualified name IS an alias |
|
| 1002 | + * WHY? |
|
| 1003 | + * Because if a class is type hinting for a concretion, |
|
| 1004 | + * then why would we need to find another class to supply it? |
|
| 1005 | + * ie: if a class asks for `Fully/Qualified/Namespace/SpecificClassName`, |
|
| 1006 | + * then give it an instance of `Fully/Qualified/Namespace/SpecificClassName`. |
|
| 1007 | + * Don't go looking for some substitute. |
|
| 1008 | + * Whereas if a class is type hinting for an interface... |
|
| 1009 | + * then we need to find an actual class to use. |
|
| 1010 | + * So the interface IS the alias for some other FQN, |
|
| 1011 | + * and we need to find out if `Fully/Qualified/Namespace/SomeInterface` |
|
| 1012 | + * represents some other class. |
|
| 1013 | + * |
|
| 1014 | + * @deprecated 4.9.62.p |
|
| 1015 | + * @param string $fqn |
|
| 1016 | + * @param string $for_class |
|
| 1017 | + * @return bool |
|
| 1018 | + */ |
|
| 1019 | + public function has_alias($fqn = '', $for_class = '') |
|
| 1020 | + { |
|
| 1021 | + return $this->isAlias($fqn, $for_class); |
|
| 1022 | + } |
|
| 1023 | + |
|
| 1024 | + |
|
| 1025 | + /** |
|
| 1026 | + * PLZ NOTE: a better name for this method would be get_fqn_for_alias() |
|
| 1027 | + * because it returns a FQN for provided alias if one exists, otherwise returns the original $alias |
|
| 1028 | + * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
| 1029 | + * for example: |
|
| 1030 | + * if the following two entries were added to the _aliases array: |
|
| 1031 | + * array( |
|
| 1032 | + * 'interface_alias' => 'some\namespace\interface' |
|
| 1033 | + * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 1034 | + * ) |
|
| 1035 | + * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
| 1036 | + * to load an instance of 'some\namespace\classname' |
|
| 1037 | + * |
|
| 1038 | + * @deprecated 4.9.62.p |
|
| 1039 | + * @param string $alias |
|
| 1040 | + * @param string $for_class |
|
| 1041 | + * @return string |
|
| 1042 | + */ |
|
| 1043 | + public function get_alias($alias = '', $for_class = '') |
|
| 1044 | + { |
|
| 1045 | + return $this->getFqnForAlias($alias, $for_class); |
|
| 1046 | + } |
|
| 1047 | 1047 | } |
@@ -122,7 +122,7 @@ discard block |
||
| 122 | 122 | public static function instance(ClassInterfaceCache $class_cache = null) |
| 123 | 123 | { |
| 124 | 124 | // check if class object is instantiated, and instantiated properly |
| 125 | - if (! self::$_instance instanceof EE_Dependency_Map |
|
| 125 | + if ( ! self::$_instance instanceof EE_Dependency_Map |
|
| 126 | 126 | && $class_cache instanceof ClassInterfaceCache |
| 127 | 127 | ) { |
| 128 | 128 | self::$_instance = new EE_Dependency_Map($class_cache); |
@@ -203,18 +203,18 @@ discard block |
||
| 203 | 203 | ) { |
| 204 | 204 | $class = trim($class, '\\'); |
| 205 | 205 | $registered = false; |
| 206 | - if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
| 207 | - self::$_instance->_dependency_map[ $class ] = array(); |
|
| 206 | + if (empty(self::$_instance->_dependency_map[$class])) { |
|
| 207 | + self::$_instance->_dependency_map[$class] = array(); |
|
| 208 | 208 | } |
| 209 | 209 | // we need to make sure that any aliases used when registering a dependency |
| 210 | 210 | // get resolved to the correct class name |
| 211 | 211 | foreach ($dependencies as $dependency => $load_source) { |
| 212 | 212 | $alias = self::$_instance->getFqnForAlias($dependency); |
| 213 | 213 | if ($overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
| 214 | - || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
| 214 | + || ! isset(self::$_instance->_dependency_map[$class][$alias]) |
|
| 215 | 215 | ) { |
| 216 | - unset($dependencies[ $dependency ]); |
|
| 217 | - $dependencies[ $alias ] = $load_source; |
|
| 216 | + unset($dependencies[$dependency]); |
|
| 217 | + $dependencies[$alias] = $load_source; |
|
| 218 | 218 | $registered = true; |
| 219 | 219 | } |
| 220 | 220 | } |
@@ -224,13 +224,13 @@ discard block |
||
| 224 | 224 | // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
| 225 | 225 | // Union is way faster than array_merge() but should be used with caution... |
| 226 | 226 | // especially with numerically indexed arrays |
| 227 | - $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
| 227 | + $dependencies += self::$_instance->_dependency_map[$class]; |
|
| 228 | 228 | // now we need to ensure that the resulting dependencies |
| 229 | 229 | // array only has the entries that are required for the class |
| 230 | 230 | // so first count how many dependencies were originally registered for the class |
| 231 | - $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
| 231 | + $dependency_count = count(self::$_instance->_dependency_map[$class]); |
|
| 232 | 232 | // if that count is non-zero (meaning dependencies were already registered) |
| 233 | - self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
| 233 | + self::$_instance->_dependency_map[$class] = $dependency_count |
|
| 234 | 234 | // then truncate the final array to match that count |
| 235 | 235 | ? array_slice($dependencies, 0, $dependency_count) |
| 236 | 236 | // otherwise just take the incoming array because nothing previously existed |
@@ -247,13 +247,13 @@ discard block |
||
| 247 | 247 | */ |
| 248 | 248 | public static function register_class_loader($class_name, $loader = 'load_core') |
| 249 | 249 | { |
| 250 | - if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 250 | + if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 251 | 251 | throw new DomainException( |
| 252 | 252 | esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
| 253 | 253 | ); |
| 254 | 254 | } |
| 255 | 255 | // check that loader is callable or method starts with "load_" and exists in EE_Registry |
| 256 | - if (! is_callable($loader) |
|
| 256 | + if ( ! is_callable($loader) |
|
| 257 | 257 | && ( |
| 258 | 258 | strpos($loader, 'load_') !== 0 |
| 259 | 259 | || ! method_exists('EE_Registry', $loader) |
@@ -270,8 +270,8 @@ discard block |
||
| 270 | 270 | ); |
| 271 | 271 | } |
| 272 | 272 | $class_name = self::$_instance->getFqnForAlias($class_name); |
| 273 | - if (! isset(self::$_instance->_class_loaders[ $class_name ])) { |
|
| 274 | - self::$_instance->_class_loaders[ $class_name ] = $loader; |
|
| 273 | + if ( ! isset(self::$_instance->_class_loaders[$class_name])) { |
|
| 274 | + self::$_instance->_class_loaders[$class_name] = $loader; |
|
| 275 | 275 | return true; |
| 276 | 276 | } |
| 277 | 277 | return false; |
@@ -299,7 +299,7 @@ discard block |
||
| 299 | 299 | if (strpos($class_name, 'EEM_') === 0) { |
| 300 | 300 | $class_name = 'LEGACY_MODELS'; |
| 301 | 301 | } |
| 302 | - return isset($this->_dependency_map[ $class_name ]) ? true : false; |
|
| 302 | + return isset($this->_dependency_map[$class_name]) ? true : false; |
|
| 303 | 303 | } |
| 304 | 304 | |
| 305 | 305 | |
@@ -317,7 +317,7 @@ discard block |
||
| 317 | 317 | $class_name = 'LEGACY_MODELS'; |
| 318 | 318 | } |
| 319 | 319 | $dependency = $this->getFqnForAlias($dependency, $class_name); |
| 320 | - return isset($this->_dependency_map[ $class_name ][ $dependency ]) |
|
| 320 | + return isset($this->_dependency_map[$class_name][$dependency]) |
|
| 321 | 321 | ? true |
| 322 | 322 | : false; |
| 323 | 323 | } |
@@ -338,7 +338,7 @@ discard block |
||
| 338 | 338 | } |
| 339 | 339 | $dependency = $this->getFqnForAlias($dependency); |
| 340 | 340 | return $this->has_dependency_for_class($class_name, $dependency) |
| 341 | - ? $this->_dependency_map[ $class_name ][ $dependency ] |
|
| 341 | + ? $this->_dependency_map[$class_name][$dependency] |
|
| 342 | 342 | : EE_Dependency_Map::not_registered; |
| 343 | 343 | } |
| 344 | 344 | |
@@ -361,7 +361,7 @@ discard block |
||
| 361 | 361 | return 'load_core'; |
| 362 | 362 | } |
| 363 | 363 | $class_name = $this->getFqnForAlias($class_name); |
| 364 | - return isset($this->_class_loaders[ $class_name ]) ? $this->_class_loaders[ $class_name ] : ''; |
|
| 364 | + return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : ''; |
|
| 365 | 365 | } |
| 366 | 366 | |
| 367 | 367 | |
@@ -830,7 +830,7 @@ discard block |
||
| 830 | 830 | // $loader = &$this->loader; |
| 831 | 831 | $this->_class_loaders = array( |
| 832 | 832 | // load_core |
| 833 | - 'EE_Dependency_Map' => function () use (&$self) { |
|
| 833 | + 'EE_Dependency_Map' => function() use (&$self) { |
|
| 834 | 834 | return $self; |
| 835 | 835 | }, |
| 836 | 836 | 'EE_Capabilities' => 'load_core', |
@@ -838,13 +838,13 @@ discard block |
||
| 838 | 838 | 'EE_Front_Controller' => 'load_core', |
| 839 | 839 | 'EE_Module_Request_Router' => 'load_core', |
| 840 | 840 | 'EE_Registry' => 'load_core', |
| 841 | - 'EE_Request' => function () use (&$legacy_request) { |
|
| 841 | + 'EE_Request' => function() use (&$legacy_request) { |
|
| 842 | 842 | return $legacy_request; |
| 843 | 843 | }, |
| 844 | - 'EventEspresso\core\services\request\Request' => function () use (&$request) { |
|
| 844 | + 'EventEspresso\core\services\request\Request' => function() use (&$request) { |
|
| 845 | 845 | return $request; |
| 846 | 846 | }, |
| 847 | - 'EventEspresso\core\services\request\Response' => function () use (&$response) { |
|
| 847 | + 'EventEspresso\core\services\request\Response' => function() use (&$response) { |
|
| 848 | 848 | return $response; |
| 849 | 849 | }, |
| 850 | 850 | 'EE_Base' => 'load_core', |
@@ -868,7 +868,7 @@ discard block |
||
| 868 | 868 | 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
| 869 | 869 | 'EE_Message_Template_Group_Collection' => 'load_lib', |
| 870 | 870 | 'EE_Payment_Method_Manager' => 'load_lib', |
| 871 | - 'EE_Messages_Generator' => function () { |
|
| 871 | + 'EE_Messages_Generator' => function() { |
|
| 872 | 872 | return EE_Registry::instance()->load_lib( |
| 873 | 873 | 'Messages_Generator', |
| 874 | 874 | array(), |
@@ -876,7 +876,7 @@ discard block |
||
| 876 | 876 | false |
| 877 | 877 | ); |
| 878 | 878 | }, |
| 879 | - 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
| 879 | + 'EE_Messages_Template_Defaults' => function($arguments = array()) { |
|
| 880 | 880 | return EE_Registry::instance()->load_lib( |
| 881 | 881 | 'Messages_Template_Defaults', |
| 882 | 882 | $arguments, |
@@ -885,37 +885,37 @@ discard block |
||
| 885 | 885 | ); |
| 886 | 886 | }, |
| 887 | 887 | // load_helper |
| 888 | - 'EEH_Parse_Shortcodes' => function () { |
|
| 888 | + 'EEH_Parse_Shortcodes' => function() { |
|
| 889 | 889 | if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
| 890 | 890 | return new EEH_Parse_Shortcodes(); |
| 891 | 891 | } |
| 892 | 892 | return null; |
| 893 | 893 | }, |
| 894 | - 'EE_Template_Config' => function () { |
|
| 894 | + 'EE_Template_Config' => function() { |
|
| 895 | 895 | return EE_Config::instance()->template_settings; |
| 896 | 896 | }, |
| 897 | - 'EE_Currency_Config' => function () { |
|
| 897 | + 'EE_Currency_Config' => function() { |
|
| 898 | 898 | return EE_Config::instance()->currency; |
| 899 | 899 | }, |
| 900 | - 'EE_Registration_Config' => function () { |
|
| 900 | + 'EE_Registration_Config' => function() { |
|
| 901 | 901 | return EE_Config::instance()->registration; |
| 902 | 902 | }, |
| 903 | - 'EE_Core_Config' => function () { |
|
| 903 | + 'EE_Core_Config' => function() { |
|
| 904 | 904 | return EE_Config::instance()->core; |
| 905 | 905 | }, |
| 906 | - 'EventEspresso\core\services\loaders\Loader' => function () { |
|
| 906 | + 'EventEspresso\core\services\loaders\Loader' => function() { |
|
| 907 | 907 | return LoaderFactory::getLoader(); |
| 908 | 908 | }, |
| 909 | - 'EE_Network_Config' => function () { |
|
| 909 | + 'EE_Network_Config' => function() { |
|
| 910 | 910 | return EE_Network_Config::instance(); |
| 911 | 911 | }, |
| 912 | - 'EE_Config' => function () { |
|
| 912 | + 'EE_Config' => function() { |
|
| 913 | 913 | return EE_Config::instance(); |
| 914 | 914 | }, |
| 915 | - 'EventEspresso\core\domain\Domain' => function () { |
|
| 915 | + 'EventEspresso\core\domain\Domain' => function() { |
|
| 916 | 916 | return DomainFactory::getEventEspressoCoreDomain(); |
| 917 | 917 | }, |
| 918 | - 'EE_Admin_Config' => function () { |
|
| 918 | + 'EE_Admin_Config' => function() { |
|
| 919 | 919 | return EE_Config::instance()->admin; |
| 920 | 920 | }, |
| 921 | 921 | ); |
@@ -976,7 +976,7 @@ discard block |
||
| 976 | 976 | } |
| 977 | 977 | $this->class_cache->addAlias($fqn, $alias); |
| 978 | 978 | } |
| 979 | - if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
| 979 | + if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) { |
|
| 980 | 980 | $this->class_cache->addAlias( |
| 981 | 981 | 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices', |
| 982 | 982 | 'EventEspresso\core\services\notices\NoticeConverterInterface' |
@@ -17,165 +17,165 @@ |
||
| 17 | 17 | class ClassInterfaceCache |
| 18 | 18 | { |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * array of interfaces indexed by FQCNs where values are arrays of interface FQNs |
|
| 22 | - * |
|
| 23 | - * @var string[][] $interfaces |
|
| 24 | - */ |
|
| 25 | - private $interfaces = array(); |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * @type string[][] $aliases |
|
| 29 | - */ |
|
| 30 | - protected $aliases = array(); |
|
| 31 | - |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @param string $fqn |
|
| 35 | - * @return string |
|
| 36 | - */ |
|
| 37 | - public function getFqn($fqn) |
|
| 38 | - { |
|
| 39 | - $fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn; |
|
| 40 | - return ltrim($fqn, '\\'); |
|
| 41 | - } |
|
| 42 | - |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * @param string $fqn |
|
| 46 | - * @return array |
|
| 47 | - */ |
|
| 48 | - public function getInterfaces($fqn) |
|
| 49 | - { |
|
| 50 | - $fqn = $this->getFqn($fqn); |
|
| 51 | - // have we already seen this FQCN ? |
|
| 52 | - if (! array_key_exists($fqn, $this->interfaces)) { |
|
| 53 | - $this->interfaces[ $fqn ] = array(); |
|
| 54 | - if (class_exists($fqn)) { |
|
| 55 | - $this->interfaces[ $fqn ] = class_implements($fqn, false); |
|
| 56 | - $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false |
|
| 57 | - ? $this->interfaces[ $fqn ] |
|
| 58 | - : array(); |
|
| 59 | - } |
|
| 60 | - } |
|
| 61 | - return $this->interfaces[ $fqn ]; |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @param string $fqn |
|
| 67 | - * @param string $interface |
|
| 68 | - * @return bool |
|
| 69 | - */ |
|
| 70 | - public function hasInterface($fqn, $interface) |
|
| 71 | - { |
|
| 72 | - $fqn = $this->getFqn($fqn); |
|
| 73 | - $interfaces = $this->getInterfaces($fqn); |
|
| 74 | - return in_array($interface, $interfaces, true); |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * adds an alias for a classname |
|
| 80 | - * |
|
| 81 | - * @param string $fqn the class name that should be used (concrete class to replace interface) |
|
| 82 | - * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
| 83 | - * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
| 84 | - * @throws InvalidAliasException |
|
| 85 | - */ |
|
| 86 | - public function addAlias($fqn, $alias, $for_class = '') |
|
| 87 | - { |
|
| 88 | - $fqn = $this->getFqn($fqn); |
|
| 89 | - $alias = $this->getFqn($alias); |
|
| 90 | - if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) { |
|
| 91 | - throw new InvalidAliasException($fqn, $alias); |
|
| 92 | - } |
|
| 93 | - // are we adding an alias for a specific class? |
|
| 94 | - if ($for_class !== '') { |
|
| 95 | - // make sure it's set up as an array |
|
| 96 | - if (! isset($this->aliases[ $for_class ])) { |
|
| 97 | - $this->aliases[ $for_class ] = array(); |
|
| 98 | - } |
|
| 99 | - $this->aliases[ $for_class ][ $alias ] = $fqn; |
|
| 100 | - return; |
|
| 101 | - } |
|
| 102 | - $this->aliases[ $alias ] = $fqn; |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * returns TRUE if the provided FQN is an alias |
|
| 108 | - * |
|
| 109 | - * @param string $fqn |
|
| 110 | - * @param string $for_class |
|
| 111 | - * @return bool |
|
| 112 | - */ |
|
| 113 | - public function isAlias($fqn = '', $for_class = '') |
|
| 114 | - { |
|
| 115 | - $fqn = $this->getFqn($fqn); |
|
| 116 | - if ($this->isAliasForClass($fqn, $for_class)) { |
|
| 117 | - return true; |
|
| 118 | - } |
|
| 119 | - if ($for_class === '' && $this->isDirectAlias($fqn)) { |
|
| 120 | - return true; |
|
| 121 | - } |
|
| 122 | - return false; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * returns TRUE if the provided FQN is an alias |
|
| 128 | - * |
|
| 129 | - * @param string $fqn |
|
| 130 | - * @return bool |
|
| 131 | - */ |
|
| 132 | - protected function isDirectAlias($fqn = '') |
|
| 133 | - { |
|
| 134 | - return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * returns TRUE if the provided FQN is an alias for the specified class |
|
| 140 | - * |
|
| 141 | - * @param string $fqn |
|
| 142 | - * @param string $for_class |
|
| 143 | - * @return bool |
|
| 144 | - */ |
|
| 145 | - protected function isAliasForClass($fqn = '', $for_class = '') |
|
| 146 | - { |
|
| 147 | - return ( |
|
| 148 | - $for_class !== '' |
|
| 149 | - && isset($this->aliases[ (string) $for_class ][ (string) $fqn ]) |
|
| 150 | - ); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * returns FQN for provided alias if one exists, otherwise returns the original FQN |
|
| 156 | - * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
| 157 | - * for example: |
|
| 158 | - * if the following two entries were added to the aliases array: |
|
| 159 | - * array( |
|
| 160 | - * 'interface_alias' => 'some\namespace\interface' |
|
| 161 | - * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 162 | - * ) |
|
| 163 | - * then one could use Loader::getNew( 'interface_alias' ) |
|
| 164 | - * to load an instance of 'some\namespace\classname' |
|
| 165 | - * |
|
| 166 | - * @param string $alias |
|
| 167 | - * @param string $for_class |
|
| 168 | - * @return string |
|
| 169 | - */ |
|
| 170 | - public function getFqnForAlias($alias = '', $for_class = '') |
|
| 171 | - { |
|
| 172 | - $alias = $this->getFqn($alias); |
|
| 173 | - if ($this->isAliasForClass($alias, $for_class)) { |
|
| 174 | - return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class); |
|
| 175 | - } |
|
| 176 | - if ($this->isDirectAlias($alias)) { |
|
| 177 | - return $this->getFqnForAlias($this->aliases[ (string) $alias ], ''); |
|
| 178 | - } |
|
| 179 | - return $alias; |
|
| 180 | - } |
|
| 20 | + /** |
|
| 21 | + * array of interfaces indexed by FQCNs where values are arrays of interface FQNs |
|
| 22 | + * |
|
| 23 | + * @var string[][] $interfaces |
|
| 24 | + */ |
|
| 25 | + private $interfaces = array(); |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * @type string[][] $aliases |
|
| 29 | + */ |
|
| 30 | + protected $aliases = array(); |
|
| 31 | + |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @param string $fqn |
|
| 35 | + * @return string |
|
| 36 | + */ |
|
| 37 | + public function getFqn($fqn) |
|
| 38 | + { |
|
| 39 | + $fqn = $fqn instanceof FullyQualifiedName ? $fqn->string() : $fqn; |
|
| 40 | + return ltrim($fqn, '\\'); |
|
| 41 | + } |
|
| 42 | + |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * @param string $fqn |
|
| 46 | + * @return array |
|
| 47 | + */ |
|
| 48 | + public function getInterfaces($fqn) |
|
| 49 | + { |
|
| 50 | + $fqn = $this->getFqn($fqn); |
|
| 51 | + // have we already seen this FQCN ? |
|
| 52 | + if (! array_key_exists($fqn, $this->interfaces)) { |
|
| 53 | + $this->interfaces[ $fqn ] = array(); |
|
| 54 | + if (class_exists($fqn)) { |
|
| 55 | + $this->interfaces[ $fqn ] = class_implements($fqn, false); |
|
| 56 | + $this->interfaces[ $fqn ] = $this->interfaces[ $fqn ] !== false |
|
| 57 | + ? $this->interfaces[ $fqn ] |
|
| 58 | + : array(); |
|
| 59 | + } |
|
| 60 | + } |
|
| 61 | + return $this->interfaces[ $fqn ]; |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @param string $fqn |
|
| 67 | + * @param string $interface |
|
| 68 | + * @return bool |
|
| 69 | + */ |
|
| 70 | + public function hasInterface($fqn, $interface) |
|
| 71 | + { |
|
| 72 | + $fqn = $this->getFqn($fqn); |
|
| 73 | + $interfaces = $this->getInterfaces($fqn); |
|
| 74 | + return in_array($interface, $interfaces, true); |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * adds an alias for a classname |
|
| 80 | + * |
|
| 81 | + * @param string $fqn the class name that should be used (concrete class to replace interface) |
|
| 82 | + * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
| 83 | + * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
| 84 | + * @throws InvalidAliasException |
|
| 85 | + */ |
|
| 86 | + public function addAlias($fqn, $alias, $for_class = '') |
|
| 87 | + { |
|
| 88 | + $fqn = $this->getFqn($fqn); |
|
| 89 | + $alias = $this->getFqn($alias); |
|
| 90 | + if (strpos($alias, '\\') !== false && ! is_subclass_of($fqn, $alias)) { |
|
| 91 | + throw new InvalidAliasException($fqn, $alias); |
|
| 92 | + } |
|
| 93 | + // are we adding an alias for a specific class? |
|
| 94 | + if ($for_class !== '') { |
|
| 95 | + // make sure it's set up as an array |
|
| 96 | + if (! isset($this->aliases[ $for_class ])) { |
|
| 97 | + $this->aliases[ $for_class ] = array(); |
|
| 98 | + } |
|
| 99 | + $this->aliases[ $for_class ][ $alias ] = $fqn; |
|
| 100 | + return; |
|
| 101 | + } |
|
| 102 | + $this->aliases[ $alias ] = $fqn; |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * returns TRUE if the provided FQN is an alias |
|
| 108 | + * |
|
| 109 | + * @param string $fqn |
|
| 110 | + * @param string $for_class |
|
| 111 | + * @return bool |
|
| 112 | + */ |
|
| 113 | + public function isAlias($fqn = '', $for_class = '') |
|
| 114 | + { |
|
| 115 | + $fqn = $this->getFqn($fqn); |
|
| 116 | + if ($this->isAliasForClass($fqn, $for_class)) { |
|
| 117 | + return true; |
|
| 118 | + } |
|
| 119 | + if ($for_class === '' && $this->isDirectAlias($fqn)) { |
|
| 120 | + return true; |
|
| 121 | + } |
|
| 122 | + return false; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * returns TRUE if the provided FQN is an alias |
|
| 128 | + * |
|
| 129 | + * @param string $fqn |
|
| 130 | + * @return bool |
|
| 131 | + */ |
|
| 132 | + protected function isDirectAlias($fqn = '') |
|
| 133 | + { |
|
| 134 | + return isset($this->aliases[ (string) $fqn ]) && ! is_array($this->aliases[ (string) $fqn ]); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * returns TRUE if the provided FQN is an alias for the specified class |
|
| 140 | + * |
|
| 141 | + * @param string $fqn |
|
| 142 | + * @param string $for_class |
|
| 143 | + * @return bool |
|
| 144 | + */ |
|
| 145 | + protected function isAliasForClass($fqn = '', $for_class = '') |
|
| 146 | + { |
|
| 147 | + return ( |
|
| 148 | + $for_class !== '' |
|
| 149 | + && isset($this->aliases[ (string) $for_class ][ (string) $fqn ]) |
|
| 150 | + ); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * returns FQN for provided alias if one exists, otherwise returns the original FQN |
|
| 156 | + * functions recursively, so that multiple aliases can be used to drill down to a FQN |
|
| 157 | + * for example: |
|
| 158 | + * if the following two entries were added to the aliases array: |
|
| 159 | + * array( |
|
| 160 | + * 'interface_alias' => 'some\namespace\interface' |
|
| 161 | + * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 162 | + * ) |
|
| 163 | + * then one could use Loader::getNew( 'interface_alias' ) |
|
| 164 | + * to load an instance of 'some\namespace\classname' |
|
| 165 | + * |
|
| 166 | + * @param string $alias |
|
| 167 | + * @param string $for_class |
|
| 168 | + * @return string |
|
| 169 | + */ |
|
| 170 | + public function getFqnForAlias($alias = '', $for_class = '') |
|
| 171 | + { |
|
| 172 | + $alias = $this->getFqn($alias); |
|
| 173 | + if ($this->isAliasForClass($alias, $for_class)) { |
|
| 174 | + return $this->getFqnForAlias($this->aliases[ (string) $for_class ][ (string) $alias ], $for_class); |
|
| 175 | + } |
|
| 176 | + if ($this->isDirectAlias($alias)) { |
|
| 177 | + return $this->getFqnForAlias($this->aliases[ (string) $alias ], ''); |
|
| 178 | + } |
|
| 179 | + return $alias; |
|
| 180 | + } |
|
| 181 | 181 | } |
@@ -25,122 +25,122 @@ |
||
| 25 | 25 | */ |
| 26 | 26 | class RouteMatchSpecificationManager |
| 27 | 27 | { |
| 28 | - /** |
|
| 29 | - * @var CollectionInterface[]|RouteMatchSpecificationInterface[] $specifications |
|
| 30 | - */ |
|
| 31 | - private $specifications; |
|
| 28 | + /** |
|
| 29 | + * @var CollectionInterface[]|RouteMatchSpecificationInterface[] $specifications |
|
| 30 | + */ |
|
| 31 | + private $specifications; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var RouteMatchSpecificationFactory $specifications_factory |
|
| 35 | - */ |
|
| 36 | - private $specifications_factory; |
|
| 33 | + /** |
|
| 34 | + * @var RouteMatchSpecificationFactory $specifications_factory |
|
| 35 | + */ |
|
| 36 | + private $specifications_factory; |
|
| 37 | 37 | |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * RouteMatchSpecificationManager constructor. |
|
| 41 | - * |
|
| 42 | - * @param RouteMatchSpecificationCollection $specifications |
|
| 43 | - * @param RouteMatchSpecificationFactory $specifications_factory |
|
| 44 | - */ |
|
| 45 | - public function __construct( |
|
| 46 | - RouteMatchSpecificationCollection $specifications, |
|
| 47 | - RouteMatchSpecificationFactory $specifications_factory |
|
| 48 | - ) { |
|
| 49 | - $this->specifications = $specifications; |
|
| 50 | - $this->specifications_factory = $specifications_factory; |
|
| 51 | - add_action('AHEE__EE_System__loadRouteMatchSpecifications', array($this, 'initialize')); |
|
| 52 | - } |
|
| 39 | + /** |
|
| 40 | + * RouteMatchSpecificationManager constructor. |
|
| 41 | + * |
|
| 42 | + * @param RouteMatchSpecificationCollection $specifications |
|
| 43 | + * @param RouteMatchSpecificationFactory $specifications_factory |
|
| 44 | + */ |
|
| 45 | + public function __construct( |
|
| 46 | + RouteMatchSpecificationCollection $specifications, |
|
| 47 | + RouteMatchSpecificationFactory $specifications_factory |
|
| 48 | + ) { |
|
| 49 | + $this->specifications = $specifications; |
|
| 50 | + $this->specifications_factory = $specifications_factory; |
|
| 51 | + add_action('AHEE__EE_System__loadRouteMatchSpecifications', array($this, 'initialize')); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Perform any early setup required for block editors to functions |
|
| 57 | - * |
|
| 58 | - * @return void |
|
| 59 | - * @throws CollectionLoaderException |
|
| 60 | - * @throws CollectionDetailsException |
|
| 61 | - */ |
|
| 62 | - public function initialize() |
|
| 63 | - { |
|
| 64 | - $this->populateSpecificationCollection(); |
|
| 65 | - } |
|
| 55 | + /** |
|
| 56 | + * Perform any early setup required for block editors to functions |
|
| 57 | + * |
|
| 58 | + * @return void |
|
| 59 | + * @throws CollectionLoaderException |
|
| 60 | + * @throws CollectionDetailsException |
|
| 61 | + */ |
|
| 62 | + public function initialize() |
|
| 63 | + { |
|
| 64 | + $this->populateSpecificationCollection(); |
|
| 65 | + } |
|
| 66 | 66 | |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * @return CollectionInterface|RouteMatchSpecificationInterface[] |
|
| 70 | - * @throws CollectionLoaderException |
|
| 71 | - * @throws CollectionDetailsException |
|
| 72 | - * @since $VID:$ |
|
| 73 | - */ |
|
| 74 | - private function populateSpecificationCollection() |
|
| 75 | - { |
|
| 76 | - $loader = new CollectionLoader( |
|
| 77 | - new CollectionDetails( |
|
| 78 | - // collection name |
|
| 79 | - RouteMatchSpecificationCollection::COLLECTION_NAME, |
|
| 80 | - // collection interface |
|
| 81 | - 'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface', |
|
| 82 | - // FQCNs for classes to add (all classes within each namespace will be loaded) |
|
| 83 | - apply_filters( |
|
| 84 | - 'FHEE__EventEspresso_core_services_route_match_RouteMatchSpecificationManager__populateSpecificationCollection__collection_FQCNs', |
|
| 85 | - array( |
|
| 86 | - 'EventEspresso\core\domain\entities\route_match\specifications\admin', |
|
| 87 | - // 'EventEspresso\core\domain\entities\route_match\specifications\public', |
|
| 88 | - ) |
|
| 89 | - ), |
|
| 90 | - // filepaths to classes to add |
|
| 91 | - array(), |
|
| 92 | - // file mask to use if parsing folder for files to add |
|
| 93 | - '', |
|
| 94 | - // what to use as identifier for collection entities |
|
| 95 | - // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 96 | - CollectionDetails::ID_CLASS_NAME |
|
| 97 | - ), |
|
| 98 | - $this->specifications, |
|
| 99 | - null, |
|
| 100 | - $this->specifications_factory |
|
| 101 | - ); |
|
| 102 | - return $loader->getCollection(); |
|
| 103 | - } |
|
| 68 | + /** |
|
| 69 | + * @return CollectionInterface|RouteMatchSpecificationInterface[] |
|
| 70 | + * @throws CollectionLoaderException |
|
| 71 | + * @throws CollectionDetailsException |
|
| 72 | + * @since $VID:$ |
|
| 73 | + */ |
|
| 74 | + private function populateSpecificationCollection() |
|
| 75 | + { |
|
| 76 | + $loader = new CollectionLoader( |
|
| 77 | + new CollectionDetails( |
|
| 78 | + // collection name |
|
| 79 | + RouteMatchSpecificationCollection::COLLECTION_NAME, |
|
| 80 | + // collection interface |
|
| 81 | + 'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface', |
|
| 82 | + // FQCNs for classes to add (all classes within each namespace will be loaded) |
|
| 83 | + apply_filters( |
|
| 84 | + 'FHEE__EventEspresso_core_services_route_match_RouteMatchSpecificationManager__populateSpecificationCollection__collection_FQCNs', |
|
| 85 | + array( |
|
| 86 | + 'EventEspresso\core\domain\entities\route_match\specifications\admin', |
|
| 87 | + // 'EventEspresso\core\domain\entities\route_match\specifications\public', |
|
| 88 | + ) |
|
| 89 | + ), |
|
| 90 | + // filepaths to classes to add |
|
| 91 | + array(), |
|
| 92 | + // file mask to use if parsing folder for files to add |
|
| 93 | + '', |
|
| 94 | + // what to use as identifier for collection entities |
|
| 95 | + // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 96 | + CollectionDetails::ID_CLASS_NAME |
|
| 97 | + ), |
|
| 98 | + $this->specifications, |
|
| 99 | + null, |
|
| 100 | + $this->specifications_factory |
|
| 101 | + ); |
|
| 102 | + return $loader->getCollection(); |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Given the FQCN for a RouteMatchSpecification, will return true if the current request matches |
|
| 108 | - * |
|
| 109 | - * @param string $routeMatchSpecificationFqcn fully qualified class name |
|
| 110 | - * @return bool |
|
| 111 | - * @throws InvalidClassException |
|
| 112 | - * @since $VID:$ |
|
| 113 | - */ |
|
| 114 | - public function routeMatchesCurrentRequest($routeMatchSpecificationFqcn) |
|
| 115 | - { |
|
| 116 | - /** @var RouteMatchSpecificationInterface $specification */ |
|
| 117 | - $specification = $this->specifications->get($routeMatchSpecificationFqcn); |
|
| 118 | - if (! $specification instanceof $routeMatchSpecificationFqcn) { |
|
| 119 | - throw new InvalidClassException($routeMatchSpecificationFqcn); |
|
| 120 | - } |
|
| 121 | - return $specification->isMatchingRoute(); |
|
| 122 | - } |
|
| 106 | + /** |
|
| 107 | + * Given the FQCN for a RouteMatchSpecification, will return true if the current request matches |
|
| 108 | + * |
|
| 109 | + * @param string $routeMatchSpecificationFqcn fully qualified class name |
|
| 110 | + * @return bool |
|
| 111 | + * @throws InvalidClassException |
|
| 112 | + * @since $VID:$ |
|
| 113 | + */ |
|
| 114 | + public function routeMatchesCurrentRequest($routeMatchSpecificationFqcn) |
|
| 115 | + { |
|
| 116 | + /** @var RouteMatchSpecificationInterface $specification */ |
|
| 117 | + $specification = $this->specifications->get($routeMatchSpecificationFqcn); |
|
| 118 | + if (! $specification instanceof $routeMatchSpecificationFqcn) { |
|
| 119 | + throw new InvalidClassException($routeMatchSpecificationFqcn); |
|
| 120 | + } |
|
| 121 | + return $specification->isMatchingRoute(); |
|
| 122 | + } |
|
| 123 | 123 | |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Handy method for development that returns |
|
| 127 | - * a list of existing RouteMatchSpecification classes |
|
| 128 | - * matching the current request that can be used to identify it. |
|
| 129 | - * If no matches are returned (or nothing acceptable) |
|
| 130 | - * then create a new one that better matches your requirements. |
|
| 131 | - * |
|
| 132 | - * @return array |
|
| 133 | - * @since $VID:$ |
|
| 134 | - */ |
|
| 135 | - public function findRouteMatchSpecificationsMatchingCurrentRequest() |
|
| 136 | - { |
|
| 137 | - $matches = array(); |
|
| 138 | - foreach ($this->specifications as $specification) { |
|
| 139 | - /** @var RouteMatchSpecificationInterface $specification */ |
|
| 140 | - if ($specification->isMatchingRoute()) { |
|
| 141 | - $matches[] = get_class($specification); |
|
| 142 | - } |
|
| 143 | - } |
|
| 144 | - return $matches; |
|
| 145 | - } |
|
| 125 | + /** |
|
| 126 | + * Handy method for development that returns |
|
| 127 | + * a list of existing RouteMatchSpecification classes |
|
| 128 | + * matching the current request that can be used to identify it. |
|
| 129 | + * If no matches are returned (or nothing acceptable) |
|
| 130 | + * then create a new one that better matches your requirements. |
|
| 131 | + * |
|
| 132 | + * @return array |
|
| 133 | + * @since $VID:$ |
|
| 134 | + */ |
|
| 135 | + public function findRouteMatchSpecificationsMatchingCurrentRequest() |
|
| 136 | + { |
|
| 137 | + $matches = array(); |
|
| 138 | + foreach ($this->specifications as $specification) { |
|
| 139 | + /** @var RouteMatchSpecificationInterface $specification */ |
|
| 140 | + if ($specification->isMatchingRoute()) { |
|
| 141 | + $matches[] = get_class($specification); |
|
| 142 | + } |
|
| 143 | + } |
|
| 144 | + return $matches; |
|
| 145 | + } |
|
| 146 | 146 | } |
@@ -115,7 +115,7 @@ |
||
| 115 | 115 | { |
| 116 | 116 | /** @var RouteMatchSpecificationInterface $specification */ |
| 117 | 117 | $specification = $this->specifications->get($routeMatchSpecificationFqcn); |
| 118 | - if (! $specification instanceof $routeMatchSpecificationFqcn) { |
|
| 118 | + if ( ! $specification instanceof $routeMatchSpecificationFqcn) { |
|
| 119 | 119 | throw new InvalidClassException($routeMatchSpecificationFqcn); |
| 120 | 120 | } |
| 121 | 121 | return $specification->isMatchingRoute(); |
@@ -32,207 +32,207 @@ |
||
| 32 | 32 | class BlockRegistrationManager extends BlockManager |
| 33 | 33 | { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var BlockAssetManagerCollection $block_asset_manager_collection |
|
| 37 | - */ |
|
| 38 | - protected $block_asset_manager_collection; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var RouteMatchSpecificationManager $route_manager |
|
| 42 | - */ |
|
| 43 | - protected $route_manager; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * array for tracking asset managers required by blocks for the current route |
|
| 47 | - * |
|
| 48 | - * @var array $block_asset_managers |
|
| 49 | - */ |
|
| 50 | - protected $block_asset_managers = array(); |
|
| 51 | - |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * BlockRegistrationManager constructor. |
|
| 55 | - * |
|
| 56 | - * @param BlockAssetManagerCollection $block_asset_manager_collection |
|
| 57 | - * @param BlockCollection $blocks |
|
| 58 | - * @param RouteMatchSpecificationManager $route_manager |
|
| 59 | - * @param RequestInterface $request |
|
| 60 | - */ |
|
| 61 | - public function __construct( |
|
| 62 | - BlockAssetManagerCollection $block_asset_manager_collection, |
|
| 63 | - BlockCollection $blocks, |
|
| 64 | - RouteMatchSpecificationManager $route_manager, |
|
| 65 | - RequestInterface $request |
|
| 66 | - ) { |
|
| 67 | - $this->block_asset_manager_collection = $block_asset_manager_collection; |
|
| 68 | - $this->route_manager = $route_manager; |
|
| 69 | - parent::__construct($blocks, $request); |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * Returns the name of a hookpoint to be used to call initialize() |
|
| 75 | - * |
|
| 76 | - * @return string |
|
| 77 | - */ |
|
| 78 | - public function initHook() |
|
| 79 | - { |
|
| 80 | - return 'AHEE__EE_System__initialize'; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Perform any early setup required for block editors to functions |
|
| 86 | - * |
|
| 87 | - * @return void |
|
| 88 | - * @throws Exception |
|
| 89 | - */ |
|
| 90 | - public function initialize() |
|
| 91 | - { |
|
| 92 | - $this->initializeBlocks(); |
|
| 93 | - add_action('AHEE__EE_System__initialize_last', array($this, 'registerBlocks')); |
|
| 94 | - add_action('wp_loaded', array($this, 'unloadAssets')); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * @return CollectionInterface|BlockInterface[] |
|
| 100 | - * @throws CollectionLoaderException |
|
| 101 | - * @throws CollectionDetailsException |
|
| 102 | - */ |
|
| 103 | - protected function populateBlockCollection() |
|
| 104 | - { |
|
| 105 | - $loader = new CollectionLoader( |
|
| 106 | - new CollectionDetails( |
|
| 107 | - // collection name |
|
| 108 | - 'editor_blocks', |
|
| 109 | - // collection interface |
|
| 110 | - 'EventEspresso\core\domain\entities\editor\BlockInterface', |
|
| 111 | - // FQCNs for classes to add (all classes within each namespace will be loaded) |
|
| 112 | - apply_filters( |
|
| 113 | - 'FHEE__EventEspresso_core_services_editor_BlockManager__populateBlockCollection__collection_FQCNs', |
|
| 114 | - array( |
|
| 115 | - // 'EventEspresso\core\domain\entities\editor\blocks\common', |
|
| 116 | - // 'EventEspresso\core\domain\entities\editor\blocks\editor', |
|
| 117 | - // 'EventEspresso\core\domain\entities\editor\blocks\widgets', |
|
| 118 | - ) |
|
| 119 | - ), |
|
| 120 | - // filepaths to classes to add |
|
| 121 | - array(), |
|
| 122 | - // file mask to use if parsing folder for files to add |
|
| 123 | - '', |
|
| 124 | - // what to use as identifier for collection entities |
|
| 125 | - // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 126 | - CollectionDetails::ID_CLASS_NAME |
|
| 127 | - ), |
|
| 128 | - $this->blocks |
|
| 129 | - ); |
|
| 130 | - return $loader->getCollection(); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * populates the BlockCollection and calls initialize() on all installed blocks |
|
| 136 | - * |
|
| 137 | - * @return void |
|
| 138 | - * @throws Exception |
|
| 139 | - */ |
|
| 140 | - public function initializeBlocks() |
|
| 141 | - { |
|
| 142 | - try { |
|
| 143 | - $this->populateBlockCollection(); |
|
| 144 | - // cycle thru block loaders and initialize each loader |
|
| 145 | - foreach ($this->blocks as $block) { |
|
| 146 | - $block->initialize(); |
|
| 147 | - $this->trackAssetManagersForBlocks($block); |
|
| 148 | - if (! $this->block_asset_manager_collection->has($block->assetManager())) { |
|
| 149 | - $this->block_asset_manager_collection->add($block->assetManager()); |
|
| 150 | - $block->assetManager()->setAssetHandles(); |
|
| 151 | - } |
|
| 152 | - } |
|
| 153 | - } catch (Exception $exception) { |
|
| 154 | - new ExceptionStackTraceDisplay($exception); |
|
| 155 | - } |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * track blocks with routes that match the current request |
|
| 161 | - * |
|
| 162 | - * @param BlockInterface $block |
|
| 163 | - * @throws InvalidClassException |
|
| 164 | - */ |
|
| 165 | - private function trackAssetManagersForBlocks(BlockInterface $block) |
|
| 166 | - { |
|
| 167 | - $supported_routes = $block->supportedRoutes(); |
|
| 168 | - foreach ($supported_routes as $supported_route) { |
|
| 169 | - if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) { |
|
| 170 | - $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace(); |
|
| 171 | - } |
|
| 172 | - } |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * returns true if the block should be registered for the current request |
|
| 178 | - * else removes block from block_routes array and returns false |
|
| 179 | - * |
|
| 180 | - * @param BlockInterface $block |
|
| 181 | - * @return boolean |
|
| 182 | - * @throws InvalidClassException |
|
| 183 | - */ |
|
| 184 | - public function matchesRoute(BlockInterface $block) |
|
| 185 | - { |
|
| 186 | - if (isset($this->block_asset_managers[ $block->blockType() ])) { |
|
| 187 | - return true; |
|
| 188 | - } |
|
| 189 | - unset($this->block_asset_managers[ $block->blockType() ]); |
|
| 190 | - return false; |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * calls registerBlock() and load assets for all installed blocks |
|
| 196 | - * |
|
| 197 | - * @return void |
|
| 198 | - * @throws Exception |
|
| 199 | - */ |
|
| 200 | - public function registerBlocks() |
|
| 201 | - { |
|
| 202 | - try { |
|
| 203 | - // cycle thru block loader folders |
|
| 204 | - foreach ($this->blocks as $block) { |
|
| 205 | - if (! $this->matchesRoute($block)) { |
|
| 206 | - continue; |
|
| 207 | - } |
|
| 208 | - // perform any setup required for the block |
|
| 209 | - $block_type = $block->registerBlock(); |
|
| 210 | - if (! $block_type instanceof WP_Block_Type) { |
|
| 211 | - throw new InvalidEntityException($block_type, 'WP_Block_Type'); |
|
| 212 | - } |
|
| 213 | - do_action( |
|
| 214 | - 'FHEE__EventEspresso_core_services_editor_BlockManager__registerBlocks__block_type_registered', |
|
| 215 | - $block, |
|
| 216 | - $block_type |
|
| 217 | - ); |
|
| 218 | - } |
|
| 219 | - } catch (Exception $exception) { |
|
| 220 | - new ExceptionStackTraceDisplay($exception); |
|
| 221 | - } |
|
| 222 | - } |
|
| 223 | - |
|
| 224 | - public function unloadAssets() |
|
| 225 | - { |
|
| 226 | - $assets = array_flip($this->block_asset_managers); |
|
| 227 | - foreach ($this->block_asset_manager_collection as $asset_manager) { |
|
| 228 | - // if there are no longer any blocks that require these assets, |
|
| 229 | - if (! isset($assets[ $asset_manager->assetNamespace() ])) { |
|
| 230 | - // then unset asset enqueueing and bail |
|
| 231 | - remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0); |
|
| 232 | - remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0); |
|
| 233 | - remove_action('wp_enqueue_scripts', array($asset_manager, 'addAssets'), 2); |
|
| 234 | - remove_action('admin_enqueue_scripts', array($asset_manager, 'addAssets'), 2); |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - } |
|
| 35 | + /** |
|
| 36 | + * @var BlockAssetManagerCollection $block_asset_manager_collection |
|
| 37 | + */ |
|
| 38 | + protected $block_asset_manager_collection; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var RouteMatchSpecificationManager $route_manager |
|
| 42 | + */ |
|
| 43 | + protected $route_manager; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * array for tracking asset managers required by blocks for the current route |
|
| 47 | + * |
|
| 48 | + * @var array $block_asset_managers |
|
| 49 | + */ |
|
| 50 | + protected $block_asset_managers = array(); |
|
| 51 | + |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * BlockRegistrationManager constructor. |
|
| 55 | + * |
|
| 56 | + * @param BlockAssetManagerCollection $block_asset_manager_collection |
|
| 57 | + * @param BlockCollection $blocks |
|
| 58 | + * @param RouteMatchSpecificationManager $route_manager |
|
| 59 | + * @param RequestInterface $request |
|
| 60 | + */ |
|
| 61 | + public function __construct( |
|
| 62 | + BlockAssetManagerCollection $block_asset_manager_collection, |
|
| 63 | + BlockCollection $blocks, |
|
| 64 | + RouteMatchSpecificationManager $route_manager, |
|
| 65 | + RequestInterface $request |
|
| 66 | + ) { |
|
| 67 | + $this->block_asset_manager_collection = $block_asset_manager_collection; |
|
| 68 | + $this->route_manager = $route_manager; |
|
| 69 | + parent::__construct($blocks, $request); |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * Returns the name of a hookpoint to be used to call initialize() |
|
| 75 | + * |
|
| 76 | + * @return string |
|
| 77 | + */ |
|
| 78 | + public function initHook() |
|
| 79 | + { |
|
| 80 | + return 'AHEE__EE_System__initialize'; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Perform any early setup required for block editors to functions |
|
| 86 | + * |
|
| 87 | + * @return void |
|
| 88 | + * @throws Exception |
|
| 89 | + */ |
|
| 90 | + public function initialize() |
|
| 91 | + { |
|
| 92 | + $this->initializeBlocks(); |
|
| 93 | + add_action('AHEE__EE_System__initialize_last', array($this, 'registerBlocks')); |
|
| 94 | + add_action('wp_loaded', array($this, 'unloadAssets')); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * @return CollectionInterface|BlockInterface[] |
|
| 100 | + * @throws CollectionLoaderException |
|
| 101 | + * @throws CollectionDetailsException |
|
| 102 | + */ |
|
| 103 | + protected function populateBlockCollection() |
|
| 104 | + { |
|
| 105 | + $loader = new CollectionLoader( |
|
| 106 | + new CollectionDetails( |
|
| 107 | + // collection name |
|
| 108 | + 'editor_blocks', |
|
| 109 | + // collection interface |
|
| 110 | + 'EventEspresso\core\domain\entities\editor\BlockInterface', |
|
| 111 | + // FQCNs for classes to add (all classes within each namespace will be loaded) |
|
| 112 | + apply_filters( |
|
| 113 | + 'FHEE__EventEspresso_core_services_editor_BlockManager__populateBlockCollection__collection_FQCNs', |
|
| 114 | + array( |
|
| 115 | + // 'EventEspresso\core\domain\entities\editor\blocks\common', |
|
| 116 | + // 'EventEspresso\core\domain\entities\editor\blocks\editor', |
|
| 117 | + // 'EventEspresso\core\domain\entities\editor\blocks\widgets', |
|
| 118 | + ) |
|
| 119 | + ), |
|
| 120 | + // filepaths to classes to add |
|
| 121 | + array(), |
|
| 122 | + // file mask to use if parsing folder for files to add |
|
| 123 | + '', |
|
| 124 | + // what to use as identifier for collection entities |
|
| 125 | + // using CLASS NAME prevents duplicates (works like a singleton) |
|
| 126 | + CollectionDetails::ID_CLASS_NAME |
|
| 127 | + ), |
|
| 128 | + $this->blocks |
|
| 129 | + ); |
|
| 130 | + return $loader->getCollection(); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * populates the BlockCollection and calls initialize() on all installed blocks |
|
| 136 | + * |
|
| 137 | + * @return void |
|
| 138 | + * @throws Exception |
|
| 139 | + */ |
|
| 140 | + public function initializeBlocks() |
|
| 141 | + { |
|
| 142 | + try { |
|
| 143 | + $this->populateBlockCollection(); |
|
| 144 | + // cycle thru block loaders and initialize each loader |
|
| 145 | + foreach ($this->blocks as $block) { |
|
| 146 | + $block->initialize(); |
|
| 147 | + $this->trackAssetManagersForBlocks($block); |
|
| 148 | + if (! $this->block_asset_manager_collection->has($block->assetManager())) { |
|
| 149 | + $this->block_asset_manager_collection->add($block->assetManager()); |
|
| 150 | + $block->assetManager()->setAssetHandles(); |
|
| 151 | + } |
|
| 152 | + } |
|
| 153 | + } catch (Exception $exception) { |
|
| 154 | + new ExceptionStackTraceDisplay($exception); |
|
| 155 | + } |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * track blocks with routes that match the current request |
|
| 161 | + * |
|
| 162 | + * @param BlockInterface $block |
|
| 163 | + * @throws InvalidClassException |
|
| 164 | + */ |
|
| 165 | + private function trackAssetManagersForBlocks(BlockInterface $block) |
|
| 166 | + { |
|
| 167 | + $supported_routes = $block->supportedRoutes(); |
|
| 168 | + foreach ($supported_routes as $supported_route) { |
|
| 169 | + if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) { |
|
| 170 | + $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace(); |
|
| 171 | + } |
|
| 172 | + } |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * returns true if the block should be registered for the current request |
|
| 178 | + * else removes block from block_routes array and returns false |
|
| 179 | + * |
|
| 180 | + * @param BlockInterface $block |
|
| 181 | + * @return boolean |
|
| 182 | + * @throws InvalidClassException |
|
| 183 | + */ |
|
| 184 | + public function matchesRoute(BlockInterface $block) |
|
| 185 | + { |
|
| 186 | + if (isset($this->block_asset_managers[ $block->blockType() ])) { |
|
| 187 | + return true; |
|
| 188 | + } |
|
| 189 | + unset($this->block_asset_managers[ $block->blockType() ]); |
|
| 190 | + return false; |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * calls registerBlock() and load assets for all installed blocks |
|
| 196 | + * |
|
| 197 | + * @return void |
|
| 198 | + * @throws Exception |
|
| 199 | + */ |
|
| 200 | + public function registerBlocks() |
|
| 201 | + { |
|
| 202 | + try { |
|
| 203 | + // cycle thru block loader folders |
|
| 204 | + foreach ($this->blocks as $block) { |
|
| 205 | + if (! $this->matchesRoute($block)) { |
|
| 206 | + continue; |
|
| 207 | + } |
|
| 208 | + // perform any setup required for the block |
|
| 209 | + $block_type = $block->registerBlock(); |
|
| 210 | + if (! $block_type instanceof WP_Block_Type) { |
|
| 211 | + throw new InvalidEntityException($block_type, 'WP_Block_Type'); |
|
| 212 | + } |
|
| 213 | + do_action( |
|
| 214 | + 'FHEE__EventEspresso_core_services_editor_BlockManager__registerBlocks__block_type_registered', |
|
| 215 | + $block, |
|
| 216 | + $block_type |
|
| 217 | + ); |
|
| 218 | + } |
|
| 219 | + } catch (Exception $exception) { |
|
| 220 | + new ExceptionStackTraceDisplay($exception); |
|
| 221 | + } |
|
| 222 | + } |
|
| 223 | + |
|
| 224 | + public function unloadAssets() |
|
| 225 | + { |
|
| 226 | + $assets = array_flip($this->block_asset_managers); |
|
| 227 | + foreach ($this->block_asset_manager_collection as $asset_manager) { |
|
| 228 | + // if there are no longer any blocks that require these assets, |
|
| 229 | + if (! isset($assets[ $asset_manager->assetNamespace() ])) { |
|
| 230 | + // then unset asset enqueueing and bail |
|
| 231 | + remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0); |
|
| 232 | + remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0); |
|
| 233 | + remove_action('wp_enqueue_scripts', array($asset_manager, 'addAssets'), 2); |
|
| 234 | + remove_action('admin_enqueue_scripts', array($asset_manager, 'addAssets'), 2); |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + } |
|
| 238 | 238 | } |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | foreach ($this->blocks as $block) { |
| 146 | 146 | $block->initialize(); |
| 147 | 147 | $this->trackAssetManagersForBlocks($block); |
| 148 | - if (! $this->block_asset_manager_collection->has($block->assetManager())) { |
|
| 148 | + if ( ! $this->block_asset_manager_collection->has($block->assetManager())) { |
|
| 149 | 149 | $this->block_asset_manager_collection->add($block->assetManager()); |
| 150 | 150 | $block->assetManager()->setAssetHandles(); |
| 151 | 151 | } |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | $supported_routes = $block->supportedRoutes(); |
| 168 | 168 | foreach ($supported_routes as $supported_route) { |
| 169 | 169 | if ($this->route_manager->routeMatchesCurrentRequest($supported_route)) { |
| 170 | - $this->block_asset_managers[ $block->blockType() ] = $block->assetManager()->assetNamespace(); |
|
| 170 | + $this->block_asset_managers[$block->blockType()] = $block->assetManager()->assetNamespace(); |
|
| 171 | 171 | } |
| 172 | 172 | } |
| 173 | 173 | } |
@@ -183,10 +183,10 @@ discard block |
||
| 183 | 183 | */ |
| 184 | 184 | public function matchesRoute(BlockInterface $block) |
| 185 | 185 | { |
| 186 | - if (isset($this->block_asset_managers[ $block->blockType() ])) { |
|
| 186 | + if (isset($this->block_asset_managers[$block->blockType()])) { |
|
| 187 | 187 | return true; |
| 188 | 188 | } |
| 189 | - unset($this->block_asset_managers[ $block->blockType() ]); |
|
| 189 | + unset($this->block_asset_managers[$block->blockType()]); |
|
| 190 | 190 | return false; |
| 191 | 191 | } |
| 192 | 192 | |
@@ -202,12 +202,12 @@ discard block |
||
| 202 | 202 | try { |
| 203 | 203 | // cycle thru block loader folders |
| 204 | 204 | foreach ($this->blocks as $block) { |
| 205 | - if (! $this->matchesRoute($block)) { |
|
| 205 | + if ( ! $this->matchesRoute($block)) { |
|
| 206 | 206 | continue; |
| 207 | 207 | } |
| 208 | 208 | // perform any setup required for the block |
| 209 | 209 | $block_type = $block->registerBlock(); |
| 210 | - if (! $block_type instanceof WP_Block_Type) { |
|
| 210 | + if ( ! $block_type instanceof WP_Block_Type) { |
|
| 211 | 211 | throw new InvalidEntityException($block_type, 'WP_Block_Type'); |
| 212 | 212 | } |
| 213 | 213 | do_action( |
@@ -226,7 +226,7 @@ discard block |
||
| 226 | 226 | $assets = array_flip($this->block_asset_managers); |
| 227 | 227 | foreach ($this->block_asset_manager_collection as $asset_manager) { |
| 228 | 228 | // if there are no longer any blocks that require these assets, |
| 229 | - if (! isset($assets[ $asset_manager->assetNamespace() ])) { |
|
| 229 | + if ( ! isset($assets[$asset_manager->assetNamespace()])) { |
|
| 230 | 230 | // then unset asset enqueueing and bail |
| 231 | 231 | remove_action('wp_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0); |
| 232 | 232 | remove_action('admin_enqueue_scripts', array($asset_manager, 'addManifestFile'), 0); |
@@ -14,16 +14,16 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class WordPressPostsEditorEdit extends RouteMatchSpecification |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * returns true if current request matches specification |
|
| 19 | - * |
|
| 20 | - * @since $VID:$ |
|
| 21 | - * @return boolean |
|
| 22 | - */ |
|
| 23 | - public function isMatchingRoute() |
|
| 24 | - { |
|
| 25 | - return strpos($this->request->requestUri(), 'wp-admin/post.php') !== false |
|
| 26 | - && $this->request->getRequestParam('post_type', 'post') === 'post' |
|
| 27 | - && $this->request->getRequestParam('action') === 'edit'; |
|
| 28 | - } |
|
| 17 | + /** |
|
| 18 | + * returns true if current request matches specification |
|
| 19 | + * |
|
| 20 | + * @since $VID:$ |
|
| 21 | + * @return boolean |
|
| 22 | + */ |
|
| 23 | + public function isMatchingRoute() |
|
| 24 | + { |
|
| 25 | + return strpos($this->request->requestUri(), 'wp-admin/post.php') !== false |
|
| 26 | + && $this->request->getRequestParam('post_type', 'post') === 'post' |
|
| 27 | + && $this->request->getRequestParam('action') === 'edit'; |
|
| 28 | + } |
|
| 29 | 29 | } |
@@ -14,15 +14,15 @@ |
||
| 14 | 14 | */ |
| 15 | 15 | class WordPressPostsEditorAddNew extends RouteMatchSpecification |
| 16 | 16 | { |
| 17 | - /** |
|
| 18 | - * returns true if current request matches specification |
|
| 19 | - * |
|
| 20 | - * @since $VID:$ |
|
| 21 | - * @return boolean |
|
| 22 | - */ |
|
| 23 | - public function isMatchingRoute() |
|
| 24 | - { |
|
| 25 | - return strpos($this->request->requestUri(), 'wp-admin/post-new.php') !== false |
|
| 26 | - && $this->request->getRequestParam('post_type', 'post') === 'post'; |
|
| 27 | - } |
|
| 17 | + /** |
|
| 18 | + * returns true if current request matches specification |
|
| 19 | + * |
|
| 20 | + * @since $VID:$ |
|
| 21 | + * @return boolean |
|
| 22 | + */ |
|
| 23 | + public function isMatchingRoute() |
|
| 24 | + { |
|
| 25 | + return strpos($this->request->requestUri(), 'wp-admin/post-new.php') !== false |
|
| 26 | + && $this->request->getRequestParam('post_type', 'post') === 'post'; |
|
| 27 | + } |
|
| 28 | 28 | } |
@@ -18,21 +18,21 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class WordPressPostsEditor extends MatchAnyRouteSpecification |
| 20 | 20 | { |
| 21 | - /** |
|
| 22 | - * WordPressPostsEditor constructor. |
|
| 23 | - * |
|
| 24 | - * @param WordPressPostsEditorEdit $edit_event_route_match |
|
| 25 | - * @param WordPressPostsEditorAddNew $create_event_route_match |
|
| 26 | - * @param RequestInterface $request |
|
| 27 | - */ |
|
| 28 | - public function __construct( |
|
| 29 | - WordPressPostsEditorEdit $edit_event_route_match, |
|
| 30 | - WordPressPostsEditorAddNew $create_event_route_match, |
|
| 31 | - RequestInterface $request |
|
| 32 | - ) { |
|
| 33 | - parent::__construct( |
|
| 34 | - array($edit_event_route_match, $create_event_route_match), |
|
| 35 | - $request |
|
| 36 | - ); |
|
| 37 | - } |
|
| 21 | + /** |
|
| 22 | + * WordPressPostsEditor constructor. |
|
| 23 | + * |
|
| 24 | + * @param WordPressPostsEditorEdit $edit_event_route_match |
|
| 25 | + * @param WordPressPostsEditorAddNew $create_event_route_match |
|
| 26 | + * @param RequestInterface $request |
|
| 27 | + */ |
|
| 28 | + public function __construct( |
|
| 29 | + WordPressPostsEditorEdit $edit_event_route_match, |
|
| 30 | + WordPressPostsEditorAddNew $create_event_route_match, |
|
| 31 | + RequestInterface $request |
|
| 32 | + ) { |
|
| 33 | + parent::__construct( |
|
| 34 | + array($edit_event_route_match, $create_event_route_match), |
|
| 35 | + $request |
|
| 36 | + ); |
|
| 37 | + } |
|
| 38 | 38 | } |