@@ -27,1313 +27,1313 @@ |
||
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->isWordPressApi() || $this->request->isApi()) |
|
390 | - && $this->request->getRequestParam('activate') !== 'true' |
|
391 | - && ! function_exists('json_basic_auth_handler') |
|
392 | - && ! function_exists('json_basic_auth_error') |
|
393 | - && ! in_array( |
|
394 | - $this->request->getRequestParam('action'), |
|
395 | - array('activate', 'activate-selected'), |
|
396 | - true |
|
397 | - ) |
|
398 | - ) { |
|
399 | - include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php'; |
|
400 | - } |
|
401 | - do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
402 | - } |
|
403 | - |
|
404 | - |
|
405 | - /** |
|
406 | - * detect_activations_or_upgrades |
|
407 | - * Checks for activation or upgrade of core first; |
|
408 | - * then also checks if any registered addons have been activated or upgraded |
|
409 | - * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
410 | - * which runs during the WP 'plugins_loaded' action at priority 3 |
|
411 | - * |
|
412 | - * @access public |
|
413 | - * @return void |
|
414 | - */ |
|
415 | - public function detect_activations_or_upgrades() |
|
416 | - { |
|
417 | - // first off: let's make sure to handle core |
|
418 | - $this->detect_if_activation_or_upgrade(); |
|
419 | - foreach ($this->registry->addons as $addon) { |
|
420 | - if ($addon instanceof EE_Addon) { |
|
421 | - // detect teh request type for that addon |
|
422 | - $addon->detect_activation_or_upgrade(); |
|
423 | - } |
|
424 | - } |
|
425 | - } |
|
426 | - |
|
427 | - |
|
428 | - /** |
|
429 | - * detect_if_activation_or_upgrade |
|
430 | - * Takes care of detecting whether this is a brand new install or code upgrade, |
|
431 | - * and either setting up the DB or setting up maintenance mode etc. |
|
432 | - * |
|
433 | - * @access public |
|
434 | - * @return void |
|
435 | - */ |
|
436 | - public function detect_if_activation_or_upgrade() |
|
437 | - { |
|
438 | - do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
439 | - // check if db has been updated, or if its a brand-new installation |
|
440 | - $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
441 | - $request_type = $this->detect_req_type($espresso_db_update); |
|
442 | - // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
443 | - switch ($request_type) { |
|
444 | - case EE_System::req_type_new_activation: |
|
445 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
446 | - $this->_handle_core_version_change($espresso_db_update); |
|
447 | - break; |
|
448 | - case EE_System::req_type_reactivation: |
|
449 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
450 | - $this->_handle_core_version_change($espresso_db_update); |
|
451 | - break; |
|
452 | - case EE_System::req_type_upgrade: |
|
453 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
454 | - // migrations may be required now that we've upgraded |
|
455 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
456 | - $this->_handle_core_version_change($espresso_db_update); |
|
457 | - break; |
|
458 | - case EE_System::req_type_downgrade: |
|
459 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
460 | - // its possible migrations are no longer required |
|
461 | - $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
462 | - $this->_handle_core_version_change($espresso_db_update); |
|
463 | - break; |
|
464 | - case EE_System::req_type_normal: |
|
465 | - default: |
|
466 | - break; |
|
467 | - } |
|
468 | - do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
469 | - } |
|
470 | - |
|
471 | - |
|
472 | - /** |
|
473 | - * Updates the list of installed versions and sets hooks for |
|
474 | - * initializing the database later during the request |
|
475 | - * |
|
476 | - * @param array $espresso_db_update |
|
477 | - */ |
|
478 | - private function _handle_core_version_change($espresso_db_update) |
|
479 | - { |
|
480 | - $this->update_list_of_installed_versions($espresso_db_update); |
|
481 | - // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
482 | - add_action( |
|
483 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
484 | - array($this, 'initialize_db_if_no_migrations_required') |
|
485 | - ); |
|
486 | - } |
|
487 | - |
|
488 | - |
|
489 | - /** |
|
490 | - * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
491 | - * information about what versions of EE have been installed and activated, |
|
492 | - * NOT necessarily the state of the database |
|
493 | - * |
|
494 | - * @param mixed $espresso_db_update the value of the WordPress option. |
|
495 | - * If not supplied, fetches it from the options table |
|
496 | - * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
497 | - */ |
|
498 | - private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
499 | - { |
|
500 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
501 | - if (! $espresso_db_update) { |
|
502 | - $espresso_db_update = get_option('espresso_db_update'); |
|
503 | - } |
|
504 | - // check that option is an array |
|
505 | - if (! is_array($espresso_db_update)) { |
|
506 | - // if option is FALSE, then it never existed |
|
507 | - if ($espresso_db_update === false) { |
|
508 | - // make $espresso_db_update an array and save option with autoload OFF |
|
509 | - $espresso_db_update = array(); |
|
510 | - add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
511 | - } else { |
|
512 | - // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
513 | - $espresso_db_update = array($espresso_db_update => array()); |
|
514 | - update_option('espresso_db_update', $espresso_db_update); |
|
515 | - } |
|
516 | - } else { |
|
517 | - $corrected_db_update = array(); |
|
518 | - // if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
519 | - foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
520 | - if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
521 | - // the key is an int, and the value IS NOT an array |
|
522 | - // so it must be numerically-indexed, where values are versions installed... |
|
523 | - // fix it! |
|
524 | - $version_string = $should_be_array; |
|
525 | - $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
526 | - } else { |
|
527 | - // ok it checks out |
|
528 | - $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
529 | - } |
|
530 | - } |
|
531 | - $espresso_db_update = $corrected_db_update; |
|
532 | - update_option('espresso_db_update', $espresso_db_update); |
|
533 | - } |
|
534 | - do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
535 | - return $espresso_db_update; |
|
536 | - } |
|
537 | - |
|
538 | - |
|
539 | - /** |
|
540 | - * Does the traditional work of setting up the plugin's database and adding default data. |
|
541 | - * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
542 | - * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
543 | - * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
544 | - * so that it will be done when migrations are finished |
|
545 | - * |
|
546 | - * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
547 | - * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
548 | - * This is a resource-intensive job |
|
549 | - * so we prefer to only do it when necessary |
|
550 | - * @return void |
|
551 | - * @throws EE_Error |
|
552 | - */ |
|
553 | - public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
554 | - { |
|
555 | - $request_type = $this->detect_req_type(); |
|
556 | - // only initialize system if we're not in maintenance mode. |
|
557 | - if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
558 | - /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
559 | - $rewrite_rules = $this->loader->getShared( |
|
560 | - 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
561 | - ); |
|
562 | - $rewrite_rules->flush(); |
|
563 | - if ($verify_schema) { |
|
564 | - EEH_Activation::initialize_db_and_folders(); |
|
565 | - } |
|
566 | - EEH_Activation::initialize_db_content(); |
|
567 | - EEH_Activation::system_initialization(); |
|
568 | - if ($initialize_addons_too) { |
|
569 | - $this->initialize_addons(); |
|
570 | - } |
|
571 | - } else { |
|
572 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
573 | - } |
|
574 | - if ($request_type === EE_System::req_type_new_activation |
|
575 | - || $request_type === EE_System::req_type_reactivation |
|
576 | - || ( |
|
577 | - $request_type === EE_System::req_type_upgrade |
|
578 | - && $this->is_major_version_change() |
|
579 | - ) |
|
580 | - ) { |
|
581 | - add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
582 | - } |
|
583 | - } |
|
584 | - |
|
585 | - |
|
586 | - /** |
|
587 | - * Initializes the db for all registered addons |
|
588 | - * |
|
589 | - * @throws EE_Error |
|
590 | - */ |
|
591 | - public function initialize_addons() |
|
592 | - { |
|
593 | - // foreach registered addon, make sure its db is up-to-date too |
|
594 | - foreach ($this->registry->addons as $addon) { |
|
595 | - if ($addon instanceof EE_Addon) { |
|
596 | - $addon->initialize_db_if_no_migrations_required(); |
|
597 | - } |
|
598 | - } |
|
599 | - } |
|
600 | - |
|
601 | - |
|
602 | - /** |
|
603 | - * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
604 | - * |
|
605 | - * @param array $version_history |
|
606 | - * @param string $current_version_to_add version to be added to the version history |
|
607 | - * @return boolean success as to whether or not this option was changed |
|
608 | - */ |
|
609 | - public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
610 | - { |
|
611 | - if (! $version_history) { |
|
612 | - $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
613 | - } |
|
614 | - if ($current_version_to_add === null) { |
|
615 | - $current_version_to_add = espresso_version(); |
|
616 | - } |
|
617 | - $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
618 | - // re-save |
|
619 | - return update_option('espresso_db_update', $version_history); |
|
620 | - } |
|
621 | - |
|
622 | - |
|
623 | - /** |
|
624 | - * Detects if the current version indicated in the has existed in the list of |
|
625 | - * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
626 | - * |
|
627 | - * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
628 | - * If not supplied, fetches it from the options table. |
|
629 | - * Also, caches its result so later parts of the code can also know whether |
|
630 | - * there's been an update or not. This way we can add the current version to |
|
631 | - * espresso_db_update, but still know if this is a new install or not |
|
632 | - * @return int one of the constants on EE_System::req_type_ |
|
633 | - */ |
|
634 | - public function detect_req_type($espresso_db_update = null) |
|
635 | - { |
|
636 | - if ($this->_req_type === null) { |
|
637 | - $espresso_db_update = ! empty($espresso_db_update) |
|
638 | - ? $espresso_db_update |
|
639 | - : $this->fix_espresso_db_upgrade_option(); |
|
640 | - $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
641 | - $espresso_db_update, |
|
642 | - 'ee_espresso_activation', |
|
643 | - espresso_version() |
|
644 | - ); |
|
645 | - $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
646 | - $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
647 | - } |
|
648 | - return $this->_req_type; |
|
649 | - } |
|
650 | - |
|
651 | - |
|
652 | - /** |
|
653 | - * Returns whether or not there was a non-micro version change (ie, change in either |
|
654 | - * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
655 | - * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
656 | - * |
|
657 | - * @param $activation_history |
|
658 | - * @return bool |
|
659 | - */ |
|
660 | - private function _detect_major_version_change($activation_history) |
|
661 | - { |
|
662 | - $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
663 | - $previous_version_parts = explode('.', $previous_version); |
|
664 | - $current_version_parts = explode('.', espresso_version()); |
|
665 | - return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
666 | - && ($previous_version_parts[0] !== $current_version_parts[0] |
|
667 | - || $previous_version_parts[1] !== $current_version_parts[1] |
|
668 | - ); |
|
669 | - } |
|
670 | - |
|
671 | - |
|
672 | - /** |
|
673 | - * Returns true if either the major or minor version of EE changed during this request. |
|
674 | - * 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 |
|
675 | - * |
|
676 | - * @return bool |
|
677 | - */ |
|
678 | - public function is_major_version_change() |
|
679 | - { |
|
680 | - return $this->_major_version_change; |
|
681 | - } |
|
682 | - |
|
683 | - |
|
684 | - /** |
|
685 | - * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
686 | - * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
687 | - * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
688 | - * just activated to (for core that will always be espresso_version()) |
|
689 | - * |
|
690 | - * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
691 | - * ee plugin. for core that's 'espresso_db_update' |
|
692 | - * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
693 | - * indicate that this plugin was just activated |
|
694 | - * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
695 | - * espresso_version()) |
|
696 | - * @return int one of the constants on EE_System::req_type_* |
|
697 | - */ |
|
698 | - public static function detect_req_type_given_activation_history( |
|
699 | - $activation_history_for_addon, |
|
700 | - $activation_indicator_option_name, |
|
701 | - $version_to_upgrade_to |
|
702 | - ) { |
|
703 | - $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
704 | - if ($activation_history_for_addon) { |
|
705 | - // it exists, so this isn't a completely new install |
|
706 | - // check if this version already in that list of previously installed versions |
|
707 | - if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
708 | - // it a version we haven't seen before |
|
709 | - if ($version_is_higher === 1) { |
|
710 | - $req_type = EE_System::req_type_upgrade; |
|
711 | - } else { |
|
712 | - $req_type = EE_System::req_type_downgrade; |
|
713 | - } |
|
714 | - delete_option($activation_indicator_option_name); |
|
715 | - } else { |
|
716 | - // its not an update. maybe a reactivation? |
|
717 | - if (get_option($activation_indicator_option_name, false)) { |
|
718 | - if ($version_is_higher === -1) { |
|
719 | - $req_type = EE_System::req_type_downgrade; |
|
720 | - } elseif ($version_is_higher === 0) { |
|
721 | - // we've seen this version before, but it's an activation. must be a reactivation |
|
722 | - $req_type = EE_System::req_type_reactivation; |
|
723 | - } else {// $version_is_higher === 1 |
|
724 | - $req_type = EE_System::req_type_upgrade; |
|
725 | - } |
|
726 | - delete_option($activation_indicator_option_name); |
|
727 | - } else { |
|
728 | - // we've seen this version before and the activation indicate doesn't show it was just activated |
|
729 | - if ($version_is_higher === -1) { |
|
730 | - $req_type = EE_System::req_type_downgrade; |
|
731 | - } elseif ($version_is_higher === 0) { |
|
732 | - // we've seen this version before and it's not an activation. its normal request |
|
733 | - $req_type = EE_System::req_type_normal; |
|
734 | - } else {// $version_is_higher === 1 |
|
735 | - $req_type = EE_System::req_type_upgrade; |
|
736 | - } |
|
737 | - } |
|
738 | - } |
|
739 | - } else { |
|
740 | - // brand new install |
|
741 | - $req_type = EE_System::req_type_new_activation; |
|
742 | - delete_option($activation_indicator_option_name); |
|
743 | - } |
|
744 | - return $req_type; |
|
745 | - } |
|
746 | - |
|
747 | - |
|
748 | - /** |
|
749 | - * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
750 | - * the $activation_history_for_addon |
|
751 | - * |
|
752 | - * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
753 | - * sometimes containing 'unknown-date' |
|
754 | - * @param string $version_to_upgrade_to (current version) |
|
755 | - * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
756 | - * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
757 | - * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
758 | - * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
759 | - */ |
|
760 | - private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
761 | - { |
|
762 | - // find the most recently-activated version |
|
763 | - $most_recently_active_version = |
|
764 | - EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
765 | - return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
766 | - } |
|
767 | - |
|
768 | - |
|
769 | - /** |
|
770 | - * Gets the most recently active version listed in the activation history, |
|
771 | - * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
772 | - * |
|
773 | - * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
774 | - * sometimes containing 'unknown-date' |
|
775 | - * @return string |
|
776 | - */ |
|
777 | - private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
778 | - { |
|
779 | - $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
780 | - $most_recently_active_version = '0.0.0.dev.000'; |
|
781 | - if (is_array($activation_history)) { |
|
782 | - foreach ($activation_history as $version => $times_activated) { |
|
783 | - // check there is a record of when this version was activated. Otherwise, |
|
784 | - // mark it as unknown |
|
785 | - if (! $times_activated) { |
|
786 | - $times_activated = array('unknown-date'); |
|
787 | - } |
|
788 | - if (is_string($times_activated)) { |
|
789 | - $times_activated = array($times_activated); |
|
790 | - } |
|
791 | - foreach ($times_activated as $an_activation) { |
|
792 | - if ($an_activation !== 'unknown-date' |
|
793 | - && $an_activation |
|
794 | - > $most_recently_active_version_activation) { |
|
795 | - $most_recently_active_version = $version; |
|
796 | - $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
797 | - ? '1970-01-01 00:00:00' |
|
798 | - : $an_activation; |
|
799 | - } |
|
800 | - } |
|
801 | - } |
|
802 | - } |
|
803 | - return $most_recently_active_version; |
|
804 | - } |
|
805 | - |
|
806 | - |
|
807 | - /** |
|
808 | - * This redirects to the about EE page after activation |
|
809 | - * |
|
810 | - * @return void |
|
811 | - */ |
|
812 | - public function redirect_to_about_ee() |
|
813 | - { |
|
814 | - $notices = EE_Error::get_notices(false); |
|
815 | - // if current user is an admin and it's not an ajax or rest request |
|
816 | - if (! isset($notices['errors']) |
|
817 | - && $this->request->isAdmin() |
|
818 | - && apply_filters( |
|
819 | - 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
820 | - $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
821 | - ) |
|
822 | - ) { |
|
823 | - $query_params = array('page' => 'espresso_about'); |
|
824 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
825 | - $query_params['new_activation'] = true; |
|
826 | - } |
|
827 | - if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
828 | - $query_params['reactivation'] = true; |
|
829 | - } |
|
830 | - $url = add_query_arg($query_params, admin_url('admin.php')); |
|
831 | - wp_safe_redirect($url); |
|
832 | - exit(); |
|
833 | - } |
|
834 | - } |
|
835 | - |
|
836 | - |
|
837 | - /** |
|
838 | - * load_core_configuration |
|
839 | - * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
840 | - * which runs during the WP 'plugins_loaded' action at priority 5 |
|
841 | - * |
|
842 | - * @return void |
|
843 | - * @throws ReflectionException |
|
844 | - * @throws Exception |
|
845 | - */ |
|
846 | - public function load_core_configuration() |
|
847 | - { |
|
848 | - do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
849 | - $this->loader->getShared('EE_Load_Textdomain'); |
|
850 | - // load textdomain |
|
851 | - EE_Load_Textdomain::load_textdomain(); |
|
852 | - // load caf stuff a chance to play during the activation process too. |
|
853 | - $this->_maybe_brew_regular(); |
|
854 | - // load and setup EE_Config and EE_Network_Config |
|
855 | - $config = $this->loader->getShared('EE_Config'); |
|
856 | - $this->loader->getShared('EE_Network_Config'); |
|
857 | - // setup autoloaders |
|
858 | - // enable logging? |
|
859 | - if ($config->admin->use_remote_logging) { |
|
860 | - $this->loader->getShared('EE_Log'); |
|
861 | - } |
|
862 | - // check for activation errors |
|
863 | - $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
864 | - if ($activation_errors) { |
|
865 | - EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
866 | - update_option('ee_plugin_activation_errors', false); |
|
867 | - } |
|
868 | - // get model names |
|
869 | - $this->_parse_model_names(); |
|
870 | - // configure custom post type definitions |
|
871 | - $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'); |
|
872 | - $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'); |
|
873 | - do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
874 | - } |
|
875 | - |
|
876 | - |
|
877 | - /** |
|
878 | - * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
879 | - * |
|
880 | - * @return void |
|
881 | - * @throws ReflectionException |
|
882 | - */ |
|
883 | - private function _parse_model_names() |
|
884 | - { |
|
885 | - // get all the files in the EE_MODELS folder that end in .model.php |
|
886 | - $models = glob(EE_MODELS . '*.model.php'); |
|
887 | - $model_names = array(); |
|
888 | - $non_abstract_db_models = array(); |
|
889 | - foreach ($models as $model) { |
|
890 | - // get model classname |
|
891 | - $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
892 | - $short_name = str_replace('EEM_', '', $classname); |
|
893 | - $reflectionClass = new ReflectionClass($classname); |
|
894 | - if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
895 | - $non_abstract_db_models[ $short_name ] = $classname; |
|
896 | - } |
|
897 | - $model_names[ $short_name ] = $classname; |
|
898 | - } |
|
899 | - $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
900 | - $this->registry->non_abstract_db_models = apply_filters( |
|
901 | - 'FHEE__EE_System__parse_implemented_model_names', |
|
902 | - $non_abstract_db_models |
|
903 | - ); |
|
904 | - } |
|
905 | - |
|
906 | - |
|
907 | - /** |
|
908 | - * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
909 | - * that need to be setup before our EE_System launches. |
|
910 | - * |
|
911 | - * @return void |
|
912 | - * @throws DomainException |
|
913 | - * @throws InvalidArgumentException |
|
914 | - * @throws InvalidDataTypeException |
|
915 | - * @throws InvalidInterfaceException |
|
916 | - * @throws InvalidClassException |
|
917 | - * @throws InvalidFilePathException |
|
918 | - */ |
|
919 | - private function _maybe_brew_regular() |
|
920 | - { |
|
921 | - /** @var Domain $domain */ |
|
922 | - $domain = DomainFactory::getShared( |
|
923 | - new FullyQualifiedName( |
|
924 | - 'EventEspresso\core\domain\Domain' |
|
925 | - ), |
|
926 | - array( |
|
927 | - new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
928 | - Version::fromString(espresso_version()), |
|
929 | - ) |
|
930 | - ); |
|
931 | - if ($domain->isCaffeinated()) { |
|
932 | - require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
933 | - } |
|
934 | - } |
|
935 | - |
|
936 | - |
|
937 | - /** |
|
938 | - * @since 4.9.71.p |
|
939 | - * @throws Exception |
|
940 | - */ |
|
941 | - public function loadRouteMatchSpecifications() |
|
942 | - { |
|
943 | - try { |
|
944 | - $this->loader->getShared( |
|
945 | - 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' |
|
946 | - ); |
|
947 | - } catch (Exception $exception) { |
|
948 | - new ExceptionStackTraceDisplay($exception); |
|
949 | - } |
|
950 | - do_action('AHEE__EE_System__loadRouteMatchSpecifications'); |
|
951 | - } |
|
952 | - |
|
953 | - |
|
954 | - /** |
|
955 | - * register_shortcodes_modules_and_widgets |
|
956 | - * generate lists of shortcodes and modules, then verify paths and classes |
|
957 | - * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
958 | - * which runs during the WP 'plugins_loaded' action at priority 7 |
|
959 | - * |
|
960 | - * @access public |
|
961 | - * @return void |
|
962 | - * @throws Exception |
|
963 | - */ |
|
964 | - public function register_shortcodes_modules_and_widgets() |
|
965 | - { |
|
966 | - if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) { |
|
967 | - try { |
|
968 | - // load, register, and add shortcodes the new way |
|
969 | - $this->loader->getShared( |
|
970 | - 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
971 | - array( |
|
972 | - // and the old way, but we'll put it under control of the new system |
|
973 | - EE_Config::getLegacyShortcodesManager(), |
|
974 | - ) |
|
975 | - ); |
|
976 | - } catch (Exception $exception) { |
|
977 | - new ExceptionStackTraceDisplay($exception); |
|
978 | - } |
|
979 | - } |
|
980 | - do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
981 | - // check for addons using old hook point |
|
982 | - if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
983 | - $this->_incompatible_addon_error(); |
|
984 | - } |
|
985 | - } |
|
986 | - |
|
987 | - |
|
988 | - /** |
|
989 | - * _incompatible_addon_error |
|
990 | - * |
|
991 | - * @access public |
|
992 | - * @return void |
|
993 | - */ |
|
994 | - private function _incompatible_addon_error() |
|
995 | - { |
|
996 | - // get array of classes hooking into here |
|
997 | - $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
998 | - 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
999 | - ); |
|
1000 | - if (! empty($class_names)) { |
|
1001 | - $msg = __( |
|
1002 | - 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
1003 | - 'event_espresso' |
|
1004 | - ); |
|
1005 | - $msg .= '<ul>'; |
|
1006 | - foreach ($class_names as $class_name) { |
|
1007 | - $msg .= '<li><b>Event Espresso - ' |
|
1008 | - . str_replace( |
|
1009 | - array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), |
|
1010 | - '', |
|
1011 | - $class_name |
|
1012 | - ) . '</b></li>'; |
|
1013 | - } |
|
1014 | - $msg .= '</ul>'; |
|
1015 | - $msg .= __( |
|
1016 | - 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
1017 | - 'event_espresso' |
|
1018 | - ); |
|
1019 | - // save list of incompatible addons to wp-options for later use |
|
1020 | - add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
1021 | - if (is_admin()) { |
|
1022 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1023 | - } |
|
1024 | - } |
|
1025 | - } |
|
1026 | - |
|
1027 | - |
|
1028 | - /** |
|
1029 | - * brew_espresso |
|
1030 | - * begins the process of setting hooks for initializing EE in the correct order |
|
1031 | - * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1032 | - * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1033 | - * |
|
1034 | - * @return void |
|
1035 | - */ |
|
1036 | - public function brew_espresso() |
|
1037 | - { |
|
1038 | - do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1039 | - // load some final core systems |
|
1040 | - add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1041 | - add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1042 | - add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1043 | - add_action('init', array($this, 'load_controllers'), 7); |
|
1044 | - add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1045 | - add_action('init', array($this, 'initialize'), 10); |
|
1046 | - add_action('init', array($this, 'initialize_last'), 100); |
|
1047 | - if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1048 | - // pew pew pew |
|
1049 | - $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
1050 | - do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1051 | - } |
|
1052 | - do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1053 | - } |
|
1054 | - |
|
1055 | - |
|
1056 | - /** |
|
1057 | - * set_hooks_for_core |
|
1058 | - * |
|
1059 | - * @access public |
|
1060 | - * @return void |
|
1061 | - * @throws EE_Error |
|
1062 | - */ |
|
1063 | - public function set_hooks_for_core() |
|
1064 | - { |
|
1065 | - $this->_deactivate_incompatible_addons(); |
|
1066 | - do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1067 | - $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1068 | - // caps need to be initialized on every request so that capability maps are set. |
|
1069 | - // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1070 | - $this->registry->CAP->init_caps(); |
|
1071 | - } |
|
1072 | - |
|
1073 | - |
|
1074 | - /** |
|
1075 | - * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1076 | - * deactivates any addons considered incompatible with the current version of EE |
|
1077 | - */ |
|
1078 | - private function _deactivate_incompatible_addons() |
|
1079 | - { |
|
1080 | - $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1081 | - if (! empty($incompatible_addons)) { |
|
1082 | - $active_plugins = get_option('active_plugins', array()); |
|
1083 | - foreach ($active_plugins as $active_plugin) { |
|
1084 | - foreach ($incompatible_addons as $incompatible_addon) { |
|
1085 | - if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1086 | - unset($_GET['activate']); |
|
1087 | - espresso_deactivate_plugin($active_plugin); |
|
1088 | - } |
|
1089 | - } |
|
1090 | - } |
|
1091 | - } |
|
1092 | - } |
|
1093 | - |
|
1094 | - |
|
1095 | - /** |
|
1096 | - * perform_activations_upgrades_and_migrations |
|
1097 | - * |
|
1098 | - * @access public |
|
1099 | - * @return void |
|
1100 | - */ |
|
1101 | - public function perform_activations_upgrades_and_migrations() |
|
1102 | - { |
|
1103 | - do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1104 | - } |
|
1105 | - |
|
1106 | - |
|
1107 | - /** |
|
1108 | - * @return void |
|
1109 | - * @throws DomainException |
|
1110 | - */ |
|
1111 | - public function load_CPTs_and_session() |
|
1112 | - { |
|
1113 | - do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1114 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */ |
|
1115 | - $register_custom_taxonomies = $this->loader->getShared( |
|
1116 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' |
|
1117 | - ); |
|
1118 | - $register_custom_taxonomies->registerCustomTaxonomies(); |
|
1119 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */ |
|
1120 | - $register_custom_post_types = $this->loader->getShared( |
|
1121 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' |
|
1122 | - ); |
|
1123 | - $register_custom_post_types->registerCustomPostTypes(); |
|
1124 | - /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */ |
|
1125 | - $register_custom_taxonomy_terms = $this->loader->getShared( |
|
1126 | - 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms' |
|
1127 | - ); |
|
1128 | - $register_custom_taxonomy_terms->registerCustomTaxonomyTerms(); |
|
1129 | - // load legacy Custom Post Types and Taxonomies |
|
1130 | - $this->loader->getShared('EE_Register_CPTs'); |
|
1131 | - do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1132 | - } |
|
1133 | - |
|
1134 | - |
|
1135 | - /** |
|
1136 | - * load_controllers |
|
1137 | - * this is the best place to load any additional controllers that needs access to EE core. |
|
1138 | - * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1139 | - * time |
|
1140 | - * |
|
1141 | - * @access public |
|
1142 | - * @return void |
|
1143 | - */ |
|
1144 | - public function load_controllers() |
|
1145 | - { |
|
1146 | - do_action('AHEE__EE_System__load_controllers__start'); |
|
1147 | - // let's get it started |
|
1148 | - if (! $this->maintenance_mode->level() |
|
1149 | - && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1150 | - ) { |
|
1151 | - do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1152 | - $this->loader->getShared('EE_Front_Controller'); |
|
1153 | - } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1154 | - do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1155 | - $this->loader->getShared('EE_Admin'); |
|
1156 | - } elseif ($this->request->isWordPressHeartbeat()) { |
|
1157 | - $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat'); |
|
1158 | - } |
|
1159 | - do_action('AHEE__EE_System__load_controllers__complete'); |
|
1160 | - } |
|
1161 | - |
|
1162 | - |
|
1163 | - /** |
|
1164 | - * core_loaded_and_ready |
|
1165 | - * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1166 | - * |
|
1167 | - * @access public |
|
1168 | - * @return void |
|
1169 | - * @throws Exception |
|
1170 | - */ |
|
1171 | - public function core_loaded_and_ready() |
|
1172 | - { |
|
1173 | - if ($this->request->isAdmin() |
|
1174 | - || $this->request->isFrontend() |
|
1175 | - || $this->request->isIframe() |
|
1176 | - || $this->request->isWordPressApi() |
|
1177 | - ) { |
|
1178 | - try { |
|
1179 | - $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1180 | - $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager'); |
|
1181 | - if ($this->canLoadBlocks()) { |
|
1182 | - $this->loader->getShared( |
|
1183 | - 'EventEspresso\core\services\editor\BlockRegistrationManager' |
|
1184 | - ); |
|
1185 | - } |
|
1186 | - } catch (Exception $exception) { |
|
1187 | - new ExceptionStackTraceDisplay($exception); |
|
1188 | - } |
|
1189 | - } |
|
1190 | - if ($this->request->isAdmin() |
|
1191 | - || $this->request->isEeAjax() |
|
1192 | - || $this->request->isFrontend() |
|
1193 | - ) { |
|
1194 | - $this->loader->getShared('EE_Session'); |
|
1195 | - } |
|
1196 | - // integrate WP_Query with the EE models |
|
1197 | - $this->loader->getShared('EE_CPT_Strategy'); |
|
1198 | - do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1199 | - // always load template tags, because it's faster than checking if it's a front-end request, and many page |
|
1200 | - // builders require these even on the front-end |
|
1201 | - require_once EE_PUBLIC . 'template_tags.php'; |
|
1202 | - do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1203 | - } |
|
1204 | - |
|
1205 | - |
|
1206 | - /** |
|
1207 | - * initialize |
|
1208 | - * this is the best place to begin initializing client code |
|
1209 | - * |
|
1210 | - * @access public |
|
1211 | - * @return void |
|
1212 | - */ |
|
1213 | - public function initialize() |
|
1214 | - { |
|
1215 | - do_action('AHEE__EE_System__initialize'); |
|
1216 | - } |
|
1217 | - |
|
1218 | - |
|
1219 | - /** |
|
1220 | - * initialize_last |
|
1221 | - * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1222 | - * initialize has done so |
|
1223 | - * |
|
1224 | - * @access public |
|
1225 | - * @return void |
|
1226 | - */ |
|
1227 | - public function initialize_last() |
|
1228 | - { |
|
1229 | - do_action('AHEE__EE_System__initialize_last'); |
|
1230 | - /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
1231 | - $rewrite_rules = $this->loader->getShared( |
|
1232 | - 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
1233 | - ); |
|
1234 | - $rewrite_rules->flushRewriteRules(); |
|
1235 | - add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1236 | - if (($this->request->isAjax() || $this->request->isAdmin()) |
|
1237 | - && $this->maintenance_mode->models_can_query()) { |
|
1238 | - $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager'); |
|
1239 | - $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager'); |
|
1240 | - } |
|
1241 | - } |
|
1242 | - |
|
1243 | - |
|
1244 | - /** |
|
1245 | - * @return void |
|
1246 | - * @throws EE_Error |
|
1247 | - */ |
|
1248 | - public function addEspressoToolbar() |
|
1249 | - { |
|
1250 | - $this->loader->getShared( |
|
1251 | - 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1252 | - array($this->registry->CAP) |
|
1253 | - ); |
|
1254 | - } |
|
1255 | - |
|
1256 | - |
|
1257 | - /** |
|
1258 | - * do_not_cache |
|
1259 | - * sets no cache headers and defines no cache constants for WP plugins |
|
1260 | - * |
|
1261 | - * @access public |
|
1262 | - * @return void |
|
1263 | - */ |
|
1264 | - public static function do_not_cache() |
|
1265 | - { |
|
1266 | - // set no cache constants |
|
1267 | - if (! defined('DONOTCACHEPAGE')) { |
|
1268 | - define('DONOTCACHEPAGE', true); |
|
1269 | - } |
|
1270 | - if (! defined('DONOTCACHCEOBJECT')) { |
|
1271 | - define('DONOTCACHCEOBJECT', true); |
|
1272 | - } |
|
1273 | - if (! defined('DONOTCACHEDB')) { |
|
1274 | - define('DONOTCACHEDB', true); |
|
1275 | - } |
|
1276 | - // add no cache headers |
|
1277 | - add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1278 | - // plus a little extra for nginx and Google Chrome |
|
1279 | - add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1280 | - // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1281 | - remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1282 | - } |
|
1283 | - |
|
1284 | - |
|
1285 | - /** |
|
1286 | - * extra_nocache_headers |
|
1287 | - * |
|
1288 | - * @access public |
|
1289 | - * @param $headers |
|
1290 | - * @return array |
|
1291 | - */ |
|
1292 | - public static function extra_nocache_headers($headers) |
|
1293 | - { |
|
1294 | - // for NGINX |
|
1295 | - $headers['X-Accel-Expires'] = 0; |
|
1296 | - // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1297 | - $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1298 | - return $headers; |
|
1299 | - } |
|
1300 | - |
|
1301 | - |
|
1302 | - /** |
|
1303 | - * nocache_headers |
|
1304 | - * |
|
1305 | - * @access public |
|
1306 | - * @return void |
|
1307 | - */ |
|
1308 | - public static function nocache_headers() |
|
1309 | - { |
|
1310 | - nocache_headers(); |
|
1311 | - } |
|
1312 | - |
|
1313 | - |
|
1314 | - /** |
|
1315 | - * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1316 | - * never returned with the function. |
|
1317 | - * |
|
1318 | - * @param array $exclude_array any existing pages being excluded are in this array. |
|
1319 | - * @return array |
|
1320 | - */ |
|
1321 | - public function remove_pages_from_wp_list_pages($exclude_array) |
|
1322 | - { |
|
1323 | - return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1324 | - } |
|
1325 | - |
|
1326 | - |
|
1327 | - /** |
|
1328 | - * Return whether blocks can be registered/loaded or not. |
|
1329 | - * @return bool |
|
1330 | - */ |
|
1331 | - private function canLoadBlocks() |
|
1332 | - { |
|
1333 | - return apply_filters('FHEE__EE_System__canLoadBlocks', true) |
|
1334 | - && function_exists('register_block_type') |
|
1335 | - // don't load blocks if in the Divi page builder editor context |
|
1336 | - // @see https://github.com/eventespresso/event-espresso-core/issues/814 |
|
1337 | - && ! $this->request->getRequestParam('et_fb', false); |
|
1338 | - } |
|
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->isWordPressApi() || $this->request->isApi()) |
|
390 | + && $this->request->getRequestParam('activate') !== 'true' |
|
391 | + && ! function_exists('json_basic_auth_handler') |
|
392 | + && ! function_exists('json_basic_auth_error') |
|
393 | + && ! in_array( |
|
394 | + $this->request->getRequestParam('action'), |
|
395 | + array('activate', 'activate-selected'), |
|
396 | + true |
|
397 | + ) |
|
398 | + ) { |
|
399 | + include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php'; |
|
400 | + } |
|
401 | + do_action('AHEE__EE_System__load_espresso_addons__complete'); |
|
402 | + } |
|
403 | + |
|
404 | + |
|
405 | + /** |
|
406 | + * detect_activations_or_upgrades |
|
407 | + * Checks for activation or upgrade of core first; |
|
408 | + * then also checks if any registered addons have been activated or upgraded |
|
409 | + * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades' |
|
410 | + * which runs during the WP 'plugins_loaded' action at priority 3 |
|
411 | + * |
|
412 | + * @access public |
|
413 | + * @return void |
|
414 | + */ |
|
415 | + public function detect_activations_or_upgrades() |
|
416 | + { |
|
417 | + // first off: let's make sure to handle core |
|
418 | + $this->detect_if_activation_or_upgrade(); |
|
419 | + foreach ($this->registry->addons as $addon) { |
|
420 | + if ($addon instanceof EE_Addon) { |
|
421 | + // detect teh request type for that addon |
|
422 | + $addon->detect_activation_or_upgrade(); |
|
423 | + } |
|
424 | + } |
|
425 | + } |
|
426 | + |
|
427 | + |
|
428 | + /** |
|
429 | + * detect_if_activation_or_upgrade |
|
430 | + * Takes care of detecting whether this is a brand new install or code upgrade, |
|
431 | + * and either setting up the DB or setting up maintenance mode etc. |
|
432 | + * |
|
433 | + * @access public |
|
434 | + * @return void |
|
435 | + */ |
|
436 | + public function detect_if_activation_or_upgrade() |
|
437 | + { |
|
438 | + do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin'); |
|
439 | + // check if db has been updated, or if its a brand-new installation |
|
440 | + $espresso_db_update = $this->fix_espresso_db_upgrade_option(); |
|
441 | + $request_type = $this->detect_req_type($espresso_db_update); |
|
442 | + // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ ); |
|
443 | + switch ($request_type) { |
|
444 | + case EE_System::req_type_new_activation: |
|
445 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation'); |
|
446 | + $this->_handle_core_version_change($espresso_db_update); |
|
447 | + break; |
|
448 | + case EE_System::req_type_reactivation: |
|
449 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation'); |
|
450 | + $this->_handle_core_version_change($espresso_db_update); |
|
451 | + break; |
|
452 | + case EE_System::req_type_upgrade: |
|
453 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade'); |
|
454 | + // migrations may be required now that we've upgraded |
|
455 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
456 | + $this->_handle_core_version_change($espresso_db_update); |
|
457 | + break; |
|
458 | + case EE_System::req_type_downgrade: |
|
459 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade'); |
|
460 | + // its possible migrations are no longer required |
|
461 | + $this->maintenance_mode->set_maintenance_mode_if_db_old(); |
|
462 | + $this->_handle_core_version_change($espresso_db_update); |
|
463 | + break; |
|
464 | + case EE_System::req_type_normal: |
|
465 | + default: |
|
466 | + break; |
|
467 | + } |
|
468 | + do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete'); |
|
469 | + } |
|
470 | + |
|
471 | + |
|
472 | + /** |
|
473 | + * Updates the list of installed versions and sets hooks for |
|
474 | + * initializing the database later during the request |
|
475 | + * |
|
476 | + * @param array $espresso_db_update |
|
477 | + */ |
|
478 | + private function _handle_core_version_change($espresso_db_update) |
|
479 | + { |
|
480 | + $this->update_list_of_installed_versions($espresso_db_update); |
|
481 | + // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course) |
|
482 | + add_action( |
|
483 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
|
484 | + array($this, 'initialize_db_if_no_migrations_required') |
|
485 | + ); |
|
486 | + } |
|
487 | + |
|
488 | + |
|
489 | + /** |
|
490 | + * standardizes the wp option 'espresso_db_upgrade' which actually stores |
|
491 | + * information about what versions of EE have been installed and activated, |
|
492 | + * NOT necessarily the state of the database |
|
493 | + * |
|
494 | + * @param mixed $espresso_db_update the value of the WordPress option. |
|
495 | + * If not supplied, fetches it from the options table |
|
496 | + * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction |
|
497 | + */ |
|
498 | + private function fix_espresso_db_upgrade_option($espresso_db_update = null) |
|
499 | + { |
|
500 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update); |
|
501 | + if (! $espresso_db_update) { |
|
502 | + $espresso_db_update = get_option('espresso_db_update'); |
|
503 | + } |
|
504 | + // check that option is an array |
|
505 | + if (! is_array($espresso_db_update)) { |
|
506 | + // if option is FALSE, then it never existed |
|
507 | + if ($espresso_db_update === false) { |
|
508 | + // make $espresso_db_update an array and save option with autoload OFF |
|
509 | + $espresso_db_update = array(); |
|
510 | + add_option('espresso_db_update', $espresso_db_update, '', 'no'); |
|
511 | + } else { |
|
512 | + // option is NOT FALSE but also is NOT an array, so make it an array and save it |
|
513 | + $espresso_db_update = array($espresso_db_update => array()); |
|
514 | + update_option('espresso_db_update', $espresso_db_update); |
|
515 | + } |
|
516 | + } else { |
|
517 | + $corrected_db_update = array(); |
|
518 | + // if IS an array, but is it an array where KEYS are version numbers, and values are arrays? |
|
519 | + foreach ($espresso_db_update as $should_be_version_string => $should_be_array) { |
|
520 | + if (is_int($should_be_version_string) && ! is_array($should_be_array)) { |
|
521 | + // the key is an int, and the value IS NOT an array |
|
522 | + // so it must be numerically-indexed, where values are versions installed... |
|
523 | + // fix it! |
|
524 | + $version_string = $should_be_array; |
|
525 | + $corrected_db_update[ $version_string ] = array('unknown-date'); |
|
526 | + } else { |
|
527 | + // ok it checks out |
|
528 | + $corrected_db_update[ $should_be_version_string ] = $should_be_array; |
|
529 | + } |
|
530 | + } |
|
531 | + $espresso_db_update = $corrected_db_update; |
|
532 | + update_option('espresso_db_update', $espresso_db_update); |
|
533 | + } |
|
534 | + do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update); |
|
535 | + return $espresso_db_update; |
|
536 | + } |
|
537 | + |
|
538 | + |
|
539 | + /** |
|
540 | + * Does the traditional work of setting up the plugin's database and adding default data. |
|
541 | + * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade. |
|
542 | + * NOTE: if we're in maintenance mode (which would be the case if we detect there are data |
|
543 | + * migration scripts that need to be run and a version change happens), enqueues core for database initialization, |
|
544 | + * so that it will be done when migrations are finished |
|
545 | + * |
|
546 | + * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too; |
|
547 | + * @param boolean $verify_schema if true will re-check the database tables have the correct schema. |
|
548 | + * This is a resource-intensive job |
|
549 | + * so we prefer to only do it when necessary |
|
550 | + * @return void |
|
551 | + * @throws EE_Error |
|
552 | + */ |
|
553 | + public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true) |
|
554 | + { |
|
555 | + $request_type = $this->detect_req_type(); |
|
556 | + // only initialize system if we're not in maintenance mode. |
|
557 | + if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
558 | + /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
559 | + $rewrite_rules = $this->loader->getShared( |
|
560 | + 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
561 | + ); |
|
562 | + $rewrite_rules->flush(); |
|
563 | + if ($verify_schema) { |
|
564 | + EEH_Activation::initialize_db_and_folders(); |
|
565 | + } |
|
566 | + EEH_Activation::initialize_db_content(); |
|
567 | + EEH_Activation::system_initialization(); |
|
568 | + if ($initialize_addons_too) { |
|
569 | + $this->initialize_addons(); |
|
570 | + } |
|
571 | + } else { |
|
572 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core'); |
|
573 | + } |
|
574 | + if ($request_type === EE_System::req_type_new_activation |
|
575 | + || $request_type === EE_System::req_type_reactivation |
|
576 | + || ( |
|
577 | + $request_type === EE_System::req_type_upgrade |
|
578 | + && $this->is_major_version_change() |
|
579 | + ) |
|
580 | + ) { |
|
581 | + add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9); |
|
582 | + } |
|
583 | + } |
|
584 | + |
|
585 | + |
|
586 | + /** |
|
587 | + * Initializes the db for all registered addons |
|
588 | + * |
|
589 | + * @throws EE_Error |
|
590 | + */ |
|
591 | + public function initialize_addons() |
|
592 | + { |
|
593 | + // foreach registered addon, make sure its db is up-to-date too |
|
594 | + foreach ($this->registry->addons as $addon) { |
|
595 | + if ($addon instanceof EE_Addon) { |
|
596 | + $addon->initialize_db_if_no_migrations_required(); |
|
597 | + } |
|
598 | + } |
|
599 | + } |
|
600 | + |
|
601 | + |
|
602 | + /** |
|
603 | + * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed. |
|
604 | + * |
|
605 | + * @param array $version_history |
|
606 | + * @param string $current_version_to_add version to be added to the version history |
|
607 | + * @return boolean success as to whether or not this option was changed |
|
608 | + */ |
|
609 | + public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null) |
|
610 | + { |
|
611 | + if (! $version_history) { |
|
612 | + $version_history = $this->fix_espresso_db_upgrade_option($version_history); |
|
613 | + } |
|
614 | + if ($current_version_to_add === null) { |
|
615 | + $current_version_to_add = espresso_version(); |
|
616 | + } |
|
617 | + $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time()); |
|
618 | + // re-save |
|
619 | + return update_option('espresso_db_update', $version_history); |
|
620 | + } |
|
621 | + |
|
622 | + |
|
623 | + /** |
|
624 | + * Detects if the current version indicated in the has existed in the list of |
|
625 | + * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect) |
|
626 | + * |
|
627 | + * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'. |
|
628 | + * If not supplied, fetches it from the options table. |
|
629 | + * Also, caches its result so later parts of the code can also know whether |
|
630 | + * there's been an update or not. This way we can add the current version to |
|
631 | + * espresso_db_update, but still know if this is a new install or not |
|
632 | + * @return int one of the constants on EE_System::req_type_ |
|
633 | + */ |
|
634 | + public function detect_req_type($espresso_db_update = null) |
|
635 | + { |
|
636 | + if ($this->_req_type === null) { |
|
637 | + $espresso_db_update = ! empty($espresso_db_update) |
|
638 | + ? $espresso_db_update |
|
639 | + : $this->fix_espresso_db_upgrade_option(); |
|
640 | + $this->_req_type = EE_System::detect_req_type_given_activation_history( |
|
641 | + $espresso_db_update, |
|
642 | + 'ee_espresso_activation', |
|
643 | + espresso_version() |
|
644 | + ); |
|
645 | + $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update); |
|
646 | + $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal); |
|
647 | + } |
|
648 | + return $this->_req_type; |
|
649 | + } |
|
650 | + |
|
651 | + |
|
652 | + /** |
|
653 | + * Returns whether or not there was a non-micro version change (ie, change in either |
|
654 | + * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000, |
|
655 | + * but not 4.9.0.rc.0001 to 4.9.1.rc.0001 |
|
656 | + * |
|
657 | + * @param $activation_history |
|
658 | + * @return bool |
|
659 | + */ |
|
660 | + private function _detect_major_version_change($activation_history) |
|
661 | + { |
|
662 | + $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history); |
|
663 | + $previous_version_parts = explode('.', $previous_version); |
|
664 | + $current_version_parts = explode('.', espresso_version()); |
|
665 | + return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1]) |
|
666 | + && ($previous_version_parts[0] !== $current_version_parts[0] |
|
667 | + || $previous_version_parts[1] !== $current_version_parts[1] |
|
668 | + ); |
|
669 | + } |
|
670 | + |
|
671 | + |
|
672 | + /** |
|
673 | + * Returns true if either the major or minor version of EE changed during this request. |
|
674 | + * 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 |
|
675 | + * |
|
676 | + * @return bool |
|
677 | + */ |
|
678 | + public function is_major_version_change() |
|
679 | + { |
|
680 | + return $this->_major_version_change; |
|
681 | + } |
|
682 | + |
|
683 | + |
|
684 | + /** |
|
685 | + * Determines the request type for any ee addon, given three piece of info: the current array of activation |
|
686 | + * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily |
|
687 | + * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was |
|
688 | + * just activated to (for core that will always be espresso_version()) |
|
689 | + * |
|
690 | + * @param array $activation_history_for_addon the option's value which stores the activation history for this |
|
691 | + * ee plugin. for core that's 'espresso_db_update' |
|
692 | + * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to |
|
693 | + * indicate that this plugin was just activated |
|
694 | + * @param string $version_to_upgrade_to the version that was just upgraded to (for core that will be |
|
695 | + * espresso_version()) |
|
696 | + * @return int one of the constants on EE_System::req_type_* |
|
697 | + */ |
|
698 | + public static function detect_req_type_given_activation_history( |
|
699 | + $activation_history_for_addon, |
|
700 | + $activation_indicator_option_name, |
|
701 | + $version_to_upgrade_to |
|
702 | + ) { |
|
703 | + $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to); |
|
704 | + if ($activation_history_for_addon) { |
|
705 | + // it exists, so this isn't a completely new install |
|
706 | + // check if this version already in that list of previously installed versions |
|
707 | + if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) { |
|
708 | + // it a version we haven't seen before |
|
709 | + if ($version_is_higher === 1) { |
|
710 | + $req_type = EE_System::req_type_upgrade; |
|
711 | + } else { |
|
712 | + $req_type = EE_System::req_type_downgrade; |
|
713 | + } |
|
714 | + delete_option($activation_indicator_option_name); |
|
715 | + } else { |
|
716 | + // its not an update. maybe a reactivation? |
|
717 | + if (get_option($activation_indicator_option_name, false)) { |
|
718 | + if ($version_is_higher === -1) { |
|
719 | + $req_type = EE_System::req_type_downgrade; |
|
720 | + } elseif ($version_is_higher === 0) { |
|
721 | + // we've seen this version before, but it's an activation. must be a reactivation |
|
722 | + $req_type = EE_System::req_type_reactivation; |
|
723 | + } else {// $version_is_higher === 1 |
|
724 | + $req_type = EE_System::req_type_upgrade; |
|
725 | + } |
|
726 | + delete_option($activation_indicator_option_name); |
|
727 | + } else { |
|
728 | + // we've seen this version before and the activation indicate doesn't show it was just activated |
|
729 | + if ($version_is_higher === -1) { |
|
730 | + $req_type = EE_System::req_type_downgrade; |
|
731 | + } elseif ($version_is_higher === 0) { |
|
732 | + // we've seen this version before and it's not an activation. its normal request |
|
733 | + $req_type = EE_System::req_type_normal; |
|
734 | + } else {// $version_is_higher === 1 |
|
735 | + $req_type = EE_System::req_type_upgrade; |
|
736 | + } |
|
737 | + } |
|
738 | + } |
|
739 | + } else { |
|
740 | + // brand new install |
|
741 | + $req_type = EE_System::req_type_new_activation; |
|
742 | + delete_option($activation_indicator_option_name); |
|
743 | + } |
|
744 | + return $req_type; |
|
745 | + } |
|
746 | + |
|
747 | + |
|
748 | + /** |
|
749 | + * Detects if the $version_to_upgrade_to is higher than the most recent version in |
|
750 | + * the $activation_history_for_addon |
|
751 | + * |
|
752 | + * @param array $activation_history_for_addon (keys are versions, values are arrays of times activated, |
|
753 | + * sometimes containing 'unknown-date' |
|
754 | + * @param string $version_to_upgrade_to (current version) |
|
755 | + * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ). |
|
756 | + * ie, -1 if $version_to_upgrade_to is LOWER (downgrade); |
|
757 | + * 0 if $version_to_upgrade_to MATCHES (reactivation or normal request); |
|
758 | + * 1 if $version_to_upgrade_to is HIGHER (upgrade) ; |
|
759 | + */ |
|
760 | + private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to) |
|
761 | + { |
|
762 | + // find the most recently-activated version |
|
763 | + $most_recently_active_version = |
|
764 | + EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon); |
|
765 | + return version_compare($version_to_upgrade_to, $most_recently_active_version); |
|
766 | + } |
|
767 | + |
|
768 | + |
|
769 | + /** |
|
770 | + * Gets the most recently active version listed in the activation history, |
|
771 | + * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'. |
|
772 | + * |
|
773 | + * @param array $activation_history (keys are versions, values are arrays of times activated, |
|
774 | + * sometimes containing 'unknown-date' |
|
775 | + * @return string |
|
776 | + */ |
|
777 | + private static function _get_most_recently_active_version_from_activation_history($activation_history) |
|
778 | + { |
|
779 | + $most_recently_active_version_activation = '1970-01-01 00:00:00'; |
|
780 | + $most_recently_active_version = '0.0.0.dev.000'; |
|
781 | + if (is_array($activation_history)) { |
|
782 | + foreach ($activation_history as $version => $times_activated) { |
|
783 | + // check there is a record of when this version was activated. Otherwise, |
|
784 | + // mark it as unknown |
|
785 | + if (! $times_activated) { |
|
786 | + $times_activated = array('unknown-date'); |
|
787 | + } |
|
788 | + if (is_string($times_activated)) { |
|
789 | + $times_activated = array($times_activated); |
|
790 | + } |
|
791 | + foreach ($times_activated as $an_activation) { |
|
792 | + if ($an_activation !== 'unknown-date' |
|
793 | + && $an_activation |
|
794 | + > $most_recently_active_version_activation) { |
|
795 | + $most_recently_active_version = $version; |
|
796 | + $most_recently_active_version_activation = $an_activation === 'unknown-date' |
|
797 | + ? '1970-01-01 00:00:00' |
|
798 | + : $an_activation; |
|
799 | + } |
|
800 | + } |
|
801 | + } |
|
802 | + } |
|
803 | + return $most_recently_active_version; |
|
804 | + } |
|
805 | + |
|
806 | + |
|
807 | + /** |
|
808 | + * This redirects to the about EE page after activation |
|
809 | + * |
|
810 | + * @return void |
|
811 | + */ |
|
812 | + public function redirect_to_about_ee() |
|
813 | + { |
|
814 | + $notices = EE_Error::get_notices(false); |
|
815 | + // if current user is an admin and it's not an ajax or rest request |
|
816 | + if (! isset($notices['errors']) |
|
817 | + && $this->request->isAdmin() |
|
818 | + && apply_filters( |
|
819 | + 'FHEE__EE_System__redirect_to_about_ee__do_redirect', |
|
820 | + $this->capabilities->current_user_can('manage_options', 'espresso_about_default') |
|
821 | + ) |
|
822 | + ) { |
|
823 | + $query_params = array('page' => 'espresso_about'); |
|
824 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) { |
|
825 | + $query_params['new_activation'] = true; |
|
826 | + } |
|
827 | + if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) { |
|
828 | + $query_params['reactivation'] = true; |
|
829 | + } |
|
830 | + $url = add_query_arg($query_params, admin_url('admin.php')); |
|
831 | + wp_safe_redirect($url); |
|
832 | + exit(); |
|
833 | + } |
|
834 | + } |
|
835 | + |
|
836 | + |
|
837 | + /** |
|
838 | + * load_core_configuration |
|
839 | + * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration' |
|
840 | + * which runs during the WP 'plugins_loaded' action at priority 5 |
|
841 | + * |
|
842 | + * @return void |
|
843 | + * @throws ReflectionException |
|
844 | + * @throws Exception |
|
845 | + */ |
|
846 | + public function load_core_configuration() |
|
847 | + { |
|
848 | + do_action('AHEE__EE_System__load_core_configuration__begin', $this); |
|
849 | + $this->loader->getShared('EE_Load_Textdomain'); |
|
850 | + // load textdomain |
|
851 | + EE_Load_Textdomain::load_textdomain(); |
|
852 | + // load caf stuff a chance to play during the activation process too. |
|
853 | + $this->_maybe_brew_regular(); |
|
854 | + // load and setup EE_Config and EE_Network_Config |
|
855 | + $config = $this->loader->getShared('EE_Config'); |
|
856 | + $this->loader->getShared('EE_Network_Config'); |
|
857 | + // setup autoloaders |
|
858 | + // enable logging? |
|
859 | + if ($config->admin->use_remote_logging) { |
|
860 | + $this->loader->getShared('EE_Log'); |
|
861 | + } |
|
862 | + // check for activation errors |
|
863 | + $activation_errors = get_option('ee_plugin_activation_errors', false); |
|
864 | + if ($activation_errors) { |
|
865 | + EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__); |
|
866 | + update_option('ee_plugin_activation_errors', false); |
|
867 | + } |
|
868 | + // get model names |
|
869 | + $this->_parse_model_names(); |
|
870 | + // configure custom post type definitions |
|
871 | + $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'); |
|
872 | + $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'); |
|
873 | + do_action('AHEE__EE_System__load_core_configuration__complete', $this); |
|
874 | + } |
|
875 | + |
|
876 | + |
|
877 | + /** |
|
878 | + * cycles through all of the models/*.model.php files, and assembles an array of model names |
|
879 | + * |
|
880 | + * @return void |
|
881 | + * @throws ReflectionException |
|
882 | + */ |
|
883 | + private function _parse_model_names() |
|
884 | + { |
|
885 | + // get all the files in the EE_MODELS folder that end in .model.php |
|
886 | + $models = glob(EE_MODELS . '*.model.php'); |
|
887 | + $model_names = array(); |
|
888 | + $non_abstract_db_models = array(); |
|
889 | + foreach ($models as $model) { |
|
890 | + // get model classname |
|
891 | + $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model); |
|
892 | + $short_name = str_replace('EEM_', '', $classname); |
|
893 | + $reflectionClass = new ReflectionClass($classname); |
|
894 | + if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) { |
|
895 | + $non_abstract_db_models[ $short_name ] = $classname; |
|
896 | + } |
|
897 | + $model_names[ $short_name ] = $classname; |
|
898 | + } |
|
899 | + $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names); |
|
900 | + $this->registry->non_abstract_db_models = apply_filters( |
|
901 | + 'FHEE__EE_System__parse_implemented_model_names', |
|
902 | + $non_abstract_db_models |
|
903 | + ); |
|
904 | + } |
|
905 | + |
|
906 | + |
|
907 | + /** |
|
908 | + * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks |
|
909 | + * that need to be setup before our EE_System launches. |
|
910 | + * |
|
911 | + * @return void |
|
912 | + * @throws DomainException |
|
913 | + * @throws InvalidArgumentException |
|
914 | + * @throws InvalidDataTypeException |
|
915 | + * @throws InvalidInterfaceException |
|
916 | + * @throws InvalidClassException |
|
917 | + * @throws InvalidFilePathException |
|
918 | + */ |
|
919 | + private function _maybe_brew_regular() |
|
920 | + { |
|
921 | + /** @var Domain $domain */ |
|
922 | + $domain = DomainFactory::getShared( |
|
923 | + new FullyQualifiedName( |
|
924 | + 'EventEspresso\core\domain\Domain' |
|
925 | + ), |
|
926 | + array( |
|
927 | + new FilePath(EVENT_ESPRESSO_MAIN_FILE), |
|
928 | + Version::fromString(espresso_version()), |
|
929 | + ) |
|
930 | + ); |
|
931 | + if ($domain->isCaffeinated()) { |
|
932 | + require_once EE_CAFF_PATH . 'brewing_regular.php'; |
|
933 | + } |
|
934 | + } |
|
935 | + |
|
936 | + |
|
937 | + /** |
|
938 | + * @since 4.9.71.p |
|
939 | + * @throws Exception |
|
940 | + */ |
|
941 | + public function loadRouteMatchSpecifications() |
|
942 | + { |
|
943 | + try { |
|
944 | + $this->loader->getShared( |
|
945 | + 'EventEspresso\core\services\route_match\RouteMatchSpecificationManager' |
|
946 | + ); |
|
947 | + } catch (Exception $exception) { |
|
948 | + new ExceptionStackTraceDisplay($exception); |
|
949 | + } |
|
950 | + do_action('AHEE__EE_System__loadRouteMatchSpecifications'); |
|
951 | + } |
|
952 | + |
|
953 | + |
|
954 | + /** |
|
955 | + * register_shortcodes_modules_and_widgets |
|
956 | + * generate lists of shortcodes and modules, then verify paths and classes |
|
957 | + * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets' |
|
958 | + * which runs during the WP 'plugins_loaded' action at priority 7 |
|
959 | + * |
|
960 | + * @access public |
|
961 | + * @return void |
|
962 | + * @throws Exception |
|
963 | + */ |
|
964 | + public function register_shortcodes_modules_and_widgets() |
|
965 | + { |
|
966 | + if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) { |
|
967 | + try { |
|
968 | + // load, register, and add shortcodes the new way |
|
969 | + $this->loader->getShared( |
|
970 | + 'EventEspresso\core\services\shortcodes\ShortcodesManager', |
|
971 | + array( |
|
972 | + // and the old way, but we'll put it under control of the new system |
|
973 | + EE_Config::getLegacyShortcodesManager(), |
|
974 | + ) |
|
975 | + ); |
|
976 | + } catch (Exception $exception) { |
|
977 | + new ExceptionStackTraceDisplay($exception); |
|
978 | + } |
|
979 | + } |
|
980 | + do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets'); |
|
981 | + // check for addons using old hook point |
|
982 | + if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) { |
|
983 | + $this->_incompatible_addon_error(); |
|
984 | + } |
|
985 | + } |
|
986 | + |
|
987 | + |
|
988 | + /** |
|
989 | + * _incompatible_addon_error |
|
990 | + * |
|
991 | + * @access public |
|
992 | + * @return void |
|
993 | + */ |
|
994 | + private function _incompatible_addon_error() |
|
995 | + { |
|
996 | + // get array of classes hooking into here |
|
997 | + $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook( |
|
998 | + 'AHEE__EE_System__register_shortcodes_modules_and_addons' |
|
999 | + ); |
|
1000 | + if (! empty($class_names)) { |
|
1001 | + $msg = __( |
|
1002 | + 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:', |
|
1003 | + 'event_espresso' |
|
1004 | + ); |
|
1005 | + $msg .= '<ul>'; |
|
1006 | + foreach ($class_names as $class_name) { |
|
1007 | + $msg .= '<li><b>Event Espresso - ' |
|
1008 | + . str_replace( |
|
1009 | + array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'), |
|
1010 | + '', |
|
1011 | + $class_name |
|
1012 | + ) . '</b></li>'; |
|
1013 | + } |
|
1014 | + $msg .= '</ul>'; |
|
1015 | + $msg .= __( |
|
1016 | + 'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.', |
|
1017 | + 'event_espresso' |
|
1018 | + ); |
|
1019 | + // save list of incompatible addons to wp-options for later use |
|
1020 | + add_option('ee_incompatible_addons', $class_names, '', 'no'); |
|
1021 | + if (is_admin()) { |
|
1022 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
1023 | + } |
|
1024 | + } |
|
1025 | + } |
|
1026 | + |
|
1027 | + |
|
1028 | + /** |
|
1029 | + * brew_espresso |
|
1030 | + * begins the process of setting hooks for initializing EE in the correct order |
|
1031 | + * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point |
|
1032 | + * which runs during the WP 'plugins_loaded' action at priority 9 |
|
1033 | + * |
|
1034 | + * @return void |
|
1035 | + */ |
|
1036 | + public function brew_espresso() |
|
1037 | + { |
|
1038 | + do_action('AHEE__EE_System__brew_espresso__begin', $this); |
|
1039 | + // load some final core systems |
|
1040 | + add_action('init', array($this, 'set_hooks_for_core'), 1); |
|
1041 | + add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3); |
|
1042 | + add_action('init', array($this, 'load_CPTs_and_session'), 5); |
|
1043 | + add_action('init', array($this, 'load_controllers'), 7); |
|
1044 | + add_action('init', array($this, 'core_loaded_and_ready'), 9); |
|
1045 | + add_action('init', array($this, 'initialize'), 10); |
|
1046 | + add_action('init', array($this, 'initialize_last'), 100); |
|
1047 | + if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) { |
|
1048 | + // pew pew pew |
|
1049 | + $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService'); |
|
1050 | + do_action('AHEE__EE_System__brew_espresso__after_pue_init'); |
|
1051 | + } |
|
1052 | + do_action('AHEE__EE_System__brew_espresso__complete', $this); |
|
1053 | + } |
|
1054 | + |
|
1055 | + |
|
1056 | + /** |
|
1057 | + * set_hooks_for_core |
|
1058 | + * |
|
1059 | + * @access public |
|
1060 | + * @return void |
|
1061 | + * @throws EE_Error |
|
1062 | + */ |
|
1063 | + public function set_hooks_for_core() |
|
1064 | + { |
|
1065 | + $this->_deactivate_incompatible_addons(); |
|
1066 | + do_action('AHEE__EE_System__set_hooks_for_core'); |
|
1067 | + $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan'); |
|
1068 | + // caps need to be initialized on every request so that capability maps are set. |
|
1069 | + // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674 |
|
1070 | + $this->registry->CAP->init_caps(); |
|
1071 | + } |
|
1072 | + |
|
1073 | + |
|
1074 | + /** |
|
1075 | + * Using the information gathered in EE_System::_incompatible_addon_error, |
|
1076 | + * deactivates any addons considered incompatible with the current version of EE |
|
1077 | + */ |
|
1078 | + private function _deactivate_incompatible_addons() |
|
1079 | + { |
|
1080 | + $incompatible_addons = get_option('ee_incompatible_addons', array()); |
|
1081 | + if (! empty($incompatible_addons)) { |
|
1082 | + $active_plugins = get_option('active_plugins', array()); |
|
1083 | + foreach ($active_plugins as $active_plugin) { |
|
1084 | + foreach ($incompatible_addons as $incompatible_addon) { |
|
1085 | + if (strpos($active_plugin, $incompatible_addon) !== false) { |
|
1086 | + unset($_GET['activate']); |
|
1087 | + espresso_deactivate_plugin($active_plugin); |
|
1088 | + } |
|
1089 | + } |
|
1090 | + } |
|
1091 | + } |
|
1092 | + } |
|
1093 | + |
|
1094 | + |
|
1095 | + /** |
|
1096 | + * perform_activations_upgrades_and_migrations |
|
1097 | + * |
|
1098 | + * @access public |
|
1099 | + * @return void |
|
1100 | + */ |
|
1101 | + public function perform_activations_upgrades_and_migrations() |
|
1102 | + { |
|
1103 | + do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations'); |
|
1104 | + } |
|
1105 | + |
|
1106 | + |
|
1107 | + /** |
|
1108 | + * @return void |
|
1109 | + * @throws DomainException |
|
1110 | + */ |
|
1111 | + public function load_CPTs_and_session() |
|
1112 | + { |
|
1113 | + do_action('AHEE__EE_System__load_CPTs_and_session__start'); |
|
1114 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */ |
|
1115 | + $register_custom_taxonomies = $this->loader->getShared( |
|
1116 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies' |
|
1117 | + ); |
|
1118 | + $register_custom_taxonomies->registerCustomTaxonomies(); |
|
1119 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */ |
|
1120 | + $register_custom_post_types = $this->loader->getShared( |
|
1121 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes' |
|
1122 | + ); |
|
1123 | + $register_custom_post_types->registerCustomPostTypes(); |
|
1124 | + /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */ |
|
1125 | + $register_custom_taxonomy_terms = $this->loader->getShared( |
|
1126 | + 'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms' |
|
1127 | + ); |
|
1128 | + $register_custom_taxonomy_terms->registerCustomTaxonomyTerms(); |
|
1129 | + // load legacy Custom Post Types and Taxonomies |
|
1130 | + $this->loader->getShared('EE_Register_CPTs'); |
|
1131 | + do_action('AHEE__EE_System__load_CPTs_and_session__complete'); |
|
1132 | + } |
|
1133 | + |
|
1134 | + |
|
1135 | + /** |
|
1136 | + * load_controllers |
|
1137 | + * this is the best place to load any additional controllers that needs access to EE core. |
|
1138 | + * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this |
|
1139 | + * time |
|
1140 | + * |
|
1141 | + * @access public |
|
1142 | + * @return void |
|
1143 | + */ |
|
1144 | + public function load_controllers() |
|
1145 | + { |
|
1146 | + do_action('AHEE__EE_System__load_controllers__start'); |
|
1147 | + // let's get it started |
|
1148 | + if (! $this->maintenance_mode->level() |
|
1149 | + && ($this->request->isFrontend() || $this->request->isFrontAjax()) |
|
1150 | + ) { |
|
1151 | + do_action('AHEE__EE_System__load_controllers__load_front_controllers'); |
|
1152 | + $this->loader->getShared('EE_Front_Controller'); |
|
1153 | + } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) { |
|
1154 | + do_action('AHEE__EE_System__load_controllers__load_admin_controllers'); |
|
1155 | + $this->loader->getShared('EE_Admin'); |
|
1156 | + } elseif ($this->request->isWordPressHeartbeat()) { |
|
1157 | + $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat'); |
|
1158 | + } |
|
1159 | + do_action('AHEE__EE_System__load_controllers__complete'); |
|
1160 | + } |
|
1161 | + |
|
1162 | + |
|
1163 | + /** |
|
1164 | + * core_loaded_and_ready |
|
1165 | + * all of the basic EE core should be loaded at this point and available regardless of M-Mode |
|
1166 | + * |
|
1167 | + * @access public |
|
1168 | + * @return void |
|
1169 | + * @throws Exception |
|
1170 | + */ |
|
1171 | + public function core_loaded_and_ready() |
|
1172 | + { |
|
1173 | + if ($this->request->isAdmin() |
|
1174 | + || $this->request->isFrontend() |
|
1175 | + || $this->request->isIframe() |
|
1176 | + || $this->request->isWordPressApi() |
|
1177 | + ) { |
|
1178 | + try { |
|
1179 | + $this->loader->getShared('EventEspresso\core\services\assets\Registry'); |
|
1180 | + $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager'); |
|
1181 | + if ($this->canLoadBlocks()) { |
|
1182 | + $this->loader->getShared( |
|
1183 | + 'EventEspresso\core\services\editor\BlockRegistrationManager' |
|
1184 | + ); |
|
1185 | + } |
|
1186 | + } catch (Exception $exception) { |
|
1187 | + new ExceptionStackTraceDisplay($exception); |
|
1188 | + } |
|
1189 | + } |
|
1190 | + if ($this->request->isAdmin() |
|
1191 | + || $this->request->isEeAjax() |
|
1192 | + || $this->request->isFrontend() |
|
1193 | + ) { |
|
1194 | + $this->loader->getShared('EE_Session'); |
|
1195 | + } |
|
1196 | + // integrate WP_Query with the EE models |
|
1197 | + $this->loader->getShared('EE_CPT_Strategy'); |
|
1198 | + do_action('AHEE__EE_System__core_loaded_and_ready'); |
|
1199 | + // always load template tags, because it's faster than checking if it's a front-end request, and many page |
|
1200 | + // builders require these even on the front-end |
|
1201 | + require_once EE_PUBLIC . 'template_tags.php'; |
|
1202 | + do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons'); |
|
1203 | + } |
|
1204 | + |
|
1205 | + |
|
1206 | + /** |
|
1207 | + * initialize |
|
1208 | + * this is the best place to begin initializing client code |
|
1209 | + * |
|
1210 | + * @access public |
|
1211 | + * @return void |
|
1212 | + */ |
|
1213 | + public function initialize() |
|
1214 | + { |
|
1215 | + do_action('AHEE__EE_System__initialize'); |
|
1216 | + } |
|
1217 | + |
|
1218 | + |
|
1219 | + /** |
|
1220 | + * initialize_last |
|
1221 | + * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to |
|
1222 | + * initialize has done so |
|
1223 | + * |
|
1224 | + * @access public |
|
1225 | + * @return void |
|
1226 | + */ |
|
1227 | + public function initialize_last() |
|
1228 | + { |
|
1229 | + do_action('AHEE__EE_System__initialize_last'); |
|
1230 | + /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */ |
|
1231 | + $rewrite_rules = $this->loader->getShared( |
|
1232 | + 'EventEspresso\core\domain\services\custom_post_types\RewriteRules' |
|
1233 | + ); |
|
1234 | + $rewrite_rules->flushRewriteRules(); |
|
1235 | + add_action('admin_bar_init', array($this, 'addEspressoToolbar')); |
|
1236 | + if (($this->request->isAjax() || $this->request->isAdmin()) |
|
1237 | + && $this->maintenance_mode->models_can_query()) { |
|
1238 | + $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager'); |
|
1239 | + $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager'); |
|
1240 | + } |
|
1241 | + } |
|
1242 | + |
|
1243 | + |
|
1244 | + /** |
|
1245 | + * @return void |
|
1246 | + * @throws EE_Error |
|
1247 | + */ |
|
1248 | + public function addEspressoToolbar() |
|
1249 | + { |
|
1250 | + $this->loader->getShared( |
|
1251 | + 'EventEspresso\core\domain\services\admin\AdminToolBar', |
|
1252 | + array($this->registry->CAP) |
|
1253 | + ); |
|
1254 | + } |
|
1255 | + |
|
1256 | + |
|
1257 | + /** |
|
1258 | + * do_not_cache |
|
1259 | + * sets no cache headers and defines no cache constants for WP plugins |
|
1260 | + * |
|
1261 | + * @access public |
|
1262 | + * @return void |
|
1263 | + */ |
|
1264 | + public static function do_not_cache() |
|
1265 | + { |
|
1266 | + // set no cache constants |
|
1267 | + if (! defined('DONOTCACHEPAGE')) { |
|
1268 | + define('DONOTCACHEPAGE', true); |
|
1269 | + } |
|
1270 | + if (! defined('DONOTCACHCEOBJECT')) { |
|
1271 | + define('DONOTCACHCEOBJECT', true); |
|
1272 | + } |
|
1273 | + if (! defined('DONOTCACHEDB')) { |
|
1274 | + define('DONOTCACHEDB', true); |
|
1275 | + } |
|
1276 | + // add no cache headers |
|
1277 | + add_action('send_headers', array('EE_System', 'nocache_headers'), 10); |
|
1278 | + // plus a little extra for nginx and Google Chrome |
|
1279 | + add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1); |
|
1280 | + // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process |
|
1281 | + remove_action('wp_head', 'adjacent_posts_rel_link_wp_head'); |
|
1282 | + } |
|
1283 | + |
|
1284 | + |
|
1285 | + /** |
|
1286 | + * extra_nocache_headers |
|
1287 | + * |
|
1288 | + * @access public |
|
1289 | + * @param $headers |
|
1290 | + * @return array |
|
1291 | + */ |
|
1292 | + public static function extra_nocache_headers($headers) |
|
1293 | + { |
|
1294 | + // for NGINX |
|
1295 | + $headers['X-Accel-Expires'] = 0; |
|
1296 | + // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store" |
|
1297 | + $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0'; |
|
1298 | + return $headers; |
|
1299 | + } |
|
1300 | + |
|
1301 | + |
|
1302 | + /** |
|
1303 | + * nocache_headers |
|
1304 | + * |
|
1305 | + * @access public |
|
1306 | + * @return void |
|
1307 | + */ |
|
1308 | + public static function nocache_headers() |
|
1309 | + { |
|
1310 | + nocache_headers(); |
|
1311 | + } |
|
1312 | + |
|
1313 | + |
|
1314 | + /** |
|
1315 | + * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are |
|
1316 | + * never returned with the function. |
|
1317 | + * |
|
1318 | + * @param array $exclude_array any existing pages being excluded are in this array. |
|
1319 | + * @return array |
|
1320 | + */ |
|
1321 | + public function remove_pages_from_wp_list_pages($exclude_array) |
|
1322 | + { |
|
1323 | + return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array()); |
|
1324 | + } |
|
1325 | + |
|
1326 | + |
|
1327 | + /** |
|
1328 | + * Return whether blocks can be registered/loaded or not. |
|
1329 | + * @return bool |
|
1330 | + */ |
|
1331 | + private function canLoadBlocks() |
|
1332 | + { |
|
1333 | + return apply_filters('FHEE__EE_System__canLoadBlocks', true) |
|
1334 | + && function_exists('register_block_type') |
|
1335 | + // don't load blocks if in the Divi page builder editor context |
|
1336 | + // @see https://github.com/eventespresso/event-espresso-core/issues/814 |
|
1337 | + && ! $this->request->getRequestParam('et_fb', false); |
|
1338 | + } |
|
1339 | 1339 | } |
@@ -14,2509 +14,2509 @@ discard block |
||
14 | 14 | final class EE_Config implements ResettableInterface |
15 | 15 | { |
16 | 16 | |
17 | - const OPTION_NAME = 'ee_config'; |
|
18 | - |
|
19 | - const LOG_NAME = 'ee_config_log'; |
|
20 | - |
|
21 | - const LOG_LENGTH = 100; |
|
22 | - |
|
23 | - const ADDON_OPTION_NAMES = 'ee_config_option_names'; |
|
24 | - |
|
25 | - /** |
|
26 | - * instance of the EE_Config object |
|
27 | - * |
|
28 | - * @var EE_Config $_instance |
|
29 | - * @access private |
|
30 | - */ |
|
31 | - private static $_instance; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var boolean $_logging_enabled |
|
35 | - */ |
|
36 | - private static $_logging_enabled = false; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
40 | - */ |
|
41 | - private $legacy_shortcodes_manager; |
|
42 | - |
|
43 | - /** |
|
44 | - * An StdClass whose property names are addon slugs, |
|
45 | - * and values are their config classes |
|
46 | - * |
|
47 | - * @var StdClass |
|
48 | - */ |
|
49 | - public $addons; |
|
50 | - |
|
51 | - /** |
|
52 | - * @var EE_Admin_Config |
|
53 | - */ |
|
54 | - public $admin; |
|
55 | - |
|
56 | - /** |
|
57 | - * @var EE_Core_Config |
|
58 | - */ |
|
59 | - public $core; |
|
60 | - |
|
61 | - /** |
|
62 | - * @var EE_Currency_Config |
|
63 | - */ |
|
64 | - public $currency; |
|
65 | - |
|
66 | - /** |
|
67 | - * @var EE_Organization_Config |
|
68 | - */ |
|
69 | - public $organization; |
|
70 | - |
|
71 | - /** |
|
72 | - * @var EE_Registration_Config |
|
73 | - */ |
|
74 | - public $registration; |
|
75 | - |
|
76 | - /** |
|
77 | - * @var EE_Template_Config |
|
78 | - */ |
|
79 | - public $template_settings; |
|
80 | - |
|
81 | - /** |
|
82 | - * Holds EE environment values. |
|
83 | - * |
|
84 | - * @var EE_Environment_Config |
|
85 | - */ |
|
86 | - public $environment; |
|
87 | - |
|
88 | - /** |
|
89 | - * settings pertaining to Google maps |
|
90 | - * |
|
91 | - * @var EE_Map_Config |
|
92 | - */ |
|
93 | - public $map_settings; |
|
94 | - |
|
95 | - /** |
|
96 | - * settings pertaining to Taxes |
|
97 | - * |
|
98 | - * @var EE_Tax_Config |
|
99 | - */ |
|
100 | - public $tax_settings; |
|
101 | - |
|
102 | - /** |
|
103 | - * Settings pertaining to global messages settings. |
|
104 | - * |
|
105 | - * @var EE_Messages_Config |
|
106 | - */ |
|
107 | - public $messages; |
|
108 | - |
|
109 | - /** |
|
110 | - * @deprecated |
|
111 | - * @var EE_Gateway_Config |
|
112 | - */ |
|
113 | - public $gateway; |
|
114 | - |
|
115 | - /** |
|
116 | - * @var array $_addon_option_names |
|
117 | - * @access private |
|
118 | - */ |
|
119 | - private $_addon_option_names = array(); |
|
120 | - |
|
121 | - /** |
|
122 | - * @var array $_module_route_map |
|
123 | - * @access private |
|
124 | - */ |
|
125 | - private static $_module_route_map = array(); |
|
126 | - |
|
127 | - /** |
|
128 | - * @var array $_module_forward_map |
|
129 | - * @access private |
|
130 | - */ |
|
131 | - private static $_module_forward_map = array(); |
|
132 | - |
|
133 | - /** |
|
134 | - * @var array $_module_view_map |
|
135 | - * @access private |
|
136 | - */ |
|
137 | - private static $_module_view_map = array(); |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * @singleton method used to instantiate class object |
|
142 | - * @access public |
|
143 | - * @return EE_Config instance |
|
144 | - */ |
|
145 | - public static function instance() |
|
146 | - { |
|
147 | - // check if class object is instantiated, and instantiated properly |
|
148 | - if (! self::$_instance instanceof EE_Config) { |
|
149 | - self::$_instance = new self(); |
|
150 | - } |
|
151 | - return self::$_instance; |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * Resets the config |
|
157 | - * |
|
158 | - * @param bool $hard_reset if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE |
|
159 | - * (default) leaves the database alone, and merely resets the EE_Config object to |
|
160 | - * reflect its state in the database |
|
161 | - * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave |
|
162 | - * $_instance as NULL. Useful in case you want to forget about the old instance on |
|
163 | - * EE_Config, but might not be ready to instantiate EE_Config currently (eg if the |
|
164 | - * site was put into maintenance mode) |
|
165 | - * @return EE_Config |
|
166 | - */ |
|
167 | - public static function reset($hard_reset = false, $reinstantiate = true) |
|
168 | - { |
|
169 | - if (self::$_instance instanceof EE_Config) { |
|
170 | - if ($hard_reset) { |
|
171 | - self::$_instance->legacy_shortcodes_manager = null; |
|
172 | - self::$_instance->_addon_option_names = array(); |
|
173 | - self::$_instance->_initialize_config(); |
|
174 | - self::$_instance->update_espresso_config(); |
|
175 | - } |
|
176 | - self::$_instance->update_addon_option_names(); |
|
177 | - } |
|
178 | - self::$_instance = null; |
|
179 | - // we don't need to reset the static properties imo because those should |
|
180 | - // only change when a module is added or removed. Currently we don't |
|
181 | - // support removing a module during a request when it previously existed |
|
182 | - if ($reinstantiate) { |
|
183 | - return self::instance(); |
|
184 | - } else { |
|
185 | - return null; |
|
186 | - } |
|
187 | - } |
|
188 | - |
|
189 | - |
|
190 | - /** |
|
191 | - * class constructor |
|
192 | - * |
|
193 | - * @access private |
|
194 | - */ |
|
195 | - private function __construct() |
|
196 | - { |
|
197 | - do_action('AHEE__EE_Config__construct__begin', $this); |
|
198 | - EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false); |
|
199 | - // setup empty config classes |
|
200 | - $this->_initialize_config(); |
|
201 | - // load existing EE site settings |
|
202 | - $this->_load_core_config(); |
|
203 | - // confirm everything loaded correctly and set filtered defaults if not |
|
204 | - $this->_verify_config(); |
|
205 | - // register shortcodes and modules |
|
206 | - add_action( |
|
207 | - 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
208 | - array($this, 'register_shortcodes_and_modules'), |
|
209 | - 999 |
|
210 | - ); |
|
211 | - // initialize shortcodes and modules |
|
212 | - add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules')); |
|
213 | - // register widgets |
|
214 | - add_action('widgets_init', array($this, 'widgets_init'), 10); |
|
215 | - // shutdown |
|
216 | - add_action('shutdown', array($this, 'shutdown'), 10); |
|
217 | - // construct__end hook |
|
218 | - do_action('AHEE__EE_Config__construct__end', $this); |
|
219 | - // hardcoded hack |
|
220 | - $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
221 | - } |
|
222 | - |
|
223 | - |
|
224 | - /** |
|
225 | - * @return boolean |
|
226 | - */ |
|
227 | - public static function logging_enabled() |
|
228 | - { |
|
229 | - return self::$_logging_enabled; |
|
230 | - } |
|
231 | - |
|
232 | - |
|
233 | - /** |
|
234 | - * use to get the current theme if needed from static context |
|
235 | - * |
|
236 | - * @return string current theme set. |
|
237 | - */ |
|
238 | - public static function get_current_theme() |
|
239 | - { |
|
240 | - return isset(self::$_instance->template_settings->current_espresso_theme) |
|
241 | - ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014'; |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * _initialize_config |
|
247 | - * |
|
248 | - * @access private |
|
249 | - * @return void |
|
250 | - */ |
|
251 | - private function _initialize_config() |
|
252 | - { |
|
253 | - EE_Config::trim_log(); |
|
254 | - // set defaults |
|
255 | - $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array()); |
|
256 | - $this->addons = new stdClass(); |
|
257 | - // set _module_route_map |
|
258 | - EE_Config::$_module_route_map = array(); |
|
259 | - // set _module_forward_map |
|
260 | - EE_Config::$_module_forward_map = array(); |
|
261 | - // set _module_view_map |
|
262 | - EE_Config::$_module_view_map = array(); |
|
263 | - } |
|
264 | - |
|
265 | - |
|
266 | - /** |
|
267 | - * load core plugin configuration |
|
268 | - * |
|
269 | - * @access private |
|
270 | - * @return void |
|
271 | - */ |
|
272 | - private function _load_core_config() |
|
273 | - { |
|
274 | - // load_core_config__start hook |
|
275 | - do_action('AHEE__EE_Config___load_core_config__start', $this); |
|
276 | - $espresso_config = $this->get_espresso_config(); |
|
277 | - foreach ($espresso_config as $config => $settings) { |
|
278 | - // load_core_config__start hook |
|
279 | - $settings = apply_filters( |
|
280 | - 'FHEE__EE_Config___load_core_config__config_settings', |
|
281 | - $settings, |
|
282 | - $config, |
|
283 | - $this |
|
284 | - ); |
|
285 | - if (is_object($settings) && property_exists($this, $config)) { |
|
286 | - $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings); |
|
287 | - // call configs populate method to ensure any defaults are set for empty values. |
|
288 | - if (method_exists($settings, 'populate')) { |
|
289 | - $this->{$config}->populate(); |
|
290 | - } |
|
291 | - if (method_exists($settings, 'do_hooks')) { |
|
292 | - $this->{$config}->do_hooks(); |
|
293 | - } |
|
294 | - } |
|
295 | - } |
|
296 | - if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) { |
|
297 | - $this->update_espresso_config(); |
|
298 | - } |
|
299 | - // load_core_config__end hook |
|
300 | - do_action('AHEE__EE_Config___load_core_config__end', $this); |
|
301 | - } |
|
302 | - |
|
303 | - |
|
304 | - /** |
|
305 | - * _verify_config |
|
306 | - * |
|
307 | - * @access protected |
|
308 | - * @return void |
|
309 | - */ |
|
310 | - protected function _verify_config() |
|
311 | - { |
|
312 | - $this->core = $this->core instanceof EE_Core_Config |
|
313 | - ? $this->core |
|
314 | - : new EE_Core_Config(); |
|
315 | - $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core); |
|
316 | - $this->organization = $this->organization instanceof EE_Organization_Config |
|
317 | - ? $this->organization |
|
318 | - : new EE_Organization_Config(); |
|
319 | - $this->organization = apply_filters( |
|
320 | - 'FHEE__EE_Config___initialize_config__organization', |
|
321 | - $this->organization |
|
322 | - ); |
|
323 | - $this->currency = $this->currency instanceof EE_Currency_Config |
|
324 | - ? $this->currency |
|
325 | - : new EE_Currency_Config(); |
|
326 | - $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency); |
|
327 | - $this->registration = $this->registration instanceof EE_Registration_Config |
|
328 | - ? $this->registration |
|
329 | - : new EE_Registration_Config(); |
|
330 | - $this->registration = apply_filters( |
|
331 | - 'FHEE__EE_Config___initialize_config__registration', |
|
332 | - $this->registration |
|
333 | - ); |
|
334 | - $this->admin = $this->admin instanceof EE_Admin_Config |
|
335 | - ? $this->admin |
|
336 | - : new EE_Admin_Config(); |
|
337 | - $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin); |
|
338 | - $this->template_settings = $this->template_settings instanceof EE_Template_Config |
|
339 | - ? $this->template_settings |
|
340 | - : new EE_Template_Config(); |
|
341 | - $this->template_settings = apply_filters( |
|
342 | - 'FHEE__EE_Config___initialize_config__template_settings', |
|
343 | - $this->template_settings |
|
344 | - ); |
|
345 | - $this->map_settings = $this->map_settings instanceof EE_Map_Config |
|
346 | - ? $this->map_settings |
|
347 | - : new EE_Map_Config(); |
|
348 | - $this->map_settings = apply_filters( |
|
349 | - 'FHEE__EE_Config___initialize_config__map_settings', |
|
350 | - $this->map_settings |
|
351 | - ); |
|
352 | - $this->environment = $this->environment instanceof EE_Environment_Config |
|
353 | - ? $this->environment |
|
354 | - : new EE_Environment_Config(); |
|
355 | - $this->environment = apply_filters( |
|
356 | - 'FHEE__EE_Config___initialize_config__environment', |
|
357 | - $this->environment |
|
358 | - ); |
|
359 | - $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config |
|
360 | - ? $this->tax_settings |
|
361 | - : new EE_Tax_Config(); |
|
362 | - $this->tax_settings = apply_filters( |
|
363 | - 'FHEE__EE_Config___initialize_config__tax_settings', |
|
364 | - $this->tax_settings |
|
365 | - ); |
|
366 | - $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages); |
|
367 | - $this->messages = $this->messages instanceof EE_Messages_Config |
|
368 | - ? $this->messages |
|
369 | - : new EE_Messages_Config(); |
|
370 | - $this->gateway = $this->gateway instanceof EE_Gateway_Config |
|
371 | - ? $this->gateway |
|
372 | - : new EE_Gateway_Config(); |
|
373 | - $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway); |
|
374 | - $this->legacy_shortcodes_manager = null; |
|
375 | - } |
|
376 | - |
|
377 | - |
|
378 | - /** |
|
379 | - * get_espresso_config |
|
380 | - * |
|
381 | - * @access public |
|
382 | - * @return array of espresso config stuff |
|
383 | - */ |
|
384 | - public function get_espresso_config() |
|
385 | - { |
|
386 | - // grab espresso configuration |
|
387 | - return apply_filters( |
|
388 | - 'FHEE__EE_Config__get_espresso_config__CFG', |
|
389 | - get_option(EE_Config::OPTION_NAME, array()) |
|
390 | - ); |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * double_check_config_comparison |
|
396 | - * |
|
397 | - * @access public |
|
398 | - * @param string $option |
|
399 | - * @param $old_value |
|
400 | - * @param $value |
|
401 | - */ |
|
402 | - public function double_check_config_comparison($option = '', $old_value, $value) |
|
403 | - { |
|
404 | - // make sure we're checking the ee config |
|
405 | - if ($option === EE_Config::OPTION_NAME) { |
|
406 | - // run a loose comparison of the old value against the new value for type and properties, |
|
407 | - // but NOT exact instance like WP update_option does (ie: NOT type safe comparison) |
|
408 | - if ($value != $old_value) { |
|
409 | - // if they are NOT the same, then remove the hook, |
|
410 | - // which means the subsequent update results will be based solely on the update query results |
|
411 | - // the reason we do this is because, as stated above, |
|
412 | - // WP update_option performs an exact instance comparison (===) on any update values passed to it |
|
413 | - // this happens PRIOR to serialization and any subsequent update. |
|
414 | - // If values are found to match their previous old value, |
|
415 | - // then WP bails before performing any update. |
|
416 | - // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version |
|
417 | - // it just pulled from the db, with the one being passed to it (which will not match). |
|
418 | - // HOWEVER, once the object is serialized and passed off to MySQL to update, |
|
419 | - // MySQL MAY ALSO NOT perform the update because |
|
420 | - // the string it sees in the db looks the same as the new one it has been passed!!! |
|
421 | - // This results in the query returning an "affected rows" value of ZERO, |
|
422 | - // which gets returned immediately by WP update_option and looks like an error. |
|
423 | - remove_action('update_option', array($this, 'check_config_updated')); |
|
424 | - } |
|
425 | - } |
|
426 | - } |
|
427 | - |
|
428 | - |
|
429 | - /** |
|
430 | - * update_espresso_config |
|
431 | - * |
|
432 | - * @access public |
|
433 | - */ |
|
434 | - protected function _reset_espresso_addon_config() |
|
435 | - { |
|
436 | - $this->_addon_option_names = array(); |
|
437 | - foreach ($this->addons as $addon_name => $addon_config_obj) { |
|
438 | - $addon_config_obj = maybe_unserialize($addon_config_obj); |
|
439 | - if ($addon_config_obj instanceof EE_Config_Base) { |
|
440 | - $this->update_config('addons', $addon_name, $addon_config_obj, false); |
|
441 | - } |
|
442 | - $this->addons->{$addon_name} = null; |
|
443 | - } |
|
444 | - } |
|
445 | - |
|
446 | - |
|
447 | - /** |
|
448 | - * update_espresso_config |
|
449 | - * |
|
450 | - * @access public |
|
451 | - * @param bool $add_success |
|
452 | - * @param bool $add_error |
|
453 | - * @return bool |
|
454 | - */ |
|
455 | - public function update_espresso_config($add_success = false, $add_error = true) |
|
456 | - { |
|
457 | - // don't allow config updates during WP heartbeats |
|
458 | - if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
459 | - return false; |
|
460 | - } |
|
461 | - // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197 |
|
462 | - // $clone = clone( self::$_instance ); |
|
463 | - // self::$_instance = NULL; |
|
464 | - do_action('AHEE__EE_Config__update_espresso_config__begin', $this); |
|
465 | - $this->_reset_espresso_addon_config(); |
|
466 | - // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional |
|
467 | - // but BEFORE the actual update occurs |
|
468 | - add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3); |
|
469 | - // don't want to persist legacy_shortcodes_manager, but don't want to lose it either |
|
470 | - $legacy_shortcodes_manager = $this->legacy_shortcodes_manager; |
|
471 | - $this->legacy_shortcodes_manager = null; |
|
472 | - // now update "ee_config" |
|
473 | - $saved = update_option(EE_Config::OPTION_NAME, $this); |
|
474 | - $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
475 | - EE_Config::log(EE_Config::OPTION_NAME); |
|
476 | - // if not saved... check if the hook we just added still exists; |
|
477 | - // if it does, it means one of two things: |
|
478 | - // that update_option bailed at the($value === $old_value) conditional, |
|
479 | - // or... |
|
480 | - // the db update query returned 0 rows affected |
|
481 | - // (probably because the data value was the same from it's perspective) |
|
482 | - // so the existence of the hook means that a negative result from update_option is NOT an error, |
|
483 | - // but just means no update occurred, so don't display an error to the user. |
|
484 | - // BUT... if update_option returns FALSE, AND the hook is missing, |
|
485 | - // then it means that something truly went wrong |
|
486 | - $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved; |
|
487 | - // remove our action since we don't want it in the system anymore |
|
488 | - remove_action('update_option', array($this, 'double_check_config_comparison'), 1); |
|
489 | - do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved); |
|
490 | - // self::$_instance = $clone; |
|
491 | - // unset( $clone ); |
|
492 | - // if config remains the same or was updated successfully |
|
493 | - if ($saved) { |
|
494 | - if ($add_success) { |
|
495 | - EE_Error::add_success( |
|
496 | - __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'), |
|
497 | - __FILE__, |
|
498 | - __FUNCTION__, |
|
499 | - __LINE__ |
|
500 | - ); |
|
501 | - } |
|
502 | - return true; |
|
503 | - } else { |
|
504 | - if ($add_error) { |
|
505 | - EE_Error::add_error( |
|
506 | - __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'), |
|
507 | - __FILE__, |
|
508 | - __FUNCTION__, |
|
509 | - __LINE__ |
|
510 | - ); |
|
511 | - } |
|
512 | - return false; |
|
513 | - } |
|
514 | - } |
|
515 | - |
|
516 | - |
|
517 | - /** |
|
518 | - * _verify_config_params |
|
519 | - * |
|
520 | - * @access private |
|
521 | - * @param string $section |
|
522 | - * @param string $name |
|
523 | - * @param string $config_class |
|
524 | - * @param EE_Config_Base $config_obj |
|
525 | - * @param array $tests_to_run |
|
526 | - * @param bool $display_errors |
|
527 | - * @return bool TRUE on success, FALSE on fail |
|
528 | - */ |
|
529 | - private function _verify_config_params( |
|
530 | - $section = '', |
|
531 | - $name = '', |
|
532 | - $config_class = '', |
|
533 | - $config_obj = null, |
|
534 | - $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8), |
|
535 | - $display_errors = true |
|
536 | - ) { |
|
537 | - try { |
|
538 | - foreach ($tests_to_run as $test) { |
|
539 | - switch ($test) { |
|
540 | - // TEST #1 : check that section was set |
|
541 | - case 1: |
|
542 | - if (empty($section)) { |
|
543 | - if ($display_errors) { |
|
544 | - throw new EE_Error( |
|
545 | - sprintf( |
|
546 | - __( |
|
547 | - 'No configuration section has been provided while attempting to save "%s".', |
|
548 | - 'event_espresso' |
|
549 | - ), |
|
550 | - $config_class |
|
551 | - ) |
|
552 | - ); |
|
553 | - } |
|
554 | - return false; |
|
555 | - } |
|
556 | - break; |
|
557 | - // TEST #2 : check that settings section exists |
|
558 | - case 2: |
|
559 | - if (! isset($this->{$section})) { |
|
560 | - if ($display_errors) { |
|
561 | - throw new EE_Error( |
|
562 | - sprintf( |
|
563 | - __('The "%s" configuration section does not exist.', 'event_espresso'), |
|
564 | - $section |
|
565 | - ) |
|
566 | - ); |
|
567 | - } |
|
568 | - return false; |
|
569 | - } |
|
570 | - break; |
|
571 | - // TEST #3 : check that section is the proper format |
|
572 | - case 3: |
|
573 | - if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass) |
|
574 | - ) { |
|
575 | - if ($display_errors) { |
|
576 | - throw new EE_Error( |
|
577 | - sprintf( |
|
578 | - __( |
|
579 | - 'The "%s" configuration settings have not been formatted correctly.', |
|
580 | - 'event_espresso' |
|
581 | - ), |
|
582 | - $section |
|
583 | - ) |
|
584 | - ); |
|
585 | - } |
|
586 | - return false; |
|
587 | - } |
|
588 | - break; |
|
589 | - // TEST #4 : check that config section name has been set |
|
590 | - case 4: |
|
591 | - if (empty($name)) { |
|
592 | - if ($display_errors) { |
|
593 | - throw new EE_Error( |
|
594 | - __( |
|
595 | - 'No name has been provided for the specific configuration section.', |
|
596 | - 'event_espresso' |
|
597 | - ) |
|
598 | - ); |
|
599 | - } |
|
600 | - return false; |
|
601 | - } |
|
602 | - break; |
|
603 | - // TEST #5 : check that a config class name has been set |
|
604 | - case 5: |
|
605 | - if (empty($config_class)) { |
|
606 | - if ($display_errors) { |
|
607 | - throw new EE_Error( |
|
608 | - __( |
|
609 | - 'No class name has been provided for the specific configuration section.', |
|
610 | - 'event_espresso' |
|
611 | - ) |
|
612 | - ); |
|
613 | - } |
|
614 | - return false; |
|
615 | - } |
|
616 | - break; |
|
617 | - // TEST #6 : verify config class is accessible |
|
618 | - case 6: |
|
619 | - if (! class_exists($config_class)) { |
|
620 | - if ($display_errors) { |
|
621 | - throw new EE_Error( |
|
622 | - sprintf( |
|
623 | - __( |
|
624 | - 'The "%s" class does not exist. Please ensure that an autoloader has been set for it.', |
|
625 | - 'event_espresso' |
|
626 | - ), |
|
627 | - $config_class |
|
628 | - ) |
|
629 | - ); |
|
630 | - } |
|
631 | - return false; |
|
632 | - } |
|
633 | - break; |
|
634 | - // TEST #7 : check that config has even been set |
|
635 | - case 7: |
|
636 | - if (! isset($this->{$section}->{$name})) { |
|
637 | - if ($display_errors) { |
|
638 | - throw new EE_Error( |
|
639 | - sprintf( |
|
640 | - __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'), |
|
641 | - $section, |
|
642 | - $name |
|
643 | - ) |
|
644 | - ); |
|
645 | - } |
|
646 | - return false; |
|
647 | - } else { |
|
648 | - // and make sure it's not serialized |
|
649 | - $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name}); |
|
650 | - } |
|
651 | - break; |
|
652 | - // TEST #8 : check that config is the requested type |
|
653 | - case 8: |
|
654 | - if (! $this->{$section}->{$name} instanceof $config_class) { |
|
655 | - if ($display_errors) { |
|
656 | - throw new EE_Error( |
|
657 | - sprintf( |
|
658 | - __( |
|
659 | - 'The configuration for "%1$s->%2$s" is not of the "%3$s" class.', |
|
660 | - 'event_espresso' |
|
661 | - ), |
|
662 | - $section, |
|
663 | - $name, |
|
664 | - $config_class |
|
665 | - ) |
|
666 | - ); |
|
667 | - } |
|
668 | - return false; |
|
669 | - } |
|
670 | - break; |
|
671 | - // TEST #9 : verify config object |
|
672 | - case 9: |
|
673 | - if (! $config_obj instanceof EE_Config_Base) { |
|
674 | - if ($display_errors) { |
|
675 | - throw new EE_Error( |
|
676 | - sprintf( |
|
677 | - __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'), |
|
678 | - print_r($config_obj, true) |
|
679 | - ) |
|
680 | - ); |
|
681 | - } |
|
682 | - return false; |
|
683 | - } |
|
684 | - break; |
|
685 | - } |
|
686 | - } |
|
687 | - } catch (EE_Error $e) { |
|
688 | - $e->get_error(); |
|
689 | - } |
|
690 | - // you have successfully run the gauntlet |
|
691 | - return true; |
|
692 | - } |
|
693 | - |
|
694 | - |
|
695 | - /** |
|
696 | - * _generate_config_option_name |
|
697 | - * |
|
698 | - * @access protected |
|
699 | - * @param string $section |
|
700 | - * @param string $name |
|
701 | - * @return string |
|
702 | - */ |
|
703 | - private function _generate_config_option_name($section = '', $name = '') |
|
704 | - { |
|
705 | - return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name)); |
|
706 | - } |
|
707 | - |
|
708 | - |
|
709 | - /** |
|
710 | - * _set_config_class |
|
711 | - * ensures that a config class is set, either from a passed config class or one generated from the config name |
|
712 | - * |
|
713 | - * @access private |
|
714 | - * @param string $config_class |
|
715 | - * @param string $name |
|
716 | - * @return string |
|
717 | - */ |
|
718 | - private function _set_config_class($config_class = '', $name = '') |
|
719 | - { |
|
720 | - return ! empty($config_class) |
|
721 | - ? $config_class |
|
722 | - : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config'; |
|
723 | - } |
|
724 | - |
|
725 | - |
|
726 | - /** |
|
727 | - * set_config |
|
728 | - * |
|
729 | - * @access protected |
|
730 | - * @param string $section |
|
731 | - * @param string $name |
|
732 | - * @param string $config_class |
|
733 | - * @param EE_Config_Base $config_obj |
|
734 | - * @return EE_Config_Base |
|
735 | - */ |
|
736 | - public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null) |
|
737 | - { |
|
738 | - // ensure config class is set to something |
|
739 | - $config_class = $this->_set_config_class($config_class, $name); |
|
740 | - // run tests 1-4, 6, and 7 to verify all config params are set and valid |
|
741 | - if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
742 | - return null; |
|
743 | - } |
|
744 | - $config_option_name = $this->_generate_config_option_name($section, $name); |
|
745 | - // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now |
|
746 | - if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
747 | - $this->_addon_option_names[ $config_option_name ] = $config_class; |
|
748 | - $this->update_addon_option_names(); |
|
749 | - } |
|
750 | - // verify the incoming config object but suppress errors |
|
751 | - if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
752 | - $config_obj = new $config_class(); |
|
753 | - } |
|
754 | - if (get_option($config_option_name)) { |
|
755 | - EE_Config::log($config_option_name); |
|
756 | - update_option($config_option_name, $config_obj); |
|
757 | - $this->{$section}->{$name} = $config_obj; |
|
758 | - return $this->{$section}->{$name}; |
|
759 | - } else { |
|
760 | - // create a wp-option for this config |
|
761 | - if (add_option($config_option_name, $config_obj, '', 'no')) { |
|
762 | - $this->{$section}->{$name} = maybe_unserialize($config_obj); |
|
763 | - return $this->{$section}->{$name}; |
|
764 | - } else { |
|
765 | - EE_Error::add_error( |
|
766 | - sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class), |
|
767 | - __FILE__, |
|
768 | - __FUNCTION__, |
|
769 | - __LINE__ |
|
770 | - ); |
|
771 | - return null; |
|
772 | - } |
|
773 | - } |
|
774 | - } |
|
775 | - |
|
776 | - |
|
777 | - /** |
|
778 | - * update_config |
|
779 | - * Important: the config object must ALREADY be set, otherwise this will produce an error. |
|
780 | - * |
|
781 | - * @access public |
|
782 | - * @param string $section |
|
783 | - * @param string $name |
|
784 | - * @param EE_Config_Base|string $config_obj |
|
785 | - * @param bool $throw_errors |
|
786 | - * @return bool |
|
787 | - */ |
|
788 | - public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true) |
|
789 | - { |
|
790 | - // don't allow config updates during WP heartbeats |
|
791 | - if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
792 | - return false; |
|
793 | - } |
|
794 | - $config_obj = maybe_unserialize($config_obj); |
|
795 | - // get class name of the incoming object |
|
796 | - $config_class = get_class($config_obj); |
|
797 | - // run tests 1-5 and 9 to verify config |
|
798 | - if (! $this->_verify_config_params( |
|
799 | - $section, |
|
800 | - $name, |
|
801 | - $config_class, |
|
802 | - $config_obj, |
|
803 | - array(1, 2, 3, 4, 7, 9) |
|
804 | - ) |
|
805 | - ) { |
|
806 | - return false; |
|
807 | - } |
|
808 | - $config_option_name = $this->_generate_config_option_name($section, $name); |
|
809 | - // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array |
|
810 | - if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
811 | - // save new config to db |
|
812 | - if ($this->set_config($section, $name, $config_class, $config_obj)) { |
|
813 | - return true; |
|
814 | - } |
|
815 | - } else { |
|
816 | - // first check if the record already exists |
|
817 | - $existing_config = get_option($config_option_name); |
|
818 | - $config_obj = serialize($config_obj); |
|
819 | - // just return if db record is already up to date (NOT type safe comparison) |
|
820 | - if ($existing_config == $config_obj) { |
|
821 | - $this->{$section}->{$name} = $config_obj; |
|
822 | - return true; |
|
823 | - } elseif (update_option($config_option_name, $config_obj)) { |
|
824 | - EE_Config::log($config_option_name); |
|
825 | - // update wp-option for this config class |
|
826 | - $this->{$section}->{$name} = $config_obj; |
|
827 | - return true; |
|
828 | - } elseif ($throw_errors) { |
|
829 | - EE_Error::add_error( |
|
830 | - sprintf( |
|
831 | - __( |
|
832 | - 'The "%1$s" object stored at"%2$s" was not successfully updated in the database.', |
|
833 | - 'event_espresso' |
|
834 | - ), |
|
835 | - $config_class, |
|
836 | - 'EE_Config->' . $section . '->' . $name |
|
837 | - ), |
|
838 | - __FILE__, |
|
839 | - __FUNCTION__, |
|
840 | - __LINE__ |
|
841 | - ); |
|
842 | - } |
|
843 | - } |
|
844 | - return false; |
|
845 | - } |
|
846 | - |
|
847 | - |
|
848 | - /** |
|
849 | - * get_config |
|
850 | - * |
|
851 | - * @access public |
|
852 | - * @param string $section |
|
853 | - * @param string $name |
|
854 | - * @param string $config_class |
|
855 | - * @return mixed EE_Config_Base | NULL |
|
856 | - */ |
|
857 | - public function get_config($section = '', $name = '', $config_class = '') |
|
858 | - { |
|
859 | - // ensure config class is set to something |
|
860 | - $config_class = $this->_set_config_class($config_class, $name); |
|
861 | - // run tests 1-4, 6 and 7 to verify that all params have been set |
|
862 | - if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
863 | - return null; |
|
864 | - } |
|
865 | - // now test if the requested config object exists, but suppress errors |
|
866 | - if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) { |
|
867 | - // config already exists, so pass it back |
|
868 | - return $this->{$section}->{$name}; |
|
869 | - } |
|
870 | - // load config option from db if it exists |
|
871 | - $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name)); |
|
872 | - // verify the newly retrieved config object, but suppress errors |
|
873 | - if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
874 | - // config is good, so set it and pass it back |
|
875 | - $this->{$section}->{$name} = $config_obj; |
|
876 | - return $this->{$section}->{$name}; |
|
877 | - } |
|
878 | - // oops! $config_obj is not already set and does not exist in the db, so create a new one |
|
879 | - $config_obj = $this->set_config($section, $name, $config_class); |
|
880 | - // verify the newly created config object |
|
881 | - if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) { |
|
882 | - return $this->{$section}->{$name}; |
|
883 | - } else { |
|
884 | - EE_Error::add_error( |
|
885 | - sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class), |
|
886 | - __FILE__, |
|
887 | - __FUNCTION__, |
|
888 | - __LINE__ |
|
889 | - ); |
|
890 | - } |
|
891 | - return null; |
|
892 | - } |
|
893 | - |
|
894 | - |
|
895 | - /** |
|
896 | - * get_config_option |
|
897 | - * |
|
898 | - * @access public |
|
899 | - * @param string $config_option_name |
|
900 | - * @return mixed EE_Config_Base | FALSE |
|
901 | - */ |
|
902 | - public function get_config_option($config_option_name = '') |
|
903 | - { |
|
904 | - // retrieve the wp-option for this config class. |
|
905 | - $config_option = maybe_unserialize(get_option($config_option_name, array())); |
|
906 | - if (empty($config_option)) { |
|
907 | - EE_Config::log($config_option_name . '-NOT-FOUND'); |
|
908 | - } |
|
909 | - return $config_option; |
|
910 | - } |
|
911 | - |
|
912 | - |
|
913 | - /** |
|
914 | - * log |
|
915 | - * |
|
916 | - * @param string $config_option_name |
|
917 | - */ |
|
918 | - public static function log($config_option_name = '') |
|
919 | - { |
|
920 | - if (EE_Config::logging_enabled() && ! empty($config_option_name)) { |
|
921 | - $config_log = get_option(EE_Config::LOG_NAME, array()); |
|
922 | - // copy incoming $_REQUEST and sanitize it so we can save it |
|
923 | - $_request = $_REQUEST; |
|
924 | - array_walk_recursive($_request, 'sanitize_text_field'); |
|
925 | - $config_log[ (string) microtime(true) ] = array( |
|
926 | - 'config_name' => $config_option_name, |
|
927 | - 'request' => $_request, |
|
928 | - ); |
|
929 | - update_option(EE_Config::LOG_NAME, $config_log); |
|
930 | - } |
|
931 | - } |
|
932 | - |
|
933 | - |
|
934 | - /** |
|
935 | - * trim_log |
|
936 | - * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH |
|
937 | - */ |
|
938 | - public static function trim_log() |
|
939 | - { |
|
940 | - if (! EE_Config::logging_enabled()) { |
|
941 | - return; |
|
942 | - } |
|
943 | - $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array())); |
|
944 | - $log_length = count($config_log); |
|
945 | - if ($log_length > EE_Config::LOG_LENGTH) { |
|
946 | - ksort($config_log); |
|
947 | - $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true); |
|
948 | - update_option(EE_Config::LOG_NAME, $config_log); |
|
949 | - } |
|
950 | - } |
|
951 | - |
|
952 | - |
|
953 | - /** |
|
954 | - * get_page_for_posts |
|
955 | - * if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the |
|
956 | - * wp-option "page_for_posts", or "posts" if no page is selected |
|
957 | - * |
|
958 | - * @access public |
|
959 | - * @return string |
|
960 | - */ |
|
961 | - public static function get_page_for_posts() |
|
962 | - { |
|
963 | - $page_for_posts = get_option('page_for_posts'); |
|
964 | - if (! $page_for_posts) { |
|
965 | - return 'posts'; |
|
966 | - } |
|
967 | - /** @type WPDB $wpdb */ |
|
968 | - global $wpdb; |
|
969 | - $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d"; |
|
970 | - return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts)); |
|
971 | - } |
|
972 | - |
|
973 | - |
|
974 | - /** |
|
975 | - * register_shortcodes_and_modules. |
|
976 | - * At this point, it's too early to tell if we're maintenance mode or not. |
|
977 | - * In fact, this is where we give modules a chance to let core know they exist |
|
978 | - * so they can help trigger maintenance mode if it's needed |
|
979 | - * |
|
980 | - * @access public |
|
981 | - * @return void |
|
982 | - */ |
|
983 | - public function register_shortcodes_and_modules() |
|
984 | - { |
|
985 | - // allow modules to set hooks for the rest of the system |
|
986 | - EE_Registry::instance()->modules = $this->_register_modules(); |
|
987 | - } |
|
988 | - |
|
989 | - |
|
990 | - /** |
|
991 | - * initialize_shortcodes_and_modules |
|
992 | - * meaning they can start adding their hooks to get stuff done |
|
993 | - * |
|
994 | - * @access public |
|
995 | - * @return void |
|
996 | - */ |
|
997 | - public function initialize_shortcodes_and_modules() |
|
998 | - { |
|
999 | - // allow modules to set hooks for the rest of the system |
|
1000 | - $this->_initialize_modules(); |
|
1001 | - } |
|
1002 | - |
|
1003 | - |
|
1004 | - /** |
|
1005 | - * widgets_init |
|
1006 | - * |
|
1007 | - * @access private |
|
1008 | - * @return void |
|
1009 | - */ |
|
1010 | - public function widgets_init() |
|
1011 | - { |
|
1012 | - // only init widgets on admin pages when not in complete maintenance, and |
|
1013 | - // on frontend when not in any maintenance mode |
|
1014 | - if (! EE_Maintenance_Mode::instance()->level() |
|
1015 | - || ( |
|
1016 | - is_admin() |
|
1017 | - && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance |
|
1018 | - ) |
|
1019 | - ) { |
|
1020 | - // grab list of installed widgets |
|
1021 | - $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR); |
|
1022 | - // filter list of modules to register |
|
1023 | - $widgets_to_register = apply_filters( |
|
1024 | - 'FHEE__EE_Config__register_widgets__widgets_to_register', |
|
1025 | - $widgets_to_register |
|
1026 | - ); |
|
1027 | - if (! empty($widgets_to_register)) { |
|
1028 | - // cycle thru widget folders |
|
1029 | - foreach ($widgets_to_register as $widget_path) { |
|
1030 | - // add to list of installed widget modules |
|
1031 | - EE_Config::register_ee_widget($widget_path); |
|
1032 | - } |
|
1033 | - } |
|
1034 | - // filter list of installed modules |
|
1035 | - EE_Registry::instance()->widgets = apply_filters( |
|
1036 | - 'FHEE__EE_Config__register_widgets__installed_widgets', |
|
1037 | - EE_Registry::instance()->widgets |
|
1038 | - ); |
|
1039 | - } |
|
1040 | - } |
|
1041 | - |
|
1042 | - |
|
1043 | - /** |
|
1044 | - * register_ee_widget - makes core aware of this widget |
|
1045 | - * |
|
1046 | - * @access public |
|
1047 | - * @param string $widget_path - full path up to and including widget folder |
|
1048 | - * @return void |
|
1049 | - */ |
|
1050 | - public static function register_ee_widget($widget_path = null) |
|
1051 | - { |
|
1052 | - do_action('AHEE__EE_Config__register_widget__begin', $widget_path); |
|
1053 | - $widget_ext = '.widget.php'; |
|
1054 | - // make all separators match |
|
1055 | - $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS); |
|
1056 | - // does the file path INCLUDE the actual file name as part of the path ? |
|
1057 | - if (strpos($widget_path, $widget_ext) !== false) { |
|
1058 | - // grab and shortcode file name from directory name and break apart at dots |
|
1059 | - $file_name = explode('.', basename($widget_path)); |
|
1060 | - // take first segment from file name pieces and remove class prefix if it exists |
|
1061 | - $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0]; |
|
1062 | - // sanitize shortcode directory name |
|
1063 | - $widget = sanitize_key($widget); |
|
1064 | - // now we need to rebuild the shortcode path |
|
1065 | - $widget_path = explode('/', $widget_path); |
|
1066 | - // remove last segment |
|
1067 | - array_pop($widget_path); |
|
1068 | - // glue it back together |
|
1069 | - $widget_path = implode(DS, $widget_path); |
|
1070 | - } else { |
|
1071 | - // grab and sanitize widget directory name |
|
1072 | - $widget = sanitize_key(basename($widget_path)); |
|
1073 | - } |
|
1074 | - // create classname from widget directory name |
|
1075 | - $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget))); |
|
1076 | - // add class prefix |
|
1077 | - $widget_class = 'EEW_' . $widget; |
|
1078 | - // does the widget exist ? |
|
1079 | - if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) { |
|
1080 | - $msg = sprintf( |
|
1081 | - __( |
|
1082 | - 'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', |
|
1083 | - 'event_espresso' |
|
1084 | - ), |
|
1085 | - $widget_class, |
|
1086 | - $widget_path . '/' . $widget_class . $widget_ext |
|
1087 | - ); |
|
1088 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1089 | - return; |
|
1090 | - } |
|
1091 | - // load the widget class file |
|
1092 | - require_once($widget_path . '/' . $widget_class . $widget_ext); |
|
1093 | - // verify that class exists |
|
1094 | - if (! class_exists($widget_class)) { |
|
1095 | - $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class); |
|
1096 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1097 | - return; |
|
1098 | - } |
|
1099 | - register_widget($widget_class); |
|
1100 | - // add to array of registered widgets |
|
1101 | - EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext; |
|
1102 | - } |
|
1103 | - |
|
1104 | - |
|
1105 | - /** |
|
1106 | - * _register_modules |
|
1107 | - * |
|
1108 | - * @access private |
|
1109 | - * @return array |
|
1110 | - */ |
|
1111 | - private function _register_modules() |
|
1112 | - { |
|
1113 | - // grab list of installed modules |
|
1114 | - $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR); |
|
1115 | - // filter list of modules to register |
|
1116 | - $modules_to_register = apply_filters( |
|
1117 | - 'FHEE__EE_Config__register_modules__modules_to_register', |
|
1118 | - $modules_to_register |
|
1119 | - ); |
|
1120 | - if (! empty($modules_to_register)) { |
|
1121 | - // loop through folders |
|
1122 | - foreach ($modules_to_register as $module_path) { |
|
1123 | - /**TEMPORARILY EXCLUDE gateways from modules for time being**/ |
|
1124 | - if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template' |
|
1125 | - && $module_path !== EE_MODULES . 'gateways' |
|
1126 | - ) { |
|
1127 | - // add to list of installed modules |
|
1128 | - EE_Config::register_module($module_path); |
|
1129 | - } |
|
1130 | - } |
|
1131 | - } |
|
1132 | - // filter list of installed modules |
|
1133 | - return apply_filters( |
|
1134 | - 'FHEE__EE_Config___register_modules__installed_modules', |
|
1135 | - EE_Registry::instance()->modules |
|
1136 | - ); |
|
1137 | - } |
|
1138 | - |
|
1139 | - |
|
1140 | - /** |
|
1141 | - * register_module - makes core aware of this module |
|
1142 | - * |
|
1143 | - * @access public |
|
1144 | - * @param string $module_path - full path up to and including module folder |
|
1145 | - * @return bool |
|
1146 | - */ |
|
1147 | - public static function register_module($module_path = null) |
|
1148 | - { |
|
1149 | - do_action('AHEE__EE_Config__register_module__begin', $module_path); |
|
1150 | - $module_ext = '.module.php'; |
|
1151 | - // make all separators match |
|
1152 | - $module_path = str_replace(array('\\', '/'), '/', $module_path); |
|
1153 | - // does the file path INCLUDE the actual file name as part of the path ? |
|
1154 | - if (strpos($module_path, $module_ext) !== false) { |
|
1155 | - // grab and shortcode file name from directory name and break apart at dots |
|
1156 | - $module_file = explode('.', basename($module_path)); |
|
1157 | - // now we need to rebuild the shortcode path |
|
1158 | - $module_path = explode('/', $module_path); |
|
1159 | - // remove last segment |
|
1160 | - array_pop($module_path); |
|
1161 | - // glue it back together |
|
1162 | - $module_path = implode('/', $module_path) . '/'; |
|
1163 | - // take first segment from file name pieces and sanitize it |
|
1164 | - $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]); |
|
1165 | - // ensure class prefix is added |
|
1166 | - $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module; |
|
1167 | - } else { |
|
1168 | - // we need to generate the filename based off of the folder name |
|
1169 | - // grab and sanitize module name |
|
1170 | - $module = strtolower(basename($module_path)); |
|
1171 | - $module = preg_replace('/[^a-z0-9_\-]/', '', $module); |
|
1172 | - // like trailingslashit() |
|
1173 | - $module_path = rtrim($module_path, '/') . '/'; |
|
1174 | - // create classname from module directory name |
|
1175 | - $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module))); |
|
1176 | - // add class prefix |
|
1177 | - $module_class = 'EED_' . $module; |
|
1178 | - } |
|
1179 | - // does the module exist ? |
|
1180 | - if (! is_readable($module_path . '/' . $module_class . $module_ext)) { |
|
1181 | - $msg = sprintf( |
|
1182 | - __( |
|
1183 | - 'The requested %s module file could not be found or is not readable due to file permissions.', |
|
1184 | - 'event_espresso' |
|
1185 | - ), |
|
1186 | - $module |
|
1187 | - ); |
|
1188 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1189 | - return false; |
|
1190 | - } |
|
1191 | - // load the module class file |
|
1192 | - require_once($module_path . $module_class . $module_ext); |
|
1193 | - // verify that class exists |
|
1194 | - if (! class_exists($module_class)) { |
|
1195 | - $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class); |
|
1196 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1197 | - return false; |
|
1198 | - } |
|
1199 | - // add to array of registered modules |
|
1200 | - EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext; |
|
1201 | - do_action( |
|
1202 | - 'AHEE__EE_Config__register_module__complete', |
|
1203 | - $module_class, |
|
1204 | - EE_Registry::instance()->modules->{$module_class} |
|
1205 | - ); |
|
1206 | - return true; |
|
1207 | - } |
|
1208 | - |
|
1209 | - |
|
1210 | - /** |
|
1211 | - * _initialize_modules |
|
1212 | - * allow modules to set hooks for the rest of the system |
|
1213 | - * |
|
1214 | - * @access private |
|
1215 | - * @return void |
|
1216 | - */ |
|
1217 | - private function _initialize_modules() |
|
1218 | - { |
|
1219 | - // cycle thru shortcode folders |
|
1220 | - foreach (EE_Registry::instance()->modules as $module_class => $module_path) { |
|
1221 | - // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system |
|
1222 | - // which set hooks ? |
|
1223 | - if (is_admin()) { |
|
1224 | - // fire immediately |
|
1225 | - call_user_func(array($module_class, 'set_hooks_admin')); |
|
1226 | - } else { |
|
1227 | - // delay until other systems are online |
|
1228 | - add_action( |
|
1229 | - 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', |
|
1230 | - array($module_class, 'set_hooks') |
|
1231 | - ); |
|
1232 | - } |
|
1233 | - } |
|
1234 | - } |
|
1235 | - |
|
1236 | - |
|
1237 | - /** |
|
1238 | - * register_route - adds module method routes to route_map |
|
1239 | - * |
|
1240 | - * @access public |
|
1241 | - * @param string $route - "pretty" public alias for module method |
|
1242 | - * @param string $module - module name (classname without EED_ prefix) |
|
1243 | - * @param string $method_name - the actual module method to be routed to |
|
1244 | - * @param string $key - url param key indicating a route is being called |
|
1245 | - * @return bool |
|
1246 | - */ |
|
1247 | - public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee') |
|
1248 | - { |
|
1249 | - do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name); |
|
1250 | - $module = str_replace('EED_', '', $module); |
|
1251 | - $module_class = 'EED_' . $module; |
|
1252 | - if (! isset(EE_Registry::instance()->modules->{$module_class})) { |
|
1253 | - $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module); |
|
1254 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1255 | - return false; |
|
1256 | - } |
|
1257 | - if (empty($route)) { |
|
1258 | - $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route); |
|
1259 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1260 | - return false; |
|
1261 | - } |
|
1262 | - if (! method_exists('EED_' . $module, $method_name)) { |
|
1263 | - $msg = sprintf( |
|
1264 | - __('A valid class method for the %s route has not been supplied.', 'event_espresso'), |
|
1265 | - $route |
|
1266 | - ); |
|
1267 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1268 | - return false; |
|
1269 | - } |
|
1270 | - EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name); |
|
1271 | - return true; |
|
1272 | - } |
|
1273 | - |
|
1274 | - |
|
1275 | - /** |
|
1276 | - * get_route - get module method route |
|
1277 | - * |
|
1278 | - * @access public |
|
1279 | - * @param string $route - "pretty" public alias for module method |
|
1280 | - * @param string $key - url param key indicating a route is being called |
|
1281 | - * @return string |
|
1282 | - */ |
|
1283 | - public static function get_route($route = null, $key = 'ee') |
|
1284 | - { |
|
1285 | - do_action('AHEE__EE_Config__get_route__begin', $route); |
|
1286 | - $route = (string) apply_filters('FHEE__EE_Config__get_route', $route); |
|
1287 | - if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) { |
|
1288 | - return EE_Config::$_module_route_map[ $key ][ $route ]; |
|
1289 | - } |
|
1290 | - return null; |
|
1291 | - } |
|
1292 | - |
|
1293 | - |
|
1294 | - /** |
|
1295 | - * get_routes - get ALL module method routes |
|
1296 | - * |
|
1297 | - * @access public |
|
1298 | - * @return array |
|
1299 | - */ |
|
1300 | - public static function get_routes() |
|
1301 | - { |
|
1302 | - return EE_Config::$_module_route_map; |
|
1303 | - } |
|
1304 | - |
|
1305 | - |
|
1306 | - /** |
|
1307 | - * register_forward - allows modules to forward request to another module for further processing |
|
1308 | - * |
|
1309 | - * @access public |
|
1310 | - * @param string $route - "pretty" public alias for module method |
|
1311 | - * @param integer $status - integer value corresponding to status constant strings set in module parent |
|
1312 | - * class, allows different forwards to be served based on status |
|
1313 | - * @param array|string $forward - function name or array( class, method ) |
|
1314 | - * @param string $key - url param key indicating a route is being called |
|
1315 | - * @return bool |
|
1316 | - */ |
|
1317 | - public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee') |
|
1318 | - { |
|
1319 | - do_action('AHEE__EE_Config__register_forward', $route, $status, $forward); |
|
1320 | - if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
1321 | - $msg = sprintf( |
|
1322 | - __('The module route %s for this forward has not been registered.', 'event_espresso'), |
|
1323 | - $route |
|
1324 | - ); |
|
1325 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1326 | - return false; |
|
1327 | - } |
|
1328 | - if (empty($forward)) { |
|
1329 | - $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route); |
|
1330 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1331 | - return false; |
|
1332 | - } |
|
1333 | - if (is_array($forward)) { |
|
1334 | - if (! isset($forward[1])) { |
|
1335 | - $msg = sprintf( |
|
1336 | - __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'), |
|
1337 | - $route |
|
1338 | - ); |
|
1339 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1340 | - return false; |
|
1341 | - } |
|
1342 | - if (! method_exists($forward[0], $forward[1])) { |
|
1343 | - $msg = sprintf( |
|
1344 | - __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
1345 | - $forward[1], |
|
1346 | - $route |
|
1347 | - ); |
|
1348 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1349 | - return false; |
|
1350 | - } |
|
1351 | - } elseif (! function_exists($forward)) { |
|
1352 | - $msg = sprintf( |
|
1353 | - __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
1354 | - $forward, |
|
1355 | - $route |
|
1356 | - ); |
|
1357 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1358 | - return false; |
|
1359 | - } |
|
1360 | - EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward; |
|
1361 | - return true; |
|
1362 | - } |
|
1363 | - |
|
1364 | - |
|
1365 | - /** |
|
1366 | - * get_forward - get forwarding route |
|
1367 | - * |
|
1368 | - * @access public |
|
1369 | - * @param string $route - "pretty" public alias for module method |
|
1370 | - * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
1371 | - * allows different forwards to be served based on status |
|
1372 | - * @param string $key - url param key indicating a route is being called |
|
1373 | - * @return string |
|
1374 | - */ |
|
1375 | - public static function get_forward($route = null, $status = 0, $key = 'ee') |
|
1376 | - { |
|
1377 | - do_action('AHEE__EE_Config__get_forward__begin', $route, $status); |
|
1378 | - if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) { |
|
1379 | - return apply_filters( |
|
1380 | - 'FHEE__EE_Config__get_forward', |
|
1381 | - EE_Config::$_module_forward_map[ $key ][ $route ][ $status ], |
|
1382 | - $route, |
|
1383 | - $status |
|
1384 | - ); |
|
1385 | - } |
|
1386 | - return null; |
|
1387 | - } |
|
1388 | - |
|
1389 | - |
|
1390 | - /** |
|
1391 | - * register_forward - allows modules to specify different view templates for different method routes and status |
|
1392 | - * results |
|
1393 | - * |
|
1394 | - * @access public |
|
1395 | - * @param string $route - "pretty" public alias for module method |
|
1396 | - * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
1397 | - * allows different views to be served based on status |
|
1398 | - * @param string $view |
|
1399 | - * @param string $key - url param key indicating a route is being called |
|
1400 | - * @return bool |
|
1401 | - */ |
|
1402 | - public static function register_view($route = null, $status = 0, $view = null, $key = 'ee') |
|
1403 | - { |
|
1404 | - do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view); |
|
1405 | - if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
1406 | - $msg = sprintf( |
|
1407 | - __('The module route %s for this view has not been registered.', 'event_espresso'), |
|
1408 | - $route |
|
1409 | - ); |
|
1410 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1411 | - return false; |
|
1412 | - } |
|
1413 | - if (! is_readable($view)) { |
|
1414 | - $msg = sprintf( |
|
1415 | - __( |
|
1416 | - 'The %s view file could not be found or is not readable due to file permissions.', |
|
1417 | - 'event_espresso' |
|
1418 | - ), |
|
1419 | - $view |
|
1420 | - ); |
|
1421 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1422 | - return false; |
|
1423 | - } |
|
1424 | - EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view; |
|
1425 | - return true; |
|
1426 | - } |
|
1427 | - |
|
1428 | - |
|
1429 | - /** |
|
1430 | - * get_view - get view for route and status |
|
1431 | - * |
|
1432 | - * @access public |
|
1433 | - * @param string $route - "pretty" public alias for module method |
|
1434 | - * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
1435 | - * allows different views to be served based on status |
|
1436 | - * @param string $key - url param key indicating a route is being called |
|
1437 | - * @return string |
|
1438 | - */ |
|
1439 | - public static function get_view($route = null, $status = 0, $key = 'ee') |
|
1440 | - { |
|
1441 | - do_action('AHEE__EE_Config__get_view__begin', $route, $status); |
|
1442 | - if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) { |
|
1443 | - return apply_filters( |
|
1444 | - 'FHEE__EE_Config__get_view', |
|
1445 | - EE_Config::$_module_view_map[ $key ][ $route ][ $status ], |
|
1446 | - $route, |
|
1447 | - $status |
|
1448 | - ); |
|
1449 | - } |
|
1450 | - return null; |
|
1451 | - } |
|
1452 | - |
|
1453 | - |
|
1454 | - public function update_addon_option_names() |
|
1455 | - { |
|
1456 | - update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names); |
|
1457 | - } |
|
1458 | - |
|
1459 | - |
|
1460 | - public function shutdown() |
|
1461 | - { |
|
1462 | - $this->update_addon_option_names(); |
|
1463 | - } |
|
1464 | - |
|
1465 | - |
|
1466 | - /** |
|
1467 | - * @return LegacyShortcodesManager |
|
1468 | - */ |
|
1469 | - public static function getLegacyShortcodesManager() |
|
1470 | - { |
|
1471 | - |
|
1472 | - if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) { |
|
1473 | - EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager( |
|
1474 | - EE_Registry::instance() |
|
1475 | - ); |
|
1476 | - } |
|
1477 | - return EE_Config::instance()->legacy_shortcodes_manager; |
|
1478 | - } |
|
1479 | - |
|
1480 | - |
|
1481 | - /** |
|
1482 | - * register_shortcode - makes core aware of this shortcode |
|
1483 | - * |
|
1484 | - * @deprecated 4.9.26 |
|
1485 | - * @param string $shortcode_path - full path up to and including shortcode folder |
|
1486 | - * @return bool |
|
1487 | - */ |
|
1488 | - public static function register_shortcode($shortcode_path = null) |
|
1489 | - { |
|
1490 | - EE_Error::doing_it_wrong( |
|
1491 | - __METHOD__, |
|
1492 | - __( |
|
1493 | - 'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.', |
|
1494 | - 'event_espresso' |
|
1495 | - ), |
|
1496 | - '4.9.26' |
|
1497 | - ); |
|
1498 | - return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path); |
|
1499 | - } |
|
1500 | -} |
|
1501 | - |
|
1502 | -/** |
|
1503 | - * Base class used for config classes. These classes should generally not have |
|
1504 | - * magic functions in use, except we'll allow them to magically set and get stuff... |
|
1505 | - * basically, they should just be well-defined stdClasses |
|
1506 | - */ |
|
1507 | -class EE_Config_Base |
|
1508 | -{ |
|
1509 | - |
|
1510 | - /** |
|
1511 | - * Utility function for escaping the value of a property and returning. |
|
1512 | - * |
|
1513 | - * @param string $property property name (checks to see if exists). |
|
1514 | - * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
1515 | - * @throws \EE_Error |
|
1516 | - */ |
|
1517 | - public function get_pretty($property) |
|
1518 | - { |
|
1519 | - if (! property_exists($this, $property)) { |
|
1520 | - throw new EE_Error( |
|
1521 | - sprintf( |
|
1522 | - __( |
|
1523 | - '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.', |
|
1524 | - 'event_espresso' |
|
1525 | - ), |
|
1526 | - get_class($this), |
|
1527 | - $property |
|
1528 | - ) |
|
1529 | - ); |
|
1530 | - } |
|
1531 | - // just handling escaping of strings for now. |
|
1532 | - if (is_string($this->{$property})) { |
|
1533 | - return stripslashes($this->{$property}); |
|
1534 | - } |
|
1535 | - return $this->{$property}; |
|
1536 | - } |
|
1537 | - |
|
1538 | - |
|
1539 | - public function populate() |
|
1540 | - { |
|
1541 | - // grab defaults via a new instance of this class. |
|
1542 | - $class_name = get_class($this); |
|
1543 | - $defaults = new $class_name; |
|
1544 | - // loop through the properties for this class and see if they are set. If they are NOT, then grab the |
|
1545 | - // default from our $defaults object. |
|
1546 | - foreach (get_object_vars($defaults) as $property => $value) { |
|
1547 | - if ($this->{$property} === null) { |
|
1548 | - $this->{$property} = $value; |
|
1549 | - } |
|
1550 | - } |
|
1551 | - // cleanup |
|
1552 | - unset($defaults); |
|
1553 | - } |
|
1554 | - |
|
1555 | - |
|
1556 | - /** |
|
1557 | - * __isset |
|
1558 | - * |
|
1559 | - * @param $a |
|
1560 | - * @return bool |
|
1561 | - */ |
|
1562 | - public function __isset($a) |
|
1563 | - { |
|
1564 | - return false; |
|
1565 | - } |
|
1566 | - |
|
1567 | - |
|
1568 | - /** |
|
1569 | - * __unset |
|
1570 | - * |
|
1571 | - * @param $a |
|
1572 | - * @return bool |
|
1573 | - */ |
|
1574 | - public function __unset($a) |
|
1575 | - { |
|
1576 | - return false; |
|
1577 | - } |
|
1578 | - |
|
1579 | - |
|
1580 | - /** |
|
1581 | - * __clone |
|
1582 | - */ |
|
1583 | - public function __clone() |
|
1584 | - { |
|
1585 | - } |
|
1586 | - |
|
1587 | - |
|
1588 | - /** |
|
1589 | - * __wakeup |
|
1590 | - */ |
|
1591 | - public function __wakeup() |
|
1592 | - { |
|
1593 | - } |
|
1594 | - |
|
1595 | - |
|
1596 | - /** |
|
1597 | - * __destruct |
|
1598 | - */ |
|
1599 | - public function __destruct() |
|
1600 | - { |
|
1601 | - } |
|
1602 | -} |
|
1603 | - |
|
1604 | -/** |
|
1605 | - * Class for defining what's in the EE_Config relating to registration settings |
|
1606 | - */ |
|
1607 | -class EE_Core_Config extends EE_Config_Base |
|
1608 | -{ |
|
1609 | - |
|
1610 | - const OPTION_NAME_UXIP = 'ee_ueip_optin'; |
|
1611 | - |
|
1612 | - |
|
1613 | - public $current_blog_id; |
|
1614 | - |
|
1615 | - public $ee_ueip_optin; |
|
1616 | - |
|
1617 | - public $ee_ueip_has_notified; |
|
1618 | - |
|
1619 | - /** |
|
1620 | - * Not to be confused with the 4 critical page variables (See |
|
1621 | - * get_critical_pages_array()), this is just an array of wp posts that have EE |
|
1622 | - * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode |
|
1623 | - * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array. |
|
1624 | - * |
|
1625 | - * @var array |
|
1626 | - */ |
|
1627 | - public $post_shortcodes; |
|
1628 | - |
|
1629 | - public $module_route_map; |
|
1630 | - |
|
1631 | - public $module_forward_map; |
|
1632 | - |
|
1633 | - public $module_view_map; |
|
1634 | - |
|
1635 | - /** |
|
1636 | - * The next 4 vars are the IDs of critical EE pages. |
|
1637 | - * |
|
1638 | - * @var int |
|
1639 | - */ |
|
1640 | - public $reg_page_id; |
|
1641 | - |
|
1642 | - public $txn_page_id; |
|
1643 | - |
|
1644 | - public $thank_you_page_id; |
|
1645 | - |
|
1646 | - public $cancel_page_id; |
|
1647 | - |
|
1648 | - /** |
|
1649 | - * The next 4 vars are the URLs of critical EE pages. |
|
1650 | - * |
|
1651 | - * @var int |
|
1652 | - */ |
|
1653 | - public $reg_page_url; |
|
1654 | - |
|
1655 | - public $txn_page_url; |
|
1656 | - |
|
1657 | - public $thank_you_page_url; |
|
1658 | - |
|
1659 | - public $cancel_page_url; |
|
1660 | - |
|
1661 | - /** |
|
1662 | - * The next vars relate to the custom slugs for EE CPT routes |
|
1663 | - */ |
|
1664 | - public $event_cpt_slug; |
|
1665 | - |
|
1666 | - /** |
|
1667 | - * This caches the _ee_ueip_option in case this config is reset in the same |
|
1668 | - * request across blog switches in a multisite context. |
|
1669 | - * Avoids extra queries to the db for this option. |
|
1670 | - * |
|
1671 | - * @var bool |
|
1672 | - */ |
|
1673 | - public static $ee_ueip_option; |
|
1674 | - |
|
1675 | - |
|
1676 | - /** |
|
1677 | - * class constructor |
|
1678 | - * |
|
1679 | - * @access public |
|
1680 | - */ |
|
1681 | - public function __construct() |
|
1682 | - { |
|
1683 | - // set default organization settings |
|
1684 | - $this->current_blog_id = get_current_blog_id(); |
|
1685 | - $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id; |
|
1686 | - $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin(); |
|
1687 | - $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true; |
|
1688 | - $this->post_shortcodes = array(); |
|
1689 | - $this->module_route_map = array(); |
|
1690 | - $this->module_forward_map = array(); |
|
1691 | - $this->module_view_map = array(); |
|
1692 | - // critical EE page IDs |
|
1693 | - $this->reg_page_id = 0; |
|
1694 | - $this->txn_page_id = 0; |
|
1695 | - $this->thank_you_page_id = 0; |
|
1696 | - $this->cancel_page_id = 0; |
|
1697 | - // critical EE page URLs |
|
1698 | - $this->reg_page_url = ''; |
|
1699 | - $this->txn_page_url = ''; |
|
1700 | - $this->thank_you_page_url = ''; |
|
1701 | - $this->cancel_page_url = ''; |
|
1702 | - // cpt slugs |
|
1703 | - $this->event_cpt_slug = __('events', 'event_espresso'); |
|
1704 | - // ueip constant check |
|
1705 | - if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) { |
|
1706 | - $this->ee_ueip_optin = false; |
|
1707 | - $this->ee_ueip_has_notified = true; |
|
1708 | - } |
|
1709 | - } |
|
1710 | - |
|
1711 | - |
|
1712 | - /** |
|
1713 | - * @return array |
|
1714 | - */ |
|
1715 | - public function get_critical_pages_array() |
|
1716 | - { |
|
1717 | - return array( |
|
1718 | - $this->reg_page_id, |
|
1719 | - $this->txn_page_id, |
|
1720 | - $this->thank_you_page_id, |
|
1721 | - $this->cancel_page_id, |
|
1722 | - ); |
|
1723 | - } |
|
1724 | - |
|
1725 | - |
|
1726 | - /** |
|
1727 | - * @return array |
|
1728 | - */ |
|
1729 | - public function get_critical_pages_shortcodes_array() |
|
1730 | - { |
|
1731 | - return array( |
|
1732 | - $this->reg_page_id => 'ESPRESSO_CHECKOUT', |
|
1733 | - $this->txn_page_id => 'ESPRESSO_TXN_PAGE', |
|
1734 | - $this->thank_you_page_id => 'ESPRESSO_THANK_YOU', |
|
1735 | - $this->cancel_page_id => 'ESPRESSO_CANCELLED', |
|
1736 | - ); |
|
1737 | - } |
|
1738 | - |
|
1739 | - |
|
1740 | - /** |
|
1741 | - * gets/returns URL for EE reg_page |
|
1742 | - * |
|
1743 | - * @access public |
|
1744 | - * @return string |
|
1745 | - */ |
|
1746 | - public function reg_page_url() |
|
1747 | - { |
|
1748 | - if (! $this->reg_page_url) { |
|
1749 | - $this->reg_page_url = add_query_arg( |
|
1750 | - array('uts' => time()), |
|
1751 | - get_permalink($this->reg_page_id) |
|
1752 | - ) . '#checkout'; |
|
1753 | - } |
|
1754 | - return $this->reg_page_url; |
|
1755 | - } |
|
1756 | - |
|
1757 | - |
|
1758 | - /** |
|
1759 | - * gets/returns URL for EE txn_page |
|
1760 | - * |
|
1761 | - * @param array $query_args like what gets passed to |
|
1762 | - * add_query_arg() as the first argument |
|
1763 | - * @access public |
|
1764 | - * @return string |
|
1765 | - */ |
|
1766 | - public function txn_page_url($query_args = array()) |
|
1767 | - { |
|
1768 | - if (! $this->txn_page_url) { |
|
1769 | - $this->txn_page_url = get_permalink($this->txn_page_id); |
|
1770 | - } |
|
1771 | - if ($query_args) { |
|
1772 | - return add_query_arg($query_args, $this->txn_page_url); |
|
1773 | - } else { |
|
1774 | - return $this->txn_page_url; |
|
1775 | - } |
|
1776 | - } |
|
1777 | - |
|
1778 | - |
|
1779 | - /** |
|
1780 | - * gets/returns URL for EE thank_you_page |
|
1781 | - * |
|
1782 | - * @param array $query_args like what gets passed to |
|
1783 | - * add_query_arg() as the first argument |
|
1784 | - * @access public |
|
1785 | - * @return string |
|
1786 | - */ |
|
1787 | - public function thank_you_page_url($query_args = array()) |
|
1788 | - { |
|
1789 | - if (! $this->thank_you_page_url) { |
|
1790 | - $this->thank_you_page_url = get_permalink($this->thank_you_page_id); |
|
1791 | - } |
|
1792 | - if ($query_args) { |
|
1793 | - return add_query_arg($query_args, $this->thank_you_page_url); |
|
1794 | - } else { |
|
1795 | - return $this->thank_you_page_url; |
|
1796 | - } |
|
1797 | - } |
|
1798 | - |
|
1799 | - |
|
1800 | - /** |
|
1801 | - * gets/returns URL for EE cancel_page |
|
1802 | - * |
|
1803 | - * @access public |
|
1804 | - * @return string |
|
1805 | - */ |
|
1806 | - public function cancel_page_url() |
|
1807 | - { |
|
1808 | - if (! $this->cancel_page_url) { |
|
1809 | - $this->cancel_page_url = get_permalink($this->cancel_page_id); |
|
1810 | - } |
|
1811 | - return $this->cancel_page_url; |
|
1812 | - } |
|
1813 | - |
|
1814 | - |
|
1815 | - /** |
|
1816 | - * Resets all critical page urls to their original state. Used primarily by the __sleep() magic method currently. |
|
1817 | - * |
|
1818 | - * @since 4.7.5 |
|
1819 | - */ |
|
1820 | - protected function _reset_urls() |
|
1821 | - { |
|
1822 | - $this->reg_page_url = ''; |
|
1823 | - $this->txn_page_url = ''; |
|
1824 | - $this->cancel_page_url = ''; |
|
1825 | - $this->thank_you_page_url = ''; |
|
1826 | - } |
|
1827 | - |
|
1828 | - |
|
1829 | - /** |
|
1830 | - * Used to return what the optin value is set for the EE User Experience Program. |
|
1831 | - * This accounts for multisite and this value being requested for a subsite. In multisite, the value is set |
|
1832 | - * on the main site only. |
|
1833 | - * |
|
1834 | - * @return bool |
|
1835 | - */ |
|
1836 | - protected function _get_main_ee_ueip_optin() |
|
1837 | - { |
|
1838 | - // if this is the main site then we can just bypass our direct query. |
|
1839 | - if (is_main_site()) { |
|
1840 | - return get_option(self::OPTION_NAME_UXIP, false); |
|
1841 | - } |
|
1842 | - // is this already cached for this request? If so use it. |
|
1843 | - if (EE_Core_Config::$ee_ueip_option !== null) { |
|
1844 | - return EE_Core_Config::$ee_ueip_option; |
|
1845 | - } |
|
1846 | - global $wpdb; |
|
1847 | - $current_network_main_site = is_multisite() ? get_current_site() : null; |
|
1848 | - $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1; |
|
1849 | - $option = self::OPTION_NAME_UXIP; |
|
1850 | - // set correct table for query |
|
1851 | - $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options'; |
|
1852 | - // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because |
|
1853 | - // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be |
|
1854 | - // re-constructed on the blog switch. Note, we are still executing any core wp filters on this option retrieval. |
|
1855 | - // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog |
|
1856 | - // for the purpose of caching. |
|
1857 | - $pre = apply_filters('pre_option_' . $option, false, $option); |
|
1858 | - if (false !== $pre) { |
|
1859 | - EE_Core_Config::$ee_ueip_option = $pre; |
|
1860 | - return EE_Core_Config::$ee_ueip_option; |
|
1861 | - } |
|
1862 | - $row = $wpdb->get_row( |
|
1863 | - $wpdb->prepare( |
|
1864 | - "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1", |
|
1865 | - $option |
|
1866 | - ) |
|
1867 | - ); |
|
1868 | - if (is_object($row)) { |
|
1869 | - $value = $row->option_value; |
|
1870 | - } else { // option does not exist so use default. |
|
1871 | - EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option); |
|
1872 | - return EE_Core_Config::$ee_ueip_option; |
|
1873 | - } |
|
1874 | - EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option); |
|
1875 | - return EE_Core_Config::$ee_ueip_option; |
|
1876 | - } |
|
1877 | - |
|
1878 | - |
|
1879 | - /** |
|
1880 | - * Utility function for escaping the value of a property and returning. |
|
1881 | - * |
|
1882 | - * @param string $property property name (checks to see if exists). |
|
1883 | - * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
1884 | - * @throws \EE_Error |
|
1885 | - */ |
|
1886 | - public function get_pretty($property) |
|
1887 | - { |
|
1888 | - if ($property === self::OPTION_NAME_UXIP) { |
|
1889 | - return $this->ee_ueip_optin ? 'yes' : 'no'; |
|
1890 | - } |
|
1891 | - return parent::get_pretty($property); |
|
1892 | - } |
|
1893 | - |
|
1894 | - |
|
1895 | - /** |
|
1896 | - * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values |
|
1897 | - * on the object. |
|
1898 | - * |
|
1899 | - * @return array |
|
1900 | - */ |
|
1901 | - public function __sleep() |
|
1902 | - { |
|
1903 | - // reset all url properties |
|
1904 | - $this->_reset_urls(); |
|
1905 | - // return what to save to db |
|
1906 | - return array_keys(get_object_vars($this)); |
|
1907 | - } |
|
1908 | -} |
|
1909 | - |
|
1910 | -/** |
|
1911 | - * Config class for storing info on the Organization |
|
1912 | - */ |
|
1913 | -class EE_Organization_Config extends EE_Config_Base |
|
1914 | -{ |
|
1915 | - |
|
1916 | - /** |
|
1917 | - * @var string $name |
|
1918 | - * eg EE4.1 |
|
1919 | - */ |
|
1920 | - public $name; |
|
1921 | - |
|
1922 | - /** |
|
1923 | - * @var string $address_1 |
|
1924 | - * eg 123 Onna Road |
|
1925 | - */ |
|
1926 | - public $address_1 = ''; |
|
1927 | - |
|
1928 | - /** |
|
1929 | - * @var string $address_2 |
|
1930 | - * eg PO Box 123 |
|
1931 | - */ |
|
1932 | - public $address_2 = ''; |
|
1933 | - |
|
1934 | - /** |
|
1935 | - * @var string $city |
|
1936 | - * eg Inna City |
|
1937 | - */ |
|
1938 | - public $city = ''; |
|
1939 | - |
|
1940 | - /** |
|
1941 | - * @var int $STA_ID |
|
1942 | - * eg 4 |
|
1943 | - */ |
|
1944 | - public $STA_ID = 0; |
|
1945 | - |
|
1946 | - /** |
|
1947 | - * @var string $CNT_ISO |
|
1948 | - * eg US |
|
1949 | - */ |
|
1950 | - public $CNT_ISO = ''; |
|
1951 | - |
|
1952 | - /** |
|
1953 | - * @var string $zip |
|
1954 | - * eg 12345 or V1A 2B3 |
|
1955 | - */ |
|
1956 | - public $zip = ''; |
|
1957 | - |
|
1958 | - /** |
|
1959 | - * @var string $email |
|
1960 | - * eg [email protected] |
|
1961 | - */ |
|
1962 | - public $email; |
|
1963 | - |
|
1964 | - /** |
|
1965 | - * @var string $phone |
|
1966 | - * eg. 111-111-1111 |
|
1967 | - */ |
|
1968 | - public $phone = ''; |
|
1969 | - |
|
1970 | - /** |
|
1971 | - * @var string $vat |
|
1972 | - * VAT/Tax Number |
|
1973 | - */ |
|
1974 | - public $vat = ''; |
|
1975 | - |
|
1976 | - /** |
|
1977 | - * @var string $logo_url |
|
1978 | - * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg |
|
1979 | - */ |
|
1980 | - public $logo_url = ''; |
|
1981 | - |
|
1982 | - /** |
|
1983 | - * The below are all various properties for holding links to organization social network profiles |
|
1984 | - * |
|
1985 | - * @var string |
|
1986 | - */ |
|
1987 | - /** |
|
1988 | - * facebook (facebook.com/profile.name) |
|
1989 | - * |
|
1990 | - * @var string |
|
1991 | - */ |
|
1992 | - public $facebook = ''; |
|
1993 | - |
|
1994 | - /** |
|
1995 | - * twitter (twitter.com/twitter_handle) |
|
1996 | - * |
|
1997 | - * @var string |
|
1998 | - */ |
|
1999 | - public $twitter = ''; |
|
2000 | - |
|
2001 | - /** |
|
2002 | - * linkedin (linkedin.com/in/profile_name) |
|
2003 | - * |
|
2004 | - * @var string |
|
2005 | - */ |
|
2006 | - public $linkedin = ''; |
|
2007 | - |
|
2008 | - /** |
|
2009 | - * pinterest (www.pinterest.com/profile_name) |
|
2010 | - * |
|
2011 | - * @var string |
|
2012 | - */ |
|
2013 | - public $pinterest = ''; |
|
2014 | - |
|
2015 | - /** |
|
2016 | - * google+ (google.com/+profileName) |
|
2017 | - * |
|
2018 | - * @var string |
|
2019 | - */ |
|
2020 | - public $google = ''; |
|
2021 | - |
|
2022 | - /** |
|
2023 | - * instagram (instagram.com/handle) |
|
2024 | - * |
|
2025 | - * @var string |
|
2026 | - */ |
|
2027 | - public $instagram = ''; |
|
2028 | - |
|
2029 | - |
|
2030 | - /** |
|
2031 | - * class constructor |
|
2032 | - * |
|
2033 | - * @access public |
|
2034 | - */ |
|
2035 | - public function __construct() |
|
2036 | - { |
|
2037 | - // set default organization settings |
|
2038 | - // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded |
|
2039 | - $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES); |
|
2040 | - $this->email = get_bloginfo('admin_email'); |
|
2041 | - } |
|
2042 | -} |
|
2043 | - |
|
2044 | -/** |
|
2045 | - * Class for defining what's in the EE_Config relating to currency |
|
2046 | - */ |
|
2047 | -class EE_Currency_Config extends EE_Config_Base |
|
2048 | -{ |
|
2049 | - |
|
2050 | - /** |
|
2051 | - * @var string $code |
|
2052 | - * eg 'US' |
|
2053 | - */ |
|
2054 | - public $code; |
|
2055 | - |
|
2056 | - /** |
|
2057 | - * @var string $name |
|
2058 | - * eg 'Dollar' |
|
2059 | - */ |
|
2060 | - public $name; |
|
2061 | - |
|
2062 | - /** |
|
2063 | - * plural name |
|
2064 | - * |
|
2065 | - * @var string $plural |
|
2066 | - * eg 'Dollars' |
|
2067 | - */ |
|
2068 | - public $plural; |
|
2069 | - |
|
2070 | - /** |
|
2071 | - * currency sign |
|
2072 | - * |
|
2073 | - * @var string $sign |
|
2074 | - * eg '$' |
|
2075 | - */ |
|
2076 | - public $sign; |
|
2077 | - |
|
2078 | - /** |
|
2079 | - * Whether the currency sign should come before the number or not |
|
2080 | - * |
|
2081 | - * @var boolean $sign_b4 |
|
2082 | - */ |
|
2083 | - public $sign_b4; |
|
2084 | - |
|
2085 | - /** |
|
2086 | - * How many digits should come after the decimal place |
|
2087 | - * |
|
2088 | - * @var int $dec_plc |
|
2089 | - */ |
|
2090 | - public $dec_plc; |
|
2091 | - |
|
2092 | - /** |
|
2093 | - * Symbol to use for decimal mark |
|
2094 | - * |
|
2095 | - * @var string $dec_mrk |
|
2096 | - * eg '.' |
|
2097 | - */ |
|
2098 | - public $dec_mrk; |
|
2099 | - |
|
2100 | - /** |
|
2101 | - * Symbol to use for thousands |
|
2102 | - * |
|
2103 | - * @var string $thsnds |
|
2104 | - * eg ',' |
|
2105 | - */ |
|
2106 | - public $thsnds; |
|
2107 | - |
|
2108 | - |
|
2109 | - /** |
|
2110 | - * class constructor |
|
2111 | - * |
|
2112 | - * @access public |
|
2113 | - * @param string $CNT_ISO |
|
2114 | - * @throws \EE_Error |
|
2115 | - */ |
|
2116 | - public function __construct($CNT_ISO = '') |
|
2117 | - { |
|
2118 | - /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */ |
|
2119 | - $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
2120 | - // get country code from organization settings or use default |
|
2121 | - $ORG_CNT = isset(EE_Registry::instance()->CFG->organization) |
|
2122 | - && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config |
|
2123 | - ? EE_Registry::instance()->CFG->organization->CNT_ISO |
|
2124 | - : ''; |
|
2125 | - // but override if requested |
|
2126 | - $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT; |
|
2127 | - // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists |
|
2128 | - if (! empty($CNT_ISO) |
|
2129 | - && EE_Maintenance_Mode::instance()->models_can_query() |
|
2130 | - && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table()) |
|
2131 | - ) { |
|
2132 | - // retrieve the country settings from the db, just in case they have been customized |
|
2133 | - $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO); |
|
2134 | - if ($country instanceof EE_Country) { |
|
2135 | - $this->code = $country->currency_code(); // currency code: USD, CAD, EUR |
|
2136 | - $this->name = $country->currency_name_single(); // Dollar |
|
2137 | - $this->plural = $country->currency_name_plural(); // Dollars |
|
2138 | - $this->sign = $country->currency_sign(); // currency sign: $ |
|
2139 | - $this->sign_b4 = $country->currency_sign_before( |
|
2140 | - ); // currency sign before or after: $TRUE or FALSE$ |
|
2141 | - $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00 3 = 0.000 |
|
2142 | - $this->dec_mrk = $country->currency_decimal_mark( |
|
2143 | - ); // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
2144 | - $this->thsnds = $country->currency_thousands_separator( |
|
2145 | - ); // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
2146 | - } |
|
2147 | - } |
|
2148 | - // fallback to hardcoded defaults, in case the above failed |
|
2149 | - if (empty($this->code)) { |
|
2150 | - // set default currency settings |
|
2151 | - $this->code = 'USD'; // currency code: USD, CAD, EUR |
|
2152 | - $this->name = __('Dollar', 'event_espresso'); // Dollar |
|
2153 | - $this->plural = __('Dollars', 'event_espresso'); // Dollars |
|
2154 | - $this->sign = '$'; // currency sign: $ |
|
2155 | - $this->sign_b4 = true; // currency sign before or after: $TRUE or FALSE$ |
|
2156 | - $this->dec_plc = 2; // decimal places: 2 = 0.00 3 = 0.000 |
|
2157 | - $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
2158 | - $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
2159 | - } |
|
2160 | - } |
|
2161 | -} |
|
2162 | - |
|
2163 | -/** |
|
2164 | - * Class for defining what's in the EE_Config relating to registration settings |
|
2165 | - */ |
|
2166 | -class EE_Registration_Config extends EE_Config_Base |
|
2167 | -{ |
|
2168 | - |
|
2169 | - /** |
|
2170 | - * Default registration status |
|
2171 | - * |
|
2172 | - * @var string $default_STS_ID |
|
2173 | - * eg 'RPP' |
|
2174 | - */ |
|
2175 | - public $default_STS_ID; |
|
2176 | - |
|
2177 | - /** |
|
2178 | - * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of |
|
2179 | - * registrations) |
|
2180 | - * |
|
2181 | - * @var int |
|
2182 | - */ |
|
2183 | - public $default_maximum_number_of_tickets; |
|
2184 | - |
|
2185 | - /** |
|
2186 | - * level of validation to apply to email addresses |
|
2187 | - * |
|
2188 | - * @var string $email_validation_level |
|
2189 | - * options: 'basic', 'wp_default', 'i18n', 'i18n_dns' |
|
2190 | - */ |
|
2191 | - public $email_validation_level; |
|
2192 | - |
|
2193 | - /** |
|
2194 | - * whether or not to show alternate payment options during the reg process if payment status is pending |
|
2195 | - * |
|
2196 | - * @var boolean $show_pending_payment_options |
|
2197 | - */ |
|
2198 | - public $show_pending_payment_options; |
|
2199 | - |
|
2200 | - /** |
|
2201 | - * Whether to skip the registration confirmation page |
|
2202 | - * |
|
2203 | - * @var boolean $skip_reg_confirmation |
|
2204 | - */ |
|
2205 | - public $skip_reg_confirmation; |
|
2206 | - |
|
2207 | - /** |
|
2208 | - * an array of SPCO reg steps where: |
|
2209 | - * the keys denotes the reg step order |
|
2210 | - * each element consists of an array with the following elements: |
|
2211 | - * "file_path" => the file path to the EE_SPCO_Reg_Step class |
|
2212 | - * "class_name" => the specific EE_SPCO_Reg_Step child class name |
|
2213 | - * "slug" => the URL param used to trigger the reg step |
|
2214 | - * |
|
2215 | - * @var array $reg_steps |
|
2216 | - */ |
|
2217 | - public $reg_steps; |
|
2218 | - |
|
2219 | - /** |
|
2220 | - * Whether registration confirmation should be the last page of SPCO |
|
2221 | - * |
|
2222 | - * @var boolean $reg_confirmation_last |
|
2223 | - */ |
|
2224 | - public $reg_confirmation_last; |
|
2225 | - |
|
2226 | - /** |
|
2227 | - * Whether or not to enable the EE Bot Trap |
|
2228 | - * |
|
2229 | - * @var boolean $use_bot_trap |
|
2230 | - */ |
|
2231 | - public $use_bot_trap; |
|
2232 | - |
|
2233 | - /** |
|
2234 | - * Whether or not to encrypt some data sent by the EE Bot Trap |
|
2235 | - * |
|
2236 | - * @var boolean $use_encryption |
|
2237 | - */ |
|
2238 | - public $use_encryption; |
|
2239 | - |
|
2240 | - /** |
|
2241 | - * Whether or not to use ReCaptcha |
|
2242 | - * |
|
2243 | - * @var boolean $use_captcha |
|
2244 | - */ |
|
2245 | - public $use_captcha; |
|
2246 | - |
|
2247 | - /** |
|
2248 | - * ReCaptcha Theme |
|
2249 | - * |
|
2250 | - * @var string $recaptcha_theme |
|
2251 | - * options: 'dark', 'light', 'invisible' |
|
2252 | - */ |
|
2253 | - public $recaptcha_theme; |
|
2254 | - |
|
2255 | - /** |
|
2256 | - * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha. |
|
2257 | - * |
|
2258 | - * @var string $recaptcha_badge |
|
2259 | - * options: 'bottomright', 'bottomleft', 'inline' |
|
2260 | - */ |
|
2261 | - public $recaptcha_badge; |
|
17 | + const OPTION_NAME = 'ee_config'; |
|
18 | + |
|
19 | + const LOG_NAME = 'ee_config_log'; |
|
20 | + |
|
21 | + const LOG_LENGTH = 100; |
|
22 | + |
|
23 | + const ADDON_OPTION_NAMES = 'ee_config_option_names'; |
|
24 | + |
|
25 | + /** |
|
26 | + * instance of the EE_Config object |
|
27 | + * |
|
28 | + * @var EE_Config $_instance |
|
29 | + * @access private |
|
30 | + */ |
|
31 | + private static $_instance; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var boolean $_logging_enabled |
|
35 | + */ |
|
36 | + private static $_logging_enabled = false; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
40 | + */ |
|
41 | + private $legacy_shortcodes_manager; |
|
42 | + |
|
43 | + /** |
|
44 | + * An StdClass whose property names are addon slugs, |
|
45 | + * and values are their config classes |
|
46 | + * |
|
47 | + * @var StdClass |
|
48 | + */ |
|
49 | + public $addons; |
|
50 | + |
|
51 | + /** |
|
52 | + * @var EE_Admin_Config |
|
53 | + */ |
|
54 | + public $admin; |
|
55 | + |
|
56 | + /** |
|
57 | + * @var EE_Core_Config |
|
58 | + */ |
|
59 | + public $core; |
|
60 | + |
|
61 | + /** |
|
62 | + * @var EE_Currency_Config |
|
63 | + */ |
|
64 | + public $currency; |
|
65 | + |
|
66 | + /** |
|
67 | + * @var EE_Organization_Config |
|
68 | + */ |
|
69 | + public $organization; |
|
70 | + |
|
71 | + /** |
|
72 | + * @var EE_Registration_Config |
|
73 | + */ |
|
74 | + public $registration; |
|
75 | + |
|
76 | + /** |
|
77 | + * @var EE_Template_Config |
|
78 | + */ |
|
79 | + public $template_settings; |
|
80 | + |
|
81 | + /** |
|
82 | + * Holds EE environment values. |
|
83 | + * |
|
84 | + * @var EE_Environment_Config |
|
85 | + */ |
|
86 | + public $environment; |
|
87 | + |
|
88 | + /** |
|
89 | + * settings pertaining to Google maps |
|
90 | + * |
|
91 | + * @var EE_Map_Config |
|
92 | + */ |
|
93 | + public $map_settings; |
|
94 | + |
|
95 | + /** |
|
96 | + * settings pertaining to Taxes |
|
97 | + * |
|
98 | + * @var EE_Tax_Config |
|
99 | + */ |
|
100 | + public $tax_settings; |
|
101 | + |
|
102 | + /** |
|
103 | + * Settings pertaining to global messages settings. |
|
104 | + * |
|
105 | + * @var EE_Messages_Config |
|
106 | + */ |
|
107 | + public $messages; |
|
108 | + |
|
109 | + /** |
|
110 | + * @deprecated |
|
111 | + * @var EE_Gateway_Config |
|
112 | + */ |
|
113 | + public $gateway; |
|
114 | + |
|
115 | + /** |
|
116 | + * @var array $_addon_option_names |
|
117 | + * @access private |
|
118 | + */ |
|
119 | + private $_addon_option_names = array(); |
|
120 | + |
|
121 | + /** |
|
122 | + * @var array $_module_route_map |
|
123 | + * @access private |
|
124 | + */ |
|
125 | + private static $_module_route_map = array(); |
|
126 | + |
|
127 | + /** |
|
128 | + * @var array $_module_forward_map |
|
129 | + * @access private |
|
130 | + */ |
|
131 | + private static $_module_forward_map = array(); |
|
132 | + |
|
133 | + /** |
|
134 | + * @var array $_module_view_map |
|
135 | + * @access private |
|
136 | + */ |
|
137 | + private static $_module_view_map = array(); |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * @singleton method used to instantiate class object |
|
142 | + * @access public |
|
143 | + * @return EE_Config instance |
|
144 | + */ |
|
145 | + public static function instance() |
|
146 | + { |
|
147 | + // check if class object is instantiated, and instantiated properly |
|
148 | + if (! self::$_instance instanceof EE_Config) { |
|
149 | + self::$_instance = new self(); |
|
150 | + } |
|
151 | + return self::$_instance; |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * Resets the config |
|
157 | + * |
|
158 | + * @param bool $hard_reset if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE |
|
159 | + * (default) leaves the database alone, and merely resets the EE_Config object to |
|
160 | + * reflect its state in the database |
|
161 | + * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave |
|
162 | + * $_instance as NULL. Useful in case you want to forget about the old instance on |
|
163 | + * EE_Config, but might not be ready to instantiate EE_Config currently (eg if the |
|
164 | + * site was put into maintenance mode) |
|
165 | + * @return EE_Config |
|
166 | + */ |
|
167 | + public static function reset($hard_reset = false, $reinstantiate = true) |
|
168 | + { |
|
169 | + if (self::$_instance instanceof EE_Config) { |
|
170 | + if ($hard_reset) { |
|
171 | + self::$_instance->legacy_shortcodes_manager = null; |
|
172 | + self::$_instance->_addon_option_names = array(); |
|
173 | + self::$_instance->_initialize_config(); |
|
174 | + self::$_instance->update_espresso_config(); |
|
175 | + } |
|
176 | + self::$_instance->update_addon_option_names(); |
|
177 | + } |
|
178 | + self::$_instance = null; |
|
179 | + // we don't need to reset the static properties imo because those should |
|
180 | + // only change when a module is added or removed. Currently we don't |
|
181 | + // support removing a module during a request when it previously existed |
|
182 | + if ($reinstantiate) { |
|
183 | + return self::instance(); |
|
184 | + } else { |
|
185 | + return null; |
|
186 | + } |
|
187 | + } |
|
188 | + |
|
189 | + |
|
190 | + /** |
|
191 | + * class constructor |
|
192 | + * |
|
193 | + * @access private |
|
194 | + */ |
|
195 | + private function __construct() |
|
196 | + { |
|
197 | + do_action('AHEE__EE_Config__construct__begin', $this); |
|
198 | + EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false); |
|
199 | + // setup empty config classes |
|
200 | + $this->_initialize_config(); |
|
201 | + // load existing EE site settings |
|
202 | + $this->_load_core_config(); |
|
203 | + // confirm everything loaded correctly and set filtered defaults if not |
|
204 | + $this->_verify_config(); |
|
205 | + // register shortcodes and modules |
|
206 | + add_action( |
|
207 | + 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
208 | + array($this, 'register_shortcodes_and_modules'), |
|
209 | + 999 |
|
210 | + ); |
|
211 | + // initialize shortcodes and modules |
|
212 | + add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules')); |
|
213 | + // register widgets |
|
214 | + add_action('widgets_init', array($this, 'widgets_init'), 10); |
|
215 | + // shutdown |
|
216 | + add_action('shutdown', array($this, 'shutdown'), 10); |
|
217 | + // construct__end hook |
|
218 | + do_action('AHEE__EE_Config__construct__end', $this); |
|
219 | + // hardcoded hack |
|
220 | + $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
221 | + } |
|
222 | + |
|
223 | + |
|
224 | + /** |
|
225 | + * @return boolean |
|
226 | + */ |
|
227 | + public static function logging_enabled() |
|
228 | + { |
|
229 | + return self::$_logging_enabled; |
|
230 | + } |
|
231 | + |
|
232 | + |
|
233 | + /** |
|
234 | + * use to get the current theme if needed from static context |
|
235 | + * |
|
236 | + * @return string current theme set. |
|
237 | + */ |
|
238 | + public static function get_current_theme() |
|
239 | + { |
|
240 | + return isset(self::$_instance->template_settings->current_espresso_theme) |
|
241 | + ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014'; |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * _initialize_config |
|
247 | + * |
|
248 | + * @access private |
|
249 | + * @return void |
|
250 | + */ |
|
251 | + private function _initialize_config() |
|
252 | + { |
|
253 | + EE_Config::trim_log(); |
|
254 | + // set defaults |
|
255 | + $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array()); |
|
256 | + $this->addons = new stdClass(); |
|
257 | + // set _module_route_map |
|
258 | + EE_Config::$_module_route_map = array(); |
|
259 | + // set _module_forward_map |
|
260 | + EE_Config::$_module_forward_map = array(); |
|
261 | + // set _module_view_map |
|
262 | + EE_Config::$_module_view_map = array(); |
|
263 | + } |
|
264 | + |
|
265 | + |
|
266 | + /** |
|
267 | + * load core plugin configuration |
|
268 | + * |
|
269 | + * @access private |
|
270 | + * @return void |
|
271 | + */ |
|
272 | + private function _load_core_config() |
|
273 | + { |
|
274 | + // load_core_config__start hook |
|
275 | + do_action('AHEE__EE_Config___load_core_config__start', $this); |
|
276 | + $espresso_config = $this->get_espresso_config(); |
|
277 | + foreach ($espresso_config as $config => $settings) { |
|
278 | + // load_core_config__start hook |
|
279 | + $settings = apply_filters( |
|
280 | + 'FHEE__EE_Config___load_core_config__config_settings', |
|
281 | + $settings, |
|
282 | + $config, |
|
283 | + $this |
|
284 | + ); |
|
285 | + if (is_object($settings) && property_exists($this, $config)) { |
|
286 | + $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings); |
|
287 | + // call configs populate method to ensure any defaults are set for empty values. |
|
288 | + if (method_exists($settings, 'populate')) { |
|
289 | + $this->{$config}->populate(); |
|
290 | + } |
|
291 | + if (method_exists($settings, 'do_hooks')) { |
|
292 | + $this->{$config}->do_hooks(); |
|
293 | + } |
|
294 | + } |
|
295 | + } |
|
296 | + if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) { |
|
297 | + $this->update_espresso_config(); |
|
298 | + } |
|
299 | + // load_core_config__end hook |
|
300 | + do_action('AHEE__EE_Config___load_core_config__end', $this); |
|
301 | + } |
|
302 | + |
|
303 | + |
|
304 | + /** |
|
305 | + * _verify_config |
|
306 | + * |
|
307 | + * @access protected |
|
308 | + * @return void |
|
309 | + */ |
|
310 | + protected function _verify_config() |
|
311 | + { |
|
312 | + $this->core = $this->core instanceof EE_Core_Config |
|
313 | + ? $this->core |
|
314 | + : new EE_Core_Config(); |
|
315 | + $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core); |
|
316 | + $this->organization = $this->organization instanceof EE_Organization_Config |
|
317 | + ? $this->organization |
|
318 | + : new EE_Organization_Config(); |
|
319 | + $this->organization = apply_filters( |
|
320 | + 'FHEE__EE_Config___initialize_config__organization', |
|
321 | + $this->organization |
|
322 | + ); |
|
323 | + $this->currency = $this->currency instanceof EE_Currency_Config |
|
324 | + ? $this->currency |
|
325 | + : new EE_Currency_Config(); |
|
326 | + $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency); |
|
327 | + $this->registration = $this->registration instanceof EE_Registration_Config |
|
328 | + ? $this->registration |
|
329 | + : new EE_Registration_Config(); |
|
330 | + $this->registration = apply_filters( |
|
331 | + 'FHEE__EE_Config___initialize_config__registration', |
|
332 | + $this->registration |
|
333 | + ); |
|
334 | + $this->admin = $this->admin instanceof EE_Admin_Config |
|
335 | + ? $this->admin |
|
336 | + : new EE_Admin_Config(); |
|
337 | + $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin); |
|
338 | + $this->template_settings = $this->template_settings instanceof EE_Template_Config |
|
339 | + ? $this->template_settings |
|
340 | + : new EE_Template_Config(); |
|
341 | + $this->template_settings = apply_filters( |
|
342 | + 'FHEE__EE_Config___initialize_config__template_settings', |
|
343 | + $this->template_settings |
|
344 | + ); |
|
345 | + $this->map_settings = $this->map_settings instanceof EE_Map_Config |
|
346 | + ? $this->map_settings |
|
347 | + : new EE_Map_Config(); |
|
348 | + $this->map_settings = apply_filters( |
|
349 | + 'FHEE__EE_Config___initialize_config__map_settings', |
|
350 | + $this->map_settings |
|
351 | + ); |
|
352 | + $this->environment = $this->environment instanceof EE_Environment_Config |
|
353 | + ? $this->environment |
|
354 | + : new EE_Environment_Config(); |
|
355 | + $this->environment = apply_filters( |
|
356 | + 'FHEE__EE_Config___initialize_config__environment', |
|
357 | + $this->environment |
|
358 | + ); |
|
359 | + $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config |
|
360 | + ? $this->tax_settings |
|
361 | + : new EE_Tax_Config(); |
|
362 | + $this->tax_settings = apply_filters( |
|
363 | + 'FHEE__EE_Config___initialize_config__tax_settings', |
|
364 | + $this->tax_settings |
|
365 | + ); |
|
366 | + $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages); |
|
367 | + $this->messages = $this->messages instanceof EE_Messages_Config |
|
368 | + ? $this->messages |
|
369 | + : new EE_Messages_Config(); |
|
370 | + $this->gateway = $this->gateway instanceof EE_Gateway_Config |
|
371 | + ? $this->gateway |
|
372 | + : new EE_Gateway_Config(); |
|
373 | + $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway); |
|
374 | + $this->legacy_shortcodes_manager = null; |
|
375 | + } |
|
376 | + |
|
377 | + |
|
378 | + /** |
|
379 | + * get_espresso_config |
|
380 | + * |
|
381 | + * @access public |
|
382 | + * @return array of espresso config stuff |
|
383 | + */ |
|
384 | + public function get_espresso_config() |
|
385 | + { |
|
386 | + // grab espresso configuration |
|
387 | + return apply_filters( |
|
388 | + 'FHEE__EE_Config__get_espresso_config__CFG', |
|
389 | + get_option(EE_Config::OPTION_NAME, array()) |
|
390 | + ); |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * double_check_config_comparison |
|
396 | + * |
|
397 | + * @access public |
|
398 | + * @param string $option |
|
399 | + * @param $old_value |
|
400 | + * @param $value |
|
401 | + */ |
|
402 | + public function double_check_config_comparison($option = '', $old_value, $value) |
|
403 | + { |
|
404 | + // make sure we're checking the ee config |
|
405 | + if ($option === EE_Config::OPTION_NAME) { |
|
406 | + // run a loose comparison of the old value against the new value for type and properties, |
|
407 | + // but NOT exact instance like WP update_option does (ie: NOT type safe comparison) |
|
408 | + if ($value != $old_value) { |
|
409 | + // if they are NOT the same, then remove the hook, |
|
410 | + // which means the subsequent update results will be based solely on the update query results |
|
411 | + // the reason we do this is because, as stated above, |
|
412 | + // WP update_option performs an exact instance comparison (===) on any update values passed to it |
|
413 | + // this happens PRIOR to serialization and any subsequent update. |
|
414 | + // If values are found to match their previous old value, |
|
415 | + // then WP bails before performing any update. |
|
416 | + // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version |
|
417 | + // it just pulled from the db, with the one being passed to it (which will not match). |
|
418 | + // HOWEVER, once the object is serialized and passed off to MySQL to update, |
|
419 | + // MySQL MAY ALSO NOT perform the update because |
|
420 | + // the string it sees in the db looks the same as the new one it has been passed!!! |
|
421 | + // This results in the query returning an "affected rows" value of ZERO, |
|
422 | + // which gets returned immediately by WP update_option and looks like an error. |
|
423 | + remove_action('update_option', array($this, 'check_config_updated')); |
|
424 | + } |
|
425 | + } |
|
426 | + } |
|
427 | + |
|
428 | + |
|
429 | + /** |
|
430 | + * update_espresso_config |
|
431 | + * |
|
432 | + * @access public |
|
433 | + */ |
|
434 | + protected function _reset_espresso_addon_config() |
|
435 | + { |
|
436 | + $this->_addon_option_names = array(); |
|
437 | + foreach ($this->addons as $addon_name => $addon_config_obj) { |
|
438 | + $addon_config_obj = maybe_unserialize($addon_config_obj); |
|
439 | + if ($addon_config_obj instanceof EE_Config_Base) { |
|
440 | + $this->update_config('addons', $addon_name, $addon_config_obj, false); |
|
441 | + } |
|
442 | + $this->addons->{$addon_name} = null; |
|
443 | + } |
|
444 | + } |
|
445 | + |
|
446 | + |
|
447 | + /** |
|
448 | + * update_espresso_config |
|
449 | + * |
|
450 | + * @access public |
|
451 | + * @param bool $add_success |
|
452 | + * @param bool $add_error |
|
453 | + * @return bool |
|
454 | + */ |
|
455 | + public function update_espresso_config($add_success = false, $add_error = true) |
|
456 | + { |
|
457 | + // don't allow config updates during WP heartbeats |
|
458 | + if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
459 | + return false; |
|
460 | + } |
|
461 | + // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197 |
|
462 | + // $clone = clone( self::$_instance ); |
|
463 | + // self::$_instance = NULL; |
|
464 | + do_action('AHEE__EE_Config__update_espresso_config__begin', $this); |
|
465 | + $this->_reset_espresso_addon_config(); |
|
466 | + // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional |
|
467 | + // but BEFORE the actual update occurs |
|
468 | + add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3); |
|
469 | + // don't want to persist legacy_shortcodes_manager, but don't want to lose it either |
|
470 | + $legacy_shortcodes_manager = $this->legacy_shortcodes_manager; |
|
471 | + $this->legacy_shortcodes_manager = null; |
|
472 | + // now update "ee_config" |
|
473 | + $saved = update_option(EE_Config::OPTION_NAME, $this); |
|
474 | + $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
475 | + EE_Config::log(EE_Config::OPTION_NAME); |
|
476 | + // if not saved... check if the hook we just added still exists; |
|
477 | + // if it does, it means one of two things: |
|
478 | + // that update_option bailed at the($value === $old_value) conditional, |
|
479 | + // or... |
|
480 | + // the db update query returned 0 rows affected |
|
481 | + // (probably because the data value was the same from it's perspective) |
|
482 | + // so the existence of the hook means that a negative result from update_option is NOT an error, |
|
483 | + // but just means no update occurred, so don't display an error to the user. |
|
484 | + // BUT... if update_option returns FALSE, AND the hook is missing, |
|
485 | + // then it means that something truly went wrong |
|
486 | + $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved; |
|
487 | + // remove our action since we don't want it in the system anymore |
|
488 | + remove_action('update_option', array($this, 'double_check_config_comparison'), 1); |
|
489 | + do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved); |
|
490 | + // self::$_instance = $clone; |
|
491 | + // unset( $clone ); |
|
492 | + // if config remains the same or was updated successfully |
|
493 | + if ($saved) { |
|
494 | + if ($add_success) { |
|
495 | + EE_Error::add_success( |
|
496 | + __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'), |
|
497 | + __FILE__, |
|
498 | + __FUNCTION__, |
|
499 | + __LINE__ |
|
500 | + ); |
|
501 | + } |
|
502 | + return true; |
|
503 | + } else { |
|
504 | + if ($add_error) { |
|
505 | + EE_Error::add_error( |
|
506 | + __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'), |
|
507 | + __FILE__, |
|
508 | + __FUNCTION__, |
|
509 | + __LINE__ |
|
510 | + ); |
|
511 | + } |
|
512 | + return false; |
|
513 | + } |
|
514 | + } |
|
515 | + |
|
516 | + |
|
517 | + /** |
|
518 | + * _verify_config_params |
|
519 | + * |
|
520 | + * @access private |
|
521 | + * @param string $section |
|
522 | + * @param string $name |
|
523 | + * @param string $config_class |
|
524 | + * @param EE_Config_Base $config_obj |
|
525 | + * @param array $tests_to_run |
|
526 | + * @param bool $display_errors |
|
527 | + * @return bool TRUE on success, FALSE on fail |
|
528 | + */ |
|
529 | + private function _verify_config_params( |
|
530 | + $section = '', |
|
531 | + $name = '', |
|
532 | + $config_class = '', |
|
533 | + $config_obj = null, |
|
534 | + $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8), |
|
535 | + $display_errors = true |
|
536 | + ) { |
|
537 | + try { |
|
538 | + foreach ($tests_to_run as $test) { |
|
539 | + switch ($test) { |
|
540 | + // TEST #1 : check that section was set |
|
541 | + case 1: |
|
542 | + if (empty($section)) { |
|
543 | + if ($display_errors) { |
|
544 | + throw new EE_Error( |
|
545 | + sprintf( |
|
546 | + __( |
|
547 | + 'No configuration section has been provided while attempting to save "%s".', |
|
548 | + 'event_espresso' |
|
549 | + ), |
|
550 | + $config_class |
|
551 | + ) |
|
552 | + ); |
|
553 | + } |
|
554 | + return false; |
|
555 | + } |
|
556 | + break; |
|
557 | + // TEST #2 : check that settings section exists |
|
558 | + case 2: |
|
559 | + if (! isset($this->{$section})) { |
|
560 | + if ($display_errors) { |
|
561 | + throw new EE_Error( |
|
562 | + sprintf( |
|
563 | + __('The "%s" configuration section does not exist.', 'event_espresso'), |
|
564 | + $section |
|
565 | + ) |
|
566 | + ); |
|
567 | + } |
|
568 | + return false; |
|
569 | + } |
|
570 | + break; |
|
571 | + // TEST #3 : check that section is the proper format |
|
572 | + case 3: |
|
573 | + if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass) |
|
574 | + ) { |
|
575 | + if ($display_errors) { |
|
576 | + throw new EE_Error( |
|
577 | + sprintf( |
|
578 | + __( |
|
579 | + 'The "%s" configuration settings have not been formatted correctly.', |
|
580 | + 'event_espresso' |
|
581 | + ), |
|
582 | + $section |
|
583 | + ) |
|
584 | + ); |
|
585 | + } |
|
586 | + return false; |
|
587 | + } |
|
588 | + break; |
|
589 | + // TEST #4 : check that config section name has been set |
|
590 | + case 4: |
|
591 | + if (empty($name)) { |
|
592 | + if ($display_errors) { |
|
593 | + throw new EE_Error( |
|
594 | + __( |
|
595 | + 'No name has been provided for the specific configuration section.', |
|
596 | + 'event_espresso' |
|
597 | + ) |
|
598 | + ); |
|
599 | + } |
|
600 | + return false; |
|
601 | + } |
|
602 | + break; |
|
603 | + // TEST #5 : check that a config class name has been set |
|
604 | + case 5: |
|
605 | + if (empty($config_class)) { |
|
606 | + if ($display_errors) { |
|
607 | + throw new EE_Error( |
|
608 | + __( |
|
609 | + 'No class name has been provided for the specific configuration section.', |
|
610 | + 'event_espresso' |
|
611 | + ) |
|
612 | + ); |
|
613 | + } |
|
614 | + return false; |
|
615 | + } |
|
616 | + break; |
|
617 | + // TEST #6 : verify config class is accessible |
|
618 | + case 6: |
|
619 | + if (! class_exists($config_class)) { |
|
620 | + if ($display_errors) { |
|
621 | + throw new EE_Error( |
|
622 | + sprintf( |
|
623 | + __( |
|
624 | + 'The "%s" class does not exist. Please ensure that an autoloader has been set for it.', |
|
625 | + 'event_espresso' |
|
626 | + ), |
|
627 | + $config_class |
|
628 | + ) |
|
629 | + ); |
|
630 | + } |
|
631 | + return false; |
|
632 | + } |
|
633 | + break; |
|
634 | + // TEST #7 : check that config has even been set |
|
635 | + case 7: |
|
636 | + if (! isset($this->{$section}->{$name})) { |
|
637 | + if ($display_errors) { |
|
638 | + throw new EE_Error( |
|
639 | + sprintf( |
|
640 | + __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'), |
|
641 | + $section, |
|
642 | + $name |
|
643 | + ) |
|
644 | + ); |
|
645 | + } |
|
646 | + return false; |
|
647 | + } else { |
|
648 | + // and make sure it's not serialized |
|
649 | + $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name}); |
|
650 | + } |
|
651 | + break; |
|
652 | + // TEST #8 : check that config is the requested type |
|
653 | + case 8: |
|
654 | + if (! $this->{$section}->{$name} instanceof $config_class) { |
|
655 | + if ($display_errors) { |
|
656 | + throw new EE_Error( |
|
657 | + sprintf( |
|
658 | + __( |
|
659 | + 'The configuration for "%1$s->%2$s" is not of the "%3$s" class.', |
|
660 | + 'event_espresso' |
|
661 | + ), |
|
662 | + $section, |
|
663 | + $name, |
|
664 | + $config_class |
|
665 | + ) |
|
666 | + ); |
|
667 | + } |
|
668 | + return false; |
|
669 | + } |
|
670 | + break; |
|
671 | + // TEST #9 : verify config object |
|
672 | + case 9: |
|
673 | + if (! $config_obj instanceof EE_Config_Base) { |
|
674 | + if ($display_errors) { |
|
675 | + throw new EE_Error( |
|
676 | + sprintf( |
|
677 | + __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'), |
|
678 | + print_r($config_obj, true) |
|
679 | + ) |
|
680 | + ); |
|
681 | + } |
|
682 | + return false; |
|
683 | + } |
|
684 | + break; |
|
685 | + } |
|
686 | + } |
|
687 | + } catch (EE_Error $e) { |
|
688 | + $e->get_error(); |
|
689 | + } |
|
690 | + // you have successfully run the gauntlet |
|
691 | + return true; |
|
692 | + } |
|
693 | + |
|
694 | + |
|
695 | + /** |
|
696 | + * _generate_config_option_name |
|
697 | + * |
|
698 | + * @access protected |
|
699 | + * @param string $section |
|
700 | + * @param string $name |
|
701 | + * @return string |
|
702 | + */ |
|
703 | + private function _generate_config_option_name($section = '', $name = '') |
|
704 | + { |
|
705 | + return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name)); |
|
706 | + } |
|
707 | + |
|
708 | + |
|
709 | + /** |
|
710 | + * _set_config_class |
|
711 | + * ensures that a config class is set, either from a passed config class or one generated from the config name |
|
712 | + * |
|
713 | + * @access private |
|
714 | + * @param string $config_class |
|
715 | + * @param string $name |
|
716 | + * @return string |
|
717 | + */ |
|
718 | + private function _set_config_class($config_class = '', $name = '') |
|
719 | + { |
|
720 | + return ! empty($config_class) |
|
721 | + ? $config_class |
|
722 | + : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config'; |
|
723 | + } |
|
724 | + |
|
725 | + |
|
726 | + /** |
|
727 | + * set_config |
|
728 | + * |
|
729 | + * @access protected |
|
730 | + * @param string $section |
|
731 | + * @param string $name |
|
732 | + * @param string $config_class |
|
733 | + * @param EE_Config_Base $config_obj |
|
734 | + * @return EE_Config_Base |
|
735 | + */ |
|
736 | + public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null) |
|
737 | + { |
|
738 | + // ensure config class is set to something |
|
739 | + $config_class = $this->_set_config_class($config_class, $name); |
|
740 | + // run tests 1-4, 6, and 7 to verify all config params are set and valid |
|
741 | + if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
742 | + return null; |
|
743 | + } |
|
744 | + $config_option_name = $this->_generate_config_option_name($section, $name); |
|
745 | + // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now |
|
746 | + if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
747 | + $this->_addon_option_names[ $config_option_name ] = $config_class; |
|
748 | + $this->update_addon_option_names(); |
|
749 | + } |
|
750 | + // verify the incoming config object but suppress errors |
|
751 | + if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
752 | + $config_obj = new $config_class(); |
|
753 | + } |
|
754 | + if (get_option($config_option_name)) { |
|
755 | + EE_Config::log($config_option_name); |
|
756 | + update_option($config_option_name, $config_obj); |
|
757 | + $this->{$section}->{$name} = $config_obj; |
|
758 | + return $this->{$section}->{$name}; |
|
759 | + } else { |
|
760 | + // create a wp-option for this config |
|
761 | + if (add_option($config_option_name, $config_obj, '', 'no')) { |
|
762 | + $this->{$section}->{$name} = maybe_unserialize($config_obj); |
|
763 | + return $this->{$section}->{$name}; |
|
764 | + } else { |
|
765 | + EE_Error::add_error( |
|
766 | + sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class), |
|
767 | + __FILE__, |
|
768 | + __FUNCTION__, |
|
769 | + __LINE__ |
|
770 | + ); |
|
771 | + return null; |
|
772 | + } |
|
773 | + } |
|
774 | + } |
|
775 | + |
|
776 | + |
|
777 | + /** |
|
778 | + * update_config |
|
779 | + * Important: the config object must ALREADY be set, otherwise this will produce an error. |
|
780 | + * |
|
781 | + * @access public |
|
782 | + * @param string $section |
|
783 | + * @param string $name |
|
784 | + * @param EE_Config_Base|string $config_obj |
|
785 | + * @param bool $throw_errors |
|
786 | + * @return bool |
|
787 | + */ |
|
788 | + public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true) |
|
789 | + { |
|
790 | + // don't allow config updates during WP heartbeats |
|
791 | + if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
792 | + return false; |
|
793 | + } |
|
794 | + $config_obj = maybe_unserialize($config_obj); |
|
795 | + // get class name of the incoming object |
|
796 | + $config_class = get_class($config_obj); |
|
797 | + // run tests 1-5 and 9 to verify config |
|
798 | + if (! $this->_verify_config_params( |
|
799 | + $section, |
|
800 | + $name, |
|
801 | + $config_class, |
|
802 | + $config_obj, |
|
803 | + array(1, 2, 3, 4, 7, 9) |
|
804 | + ) |
|
805 | + ) { |
|
806 | + return false; |
|
807 | + } |
|
808 | + $config_option_name = $this->_generate_config_option_name($section, $name); |
|
809 | + // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array |
|
810 | + if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
811 | + // save new config to db |
|
812 | + if ($this->set_config($section, $name, $config_class, $config_obj)) { |
|
813 | + return true; |
|
814 | + } |
|
815 | + } else { |
|
816 | + // first check if the record already exists |
|
817 | + $existing_config = get_option($config_option_name); |
|
818 | + $config_obj = serialize($config_obj); |
|
819 | + // just return if db record is already up to date (NOT type safe comparison) |
|
820 | + if ($existing_config == $config_obj) { |
|
821 | + $this->{$section}->{$name} = $config_obj; |
|
822 | + return true; |
|
823 | + } elseif (update_option($config_option_name, $config_obj)) { |
|
824 | + EE_Config::log($config_option_name); |
|
825 | + // update wp-option for this config class |
|
826 | + $this->{$section}->{$name} = $config_obj; |
|
827 | + return true; |
|
828 | + } elseif ($throw_errors) { |
|
829 | + EE_Error::add_error( |
|
830 | + sprintf( |
|
831 | + __( |
|
832 | + 'The "%1$s" object stored at"%2$s" was not successfully updated in the database.', |
|
833 | + 'event_espresso' |
|
834 | + ), |
|
835 | + $config_class, |
|
836 | + 'EE_Config->' . $section . '->' . $name |
|
837 | + ), |
|
838 | + __FILE__, |
|
839 | + __FUNCTION__, |
|
840 | + __LINE__ |
|
841 | + ); |
|
842 | + } |
|
843 | + } |
|
844 | + return false; |
|
845 | + } |
|
846 | + |
|
847 | + |
|
848 | + /** |
|
849 | + * get_config |
|
850 | + * |
|
851 | + * @access public |
|
852 | + * @param string $section |
|
853 | + * @param string $name |
|
854 | + * @param string $config_class |
|
855 | + * @return mixed EE_Config_Base | NULL |
|
856 | + */ |
|
857 | + public function get_config($section = '', $name = '', $config_class = '') |
|
858 | + { |
|
859 | + // ensure config class is set to something |
|
860 | + $config_class = $this->_set_config_class($config_class, $name); |
|
861 | + // run tests 1-4, 6 and 7 to verify that all params have been set |
|
862 | + if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
863 | + return null; |
|
864 | + } |
|
865 | + // now test if the requested config object exists, but suppress errors |
|
866 | + if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) { |
|
867 | + // config already exists, so pass it back |
|
868 | + return $this->{$section}->{$name}; |
|
869 | + } |
|
870 | + // load config option from db if it exists |
|
871 | + $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name)); |
|
872 | + // verify the newly retrieved config object, but suppress errors |
|
873 | + if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
874 | + // config is good, so set it and pass it back |
|
875 | + $this->{$section}->{$name} = $config_obj; |
|
876 | + return $this->{$section}->{$name}; |
|
877 | + } |
|
878 | + // oops! $config_obj is not already set and does not exist in the db, so create a new one |
|
879 | + $config_obj = $this->set_config($section, $name, $config_class); |
|
880 | + // verify the newly created config object |
|
881 | + if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) { |
|
882 | + return $this->{$section}->{$name}; |
|
883 | + } else { |
|
884 | + EE_Error::add_error( |
|
885 | + sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class), |
|
886 | + __FILE__, |
|
887 | + __FUNCTION__, |
|
888 | + __LINE__ |
|
889 | + ); |
|
890 | + } |
|
891 | + return null; |
|
892 | + } |
|
893 | + |
|
894 | + |
|
895 | + /** |
|
896 | + * get_config_option |
|
897 | + * |
|
898 | + * @access public |
|
899 | + * @param string $config_option_name |
|
900 | + * @return mixed EE_Config_Base | FALSE |
|
901 | + */ |
|
902 | + public function get_config_option($config_option_name = '') |
|
903 | + { |
|
904 | + // retrieve the wp-option for this config class. |
|
905 | + $config_option = maybe_unserialize(get_option($config_option_name, array())); |
|
906 | + if (empty($config_option)) { |
|
907 | + EE_Config::log($config_option_name . '-NOT-FOUND'); |
|
908 | + } |
|
909 | + return $config_option; |
|
910 | + } |
|
911 | + |
|
912 | + |
|
913 | + /** |
|
914 | + * log |
|
915 | + * |
|
916 | + * @param string $config_option_name |
|
917 | + */ |
|
918 | + public static function log($config_option_name = '') |
|
919 | + { |
|
920 | + if (EE_Config::logging_enabled() && ! empty($config_option_name)) { |
|
921 | + $config_log = get_option(EE_Config::LOG_NAME, array()); |
|
922 | + // copy incoming $_REQUEST and sanitize it so we can save it |
|
923 | + $_request = $_REQUEST; |
|
924 | + array_walk_recursive($_request, 'sanitize_text_field'); |
|
925 | + $config_log[ (string) microtime(true) ] = array( |
|
926 | + 'config_name' => $config_option_name, |
|
927 | + 'request' => $_request, |
|
928 | + ); |
|
929 | + update_option(EE_Config::LOG_NAME, $config_log); |
|
930 | + } |
|
931 | + } |
|
932 | + |
|
933 | + |
|
934 | + /** |
|
935 | + * trim_log |
|
936 | + * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH |
|
937 | + */ |
|
938 | + public static function trim_log() |
|
939 | + { |
|
940 | + if (! EE_Config::logging_enabled()) { |
|
941 | + return; |
|
942 | + } |
|
943 | + $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array())); |
|
944 | + $log_length = count($config_log); |
|
945 | + if ($log_length > EE_Config::LOG_LENGTH) { |
|
946 | + ksort($config_log); |
|
947 | + $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true); |
|
948 | + update_option(EE_Config::LOG_NAME, $config_log); |
|
949 | + } |
|
950 | + } |
|
951 | + |
|
952 | + |
|
953 | + /** |
|
954 | + * get_page_for_posts |
|
955 | + * if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the |
|
956 | + * wp-option "page_for_posts", or "posts" if no page is selected |
|
957 | + * |
|
958 | + * @access public |
|
959 | + * @return string |
|
960 | + */ |
|
961 | + public static function get_page_for_posts() |
|
962 | + { |
|
963 | + $page_for_posts = get_option('page_for_posts'); |
|
964 | + if (! $page_for_posts) { |
|
965 | + return 'posts'; |
|
966 | + } |
|
967 | + /** @type WPDB $wpdb */ |
|
968 | + global $wpdb; |
|
969 | + $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d"; |
|
970 | + return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts)); |
|
971 | + } |
|
972 | + |
|
973 | + |
|
974 | + /** |
|
975 | + * register_shortcodes_and_modules. |
|
976 | + * At this point, it's too early to tell if we're maintenance mode or not. |
|
977 | + * In fact, this is where we give modules a chance to let core know they exist |
|
978 | + * so they can help trigger maintenance mode if it's needed |
|
979 | + * |
|
980 | + * @access public |
|
981 | + * @return void |
|
982 | + */ |
|
983 | + public function register_shortcodes_and_modules() |
|
984 | + { |
|
985 | + // allow modules to set hooks for the rest of the system |
|
986 | + EE_Registry::instance()->modules = $this->_register_modules(); |
|
987 | + } |
|
988 | + |
|
989 | + |
|
990 | + /** |
|
991 | + * initialize_shortcodes_and_modules |
|
992 | + * meaning they can start adding their hooks to get stuff done |
|
993 | + * |
|
994 | + * @access public |
|
995 | + * @return void |
|
996 | + */ |
|
997 | + public function initialize_shortcodes_and_modules() |
|
998 | + { |
|
999 | + // allow modules to set hooks for the rest of the system |
|
1000 | + $this->_initialize_modules(); |
|
1001 | + } |
|
1002 | + |
|
1003 | + |
|
1004 | + /** |
|
1005 | + * widgets_init |
|
1006 | + * |
|
1007 | + * @access private |
|
1008 | + * @return void |
|
1009 | + */ |
|
1010 | + public function widgets_init() |
|
1011 | + { |
|
1012 | + // only init widgets on admin pages when not in complete maintenance, and |
|
1013 | + // on frontend when not in any maintenance mode |
|
1014 | + if (! EE_Maintenance_Mode::instance()->level() |
|
1015 | + || ( |
|
1016 | + is_admin() |
|
1017 | + && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance |
|
1018 | + ) |
|
1019 | + ) { |
|
1020 | + // grab list of installed widgets |
|
1021 | + $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR); |
|
1022 | + // filter list of modules to register |
|
1023 | + $widgets_to_register = apply_filters( |
|
1024 | + 'FHEE__EE_Config__register_widgets__widgets_to_register', |
|
1025 | + $widgets_to_register |
|
1026 | + ); |
|
1027 | + if (! empty($widgets_to_register)) { |
|
1028 | + // cycle thru widget folders |
|
1029 | + foreach ($widgets_to_register as $widget_path) { |
|
1030 | + // add to list of installed widget modules |
|
1031 | + EE_Config::register_ee_widget($widget_path); |
|
1032 | + } |
|
1033 | + } |
|
1034 | + // filter list of installed modules |
|
1035 | + EE_Registry::instance()->widgets = apply_filters( |
|
1036 | + 'FHEE__EE_Config__register_widgets__installed_widgets', |
|
1037 | + EE_Registry::instance()->widgets |
|
1038 | + ); |
|
1039 | + } |
|
1040 | + } |
|
1041 | + |
|
1042 | + |
|
1043 | + /** |
|
1044 | + * register_ee_widget - makes core aware of this widget |
|
1045 | + * |
|
1046 | + * @access public |
|
1047 | + * @param string $widget_path - full path up to and including widget folder |
|
1048 | + * @return void |
|
1049 | + */ |
|
1050 | + public static function register_ee_widget($widget_path = null) |
|
1051 | + { |
|
1052 | + do_action('AHEE__EE_Config__register_widget__begin', $widget_path); |
|
1053 | + $widget_ext = '.widget.php'; |
|
1054 | + // make all separators match |
|
1055 | + $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS); |
|
1056 | + // does the file path INCLUDE the actual file name as part of the path ? |
|
1057 | + if (strpos($widget_path, $widget_ext) !== false) { |
|
1058 | + // grab and shortcode file name from directory name and break apart at dots |
|
1059 | + $file_name = explode('.', basename($widget_path)); |
|
1060 | + // take first segment from file name pieces and remove class prefix if it exists |
|
1061 | + $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0]; |
|
1062 | + // sanitize shortcode directory name |
|
1063 | + $widget = sanitize_key($widget); |
|
1064 | + // now we need to rebuild the shortcode path |
|
1065 | + $widget_path = explode('/', $widget_path); |
|
1066 | + // remove last segment |
|
1067 | + array_pop($widget_path); |
|
1068 | + // glue it back together |
|
1069 | + $widget_path = implode(DS, $widget_path); |
|
1070 | + } else { |
|
1071 | + // grab and sanitize widget directory name |
|
1072 | + $widget = sanitize_key(basename($widget_path)); |
|
1073 | + } |
|
1074 | + // create classname from widget directory name |
|
1075 | + $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget))); |
|
1076 | + // add class prefix |
|
1077 | + $widget_class = 'EEW_' . $widget; |
|
1078 | + // does the widget exist ? |
|
1079 | + if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) { |
|
1080 | + $msg = sprintf( |
|
1081 | + __( |
|
1082 | + 'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', |
|
1083 | + 'event_espresso' |
|
1084 | + ), |
|
1085 | + $widget_class, |
|
1086 | + $widget_path . '/' . $widget_class . $widget_ext |
|
1087 | + ); |
|
1088 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1089 | + return; |
|
1090 | + } |
|
1091 | + // load the widget class file |
|
1092 | + require_once($widget_path . '/' . $widget_class . $widget_ext); |
|
1093 | + // verify that class exists |
|
1094 | + if (! class_exists($widget_class)) { |
|
1095 | + $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class); |
|
1096 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1097 | + return; |
|
1098 | + } |
|
1099 | + register_widget($widget_class); |
|
1100 | + // add to array of registered widgets |
|
1101 | + EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext; |
|
1102 | + } |
|
1103 | + |
|
1104 | + |
|
1105 | + /** |
|
1106 | + * _register_modules |
|
1107 | + * |
|
1108 | + * @access private |
|
1109 | + * @return array |
|
1110 | + */ |
|
1111 | + private function _register_modules() |
|
1112 | + { |
|
1113 | + // grab list of installed modules |
|
1114 | + $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR); |
|
1115 | + // filter list of modules to register |
|
1116 | + $modules_to_register = apply_filters( |
|
1117 | + 'FHEE__EE_Config__register_modules__modules_to_register', |
|
1118 | + $modules_to_register |
|
1119 | + ); |
|
1120 | + if (! empty($modules_to_register)) { |
|
1121 | + // loop through folders |
|
1122 | + foreach ($modules_to_register as $module_path) { |
|
1123 | + /**TEMPORARILY EXCLUDE gateways from modules for time being**/ |
|
1124 | + if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template' |
|
1125 | + && $module_path !== EE_MODULES . 'gateways' |
|
1126 | + ) { |
|
1127 | + // add to list of installed modules |
|
1128 | + EE_Config::register_module($module_path); |
|
1129 | + } |
|
1130 | + } |
|
1131 | + } |
|
1132 | + // filter list of installed modules |
|
1133 | + return apply_filters( |
|
1134 | + 'FHEE__EE_Config___register_modules__installed_modules', |
|
1135 | + EE_Registry::instance()->modules |
|
1136 | + ); |
|
1137 | + } |
|
1138 | + |
|
1139 | + |
|
1140 | + /** |
|
1141 | + * register_module - makes core aware of this module |
|
1142 | + * |
|
1143 | + * @access public |
|
1144 | + * @param string $module_path - full path up to and including module folder |
|
1145 | + * @return bool |
|
1146 | + */ |
|
1147 | + public static function register_module($module_path = null) |
|
1148 | + { |
|
1149 | + do_action('AHEE__EE_Config__register_module__begin', $module_path); |
|
1150 | + $module_ext = '.module.php'; |
|
1151 | + // make all separators match |
|
1152 | + $module_path = str_replace(array('\\', '/'), '/', $module_path); |
|
1153 | + // does the file path INCLUDE the actual file name as part of the path ? |
|
1154 | + if (strpos($module_path, $module_ext) !== false) { |
|
1155 | + // grab and shortcode file name from directory name and break apart at dots |
|
1156 | + $module_file = explode('.', basename($module_path)); |
|
1157 | + // now we need to rebuild the shortcode path |
|
1158 | + $module_path = explode('/', $module_path); |
|
1159 | + // remove last segment |
|
1160 | + array_pop($module_path); |
|
1161 | + // glue it back together |
|
1162 | + $module_path = implode('/', $module_path) . '/'; |
|
1163 | + // take first segment from file name pieces and sanitize it |
|
1164 | + $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]); |
|
1165 | + // ensure class prefix is added |
|
1166 | + $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module; |
|
1167 | + } else { |
|
1168 | + // we need to generate the filename based off of the folder name |
|
1169 | + // grab and sanitize module name |
|
1170 | + $module = strtolower(basename($module_path)); |
|
1171 | + $module = preg_replace('/[^a-z0-9_\-]/', '', $module); |
|
1172 | + // like trailingslashit() |
|
1173 | + $module_path = rtrim($module_path, '/') . '/'; |
|
1174 | + // create classname from module directory name |
|
1175 | + $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module))); |
|
1176 | + // add class prefix |
|
1177 | + $module_class = 'EED_' . $module; |
|
1178 | + } |
|
1179 | + // does the module exist ? |
|
1180 | + if (! is_readable($module_path . '/' . $module_class . $module_ext)) { |
|
1181 | + $msg = sprintf( |
|
1182 | + __( |
|
1183 | + 'The requested %s module file could not be found or is not readable due to file permissions.', |
|
1184 | + 'event_espresso' |
|
1185 | + ), |
|
1186 | + $module |
|
1187 | + ); |
|
1188 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1189 | + return false; |
|
1190 | + } |
|
1191 | + // load the module class file |
|
1192 | + require_once($module_path . $module_class . $module_ext); |
|
1193 | + // verify that class exists |
|
1194 | + if (! class_exists($module_class)) { |
|
1195 | + $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class); |
|
1196 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1197 | + return false; |
|
1198 | + } |
|
1199 | + // add to array of registered modules |
|
1200 | + EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext; |
|
1201 | + do_action( |
|
1202 | + 'AHEE__EE_Config__register_module__complete', |
|
1203 | + $module_class, |
|
1204 | + EE_Registry::instance()->modules->{$module_class} |
|
1205 | + ); |
|
1206 | + return true; |
|
1207 | + } |
|
1208 | + |
|
1209 | + |
|
1210 | + /** |
|
1211 | + * _initialize_modules |
|
1212 | + * allow modules to set hooks for the rest of the system |
|
1213 | + * |
|
1214 | + * @access private |
|
1215 | + * @return void |
|
1216 | + */ |
|
1217 | + private function _initialize_modules() |
|
1218 | + { |
|
1219 | + // cycle thru shortcode folders |
|
1220 | + foreach (EE_Registry::instance()->modules as $module_class => $module_path) { |
|
1221 | + // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system |
|
1222 | + // which set hooks ? |
|
1223 | + if (is_admin()) { |
|
1224 | + // fire immediately |
|
1225 | + call_user_func(array($module_class, 'set_hooks_admin')); |
|
1226 | + } else { |
|
1227 | + // delay until other systems are online |
|
1228 | + add_action( |
|
1229 | + 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', |
|
1230 | + array($module_class, 'set_hooks') |
|
1231 | + ); |
|
1232 | + } |
|
1233 | + } |
|
1234 | + } |
|
1235 | + |
|
1236 | + |
|
1237 | + /** |
|
1238 | + * register_route - adds module method routes to route_map |
|
1239 | + * |
|
1240 | + * @access public |
|
1241 | + * @param string $route - "pretty" public alias for module method |
|
1242 | + * @param string $module - module name (classname without EED_ prefix) |
|
1243 | + * @param string $method_name - the actual module method to be routed to |
|
1244 | + * @param string $key - url param key indicating a route is being called |
|
1245 | + * @return bool |
|
1246 | + */ |
|
1247 | + public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee') |
|
1248 | + { |
|
1249 | + do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name); |
|
1250 | + $module = str_replace('EED_', '', $module); |
|
1251 | + $module_class = 'EED_' . $module; |
|
1252 | + if (! isset(EE_Registry::instance()->modules->{$module_class})) { |
|
1253 | + $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module); |
|
1254 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1255 | + return false; |
|
1256 | + } |
|
1257 | + if (empty($route)) { |
|
1258 | + $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route); |
|
1259 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1260 | + return false; |
|
1261 | + } |
|
1262 | + if (! method_exists('EED_' . $module, $method_name)) { |
|
1263 | + $msg = sprintf( |
|
1264 | + __('A valid class method for the %s route has not been supplied.', 'event_espresso'), |
|
1265 | + $route |
|
1266 | + ); |
|
1267 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1268 | + return false; |
|
1269 | + } |
|
1270 | + EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name); |
|
1271 | + return true; |
|
1272 | + } |
|
1273 | + |
|
1274 | + |
|
1275 | + /** |
|
1276 | + * get_route - get module method route |
|
1277 | + * |
|
1278 | + * @access public |
|
1279 | + * @param string $route - "pretty" public alias for module method |
|
1280 | + * @param string $key - url param key indicating a route is being called |
|
1281 | + * @return string |
|
1282 | + */ |
|
1283 | + public static function get_route($route = null, $key = 'ee') |
|
1284 | + { |
|
1285 | + do_action('AHEE__EE_Config__get_route__begin', $route); |
|
1286 | + $route = (string) apply_filters('FHEE__EE_Config__get_route', $route); |
|
1287 | + if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) { |
|
1288 | + return EE_Config::$_module_route_map[ $key ][ $route ]; |
|
1289 | + } |
|
1290 | + return null; |
|
1291 | + } |
|
1292 | + |
|
1293 | + |
|
1294 | + /** |
|
1295 | + * get_routes - get ALL module method routes |
|
1296 | + * |
|
1297 | + * @access public |
|
1298 | + * @return array |
|
1299 | + */ |
|
1300 | + public static function get_routes() |
|
1301 | + { |
|
1302 | + return EE_Config::$_module_route_map; |
|
1303 | + } |
|
1304 | + |
|
1305 | + |
|
1306 | + /** |
|
1307 | + * register_forward - allows modules to forward request to another module for further processing |
|
1308 | + * |
|
1309 | + * @access public |
|
1310 | + * @param string $route - "pretty" public alias for module method |
|
1311 | + * @param integer $status - integer value corresponding to status constant strings set in module parent |
|
1312 | + * class, allows different forwards to be served based on status |
|
1313 | + * @param array|string $forward - function name or array( class, method ) |
|
1314 | + * @param string $key - url param key indicating a route is being called |
|
1315 | + * @return bool |
|
1316 | + */ |
|
1317 | + public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee') |
|
1318 | + { |
|
1319 | + do_action('AHEE__EE_Config__register_forward', $route, $status, $forward); |
|
1320 | + if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
1321 | + $msg = sprintf( |
|
1322 | + __('The module route %s for this forward has not been registered.', 'event_espresso'), |
|
1323 | + $route |
|
1324 | + ); |
|
1325 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1326 | + return false; |
|
1327 | + } |
|
1328 | + if (empty($forward)) { |
|
1329 | + $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route); |
|
1330 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1331 | + return false; |
|
1332 | + } |
|
1333 | + if (is_array($forward)) { |
|
1334 | + if (! isset($forward[1])) { |
|
1335 | + $msg = sprintf( |
|
1336 | + __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'), |
|
1337 | + $route |
|
1338 | + ); |
|
1339 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1340 | + return false; |
|
1341 | + } |
|
1342 | + if (! method_exists($forward[0], $forward[1])) { |
|
1343 | + $msg = sprintf( |
|
1344 | + __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
1345 | + $forward[1], |
|
1346 | + $route |
|
1347 | + ); |
|
1348 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1349 | + return false; |
|
1350 | + } |
|
1351 | + } elseif (! function_exists($forward)) { |
|
1352 | + $msg = sprintf( |
|
1353 | + __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
1354 | + $forward, |
|
1355 | + $route |
|
1356 | + ); |
|
1357 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1358 | + return false; |
|
1359 | + } |
|
1360 | + EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward; |
|
1361 | + return true; |
|
1362 | + } |
|
1363 | + |
|
1364 | + |
|
1365 | + /** |
|
1366 | + * get_forward - get forwarding route |
|
1367 | + * |
|
1368 | + * @access public |
|
1369 | + * @param string $route - "pretty" public alias for module method |
|
1370 | + * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
1371 | + * allows different forwards to be served based on status |
|
1372 | + * @param string $key - url param key indicating a route is being called |
|
1373 | + * @return string |
|
1374 | + */ |
|
1375 | + public static function get_forward($route = null, $status = 0, $key = 'ee') |
|
1376 | + { |
|
1377 | + do_action('AHEE__EE_Config__get_forward__begin', $route, $status); |
|
1378 | + if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) { |
|
1379 | + return apply_filters( |
|
1380 | + 'FHEE__EE_Config__get_forward', |
|
1381 | + EE_Config::$_module_forward_map[ $key ][ $route ][ $status ], |
|
1382 | + $route, |
|
1383 | + $status |
|
1384 | + ); |
|
1385 | + } |
|
1386 | + return null; |
|
1387 | + } |
|
1388 | + |
|
1389 | + |
|
1390 | + /** |
|
1391 | + * register_forward - allows modules to specify different view templates for different method routes and status |
|
1392 | + * results |
|
1393 | + * |
|
1394 | + * @access public |
|
1395 | + * @param string $route - "pretty" public alias for module method |
|
1396 | + * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
1397 | + * allows different views to be served based on status |
|
1398 | + * @param string $view |
|
1399 | + * @param string $key - url param key indicating a route is being called |
|
1400 | + * @return bool |
|
1401 | + */ |
|
1402 | + public static function register_view($route = null, $status = 0, $view = null, $key = 'ee') |
|
1403 | + { |
|
1404 | + do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view); |
|
1405 | + if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
1406 | + $msg = sprintf( |
|
1407 | + __('The module route %s for this view has not been registered.', 'event_espresso'), |
|
1408 | + $route |
|
1409 | + ); |
|
1410 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1411 | + return false; |
|
1412 | + } |
|
1413 | + if (! is_readable($view)) { |
|
1414 | + $msg = sprintf( |
|
1415 | + __( |
|
1416 | + 'The %s view file could not be found or is not readable due to file permissions.', |
|
1417 | + 'event_espresso' |
|
1418 | + ), |
|
1419 | + $view |
|
1420 | + ); |
|
1421 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
1422 | + return false; |
|
1423 | + } |
|
1424 | + EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view; |
|
1425 | + return true; |
|
1426 | + } |
|
1427 | + |
|
1428 | + |
|
1429 | + /** |
|
1430 | + * get_view - get view for route and status |
|
1431 | + * |
|
1432 | + * @access public |
|
1433 | + * @param string $route - "pretty" public alias for module method |
|
1434 | + * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
1435 | + * allows different views to be served based on status |
|
1436 | + * @param string $key - url param key indicating a route is being called |
|
1437 | + * @return string |
|
1438 | + */ |
|
1439 | + public static function get_view($route = null, $status = 0, $key = 'ee') |
|
1440 | + { |
|
1441 | + do_action('AHEE__EE_Config__get_view__begin', $route, $status); |
|
1442 | + if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) { |
|
1443 | + return apply_filters( |
|
1444 | + 'FHEE__EE_Config__get_view', |
|
1445 | + EE_Config::$_module_view_map[ $key ][ $route ][ $status ], |
|
1446 | + $route, |
|
1447 | + $status |
|
1448 | + ); |
|
1449 | + } |
|
1450 | + return null; |
|
1451 | + } |
|
1452 | + |
|
1453 | + |
|
1454 | + public function update_addon_option_names() |
|
1455 | + { |
|
1456 | + update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names); |
|
1457 | + } |
|
1458 | + |
|
1459 | + |
|
1460 | + public function shutdown() |
|
1461 | + { |
|
1462 | + $this->update_addon_option_names(); |
|
1463 | + } |
|
1464 | + |
|
1465 | + |
|
1466 | + /** |
|
1467 | + * @return LegacyShortcodesManager |
|
1468 | + */ |
|
1469 | + public static function getLegacyShortcodesManager() |
|
1470 | + { |
|
1471 | + |
|
1472 | + if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) { |
|
1473 | + EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager( |
|
1474 | + EE_Registry::instance() |
|
1475 | + ); |
|
1476 | + } |
|
1477 | + return EE_Config::instance()->legacy_shortcodes_manager; |
|
1478 | + } |
|
1479 | + |
|
1480 | + |
|
1481 | + /** |
|
1482 | + * register_shortcode - makes core aware of this shortcode |
|
1483 | + * |
|
1484 | + * @deprecated 4.9.26 |
|
1485 | + * @param string $shortcode_path - full path up to and including shortcode folder |
|
1486 | + * @return bool |
|
1487 | + */ |
|
1488 | + public static function register_shortcode($shortcode_path = null) |
|
1489 | + { |
|
1490 | + EE_Error::doing_it_wrong( |
|
1491 | + __METHOD__, |
|
1492 | + __( |
|
1493 | + 'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.', |
|
1494 | + 'event_espresso' |
|
1495 | + ), |
|
1496 | + '4.9.26' |
|
1497 | + ); |
|
1498 | + return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path); |
|
1499 | + } |
|
1500 | +} |
|
2262 | 1501 | |
2263 | - /** |
|
2264 | - * ReCaptcha Type |
|
2265 | - * |
|
2266 | - * @var string $recaptcha_type |
|
2267 | - * options: 'audio', 'image' |
|
2268 | - */ |
|
2269 | - public $recaptcha_type; |
|
1502 | +/** |
|
1503 | + * Base class used for config classes. These classes should generally not have |
|
1504 | + * magic functions in use, except we'll allow them to magically set and get stuff... |
|
1505 | + * basically, they should just be well-defined stdClasses |
|
1506 | + */ |
|
1507 | +class EE_Config_Base |
|
1508 | +{ |
|
2270 | 1509 | |
2271 | - /** |
|
2272 | - * ReCaptcha language |
|
2273 | - * |
|
2274 | - * @var string $recaptcha_language |
|
2275 | - * eg 'en' |
|
2276 | - */ |
|
2277 | - public $recaptcha_language; |
|
1510 | + /** |
|
1511 | + * Utility function for escaping the value of a property and returning. |
|
1512 | + * |
|
1513 | + * @param string $property property name (checks to see if exists). |
|
1514 | + * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
1515 | + * @throws \EE_Error |
|
1516 | + */ |
|
1517 | + public function get_pretty($property) |
|
1518 | + { |
|
1519 | + if (! property_exists($this, $property)) { |
|
1520 | + throw new EE_Error( |
|
1521 | + sprintf( |
|
1522 | + __( |
|
1523 | + '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.', |
|
1524 | + 'event_espresso' |
|
1525 | + ), |
|
1526 | + get_class($this), |
|
1527 | + $property |
|
1528 | + ) |
|
1529 | + ); |
|
1530 | + } |
|
1531 | + // just handling escaping of strings for now. |
|
1532 | + if (is_string($this->{$property})) { |
|
1533 | + return stripslashes($this->{$property}); |
|
1534 | + } |
|
1535 | + return $this->{$property}; |
|
1536 | + } |
|
1537 | + |
|
1538 | + |
|
1539 | + public function populate() |
|
1540 | + { |
|
1541 | + // grab defaults via a new instance of this class. |
|
1542 | + $class_name = get_class($this); |
|
1543 | + $defaults = new $class_name; |
|
1544 | + // loop through the properties for this class and see if they are set. If they are NOT, then grab the |
|
1545 | + // default from our $defaults object. |
|
1546 | + foreach (get_object_vars($defaults) as $property => $value) { |
|
1547 | + if ($this->{$property} === null) { |
|
1548 | + $this->{$property} = $value; |
|
1549 | + } |
|
1550 | + } |
|
1551 | + // cleanup |
|
1552 | + unset($defaults); |
|
1553 | + } |
|
1554 | + |
|
1555 | + |
|
1556 | + /** |
|
1557 | + * __isset |
|
1558 | + * |
|
1559 | + * @param $a |
|
1560 | + * @return bool |
|
1561 | + */ |
|
1562 | + public function __isset($a) |
|
1563 | + { |
|
1564 | + return false; |
|
1565 | + } |
|
1566 | + |
|
1567 | + |
|
1568 | + /** |
|
1569 | + * __unset |
|
1570 | + * |
|
1571 | + * @param $a |
|
1572 | + * @return bool |
|
1573 | + */ |
|
1574 | + public function __unset($a) |
|
1575 | + { |
|
1576 | + return false; |
|
1577 | + } |
|
1578 | + |
|
1579 | + |
|
1580 | + /** |
|
1581 | + * __clone |
|
1582 | + */ |
|
1583 | + public function __clone() |
|
1584 | + { |
|
1585 | + } |
|
1586 | + |
|
1587 | + |
|
1588 | + /** |
|
1589 | + * __wakeup |
|
1590 | + */ |
|
1591 | + public function __wakeup() |
|
1592 | + { |
|
1593 | + } |
|
1594 | + |
|
1595 | + |
|
1596 | + /** |
|
1597 | + * __destruct |
|
1598 | + */ |
|
1599 | + public function __destruct() |
|
1600 | + { |
|
1601 | + } |
|
1602 | +} |
|
2278 | 1603 | |
2279 | - /** |
|
2280 | - * ReCaptcha public key |
|
2281 | - * |
|
2282 | - * @var string $recaptcha_publickey |
|
2283 | - */ |
|
2284 | - public $recaptcha_publickey; |
|
1604 | +/** |
|
1605 | + * Class for defining what's in the EE_Config relating to registration settings |
|
1606 | + */ |
|
1607 | +class EE_Core_Config extends EE_Config_Base |
|
1608 | +{ |
|
2285 | 1609 | |
2286 | - /** |
|
2287 | - * ReCaptcha private key |
|
2288 | - * |
|
2289 | - * @var string $recaptcha_privatekey |
|
2290 | - */ |
|
2291 | - public $recaptcha_privatekey; |
|
1610 | + const OPTION_NAME_UXIP = 'ee_ueip_optin'; |
|
1611 | + |
|
1612 | + |
|
1613 | + public $current_blog_id; |
|
1614 | + |
|
1615 | + public $ee_ueip_optin; |
|
1616 | + |
|
1617 | + public $ee_ueip_has_notified; |
|
1618 | + |
|
1619 | + /** |
|
1620 | + * Not to be confused with the 4 critical page variables (See |
|
1621 | + * get_critical_pages_array()), this is just an array of wp posts that have EE |
|
1622 | + * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode |
|
1623 | + * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array. |
|
1624 | + * |
|
1625 | + * @var array |
|
1626 | + */ |
|
1627 | + public $post_shortcodes; |
|
1628 | + |
|
1629 | + public $module_route_map; |
|
1630 | + |
|
1631 | + public $module_forward_map; |
|
1632 | + |
|
1633 | + public $module_view_map; |
|
1634 | + |
|
1635 | + /** |
|
1636 | + * The next 4 vars are the IDs of critical EE pages. |
|
1637 | + * |
|
1638 | + * @var int |
|
1639 | + */ |
|
1640 | + public $reg_page_id; |
|
1641 | + |
|
1642 | + public $txn_page_id; |
|
1643 | + |
|
1644 | + public $thank_you_page_id; |
|
1645 | + |
|
1646 | + public $cancel_page_id; |
|
1647 | + |
|
1648 | + /** |
|
1649 | + * The next 4 vars are the URLs of critical EE pages. |
|
1650 | + * |
|
1651 | + * @var int |
|
1652 | + */ |
|
1653 | + public $reg_page_url; |
|
1654 | + |
|
1655 | + public $txn_page_url; |
|
1656 | + |
|
1657 | + public $thank_you_page_url; |
|
1658 | + |
|
1659 | + public $cancel_page_url; |
|
1660 | + |
|
1661 | + /** |
|
1662 | + * The next vars relate to the custom slugs for EE CPT routes |
|
1663 | + */ |
|
1664 | + public $event_cpt_slug; |
|
1665 | + |
|
1666 | + /** |
|
1667 | + * This caches the _ee_ueip_option in case this config is reset in the same |
|
1668 | + * request across blog switches in a multisite context. |
|
1669 | + * Avoids extra queries to the db for this option. |
|
1670 | + * |
|
1671 | + * @var bool |
|
1672 | + */ |
|
1673 | + public static $ee_ueip_option; |
|
1674 | + |
|
1675 | + |
|
1676 | + /** |
|
1677 | + * class constructor |
|
1678 | + * |
|
1679 | + * @access public |
|
1680 | + */ |
|
1681 | + public function __construct() |
|
1682 | + { |
|
1683 | + // set default organization settings |
|
1684 | + $this->current_blog_id = get_current_blog_id(); |
|
1685 | + $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id; |
|
1686 | + $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin(); |
|
1687 | + $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true; |
|
1688 | + $this->post_shortcodes = array(); |
|
1689 | + $this->module_route_map = array(); |
|
1690 | + $this->module_forward_map = array(); |
|
1691 | + $this->module_view_map = array(); |
|
1692 | + // critical EE page IDs |
|
1693 | + $this->reg_page_id = 0; |
|
1694 | + $this->txn_page_id = 0; |
|
1695 | + $this->thank_you_page_id = 0; |
|
1696 | + $this->cancel_page_id = 0; |
|
1697 | + // critical EE page URLs |
|
1698 | + $this->reg_page_url = ''; |
|
1699 | + $this->txn_page_url = ''; |
|
1700 | + $this->thank_you_page_url = ''; |
|
1701 | + $this->cancel_page_url = ''; |
|
1702 | + // cpt slugs |
|
1703 | + $this->event_cpt_slug = __('events', 'event_espresso'); |
|
1704 | + // ueip constant check |
|
1705 | + if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) { |
|
1706 | + $this->ee_ueip_optin = false; |
|
1707 | + $this->ee_ueip_has_notified = true; |
|
1708 | + } |
|
1709 | + } |
|
1710 | + |
|
1711 | + |
|
1712 | + /** |
|
1713 | + * @return array |
|
1714 | + */ |
|
1715 | + public function get_critical_pages_array() |
|
1716 | + { |
|
1717 | + return array( |
|
1718 | + $this->reg_page_id, |
|
1719 | + $this->txn_page_id, |
|
1720 | + $this->thank_you_page_id, |
|
1721 | + $this->cancel_page_id, |
|
1722 | + ); |
|
1723 | + } |
|
1724 | + |
|
1725 | + |
|
1726 | + /** |
|
1727 | + * @return array |
|
1728 | + */ |
|
1729 | + public function get_critical_pages_shortcodes_array() |
|
1730 | + { |
|
1731 | + return array( |
|
1732 | + $this->reg_page_id => 'ESPRESSO_CHECKOUT', |
|
1733 | + $this->txn_page_id => 'ESPRESSO_TXN_PAGE', |
|
1734 | + $this->thank_you_page_id => 'ESPRESSO_THANK_YOU', |
|
1735 | + $this->cancel_page_id => 'ESPRESSO_CANCELLED', |
|
1736 | + ); |
|
1737 | + } |
|
1738 | + |
|
1739 | + |
|
1740 | + /** |
|
1741 | + * gets/returns URL for EE reg_page |
|
1742 | + * |
|
1743 | + * @access public |
|
1744 | + * @return string |
|
1745 | + */ |
|
1746 | + public function reg_page_url() |
|
1747 | + { |
|
1748 | + if (! $this->reg_page_url) { |
|
1749 | + $this->reg_page_url = add_query_arg( |
|
1750 | + array('uts' => time()), |
|
1751 | + get_permalink($this->reg_page_id) |
|
1752 | + ) . '#checkout'; |
|
1753 | + } |
|
1754 | + return $this->reg_page_url; |
|
1755 | + } |
|
1756 | + |
|
1757 | + |
|
1758 | + /** |
|
1759 | + * gets/returns URL for EE txn_page |
|
1760 | + * |
|
1761 | + * @param array $query_args like what gets passed to |
|
1762 | + * add_query_arg() as the first argument |
|
1763 | + * @access public |
|
1764 | + * @return string |
|
1765 | + */ |
|
1766 | + public function txn_page_url($query_args = array()) |
|
1767 | + { |
|
1768 | + if (! $this->txn_page_url) { |
|
1769 | + $this->txn_page_url = get_permalink($this->txn_page_id); |
|
1770 | + } |
|
1771 | + if ($query_args) { |
|
1772 | + return add_query_arg($query_args, $this->txn_page_url); |
|
1773 | + } else { |
|
1774 | + return $this->txn_page_url; |
|
1775 | + } |
|
1776 | + } |
|
1777 | + |
|
1778 | + |
|
1779 | + /** |
|
1780 | + * gets/returns URL for EE thank_you_page |
|
1781 | + * |
|
1782 | + * @param array $query_args like what gets passed to |
|
1783 | + * add_query_arg() as the first argument |
|
1784 | + * @access public |
|
1785 | + * @return string |
|
1786 | + */ |
|
1787 | + public function thank_you_page_url($query_args = array()) |
|
1788 | + { |
|
1789 | + if (! $this->thank_you_page_url) { |
|
1790 | + $this->thank_you_page_url = get_permalink($this->thank_you_page_id); |
|
1791 | + } |
|
1792 | + if ($query_args) { |
|
1793 | + return add_query_arg($query_args, $this->thank_you_page_url); |
|
1794 | + } else { |
|
1795 | + return $this->thank_you_page_url; |
|
1796 | + } |
|
1797 | + } |
|
1798 | + |
|
1799 | + |
|
1800 | + /** |
|
1801 | + * gets/returns URL for EE cancel_page |
|
1802 | + * |
|
1803 | + * @access public |
|
1804 | + * @return string |
|
1805 | + */ |
|
1806 | + public function cancel_page_url() |
|
1807 | + { |
|
1808 | + if (! $this->cancel_page_url) { |
|
1809 | + $this->cancel_page_url = get_permalink($this->cancel_page_id); |
|
1810 | + } |
|
1811 | + return $this->cancel_page_url; |
|
1812 | + } |
|
1813 | + |
|
1814 | + |
|
1815 | + /** |
|
1816 | + * Resets all critical page urls to their original state. Used primarily by the __sleep() magic method currently. |
|
1817 | + * |
|
1818 | + * @since 4.7.5 |
|
1819 | + */ |
|
1820 | + protected function _reset_urls() |
|
1821 | + { |
|
1822 | + $this->reg_page_url = ''; |
|
1823 | + $this->txn_page_url = ''; |
|
1824 | + $this->cancel_page_url = ''; |
|
1825 | + $this->thank_you_page_url = ''; |
|
1826 | + } |
|
1827 | + |
|
1828 | + |
|
1829 | + /** |
|
1830 | + * Used to return what the optin value is set for the EE User Experience Program. |
|
1831 | + * This accounts for multisite and this value being requested for a subsite. In multisite, the value is set |
|
1832 | + * on the main site only. |
|
1833 | + * |
|
1834 | + * @return bool |
|
1835 | + */ |
|
1836 | + protected function _get_main_ee_ueip_optin() |
|
1837 | + { |
|
1838 | + // if this is the main site then we can just bypass our direct query. |
|
1839 | + if (is_main_site()) { |
|
1840 | + return get_option(self::OPTION_NAME_UXIP, false); |
|
1841 | + } |
|
1842 | + // is this already cached for this request? If so use it. |
|
1843 | + if (EE_Core_Config::$ee_ueip_option !== null) { |
|
1844 | + return EE_Core_Config::$ee_ueip_option; |
|
1845 | + } |
|
1846 | + global $wpdb; |
|
1847 | + $current_network_main_site = is_multisite() ? get_current_site() : null; |
|
1848 | + $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1; |
|
1849 | + $option = self::OPTION_NAME_UXIP; |
|
1850 | + // set correct table for query |
|
1851 | + $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options'; |
|
1852 | + // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because |
|
1853 | + // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be |
|
1854 | + // re-constructed on the blog switch. Note, we are still executing any core wp filters on this option retrieval. |
|
1855 | + // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog |
|
1856 | + // for the purpose of caching. |
|
1857 | + $pre = apply_filters('pre_option_' . $option, false, $option); |
|
1858 | + if (false !== $pre) { |
|
1859 | + EE_Core_Config::$ee_ueip_option = $pre; |
|
1860 | + return EE_Core_Config::$ee_ueip_option; |
|
1861 | + } |
|
1862 | + $row = $wpdb->get_row( |
|
1863 | + $wpdb->prepare( |
|
1864 | + "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1", |
|
1865 | + $option |
|
1866 | + ) |
|
1867 | + ); |
|
1868 | + if (is_object($row)) { |
|
1869 | + $value = $row->option_value; |
|
1870 | + } else { // option does not exist so use default. |
|
1871 | + EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option); |
|
1872 | + return EE_Core_Config::$ee_ueip_option; |
|
1873 | + } |
|
1874 | + EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option); |
|
1875 | + return EE_Core_Config::$ee_ueip_option; |
|
1876 | + } |
|
1877 | + |
|
1878 | + |
|
1879 | + /** |
|
1880 | + * Utility function for escaping the value of a property and returning. |
|
1881 | + * |
|
1882 | + * @param string $property property name (checks to see if exists). |
|
1883 | + * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
1884 | + * @throws \EE_Error |
|
1885 | + */ |
|
1886 | + public function get_pretty($property) |
|
1887 | + { |
|
1888 | + if ($property === self::OPTION_NAME_UXIP) { |
|
1889 | + return $this->ee_ueip_optin ? 'yes' : 'no'; |
|
1890 | + } |
|
1891 | + return parent::get_pretty($property); |
|
1892 | + } |
|
1893 | + |
|
1894 | + |
|
1895 | + /** |
|
1896 | + * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values |
|
1897 | + * on the object. |
|
1898 | + * |
|
1899 | + * @return array |
|
1900 | + */ |
|
1901 | + public function __sleep() |
|
1902 | + { |
|
1903 | + // reset all url properties |
|
1904 | + $this->_reset_urls(); |
|
1905 | + // return what to save to db |
|
1906 | + return array_keys(get_object_vars($this)); |
|
1907 | + } |
|
1908 | +} |
|
2292 | 1909 | |
2293 | - /** |
|
2294 | - * array of form names protected by ReCaptcha |
|
2295 | - * |
|
2296 | - * @var array $recaptcha_protected_forms |
|
2297 | - */ |
|
2298 | - public $recaptcha_protected_forms; |
|
1910 | +/** |
|
1911 | + * Config class for storing info on the Organization |
|
1912 | + */ |
|
1913 | +class EE_Organization_Config extends EE_Config_Base |
|
1914 | +{ |
|
2299 | 1915 | |
2300 | - /** |
|
2301 | - * ReCaptcha width |
|
2302 | - * |
|
2303 | - * @var int $recaptcha_width |
|
2304 | - * @deprecated |
|
2305 | - */ |
|
2306 | - public $recaptcha_width; |
|
1916 | + /** |
|
1917 | + * @var string $name |
|
1918 | + * eg EE4.1 |
|
1919 | + */ |
|
1920 | + public $name; |
|
1921 | + |
|
1922 | + /** |
|
1923 | + * @var string $address_1 |
|
1924 | + * eg 123 Onna Road |
|
1925 | + */ |
|
1926 | + public $address_1 = ''; |
|
1927 | + |
|
1928 | + /** |
|
1929 | + * @var string $address_2 |
|
1930 | + * eg PO Box 123 |
|
1931 | + */ |
|
1932 | + public $address_2 = ''; |
|
1933 | + |
|
1934 | + /** |
|
1935 | + * @var string $city |
|
1936 | + * eg Inna City |
|
1937 | + */ |
|
1938 | + public $city = ''; |
|
1939 | + |
|
1940 | + /** |
|
1941 | + * @var int $STA_ID |
|
1942 | + * eg 4 |
|
1943 | + */ |
|
1944 | + public $STA_ID = 0; |
|
1945 | + |
|
1946 | + /** |
|
1947 | + * @var string $CNT_ISO |
|
1948 | + * eg US |
|
1949 | + */ |
|
1950 | + public $CNT_ISO = ''; |
|
1951 | + |
|
1952 | + /** |
|
1953 | + * @var string $zip |
|
1954 | + * eg 12345 or V1A 2B3 |
|
1955 | + */ |
|
1956 | + public $zip = ''; |
|
1957 | + |
|
1958 | + /** |
|
1959 | + * @var string $email |
|
1960 | + * eg [email protected] |
|
1961 | + */ |
|
1962 | + public $email; |
|
1963 | + |
|
1964 | + /** |
|
1965 | + * @var string $phone |
|
1966 | + * eg. 111-111-1111 |
|
1967 | + */ |
|
1968 | + public $phone = ''; |
|
1969 | + |
|
1970 | + /** |
|
1971 | + * @var string $vat |
|
1972 | + * VAT/Tax Number |
|
1973 | + */ |
|
1974 | + public $vat = ''; |
|
1975 | + |
|
1976 | + /** |
|
1977 | + * @var string $logo_url |
|
1978 | + * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg |
|
1979 | + */ |
|
1980 | + public $logo_url = ''; |
|
1981 | + |
|
1982 | + /** |
|
1983 | + * The below are all various properties for holding links to organization social network profiles |
|
1984 | + * |
|
1985 | + * @var string |
|
1986 | + */ |
|
1987 | + /** |
|
1988 | + * facebook (facebook.com/profile.name) |
|
1989 | + * |
|
1990 | + * @var string |
|
1991 | + */ |
|
1992 | + public $facebook = ''; |
|
1993 | + |
|
1994 | + /** |
|
1995 | + * twitter (twitter.com/twitter_handle) |
|
1996 | + * |
|
1997 | + * @var string |
|
1998 | + */ |
|
1999 | + public $twitter = ''; |
|
2000 | + |
|
2001 | + /** |
|
2002 | + * linkedin (linkedin.com/in/profile_name) |
|
2003 | + * |
|
2004 | + * @var string |
|
2005 | + */ |
|
2006 | + public $linkedin = ''; |
|
2007 | + |
|
2008 | + /** |
|
2009 | + * pinterest (www.pinterest.com/profile_name) |
|
2010 | + * |
|
2011 | + * @var string |
|
2012 | + */ |
|
2013 | + public $pinterest = ''; |
|
2014 | + |
|
2015 | + /** |
|
2016 | + * google+ (google.com/+profileName) |
|
2017 | + * |
|
2018 | + * @var string |
|
2019 | + */ |
|
2020 | + public $google = ''; |
|
2021 | + |
|
2022 | + /** |
|
2023 | + * instagram (instagram.com/handle) |
|
2024 | + * |
|
2025 | + * @var string |
|
2026 | + */ |
|
2027 | + public $instagram = ''; |
|
2028 | + |
|
2029 | + |
|
2030 | + /** |
|
2031 | + * class constructor |
|
2032 | + * |
|
2033 | + * @access public |
|
2034 | + */ |
|
2035 | + public function __construct() |
|
2036 | + { |
|
2037 | + // set default organization settings |
|
2038 | + // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded |
|
2039 | + $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES); |
|
2040 | + $this->email = get_bloginfo('admin_email'); |
|
2041 | + } |
|
2042 | +} |
|
2307 | 2043 | |
2308 | - /** |
|
2309 | - * Whether or not invalid attempts to directly access the registration checkout page should be tracked. |
|
2310 | - * |
|
2311 | - * @var boolean $track_invalid_checkout_access |
|
2312 | - */ |
|
2313 | - protected $track_invalid_checkout_access = true; |
|
2044 | +/** |
|
2045 | + * Class for defining what's in the EE_Config relating to currency |
|
2046 | + */ |
|
2047 | +class EE_Currency_Config extends EE_Config_Base |
|
2048 | +{ |
|
2314 | 2049 | |
2315 | - /** |
|
2316 | - * Whether or not to show the privacy policy consent checkbox |
|
2317 | - * |
|
2318 | - * @var bool |
|
2319 | - */ |
|
2320 | - public $consent_checkbox_enabled; |
|
2050 | + /** |
|
2051 | + * @var string $code |
|
2052 | + * eg 'US' |
|
2053 | + */ |
|
2054 | + public $code; |
|
2055 | + |
|
2056 | + /** |
|
2057 | + * @var string $name |
|
2058 | + * eg 'Dollar' |
|
2059 | + */ |
|
2060 | + public $name; |
|
2061 | + |
|
2062 | + /** |
|
2063 | + * plural name |
|
2064 | + * |
|
2065 | + * @var string $plural |
|
2066 | + * eg 'Dollars' |
|
2067 | + */ |
|
2068 | + public $plural; |
|
2069 | + |
|
2070 | + /** |
|
2071 | + * currency sign |
|
2072 | + * |
|
2073 | + * @var string $sign |
|
2074 | + * eg '$' |
|
2075 | + */ |
|
2076 | + public $sign; |
|
2077 | + |
|
2078 | + /** |
|
2079 | + * Whether the currency sign should come before the number or not |
|
2080 | + * |
|
2081 | + * @var boolean $sign_b4 |
|
2082 | + */ |
|
2083 | + public $sign_b4; |
|
2084 | + |
|
2085 | + /** |
|
2086 | + * How many digits should come after the decimal place |
|
2087 | + * |
|
2088 | + * @var int $dec_plc |
|
2089 | + */ |
|
2090 | + public $dec_plc; |
|
2091 | + |
|
2092 | + /** |
|
2093 | + * Symbol to use for decimal mark |
|
2094 | + * |
|
2095 | + * @var string $dec_mrk |
|
2096 | + * eg '.' |
|
2097 | + */ |
|
2098 | + public $dec_mrk; |
|
2099 | + |
|
2100 | + /** |
|
2101 | + * Symbol to use for thousands |
|
2102 | + * |
|
2103 | + * @var string $thsnds |
|
2104 | + * eg ',' |
|
2105 | + */ |
|
2106 | + public $thsnds; |
|
2107 | + |
|
2108 | + |
|
2109 | + /** |
|
2110 | + * class constructor |
|
2111 | + * |
|
2112 | + * @access public |
|
2113 | + * @param string $CNT_ISO |
|
2114 | + * @throws \EE_Error |
|
2115 | + */ |
|
2116 | + public function __construct($CNT_ISO = '') |
|
2117 | + { |
|
2118 | + /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */ |
|
2119 | + $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
2120 | + // get country code from organization settings or use default |
|
2121 | + $ORG_CNT = isset(EE_Registry::instance()->CFG->organization) |
|
2122 | + && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config |
|
2123 | + ? EE_Registry::instance()->CFG->organization->CNT_ISO |
|
2124 | + : ''; |
|
2125 | + // but override if requested |
|
2126 | + $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT; |
|
2127 | + // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists |
|
2128 | + if (! empty($CNT_ISO) |
|
2129 | + && EE_Maintenance_Mode::instance()->models_can_query() |
|
2130 | + && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table()) |
|
2131 | + ) { |
|
2132 | + // retrieve the country settings from the db, just in case they have been customized |
|
2133 | + $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO); |
|
2134 | + if ($country instanceof EE_Country) { |
|
2135 | + $this->code = $country->currency_code(); // currency code: USD, CAD, EUR |
|
2136 | + $this->name = $country->currency_name_single(); // Dollar |
|
2137 | + $this->plural = $country->currency_name_plural(); // Dollars |
|
2138 | + $this->sign = $country->currency_sign(); // currency sign: $ |
|
2139 | + $this->sign_b4 = $country->currency_sign_before( |
|
2140 | + ); // currency sign before or after: $TRUE or FALSE$ |
|
2141 | + $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00 3 = 0.000 |
|
2142 | + $this->dec_mrk = $country->currency_decimal_mark( |
|
2143 | + ); // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
2144 | + $this->thsnds = $country->currency_thousands_separator( |
|
2145 | + ); // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
2146 | + } |
|
2147 | + } |
|
2148 | + // fallback to hardcoded defaults, in case the above failed |
|
2149 | + if (empty($this->code)) { |
|
2150 | + // set default currency settings |
|
2151 | + $this->code = 'USD'; // currency code: USD, CAD, EUR |
|
2152 | + $this->name = __('Dollar', 'event_espresso'); // Dollar |
|
2153 | + $this->plural = __('Dollars', 'event_espresso'); // Dollars |
|
2154 | + $this->sign = '$'; // currency sign: $ |
|
2155 | + $this->sign_b4 = true; // currency sign before or after: $TRUE or FALSE$ |
|
2156 | + $this->dec_plc = 2; // decimal places: 2 = 0.00 3 = 0.000 |
|
2157 | + $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
2158 | + $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
2159 | + } |
|
2160 | + } |
|
2161 | +} |
|
2321 | 2162 | |
2322 | - /** |
|
2323 | - * Label text to show on the checkbox |
|
2324 | - * |
|
2325 | - * @var string |
|
2326 | - */ |
|
2327 | - public $consent_checkbox_label_text; |
|
2163 | +/** |
|
2164 | + * Class for defining what's in the EE_Config relating to registration settings |
|
2165 | + */ |
|
2166 | +class EE_Registration_Config extends EE_Config_Base |
|
2167 | +{ |
|
2328 | 2168 | |
2329 | - /* |
|
2169 | + /** |
|
2170 | + * Default registration status |
|
2171 | + * |
|
2172 | + * @var string $default_STS_ID |
|
2173 | + * eg 'RPP' |
|
2174 | + */ |
|
2175 | + public $default_STS_ID; |
|
2176 | + |
|
2177 | + /** |
|
2178 | + * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of |
|
2179 | + * registrations) |
|
2180 | + * |
|
2181 | + * @var int |
|
2182 | + */ |
|
2183 | + public $default_maximum_number_of_tickets; |
|
2184 | + |
|
2185 | + /** |
|
2186 | + * level of validation to apply to email addresses |
|
2187 | + * |
|
2188 | + * @var string $email_validation_level |
|
2189 | + * options: 'basic', 'wp_default', 'i18n', 'i18n_dns' |
|
2190 | + */ |
|
2191 | + public $email_validation_level; |
|
2192 | + |
|
2193 | + /** |
|
2194 | + * whether or not to show alternate payment options during the reg process if payment status is pending |
|
2195 | + * |
|
2196 | + * @var boolean $show_pending_payment_options |
|
2197 | + */ |
|
2198 | + public $show_pending_payment_options; |
|
2199 | + |
|
2200 | + /** |
|
2201 | + * Whether to skip the registration confirmation page |
|
2202 | + * |
|
2203 | + * @var boolean $skip_reg_confirmation |
|
2204 | + */ |
|
2205 | + public $skip_reg_confirmation; |
|
2206 | + |
|
2207 | + /** |
|
2208 | + * an array of SPCO reg steps where: |
|
2209 | + * the keys denotes the reg step order |
|
2210 | + * each element consists of an array with the following elements: |
|
2211 | + * "file_path" => the file path to the EE_SPCO_Reg_Step class |
|
2212 | + * "class_name" => the specific EE_SPCO_Reg_Step child class name |
|
2213 | + * "slug" => the URL param used to trigger the reg step |
|
2214 | + * |
|
2215 | + * @var array $reg_steps |
|
2216 | + */ |
|
2217 | + public $reg_steps; |
|
2218 | + |
|
2219 | + /** |
|
2220 | + * Whether registration confirmation should be the last page of SPCO |
|
2221 | + * |
|
2222 | + * @var boolean $reg_confirmation_last |
|
2223 | + */ |
|
2224 | + public $reg_confirmation_last; |
|
2225 | + |
|
2226 | + /** |
|
2227 | + * Whether or not to enable the EE Bot Trap |
|
2228 | + * |
|
2229 | + * @var boolean $use_bot_trap |
|
2230 | + */ |
|
2231 | + public $use_bot_trap; |
|
2232 | + |
|
2233 | + /** |
|
2234 | + * Whether or not to encrypt some data sent by the EE Bot Trap |
|
2235 | + * |
|
2236 | + * @var boolean $use_encryption |
|
2237 | + */ |
|
2238 | + public $use_encryption; |
|
2239 | + |
|
2240 | + /** |
|
2241 | + * Whether or not to use ReCaptcha |
|
2242 | + * |
|
2243 | + * @var boolean $use_captcha |
|
2244 | + */ |
|
2245 | + public $use_captcha; |
|
2246 | + |
|
2247 | + /** |
|
2248 | + * ReCaptcha Theme |
|
2249 | + * |
|
2250 | + * @var string $recaptcha_theme |
|
2251 | + * options: 'dark', 'light', 'invisible' |
|
2252 | + */ |
|
2253 | + public $recaptcha_theme; |
|
2254 | + |
|
2255 | + /** |
|
2256 | + * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha. |
|
2257 | + * |
|
2258 | + * @var string $recaptcha_badge |
|
2259 | + * options: 'bottomright', 'bottomleft', 'inline' |
|
2260 | + */ |
|
2261 | + public $recaptcha_badge; |
|
2262 | + |
|
2263 | + /** |
|
2264 | + * ReCaptcha Type |
|
2265 | + * |
|
2266 | + * @var string $recaptcha_type |
|
2267 | + * options: 'audio', 'image' |
|
2268 | + */ |
|
2269 | + public $recaptcha_type; |
|
2270 | + |
|
2271 | + /** |
|
2272 | + * ReCaptcha language |
|
2273 | + * |
|
2274 | + * @var string $recaptcha_language |
|
2275 | + * eg 'en' |
|
2276 | + */ |
|
2277 | + public $recaptcha_language; |
|
2278 | + |
|
2279 | + /** |
|
2280 | + * ReCaptcha public key |
|
2281 | + * |
|
2282 | + * @var string $recaptcha_publickey |
|
2283 | + */ |
|
2284 | + public $recaptcha_publickey; |
|
2285 | + |
|
2286 | + /** |
|
2287 | + * ReCaptcha private key |
|
2288 | + * |
|
2289 | + * @var string $recaptcha_privatekey |
|
2290 | + */ |
|
2291 | + public $recaptcha_privatekey; |
|
2292 | + |
|
2293 | + /** |
|
2294 | + * array of form names protected by ReCaptcha |
|
2295 | + * |
|
2296 | + * @var array $recaptcha_protected_forms |
|
2297 | + */ |
|
2298 | + public $recaptcha_protected_forms; |
|
2299 | + |
|
2300 | + /** |
|
2301 | + * ReCaptcha width |
|
2302 | + * |
|
2303 | + * @var int $recaptcha_width |
|
2304 | + * @deprecated |
|
2305 | + */ |
|
2306 | + public $recaptcha_width; |
|
2307 | + |
|
2308 | + /** |
|
2309 | + * Whether or not invalid attempts to directly access the registration checkout page should be tracked. |
|
2310 | + * |
|
2311 | + * @var boolean $track_invalid_checkout_access |
|
2312 | + */ |
|
2313 | + protected $track_invalid_checkout_access = true; |
|
2314 | + |
|
2315 | + /** |
|
2316 | + * Whether or not to show the privacy policy consent checkbox |
|
2317 | + * |
|
2318 | + * @var bool |
|
2319 | + */ |
|
2320 | + public $consent_checkbox_enabled; |
|
2321 | + |
|
2322 | + /** |
|
2323 | + * Label text to show on the checkbox |
|
2324 | + * |
|
2325 | + * @var string |
|
2326 | + */ |
|
2327 | + public $consent_checkbox_label_text; |
|
2328 | + |
|
2329 | + /* |
|
2330 | 2330 | * String describing how long to keep payment logs. Passed into DateTime constructor |
2331 | 2331 | * @var string |
2332 | 2332 | */ |
2333 | - public $gateway_log_lifespan = '1 week'; |
|
2334 | - |
|
2335 | - |
|
2336 | - /** |
|
2337 | - * class constructor |
|
2338 | - * |
|
2339 | - * @access public |
|
2340 | - */ |
|
2341 | - public function __construct() |
|
2342 | - { |
|
2343 | - // set default registration settings |
|
2344 | - $this->default_STS_ID = EEM_Registration::status_id_pending_payment; |
|
2345 | - $this->email_validation_level = 'wp_default'; |
|
2346 | - $this->show_pending_payment_options = true; |
|
2347 | - $this->skip_reg_confirmation = true; |
|
2348 | - $this->reg_steps = array(); |
|
2349 | - $this->reg_confirmation_last = false; |
|
2350 | - $this->use_bot_trap = true; |
|
2351 | - $this->use_encryption = true; |
|
2352 | - $this->use_captcha = false; |
|
2353 | - $this->recaptcha_theme = 'light'; |
|
2354 | - $this->recaptcha_badge = 'bottomleft'; |
|
2355 | - $this->recaptcha_type = 'image'; |
|
2356 | - $this->recaptcha_language = 'en'; |
|
2357 | - $this->recaptcha_publickey = null; |
|
2358 | - $this->recaptcha_privatekey = null; |
|
2359 | - $this->recaptcha_protected_forms = array(); |
|
2360 | - $this->recaptcha_width = 500; |
|
2361 | - $this->default_maximum_number_of_tickets = 10; |
|
2362 | - $this->consent_checkbox_enabled = false; |
|
2363 | - $this->consent_checkbox_label_text = ''; |
|
2364 | - $this->gateway_log_lifespan = '7 days'; |
|
2365 | - } |
|
2366 | - |
|
2367 | - |
|
2368 | - /** |
|
2369 | - * This is called by the config loader and hooks are initialized AFTER the config has been populated. |
|
2370 | - * |
|
2371 | - * @since 4.8.8.rc.019 |
|
2372 | - */ |
|
2373 | - public function do_hooks() |
|
2374 | - { |
|
2375 | - add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event')); |
|
2376 | - add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event')); |
|
2377 | - add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText')); |
|
2378 | - } |
|
2379 | - |
|
2380 | - |
|
2381 | - /** |
|
2382 | - * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the |
|
2383 | - * EVT_default_registration_status field matches the config setting for default_STS_ID. |
|
2384 | - */ |
|
2385 | - public function set_default_reg_status_on_EEM_Event() |
|
2386 | - { |
|
2387 | - EEM_Event::set_default_reg_status($this->default_STS_ID); |
|
2388 | - } |
|
2389 | - |
|
2390 | - |
|
2391 | - /** |
|
2392 | - * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field |
|
2393 | - * for Events matches the config setting for default_maximum_number_of_tickets |
|
2394 | - */ |
|
2395 | - public function set_default_max_ticket_on_EEM_Event() |
|
2396 | - { |
|
2397 | - EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets); |
|
2398 | - } |
|
2399 | - |
|
2400 | - |
|
2401 | - /** |
|
2402 | - * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is |
|
2403 | - * constructed because that happens before we can get the privacy policy page's permalink. |
|
2404 | - * |
|
2405 | - * @throws InvalidArgumentException |
|
2406 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
2407 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
2408 | - */ |
|
2409 | - public function setDefaultCheckboxLabelText() |
|
2410 | - { |
|
2411 | - if ($this->getConsentCheckboxLabelText() === null |
|
2412 | - || $this->getConsentCheckboxLabelText() === '') { |
|
2413 | - $opening_a_tag = ''; |
|
2414 | - $closing_a_tag = ''; |
|
2415 | - if (function_exists('get_privacy_policy_url')) { |
|
2416 | - $privacy_page_url = get_privacy_policy_url(); |
|
2417 | - if (! empty($privacy_page_url)) { |
|
2418 | - $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">'; |
|
2419 | - $closing_a_tag = '</a>'; |
|
2420 | - } |
|
2421 | - } |
|
2422 | - $loader = LoaderFactory::getLoader(); |
|
2423 | - $org_config = $loader->getShared('EE_Organization_Config'); |
|
2424 | - /** |
|
2425 | - * @var $org_config EE_Organization_Config |
|
2426 | - */ |
|
2427 | - |
|
2428 | - $this->setConsentCheckboxLabelText( |
|
2429 | - sprintf( |
|
2430 | - esc_html__( |
|
2431 | - 'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.', |
|
2432 | - 'event_espresso' |
|
2433 | - ), |
|
2434 | - $org_config->name, |
|
2435 | - $opening_a_tag, |
|
2436 | - $closing_a_tag |
|
2437 | - ) |
|
2438 | - ); |
|
2439 | - } |
|
2440 | - } |
|
2441 | - |
|
2442 | - |
|
2443 | - /** |
|
2444 | - * @return boolean |
|
2445 | - */ |
|
2446 | - public function track_invalid_checkout_access() |
|
2447 | - { |
|
2448 | - return $this->track_invalid_checkout_access; |
|
2449 | - } |
|
2450 | - |
|
2451 | - |
|
2452 | - /** |
|
2453 | - * @param boolean $track_invalid_checkout_access |
|
2454 | - */ |
|
2455 | - public function set_track_invalid_checkout_access($track_invalid_checkout_access) |
|
2456 | - { |
|
2457 | - $this->track_invalid_checkout_access = filter_var( |
|
2458 | - $track_invalid_checkout_access, |
|
2459 | - FILTER_VALIDATE_BOOLEAN |
|
2460 | - ); |
|
2461 | - } |
|
2462 | - |
|
2463 | - |
|
2464 | - /** |
|
2465 | - * Gets the options to make availalbe for the gateway log lifespan |
|
2466 | - * @return array |
|
2467 | - */ |
|
2468 | - public function gatewayLogLifespanOptions() |
|
2469 | - { |
|
2470 | - return (array) apply_filters( |
|
2471 | - 'FHEE_EE_Admin_Config__gatewayLogLifespanOptions', |
|
2472 | - array( |
|
2473 | - '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'), |
|
2474 | - '1 day' => esc_html__('1 Day', 'event_espresso'), |
|
2475 | - '7 days' => esc_html__('7 Days', 'event_espresso'), |
|
2476 | - '14 days' => esc_html__('14 Days', 'event_espresso'), |
|
2477 | - '30 days' => esc_html__('30 Days', 'event_espresso') |
|
2478 | - ) |
|
2479 | - ); |
|
2480 | - } |
|
2481 | - |
|
2482 | - |
|
2483 | - /** |
|
2484 | - * @return bool |
|
2485 | - */ |
|
2486 | - public function isConsentCheckboxEnabled() |
|
2487 | - { |
|
2488 | - return $this->consent_checkbox_enabled; |
|
2489 | - } |
|
2490 | - |
|
2491 | - |
|
2492 | - /** |
|
2493 | - * @param bool $consent_checkbox_enabled |
|
2494 | - */ |
|
2495 | - public function setConsentCheckboxEnabled($consent_checkbox_enabled) |
|
2496 | - { |
|
2497 | - $this->consent_checkbox_enabled = filter_var( |
|
2498 | - $consent_checkbox_enabled, |
|
2499 | - FILTER_VALIDATE_BOOLEAN |
|
2500 | - ); |
|
2501 | - } |
|
2502 | - |
|
2503 | - |
|
2504 | - /** |
|
2505 | - * @return string |
|
2506 | - */ |
|
2507 | - public function getConsentCheckboxLabelText() |
|
2508 | - { |
|
2509 | - return $this->consent_checkbox_label_text; |
|
2510 | - } |
|
2511 | - |
|
2512 | - |
|
2513 | - /** |
|
2514 | - * @param string $consent_checkbox_label_text |
|
2515 | - */ |
|
2516 | - public function setConsentCheckboxLabelText($consent_checkbox_label_text) |
|
2517 | - { |
|
2518 | - $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text; |
|
2519 | - } |
|
2333 | + public $gateway_log_lifespan = '1 week'; |
|
2334 | + |
|
2335 | + |
|
2336 | + /** |
|
2337 | + * class constructor |
|
2338 | + * |
|
2339 | + * @access public |
|
2340 | + */ |
|
2341 | + public function __construct() |
|
2342 | + { |
|
2343 | + // set default registration settings |
|
2344 | + $this->default_STS_ID = EEM_Registration::status_id_pending_payment; |
|
2345 | + $this->email_validation_level = 'wp_default'; |
|
2346 | + $this->show_pending_payment_options = true; |
|
2347 | + $this->skip_reg_confirmation = true; |
|
2348 | + $this->reg_steps = array(); |
|
2349 | + $this->reg_confirmation_last = false; |
|
2350 | + $this->use_bot_trap = true; |
|
2351 | + $this->use_encryption = true; |
|
2352 | + $this->use_captcha = false; |
|
2353 | + $this->recaptcha_theme = 'light'; |
|
2354 | + $this->recaptcha_badge = 'bottomleft'; |
|
2355 | + $this->recaptcha_type = 'image'; |
|
2356 | + $this->recaptcha_language = 'en'; |
|
2357 | + $this->recaptcha_publickey = null; |
|
2358 | + $this->recaptcha_privatekey = null; |
|
2359 | + $this->recaptcha_protected_forms = array(); |
|
2360 | + $this->recaptcha_width = 500; |
|
2361 | + $this->default_maximum_number_of_tickets = 10; |
|
2362 | + $this->consent_checkbox_enabled = false; |
|
2363 | + $this->consent_checkbox_label_text = ''; |
|
2364 | + $this->gateway_log_lifespan = '7 days'; |
|
2365 | + } |
|
2366 | + |
|
2367 | + |
|
2368 | + /** |
|
2369 | + * This is called by the config loader and hooks are initialized AFTER the config has been populated. |
|
2370 | + * |
|
2371 | + * @since 4.8.8.rc.019 |
|
2372 | + */ |
|
2373 | + public function do_hooks() |
|
2374 | + { |
|
2375 | + add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event')); |
|
2376 | + add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event')); |
|
2377 | + add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText')); |
|
2378 | + } |
|
2379 | + |
|
2380 | + |
|
2381 | + /** |
|
2382 | + * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the |
|
2383 | + * EVT_default_registration_status field matches the config setting for default_STS_ID. |
|
2384 | + */ |
|
2385 | + public function set_default_reg_status_on_EEM_Event() |
|
2386 | + { |
|
2387 | + EEM_Event::set_default_reg_status($this->default_STS_ID); |
|
2388 | + } |
|
2389 | + |
|
2390 | + |
|
2391 | + /** |
|
2392 | + * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field |
|
2393 | + * for Events matches the config setting for default_maximum_number_of_tickets |
|
2394 | + */ |
|
2395 | + public function set_default_max_ticket_on_EEM_Event() |
|
2396 | + { |
|
2397 | + EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets); |
|
2398 | + } |
|
2399 | + |
|
2400 | + |
|
2401 | + /** |
|
2402 | + * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is |
|
2403 | + * constructed because that happens before we can get the privacy policy page's permalink. |
|
2404 | + * |
|
2405 | + * @throws InvalidArgumentException |
|
2406 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
2407 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
2408 | + */ |
|
2409 | + public function setDefaultCheckboxLabelText() |
|
2410 | + { |
|
2411 | + if ($this->getConsentCheckboxLabelText() === null |
|
2412 | + || $this->getConsentCheckboxLabelText() === '') { |
|
2413 | + $opening_a_tag = ''; |
|
2414 | + $closing_a_tag = ''; |
|
2415 | + if (function_exists('get_privacy_policy_url')) { |
|
2416 | + $privacy_page_url = get_privacy_policy_url(); |
|
2417 | + if (! empty($privacy_page_url)) { |
|
2418 | + $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">'; |
|
2419 | + $closing_a_tag = '</a>'; |
|
2420 | + } |
|
2421 | + } |
|
2422 | + $loader = LoaderFactory::getLoader(); |
|
2423 | + $org_config = $loader->getShared('EE_Organization_Config'); |
|
2424 | + /** |
|
2425 | + * @var $org_config EE_Organization_Config |
|
2426 | + */ |
|
2427 | + |
|
2428 | + $this->setConsentCheckboxLabelText( |
|
2429 | + sprintf( |
|
2430 | + esc_html__( |
|
2431 | + 'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.', |
|
2432 | + 'event_espresso' |
|
2433 | + ), |
|
2434 | + $org_config->name, |
|
2435 | + $opening_a_tag, |
|
2436 | + $closing_a_tag |
|
2437 | + ) |
|
2438 | + ); |
|
2439 | + } |
|
2440 | + } |
|
2441 | + |
|
2442 | + |
|
2443 | + /** |
|
2444 | + * @return boolean |
|
2445 | + */ |
|
2446 | + public function track_invalid_checkout_access() |
|
2447 | + { |
|
2448 | + return $this->track_invalid_checkout_access; |
|
2449 | + } |
|
2450 | + |
|
2451 | + |
|
2452 | + /** |
|
2453 | + * @param boolean $track_invalid_checkout_access |
|
2454 | + */ |
|
2455 | + public function set_track_invalid_checkout_access($track_invalid_checkout_access) |
|
2456 | + { |
|
2457 | + $this->track_invalid_checkout_access = filter_var( |
|
2458 | + $track_invalid_checkout_access, |
|
2459 | + FILTER_VALIDATE_BOOLEAN |
|
2460 | + ); |
|
2461 | + } |
|
2462 | + |
|
2463 | + |
|
2464 | + /** |
|
2465 | + * Gets the options to make availalbe for the gateway log lifespan |
|
2466 | + * @return array |
|
2467 | + */ |
|
2468 | + public function gatewayLogLifespanOptions() |
|
2469 | + { |
|
2470 | + return (array) apply_filters( |
|
2471 | + 'FHEE_EE_Admin_Config__gatewayLogLifespanOptions', |
|
2472 | + array( |
|
2473 | + '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'), |
|
2474 | + '1 day' => esc_html__('1 Day', 'event_espresso'), |
|
2475 | + '7 days' => esc_html__('7 Days', 'event_espresso'), |
|
2476 | + '14 days' => esc_html__('14 Days', 'event_espresso'), |
|
2477 | + '30 days' => esc_html__('30 Days', 'event_espresso') |
|
2478 | + ) |
|
2479 | + ); |
|
2480 | + } |
|
2481 | + |
|
2482 | + |
|
2483 | + /** |
|
2484 | + * @return bool |
|
2485 | + */ |
|
2486 | + public function isConsentCheckboxEnabled() |
|
2487 | + { |
|
2488 | + return $this->consent_checkbox_enabled; |
|
2489 | + } |
|
2490 | + |
|
2491 | + |
|
2492 | + /** |
|
2493 | + * @param bool $consent_checkbox_enabled |
|
2494 | + */ |
|
2495 | + public function setConsentCheckboxEnabled($consent_checkbox_enabled) |
|
2496 | + { |
|
2497 | + $this->consent_checkbox_enabled = filter_var( |
|
2498 | + $consent_checkbox_enabled, |
|
2499 | + FILTER_VALIDATE_BOOLEAN |
|
2500 | + ); |
|
2501 | + } |
|
2502 | + |
|
2503 | + |
|
2504 | + /** |
|
2505 | + * @return string |
|
2506 | + */ |
|
2507 | + public function getConsentCheckboxLabelText() |
|
2508 | + { |
|
2509 | + return $this->consent_checkbox_label_text; |
|
2510 | + } |
|
2511 | + |
|
2512 | + |
|
2513 | + /** |
|
2514 | + * @param string $consent_checkbox_label_text |
|
2515 | + */ |
|
2516 | + public function setConsentCheckboxLabelText($consent_checkbox_label_text) |
|
2517 | + { |
|
2518 | + $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text; |
|
2519 | + } |
|
2520 | 2520 | } |
2521 | 2521 | |
2522 | 2522 | /** |
@@ -2525,151 +2525,151 @@ discard block |
||
2525 | 2525 | class EE_Admin_Config extends EE_Config_Base |
2526 | 2526 | { |
2527 | 2527 | |
2528 | - /** |
|
2529 | - * @var boolean $use_personnel_manager |
|
2530 | - */ |
|
2531 | - public $use_personnel_manager; |
|
2532 | - |
|
2533 | - /** |
|
2534 | - * @var boolean $use_dashboard_widget |
|
2535 | - */ |
|
2536 | - public $use_dashboard_widget; |
|
2537 | - |
|
2538 | - /** |
|
2539 | - * @var int $events_in_dashboard |
|
2540 | - */ |
|
2541 | - public $events_in_dashboard; |
|
2542 | - |
|
2543 | - /** |
|
2544 | - * @var boolean $use_event_timezones |
|
2545 | - */ |
|
2546 | - public $use_event_timezones; |
|
2547 | - |
|
2548 | - /** |
|
2549 | - * @var string $log_file_name |
|
2550 | - */ |
|
2551 | - public $log_file_name; |
|
2552 | - |
|
2553 | - /** |
|
2554 | - * @var string $debug_file_name |
|
2555 | - */ |
|
2556 | - public $debug_file_name; |
|
2557 | - |
|
2558 | - /** |
|
2559 | - * @var boolean $use_remote_logging |
|
2560 | - */ |
|
2561 | - public $use_remote_logging; |
|
2562 | - |
|
2563 | - /** |
|
2564 | - * @var string $remote_logging_url |
|
2565 | - */ |
|
2566 | - public $remote_logging_url; |
|
2567 | - |
|
2568 | - /** |
|
2569 | - * @var boolean $show_reg_footer |
|
2570 | - */ |
|
2571 | - public $show_reg_footer; |
|
2572 | - |
|
2573 | - /** |
|
2574 | - * @var string $affiliate_id |
|
2575 | - */ |
|
2576 | - public $affiliate_id; |
|
2577 | - |
|
2578 | - /** |
|
2579 | - * help tours on or off (global setting) |
|
2580 | - * |
|
2581 | - * @var boolean |
|
2582 | - */ |
|
2583 | - public $help_tour_activation; |
|
2584 | - |
|
2585 | - /** |
|
2586 | - * adds extra layer of encoding to session data to prevent serialization errors |
|
2587 | - * but is incompatible with some server configuration errors |
|
2588 | - * if you get "500 internal server errors" during registration, try turning this on |
|
2589 | - * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off |
|
2590 | - * |
|
2591 | - * @var boolean $encode_session_data |
|
2592 | - */ |
|
2593 | - private $encode_session_data = false; |
|
2594 | - |
|
2595 | - |
|
2596 | - /** |
|
2597 | - * class constructor |
|
2598 | - * |
|
2599 | - * @access public |
|
2600 | - */ |
|
2601 | - public function __construct() |
|
2602 | - { |
|
2603 | - // set default general admin settings |
|
2604 | - $this->use_personnel_manager = true; |
|
2605 | - $this->use_dashboard_widget = true; |
|
2606 | - $this->events_in_dashboard = 30; |
|
2607 | - $this->use_event_timezones = false; |
|
2608 | - $this->use_remote_logging = false; |
|
2609 | - $this->remote_logging_url = null; |
|
2610 | - $this->show_reg_footer = apply_filters( |
|
2611 | - 'FHEE__EE_Admin_Config__show_reg_footer__default', |
|
2612 | - false |
|
2613 | - ); |
|
2614 | - $this->affiliate_id = 'default'; |
|
2615 | - $this->help_tour_activation = true; |
|
2616 | - $this->encode_session_data = false; |
|
2617 | - } |
|
2618 | - |
|
2619 | - |
|
2620 | - /** |
|
2621 | - * @param bool $reset |
|
2622 | - * @return string |
|
2623 | - */ |
|
2624 | - public function log_file_name($reset = false) |
|
2625 | - { |
|
2626 | - if (empty($this->log_file_name) || $reset) { |
|
2627 | - $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt'; |
|
2628 | - EE_Config::instance()->update_espresso_config(false, false); |
|
2629 | - } |
|
2630 | - return $this->log_file_name; |
|
2631 | - } |
|
2632 | - |
|
2633 | - |
|
2634 | - /** |
|
2635 | - * @param bool $reset |
|
2636 | - * @return string |
|
2637 | - */ |
|
2638 | - public function debug_file_name($reset = false) |
|
2639 | - { |
|
2640 | - if (empty($this->debug_file_name) || $reset) { |
|
2641 | - $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt'; |
|
2642 | - EE_Config::instance()->update_espresso_config(false, false); |
|
2643 | - } |
|
2644 | - return $this->debug_file_name; |
|
2645 | - } |
|
2646 | - |
|
2647 | - |
|
2648 | - /** |
|
2649 | - * @return string |
|
2650 | - */ |
|
2651 | - public function affiliate_id() |
|
2652 | - { |
|
2653 | - return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default'; |
|
2654 | - } |
|
2655 | - |
|
2656 | - |
|
2657 | - /** |
|
2658 | - * @return boolean |
|
2659 | - */ |
|
2660 | - public function encode_session_data() |
|
2661 | - { |
|
2662 | - return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
2663 | - } |
|
2664 | - |
|
2665 | - |
|
2666 | - /** |
|
2667 | - * @param boolean $encode_session_data |
|
2668 | - */ |
|
2669 | - public function set_encode_session_data($encode_session_data) |
|
2670 | - { |
|
2671 | - $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
2672 | - } |
|
2528 | + /** |
|
2529 | + * @var boolean $use_personnel_manager |
|
2530 | + */ |
|
2531 | + public $use_personnel_manager; |
|
2532 | + |
|
2533 | + /** |
|
2534 | + * @var boolean $use_dashboard_widget |
|
2535 | + */ |
|
2536 | + public $use_dashboard_widget; |
|
2537 | + |
|
2538 | + /** |
|
2539 | + * @var int $events_in_dashboard |
|
2540 | + */ |
|
2541 | + public $events_in_dashboard; |
|
2542 | + |
|
2543 | + /** |
|
2544 | + * @var boolean $use_event_timezones |
|
2545 | + */ |
|
2546 | + public $use_event_timezones; |
|
2547 | + |
|
2548 | + /** |
|
2549 | + * @var string $log_file_name |
|
2550 | + */ |
|
2551 | + public $log_file_name; |
|
2552 | + |
|
2553 | + /** |
|
2554 | + * @var string $debug_file_name |
|
2555 | + */ |
|
2556 | + public $debug_file_name; |
|
2557 | + |
|
2558 | + /** |
|
2559 | + * @var boolean $use_remote_logging |
|
2560 | + */ |
|
2561 | + public $use_remote_logging; |
|
2562 | + |
|
2563 | + /** |
|
2564 | + * @var string $remote_logging_url |
|
2565 | + */ |
|
2566 | + public $remote_logging_url; |
|
2567 | + |
|
2568 | + /** |
|
2569 | + * @var boolean $show_reg_footer |
|
2570 | + */ |
|
2571 | + public $show_reg_footer; |
|
2572 | + |
|
2573 | + /** |
|
2574 | + * @var string $affiliate_id |
|
2575 | + */ |
|
2576 | + public $affiliate_id; |
|
2577 | + |
|
2578 | + /** |
|
2579 | + * help tours on or off (global setting) |
|
2580 | + * |
|
2581 | + * @var boolean |
|
2582 | + */ |
|
2583 | + public $help_tour_activation; |
|
2584 | + |
|
2585 | + /** |
|
2586 | + * adds extra layer of encoding to session data to prevent serialization errors |
|
2587 | + * but is incompatible with some server configuration errors |
|
2588 | + * if you get "500 internal server errors" during registration, try turning this on |
|
2589 | + * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off |
|
2590 | + * |
|
2591 | + * @var boolean $encode_session_data |
|
2592 | + */ |
|
2593 | + private $encode_session_data = false; |
|
2594 | + |
|
2595 | + |
|
2596 | + /** |
|
2597 | + * class constructor |
|
2598 | + * |
|
2599 | + * @access public |
|
2600 | + */ |
|
2601 | + public function __construct() |
|
2602 | + { |
|
2603 | + // set default general admin settings |
|
2604 | + $this->use_personnel_manager = true; |
|
2605 | + $this->use_dashboard_widget = true; |
|
2606 | + $this->events_in_dashboard = 30; |
|
2607 | + $this->use_event_timezones = false; |
|
2608 | + $this->use_remote_logging = false; |
|
2609 | + $this->remote_logging_url = null; |
|
2610 | + $this->show_reg_footer = apply_filters( |
|
2611 | + 'FHEE__EE_Admin_Config__show_reg_footer__default', |
|
2612 | + false |
|
2613 | + ); |
|
2614 | + $this->affiliate_id = 'default'; |
|
2615 | + $this->help_tour_activation = true; |
|
2616 | + $this->encode_session_data = false; |
|
2617 | + } |
|
2618 | + |
|
2619 | + |
|
2620 | + /** |
|
2621 | + * @param bool $reset |
|
2622 | + * @return string |
|
2623 | + */ |
|
2624 | + public function log_file_name($reset = false) |
|
2625 | + { |
|
2626 | + if (empty($this->log_file_name) || $reset) { |
|
2627 | + $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt'; |
|
2628 | + EE_Config::instance()->update_espresso_config(false, false); |
|
2629 | + } |
|
2630 | + return $this->log_file_name; |
|
2631 | + } |
|
2632 | + |
|
2633 | + |
|
2634 | + /** |
|
2635 | + * @param bool $reset |
|
2636 | + * @return string |
|
2637 | + */ |
|
2638 | + public function debug_file_name($reset = false) |
|
2639 | + { |
|
2640 | + if (empty($this->debug_file_name) || $reset) { |
|
2641 | + $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt'; |
|
2642 | + EE_Config::instance()->update_espresso_config(false, false); |
|
2643 | + } |
|
2644 | + return $this->debug_file_name; |
|
2645 | + } |
|
2646 | + |
|
2647 | + |
|
2648 | + /** |
|
2649 | + * @return string |
|
2650 | + */ |
|
2651 | + public function affiliate_id() |
|
2652 | + { |
|
2653 | + return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default'; |
|
2654 | + } |
|
2655 | + |
|
2656 | + |
|
2657 | + /** |
|
2658 | + * @return boolean |
|
2659 | + */ |
|
2660 | + public function encode_session_data() |
|
2661 | + { |
|
2662 | + return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
2663 | + } |
|
2664 | + |
|
2665 | + |
|
2666 | + /** |
|
2667 | + * @param boolean $encode_session_data |
|
2668 | + */ |
|
2669 | + public function set_encode_session_data($encode_session_data) |
|
2670 | + { |
|
2671 | + $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
2672 | + } |
|
2673 | 2673 | } |
2674 | 2674 | |
2675 | 2675 | /** |
@@ -2678,70 +2678,70 @@ discard block |
||
2678 | 2678 | class EE_Template_Config extends EE_Config_Base |
2679 | 2679 | { |
2680 | 2680 | |
2681 | - /** |
|
2682 | - * @var boolean $enable_default_style |
|
2683 | - */ |
|
2684 | - public $enable_default_style; |
|
2685 | - |
|
2686 | - /** |
|
2687 | - * @var string $custom_style_sheet |
|
2688 | - */ |
|
2689 | - public $custom_style_sheet; |
|
2690 | - |
|
2691 | - /** |
|
2692 | - * @var boolean $display_address_in_regform |
|
2693 | - */ |
|
2694 | - public $display_address_in_regform; |
|
2695 | - |
|
2696 | - /** |
|
2697 | - * @var int $display_description_on_multi_reg_page |
|
2698 | - */ |
|
2699 | - public $display_description_on_multi_reg_page; |
|
2700 | - |
|
2701 | - /** |
|
2702 | - * @var boolean $use_custom_templates |
|
2703 | - */ |
|
2704 | - public $use_custom_templates; |
|
2705 | - |
|
2706 | - /** |
|
2707 | - * @var string $current_espresso_theme |
|
2708 | - */ |
|
2709 | - public $current_espresso_theme; |
|
2710 | - |
|
2711 | - /** |
|
2712 | - * @var EE_Ticket_Selector_Config $EED_Ticket_Selector |
|
2713 | - */ |
|
2714 | - public $EED_Ticket_Selector; |
|
2715 | - |
|
2716 | - /** |
|
2717 | - * @var EE_Event_Single_Config $EED_Event_Single |
|
2718 | - */ |
|
2719 | - public $EED_Event_Single; |
|
2720 | - |
|
2721 | - /** |
|
2722 | - * @var EE_Events_Archive_Config $EED_Events_Archive |
|
2723 | - */ |
|
2724 | - public $EED_Events_Archive; |
|
2725 | - |
|
2726 | - |
|
2727 | - /** |
|
2728 | - * class constructor |
|
2729 | - * |
|
2730 | - * @access public |
|
2731 | - */ |
|
2732 | - public function __construct() |
|
2733 | - { |
|
2734 | - // set default template settings |
|
2735 | - $this->enable_default_style = true; |
|
2736 | - $this->custom_style_sheet = null; |
|
2737 | - $this->display_address_in_regform = true; |
|
2738 | - $this->display_description_on_multi_reg_page = false; |
|
2739 | - $this->use_custom_templates = false; |
|
2740 | - $this->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
2741 | - $this->EED_Event_Single = null; |
|
2742 | - $this->EED_Events_Archive = null; |
|
2743 | - $this->EED_Ticket_Selector = null; |
|
2744 | - } |
|
2681 | + /** |
|
2682 | + * @var boolean $enable_default_style |
|
2683 | + */ |
|
2684 | + public $enable_default_style; |
|
2685 | + |
|
2686 | + /** |
|
2687 | + * @var string $custom_style_sheet |
|
2688 | + */ |
|
2689 | + public $custom_style_sheet; |
|
2690 | + |
|
2691 | + /** |
|
2692 | + * @var boolean $display_address_in_regform |
|
2693 | + */ |
|
2694 | + public $display_address_in_regform; |
|
2695 | + |
|
2696 | + /** |
|
2697 | + * @var int $display_description_on_multi_reg_page |
|
2698 | + */ |
|
2699 | + public $display_description_on_multi_reg_page; |
|
2700 | + |
|
2701 | + /** |
|
2702 | + * @var boolean $use_custom_templates |
|
2703 | + */ |
|
2704 | + public $use_custom_templates; |
|
2705 | + |
|
2706 | + /** |
|
2707 | + * @var string $current_espresso_theme |
|
2708 | + */ |
|
2709 | + public $current_espresso_theme; |
|
2710 | + |
|
2711 | + /** |
|
2712 | + * @var EE_Ticket_Selector_Config $EED_Ticket_Selector |
|
2713 | + */ |
|
2714 | + public $EED_Ticket_Selector; |
|
2715 | + |
|
2716 | + /** |
|
2717 | + * @var EE_Event_Single_Config $EED_Event_Single |
|
2718 | + */ |
|
2719 | + public $EED_Event_Single; |
|
2720 | + |
|
2721 | + /** |
|
2722 | + * @var EE_Events_Archive_Config $EED_Events_Archive |
|
2723 | + */ |
|
2724 | + public $EED_Events_Archive; |
|
2725 | + |
|
2726 | + |
|
2727 | + /** |
|
2728 | + * class constructor |
|
2729 | + * |
|
2730 | + * @access public |
|
2731 | + */ |
|
2732 | + public function __construct() |
|
2733 | + { |
|
2734 | + // set default template settings |
|
2735 | + $this->enable_default_style = true; |
|
2736 | + $this->custom_style_sheet = null; |
|
2737 | + $this->display_address_in_regform = true; |
|
2738 | + $this->display_description_on_multi_reg_page = false; |
|
2739 | + $this->use_custom_templates = false; |
|
2740 | + $this->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
2741 | + $this->EED_Event_Single = null; |
|
2742 | + $this->EED_Events_Archive = null; |
|
2743 | + $this->EED_Ticket_Selector = null; |
|
2744 | + } |
|
2745 | 2745 | } |
2746 | 2746 | |
2747 | 2747 | /** |
@@ -2750,114 +2750,114 @@ discard block |
||
2750 | 2750 | class EE_Map_Config extends EE_Config_Base |
2751 | 2751 | { |
2752 | 2752 | |
2753 | - /** |
|
2754 | - * @var boolean $use_google_maps |
|
2755 | - */ |
|
2756 | - public $use_google_maps; |
|
2757 | - |
|
2758 | - /** |
|
2759 | - * @var string $api_key |
|
2760 | - */ |
|
2761 | - public $google_map_api_key; |
|
2762 | - |
|
2763 | - /** |
|
2764 | - * @var int $event_details_map_width |
|
2765 | - */ |
|
2766 | - public $event_details_map_width; |
|
2767 | - |
|
2768 | - /** |
|
2769 | - * @var int $event_details_map_height |
|
2770 | - */ |
|
2771 | - public $event_details_map_height; |
|
2772 | - |
|
2773 | - /** |
|
2774 | - * @var int $event_details_map_zoom |
|
2775 | - */ |
|
2776 | - public $event_details_map_zoom; |
|
2777 | - |
|
2778 | - /** |
|
2779 | - * @var boolean $event_details_display_nav |
|
2780 | - */ |
|
2781 | - public $event_details_display_nav; |
|
2782 | - |
|
2783 | - /** |
|
2784 | - * @var boolean $event_details_nav_size |
|
2785 | - */ |
|
2786 | - public $event_details_nav_size; |
|
2787 | - |
|
2788 | - /** |
|
2789 | - * @var string $event_details_control_type |
|
2790 | - */ |
|
2791 | - public $event_details_control_type; |
|
2792 | - |
|
2793 | - /** |
|
2794 | - * @var string $event_details_map_align |
|
2795 | - */ |
|
2796 | - public $event_details_map_align; |
|
2797 | - |
|
2798 | - /** |
|
2799 | - * @var int $event_list_map_width |
|
2800 | - */ |
|
2801 | - public $event_list_map_width; |
|
2802 | - |
|
2803 | - /** |
|
2804 | - * @var int $event_list_map_height |
|
2805 | - */ |
|
2806 | - public $event_list_map_height; |
|
2807 | - |
|
2808 | - /** |
|
2809 | - * @var int $event_list_map_zoom |
|
2810 | - */ |
|
2811 | - public $event_list_map_zoom; |
|
2812 | - |
|
2813 | - /** |
|
2814 | - * @var boolean $event_list_display_nav |
|
2815 | - */ |
|
2816 | - public $event_list_display_nav; |
|
2817 | - |
|
2818 | - /** |
|
2819 | - * @var boolean $event_list_nav_size |
|
2820 | - */ |
|
2821 | - public $event_list_nav_size; |
|
2822 | - |
|
2823 | - /** |
|
2824 | - * @var string $event_list_control_type |
|
2825 | - */ |
|
2826 | - public $event_list_control_type; |
|
2827 | - |
|
2828 | - /** |
|
2829 | - * @var string $event_list_map_align |
|
2830 | - */ |
|
2831 | - public $event_list_map_align; |
|
2832 | - |
|
2833 | - |
|
2834 | - /** |
|
2835 | - * class constructor |
|
2836 | - * |
|
2837 | - * @access public |
|
2838 | - */ |
|
2839 | - public function __construct() |
|
2840 | - { |
|
2841 | - // set default map settings |
|
2842 | - $this->use_google_maps = true; |
|
2843 | - $this->google_map_api_key = ''; |
|
2844 | - // for event details pages (reg page) |
|
2845 | - $this->event_details_map_width = 585; // ee_map_width_single |
|
2846 | - $this->event_details_map_height = 362; // ee_map_height_single |
|
2847 | - $this->event_details_map_zoom = 14; // ee_map_zoom_single |
|
2848 | - $this->event_details_display_nav = true; // ee_map_nav_display_single |
|
2849 | - $this->event_details_nav_size = false; // ee_map_nav_size_single |
|
2850 | - $this->event_details_control_type = 'default'; // ee_map_type_control_single |
|
2851 | - $this->event_details_map_align = 'center'; // ee_map_align_single |
|
2852 | - // for event list pages |
|
2853 | - $this->event_list_map_width = 300; // ee_map_width |
|
2854 | - $this->event_list_map_height = 185; // ee_map_height |
|
2855 | - $this->event_list_map_zoom = 12; // ee_map_zoom |
|
2856 | - $this->event_list_display_nav = false; // ee_map_nav_display |
|
2857 | - $this->event_list_nav_size = true; // ee_map_nav_size |
|
2858 | - $this->event_list_control_type = 'dropdown'; // ee_map_type_control |
|
2859 | - $this->event_list_map_align = 'center'; // ee_map_align |
|
2860 | - } |
|
2753 | + /** |
|
2754 | + * @var boolean $use_google_maps |
|
2755 | + */ |
|
2756 | + public $use_google_maps; |
|
2757 | + |
|
2758 | + /** |
|
2759 | + * @var string $api_key |
|
2760 | + */ |
|
2761 | + public $google_map_api_key; |
|
2762 | + |
|
2763 | + /** |
|
2764 | + * @var int $event_details_map_width |
|
2765 | + */ |
|
2766 | + public $event_details_map_width; |
|
2767 | + |
|
2768 | + /** |
|
2769 | + * @var int $event_details_map_height |
|
2770 | + */ |
|
2771 | + public $event_details_map_height; |
|
2772 | + |
|
2773 | + /** |
|
2774 | + * @var int $event_details_map_zoom |
|
2775 | + */ |
|
2776 | + public $event_details_map_zoom; |
|
2777 | + |
|
2778 | + /** |
|
2779 | + * @var boolean $event_details_display_nav |
|
2780 | + */ |
|
2781 | + public $event_details_display_nav; |
|
2782 | + |
|
2783 | + /** |
|
2784 | + * @var boolean $event_details_nav_size |
|
2785 | + */ |
|
2786 | + public $event_details_nav_size; |
|
2787 | + |
|
2788 | + /** |
|
2789 | + * @var string $event_details_control_type |
|
2790 | + */ |
|
2791 | + public $event_details_control_type; |
|
2792 | + |
|
2793 | + /** |
|
2794 | + * @var string $event_details_map_align |
|
2795 | + */ |
|
2796 | + public $event_details_map_align; |
|
2797 | + |
|
2798 | + /** |
|
2799 | + * @var int $event_list_map_width |
|
2800 | + */ |
|
2801 | + public $event_list_map_width; |
|
2802 | + |
|
2803 | + /** |
|
2804 | + * @var int $event_list_map_height |
|
2805 | + */ |
|
2806 | + public $event_list_map_height; |
|
2807 | + |
|
2808 | + /** |
|
2809 | + * @var int $event_list_map_zoom |
|
2810 | + */ |
|
2811 | + public $event_list_map_zoom; |
|
2812 | + |
|
2813 | + /** |
|
2814 | + * @var boolean $event_list_display_nav |
|
2815 | + */ |
|
2816 | + public $event_list_display_nav; |
|
2817 | + |
|
2818 | + /** |
|
2819 | + * @var boolean $event_list_nav_size |
|
2820 | + */ |
|
2821 | + public $event_list_nav_size; |
|
2822 | + |
|
2823 | + /** |
|
2824 | + * @var string $event_list_control_type |
|
2825 | + */ |
|
2826 | + public $event_list_control_type; |
|
2827 | + |
|
2828 | + /** |
|
2829 | + * @var string $event_list_map_align |
|
2830 | + */ |
|
2831 | + public $event_list_map_align; |
|
2832 | + |
|
2833 | + |
|
2834 | + /** |
|
2835 | + * class constructor |
|
2836 | + * |
|
2837 | + * @access public |
|
2838 | + */ |
|
2839 | + public function __construct() |
|
2840 | + { |
|
2841 | + // set default map settings |
|
2842 | + $this->use_google_maps = true; |
|
2843 | + $this->google_map_api_key = ''; |
|
2844 | + // for event details pages (reg page) |
|
2845 | + $this->event_details_map_width = 585; // ee_map_width_single |
|
2846 | + $this->event_details_map_height = 362; // ee_map_height_single |
|
2847 | + $this->event_details_map_zoom = 14; // ee_map_zoom_single |
|
2848 | + $this->event_details_display_nav = true; // ee_map_nav_display_single |
|
2849 | + $this->event_details_nav_size = false; // ee_map_nav_size_single |
|
2850 | + $this->event_details_control_type = 'default'; // ee_map_type_control_single |
|
2851 | + $this->event_details_map_align = 'center'; // ee_map_align_single |
|
2852 | + // for event list pages |
|
2853 | + $this->event_list_map_width = 300; // ee_map_width |
|
2854 | + $this->event_list_map_height = 185; // ee_map_height |
|
2855 | + $this->event_list_map_zoom = 12; // ee_map_zoom |
|
2856 | + $this->event_list_display_nav = false; // ee_map_nav_display |
|
2857 | + $this->event_list_nav_size = true; // ee_map_nav_size |
|
2858 | + $this->event_list_control_type = 'dropdown'; // ee_map_type_control |
|
2859 | + $this->event_list_map_align = 'center'; // ee_map_align |
|
2860 | + } |
|
2861 | 2861 | } |
2862 | 2862 | |
2863 | 2863 | /** |
@@ -2866,46 +2866,46 @@ discard block |
||
2866 | 2866 | class EE_Events_Archive_Config extends EE_Config_Base |
2867 | 2867 | { |
2868 | 2868 | |
2869 | - public $display_status_banner; |
|
2869 | + public $display_status_banner; |
|
2870 | 2870 | |
2871 | - public $display_description; |
|
2871 | + public $display_description; |
|
2872 | 2872 | |
2873 | - public $display_ticket_selector; |
|
2873 | + public $display_ticket_selector; |
|
2874 | 2874 | |
2875 | - public $display_datetimes; |
|
2875 | + public $display_datetimes; |
|
2876 | 2876 | |
2877 | - public $display_venue; |
|
2877 | + public $display_venue; |
|
2878 | 2878 | |
2879 | - public $display_expired_events; |
|
2879 | + public $display_expired_events; |
|
2880 | 2880 | |
2881 | - public $use_sortable_display_order; |
|
2881 | + public $use_sortable_display_order; |
|
2882 | 2882 | |
2883 | - public $display_order_tickets; |
|
2883 | + public $display_order_tickets; |
|
2884 | 2884 | |
2885 | - public $display_order_datetimes; |
|
2885 | + public $display_order_datetimes; |
|
2886 | 2886 | |
2887 | - public $display_order_event; |
|
2887 | + public $display_order_event; |
|
2888 | 2888 | |
2889 | - public $display_order_venue; |
|
2889 | + public $display_order_venue; |
|
2890 | 2890 | |
2891 | 2891 | |
2892 | - /** |
|
2893 | - * class constructor |
|
2894 | - */ |
|
2895 | - public function __construct() |
|
2896 | - { |
|
2897 | - $this->display_status_banner = 0; |
|
2898 | - $this->display_description = 1; |
|
2899 | - $this->display_ticket_selector = 0; |
|
2900 | - $this->display_datetimes = 1; |
|
2901 | - $this->display_venue = 0; |
|
2902 | - $this->display_expired_events = 0; |
|
2903 | - $this->use_sortable_display_order = false; |
|
2904 | - $this->display_order_tickets = 100; |
|
2905 | - $this->display_order_datetimes = 110; |
|
2906 | - $this->display_order_event = 120; |
|
2907 | - $this->display_order_venue = 130; |
|
2908 | - } |
|
2892 | + /** |
|
2893 | + * class constructor |
|
2894 | + */ |
|
2895 | + public function __construct() |
|
2896 | + { |
|
2897 | + $this->display_status_banner = 0; |
|
2898 | + $this->display_description = 1; |
|
2899 | + $this->display_ticket_selector = 0; |
|
2900 | + $this->display_datetimes = 1; |
|
2901 | + $this->display_venue = 0; |
|
2902 | + $this->display_expired_events = 0; |
|
2903 | + $this->use_sortable_display_order = false; |
|
2904 | + $this->display_order_tickets = 100; |
|
2905 | + $this->display_order_datetimes = 110; |
|
2906 | + $this->display_order_event = 120; |
|
2907 | + $this->display_order_venue = 130; |
|
2908 | + } |
|
2909 | 2909 | } |
2910 | 2910 | |
2911 | 2911 | /** |
@@ -2914,34 +2914,34 @@ discard block |
||
2914 | 2914 | class EE_Event_Single_Config extends EE_Config_Base |
2915 | 2915 | { |
2916 | 2916 | |
2917 | - public $display_status_banner_single; |
|
2917 | + public $display_status_banner_single; |
|
2918 | 2918 | |
2919 | - public $display_venue; |
|
2919 | + public $display_venue; |
|
2920 | 2920 | |
2921 | - public $use_sortable_display_order; |
|
2921 | + public $use_sortable_display_order; |
|
2922 | 2922 | |
2923 | - public $display_order_tickets; |
|
2923 | + public $display_order_tickets; |
|
2924 | 2924 | |
2925 | - public $display_order_datetimes; |
|
2925 | + public $display_order_datetimes; |
|
2926 | 2926 | |
2927 | - public $display_order_event; |
|
2927 | + public $display_order_event; |
|
2928 | 2928 | |
2929 | - public $display_order_venue; |
|
2929 | + public $display_order_venue; |
|
2930 | 2930 | |
2931 | 2931 | |
2932 | - /** |
|
2933 | - * class constructor |
|
2934 | - */ |
|
2935 | - public function __construct() |
|
2936 | - { |
|
2937 | - $this->display_status_banner_single = 0; |
|
2938 | - $this->display_venue = 1; |
|
2939 | - $this->use_sortable_display_order = false; |
|
2940 | - $this->display_order_tickets = 100; |
|
2941 | - $this->display_order_datetimes = 110; |
|
2942 | - $this->display_order_event = 120; |
|
2943 | - $this->display_order_venue = 130; |
|
2944 | - } |
|
2932 | + /** |
|
2933 | + * class constructor |
|
2934 | + */ |
|
2935 | + public function __construct() |
|
2936 | + { |
|
2937 | + $this->display_status_banner_single = 0; |
|
2938 | + $this->display_venue = 1; |
|
2939 | + $this->use_sortable_display_order = false; |
|
2940 | + $this->display_order_tickets = 100; |
|
2941 | + $this->display_order_datetimes = 110; |
|
2942 | + $this->display_order_event = 120; |
|
2943 | + $this->display_order_venue = 130; |
|
2944 | + } |
|
2945 | 2945 | } |
2946 | 2946 | |
2947 | 2947 | /** |
@@ -2950,172 +2950,172 @@ discard block |
||
2950 | 2950 | class EE_Ticket_Selector_Config extends EE_Config_Base |
2951 | 2951 | { |
2952 | 2952 | |
2953 | - /** |
|
2954 | - * constant to indicate that a datetime selector should NEVER be shown for ticket selectors |
|
2955 | - */ |
|
2956 | - const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector'; |
|
2957 | - |
|
2958 | - /** |
|
2959 | - * constant to indicate that a datetime selector should only be shown for ticket selectors |
|
2960 | - * when the number of datetimes for the event matches the value set for $datetime_selector_threshold |
|
2961 | - */ |
|
2962 | - const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector'; |
|
2963 | - |
|
2964 | - /** |
|
2965 | - * @var boolean $show_ticket_sale_columns |
|
2966 | - */ |
|
2967 | - public $show_ticket_sale_columns; |
|
2968 | - |
|
2969 | - /** |
|
2970 | - * @var boolean $show_ticket_details |
|
2971 | - */ |
|
2972 | - public $show_ticket_details; |
|
2973 | - |
|
2974 | - /** |
|
2975 | - * @var boolean $show_expired_tickets |
|
2976 | - */ |
|
2977 | - public $show_expired_tickets; |
|
2978 | - |
|
2979 | - /** |
|
2980 | - * whether or not to display a dropdown box populated with event datetimes |
|
2981 | - * that toggles which tickets are displayed for a ticket selector. |
|
2982 | - * uses one of the *_DATETIME_SELECTOR constants defined above |
|
2983 | - * |
|
2984 | - * @var string $show_datetime_selector |
|
2985 | - */ |
|
2986 | - private $show_datetime_selector = 'no_datetime_selector'; |
|
2987 | - |
|
2988 | - /** |
|
2989 | - * the number of datetimes an event has to have before conditionally displaying a datetime selector |
|
2990 | - * |
|
2991 | - * @var int $datetime_selector_threshold |
|
2992 | - */ |
|
2993 | - private $datetime_selector_threshold = 3; |
|
2994 | - |
|
2995 | - /** |
|
2996 | - * determines the maximum number of "checked" dates in the date and time filter |
|
2997 | - * |
|
2998 | - * @var int $datetime_selector_checked |
|
2999 | - */ |
|
3000 | - private $datetime_selector_max_checked = 10; |
|
3001 | - |
|
3002 | - |
|
3003 | - /** |
|
3004 | - * class constructor |
|
3005 | - */ |
|
3006 | - public function __construct() |
|
3007 | - { |
|
3008 | - $this->show_ticket_sale_columns = true; |
|
3009 | - $this->show_ticket_details = true; |
|
3010 | - $this->show_expired_tickets = true; |
|
3011 | - $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
3012 | - $this->datetime_selector_threshold = 3; |
|
3013 | - $this->datetime_selector_max_checked = 10; |
|
3014 | - } |
|
3015 | - |
|
3016 | - |
|
3017 | - /** |
|
3018 | - * returns true if a datetime selector should be displayed |
|
3019 | - * |
|
3020 | - * @param array $datetimes |
|
3021 | - * @return bool |
|
3022 | - */ |
|
3023 | - public function showDatetimeSelector(array $datetimes) |
|
3024 | - { |
|
3025 | - // if the settings are NOT: don't show OR below threshold, THEN active = true |
|
3026 | - return ! ( |
|
3027 | - $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR |
|
3028 | - || ( |
|
3029 | - $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR |
|
3030 | - && count($datetimes) < $this->getDatetimeSelectorThreshold() |
|
3031 | - ) |
|
3032 | - ); |
|
3033 | - } |
|
3034 | - |
|
3035 | - |
|
3036 | - /** |
|
3037 | - * @return string |
|
3038 | - */ |
|
3039 | - public function getShowDatetimeSelector() |
|
3040 | - { |
|
3041 | - return $this->show_datetime_selector; |
|
3042 | - } |
|
3043 | - |
|
3044 | - |
|
3045 | - /** |
|
3046 | - * @param bool $keys_only |
|
3047 | - * @return array |
|
3048 | - */ |
|
3049 | - public function getShowDatetimeSelectorOptions($keys_only = true) |
|
3050 | - { |
|
3051 | - return $keys_only |
|
3052 | - ? array( |
|
3053 | - \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR, |
|
3054 | - \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR, |
|
3055 | - ) |
|
3056 | - : array( |
|
3057 | - \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__( |
|
3058 | - 'Do not show date & time filter', |
|
3059 | - 'event_espresso' |
|
3060 | - ), |
|
3061 | - \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR => esc_html__( |
|
3062 | - 'Maybe show date & time filter', |
|
3063 | - 'event_espresso' |
|
3064 | - ), |
|
3065 | - ); |
|
3066 | - } |
|
3067 | - |
|
3068 | - |
|
3069 | - /** |
|
3070 | - * @param string $show_datetime_selector |
|
3071 | - */ |
|
3072 | - public function setShowDatetimeSelector($show_datetime_selector) |
|
3073 | - { |
|
3074 | - $this->show_datetime_selector = in_array( |
|
3075 | - $show_datetime_selector, |
|
3076 | - $this->getShowDatetimeSelectorOptions(), |
|
3077 | - true |
|
3078 | - ) |
|
3079 | - ? $show_datetime_selector |
|
3080 | - : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
3081 | - } |
|
3082 | - |
|
3083 | - |
|
3084 | - /** |
|
3085 | - * @return int |
|
3086 | - */ |
|
3087 | - public function getDatetimeSelectorThreshold() |
|
3088 | - { |
|
3089 | - return $this->datetime_selector_threshold; |
|
3090 | - } |
|
3091 | - |
|
3092 | - |
|
3093 | - /** |
|
3094 | - * @param int $datetime_selector_threshold |
|
3095 | - */ |
|
3096 | - public function setDatetimeSelectorThreshold($datetime_selector_threshold) |
|
3097 | - { |
|
3098 | - $datetime_selector_threshold = absint($datetime_selector_threshold); |
|
3099 | - $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3; |
|
3100 | - } |
|
3101 | - |
|
3102 | - |
|
3103 | - /** |
|
3104 | - * @return int |
|
3105 | - */ |
|
3106 | - public function getDatetimeSelectorMaxChecked() |
|
3107 | - { |
|
3108 | - return $this->datetime_selector_max_checked; |
|
3109 | - } |
|
3110 | - |
|
3111 | - |
|
3112 | - /** |
|
3113 | - * @param int $datetime_selector_max_checked |
|
3114 | - */ |
|
3115 | - public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked) |
|
3116 | - { |
|
3117 | - $this->datetime_selector_max_checked = absint($datetime_selector_max_checked); |
|
3118 | - } |
|
2953 | + /** |
|
2954 | + * constant to indicate that a datetime selector should NEVER be shown for ticket selectors |
|
2955 | + */ |
|
2956 | + const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector'; |
|
2957 | + |
|
2958 | + /** |
|
2959 | + * constant to indicate that a datetime selector should only be shown for ticket selectors |
|
2960 | + * when the number of datetimes for the event matches the value set for $datetime_selector_threshold |
|
2961 | + */ |
|
2962 | + const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector'; |
|
2963 | + |
|
2964 | + /** |
|
2965 | + * @var boolean $show_ticket_sale_columns |
|
2966 | + */ |
|
2967 | + public $show_ticket_sale_columns; |
|
2968 | + |
|
2969 | + /** |
|
2970 | + * @var boolean $show_ticket_details |
|
2971 | + */ |
|
2972 | + public $show_ticket_details; |
|
2973 | + |
|
2974 | + /** |
|
2975 | + * @var boolean $show_expired_tickets |
|
2976 | + */ |
|
2977 | + public $show_expired_tickets; |
|
2978 | + |
|
2979 | + /** |
|
2980 | + * whether or not to display a dropdown box populated with event datetimes |
|
2981 | + * that toggles which tickets are displayed for a ticket selector. |
|
2982 | + * uses one of the *_DATETIME_SELECTOR constants defined above |
|
2983 | + * |
|
2984 | + * @var string $show_datetime_selector |
|
2985 | + */ |
|
2986 | + private $show_datetime_selector = 'no_datetime_selector'; |
|
2987 | + |
|
2988 | + /** |
|
2989 | + * the number of datetimes an event has to have before conditionally displaying a datetime selector |
|
2990 | + * |
|
2991 | + * @var int $datetime_selector_threshold |
|
2992 | + */ |
|
2993 | + private $datetime_selector_threshold = 3; |
|
2994 | + |
|
2995 | + /** |
|
2996 | + * determines the maximum number of "checked" dates in the date and time filter |
|
2997 | + * |
|
2998 | + * @var int $datetime_selector_checked |
|
2999 | + */ |
|
3000 | + private $datetime_selector_max_checked = 10; |
|
3001 | + |
|
3002 | + |
|
3003 | + /** |
|
3004 | + * class constructor |
|
3005 | + */ |
|
3006 | + public function __construct() |
|
3007 | + { |
|
3008 | + $this->show_ticket_sale_columns = true; |
|
3009 | + $this->show_ticket_details = true; |
|
3010 | + $this->show_expired_tickets = true; |
|
3011 | + $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
3012 | + $this->datetime_selector_threshold = 3; |
|
3013 | + $this->datetime_selector_max_checked = 10; |
|
3014 | + } |
|
3015 | + |
|
3016 | + |
|
3017 | + /** |
|
3018 | + * returns true if a datetime selector should be displayed |
|
3019 | + * |
|
3020 | + * @param array $datetimes |
|
3021 | + * @return bool |
|
3022 | + */ |
|
3023 | + public function showDatetimeSelector(array $datetimes) |
|
3024 | + { |
|
3025 | + // if the settings are NOT: don't show OR below threshold, THEN active = true |
|
3026 | + return ! ( |
|
3027 | + $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR |
|
3028 | + || ( |
|
3029 | + $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR |
|
3030 | + && count($datetimes) < $this->getDatetimeSelectorThreshold() |
|
3031 | + ) |
|
3032 | + ); |
|
3033 | + } |
|
3034 | + |
|
3035 | + |
|
3036 | + /** |
|
3037 | + * @return string |
|
3038 | + */ |
|
3039 | + public function getShowDatetimeSelector() |
|
3040 | + { |
|
3041 | + return $this->show_datetime_selector; |
|
3042 | + } |
|
3043 | + |
|
3044 | + |
|
3045 | + /** |
|
3046 | + * @param bool $keys_only |
|
3047 | + * @return array |
|
3048 | + */ |
|
3049 | + public function getShowDatetimeSelectorOptions($keys_only = true) |
|
3050 | + { |
|
3051 | + return $keys_only |
|
3052 | + ? array( |
|
3053 | + \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR, |
|
3054 | + \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR, |
|
3055 | + ) |
|
3056 | + : array( |
|
3057 | + \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__( |
|
3058 | + 'Do not show date & time filter', |
|
3059 | + 'event_espresso' |
|
3060 | + ), |
|
3061 | + \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR => esc_html__( |
|
3062 | + 'Maybe show date & time filter', |
|
3063 | + 'event_espresso' |
|
3064 | + ), |
|
3065 | + ); |
|
3066 | + } |
|
3067 | + |
|
3068 | + |
|
3069 | + /** |
|
3070 | + * @param string $show_datetime_selector |
|
3071 | + */ |
|
3072 | + public function setShowDatetimeSelector($show_datetime_selector) |
|
3073 | + { |
|
3074 | + $this->show_datetime_selector = in_array( |
|
3075 | + $show_datetime_selector, |
|
3076 | + $this->getShowDatetimeSelectorOptions(), |
|
3077 | + true |
|
3078 | + ) |
|
3079 | + ? $show_datetime_selector |
|
3080 | + : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
3081 | + } |
|
3082 | + |
|
3083 | + |
|
3084 | + /** |
|
3085 | + * @return int |
|
3086 | + */ |
|
3087 | + public function getDatetimeSelectorThreshold() |
|
3088 | + { |
|
3089 | + return $this->datetime_selector_threshold; |
|
3090 | + } |
|
3091 | + |
|
3092 | + |
|
3093 | + /** |
|
3094 | + * @param int $datetime_selector_threshold |
|
3095 | + */ |
|
3096 | + public function setDatetimeSelectorThreshold($datetime_selector_threshold) |
|
3097 | + { |
|
3098 | + $datetime_selector_threshold = absint($datetime_selector_threshold); |
|
3099 | + $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3; |
|
3100 | + } |
|
3101 | + |
|
3102 | + |
|
3103 | + /** |
|
3104 | + * @return int |
|
3105 | + */ |
|
3106 | + public function getDatetimeSelectorMaxChecked() |
|
3107 | + { |
|
3108 | + return $this->datetime_selector_max_checked; |
|
3109 | + } |
|
3110 | + |
|
3111 | + |
|
3112 | + /** |
|
3113 | + * @param int $datetime_selector_max_checked |
|
3114 | + */ |
|
3115 | + public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked) |
|
3116 | + { |
|
3117 | + $this->datetime_selector_max_checked = absint($datetime_selector_max_checked); |
|
3118 | + } |
|
3119 | 3119 | } |
3120 | 3120 | |
3121 | 3121 | /** |
@@ -3128,86 +3128,86 @@ discard block |
||
3128 | 3128 | class EE_Environment_Config extends EE_Config_Base |
3129 | 3129 | { |
3130 | 3130 | |
3131 | - /** |
|
3132 | - * Hold any php environment variables that we want to track. |
|
3133 | - * |
|
3134 | - * @var stdClass; |
|
3135 | - */ |
|
3136 | - public $php; |
|
3137 | - |
|
3138 | - |
|
3139 | - /** |
|
3140 | - * constructor |
|
3141 | - */ |
|
3142 | - public function __construct() |
|
3143 | - { |
|
3144 | - $this->php = new stdClass(); |
|
3145 | - $this->_set_php_values(); |
|
3146 | - } |
|
3147 | - |
|
3148 | - |
|
3149 | - /** |
|
3150 | - * This sets the php environment variables. |
|
3151 | - * |
|
3152 | - * @since 4.4.0 |
|
3153 | - * @return void |
|
3154 | - */ |
|
3155 | - protected function _set_php_values() |
|
3156 | - { |
|
3157 | - $this->php->max_input_vars = ini_get('max_input_vars'); |
|
3158 | - $this->php->version = phpversion(); |
|
3159 | - } |
|
3160 | - |
|
3161 | - |
|
3162 | - /** |
|
3163 | - * helper method for determining whether input_count is |
|
3164 | - * reaching the potential maximum the server can handle |
|
3165 | - * according to max_input_vars |
|
3166 | - * |
|
3167 | - * @param int $input_count the count of input vars. |
|
3168 | - * @return array { |
|
3169 | - * An array that represents whether available space and if no available space the error |
|
3170 | - * message. |
|
3171 | - * @type bool $has_space whether more inputs can be added. |
|
3172 | - * @type string $msg Any message to be displayed. |
|
3173 | - * } |
|
3174 | - */ |
|
3175 | - public function max_input_vars_limit_check($input_count = 0) |
|
3176 | - { |
|
3177 | - if (! empty($this->php->max_input_vars) |
|
3178 | - && ($input_count >= $this->php->max_input_vars) |
|
3179 | - ) { |
|
3180 | - // check the server setting because the config value could be stale |
|
3181 | - $max_input_vars = ini_get('max_input_vars'); |
|
3182 | - if ($input_count >= $max_input_vars) { |
|
3183 | - return sprintf( |
|
3184 | - esc_html__( |
|
3185 | - 'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.', |
|
3186 | - 'event_espresso' |
|
3187 | - ), |
|
3188 | - '<br>', |
|
3189 | - $input_count, |
|
3190 | - $max_input_vars |
|
3191 | - ); |
|
3192 | - } else { |
|
3193 | - return ''; |
|
3194 | - } |
|
3195 | - } else { |
|
3196 | - return ''; |
|
3197 | - } |
|
3198 | - } |
|
3199 | - |
|
3200 | - |
|
3201 | - /** |
|
3202 | - * The purpose of this method is just to force rechecking php values so if they've changed, they get updated. |
|
3203 | - * |
|
3204 | - * @since 4.4.1 |
|
3205 | - * @return void |
|
3206 | - */ |
|
3207 | - public function recheck_values() |
|
3208 | - { |
|
3209 | - $this->_set_php_values(); |
|
3210 | - } |
|
3131 | + /** |
|
3132 | + * Hold any php environment variables that we want to track. |
|
3133 | + * |
|
3134 | + * @var stdClass; |
|
3135 | + */ |
|
3136 | + public $php; |
|
3137 | + |
|
3138 | + |
|
3139 | + /** |
|
3140 | + * constructor |
|
3141 | + */ |
|
3142 | + public function __construct() |
|
3143 | + { |
|
3144 | + $this->php = new stdClass(); |
|
3145 | + $this->_set_php_values(); |
|
3146 | + } |
|
3147 | + |
|
3148 | + |
|
3149 | + /** |
|
3150 | + * This sets the php environment variables. |
|
3151 | + * |
|
3152 | + * @since 4.4.0 |
|
3153 | + * @return void |
|
3154 | + */ |
|
3155 | + protected function _set_php_values() |
|
3156 | + { |
|
3157 | + $this->php->max_input_vars = ini_get('max_input_vars'); |
|
3158 | + $this->php->version = phpversion(); |
|
3159 | + } |
|
3160 | + |
|
3161 | + |
|
3162 | + /** |
|
3163 | + * helper method for determining whether input_count is |
|
3164 | + * reaching the potential maximum the server can handle |
|
3165 | + * according to max_input_vars |
|
3166 | + * |
|
3167 | + * @param int $input_count the count of input vars. |
|
3168 | + * @return array { |
|
3169 | + * An array that represents whether available space and if no available space the error |
|
3170 | + * message. |
|
3171 | + * @type bool $has_space whether more inputs can be added. |
|
3172 | + * @type string $msg Any message to be displayed. |
|
3173 | + * } |
|
3174 | + */ |
|
3175 | + public function max_input_vars_limit_check($input_count = 0) |
|
3176 | + { |
|
3177 | + if (! empty($this->php->max_input_vars) |
|
3178 | + && ($input_count >= $this->php->max_input_vars) |
|
3179 | + ) { |
|
3180 | + // check the server setting because the config value could be stale |
|
3181 | + $max_input_vars = ini_get('max_input_vars'); |
|
3182 | + if ($input_count >= $max_input_vars) { |
|
3183 | + return sprintf( |
|
3184 | + esc_html__( |
|
3185 | + 'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.', |
|
3186 | + 'event_espresso' |
|
3187 | + ), |
|
3188 | + '<br>', |
|
3189 | + $input_count, |
|
3190 | + $max_input_vars |
|
3191 | + ); |
|
3192 | + } else { |
|
3193 | + return ''; |
|
3194 | + } |
|
3195 | + } else { |
|
3196 | + return ''; |
|
3197 | + } |
|
3198 | + } |
|
3199 | + |
|
3200 | + |
|
3201 | + /** |
|
3202 | + * The purpose of this method is just to force rechecking php values so if they've changed, they get updated. |
|
3203 | + * |
|
3204 | + * @since 4.4.1 |
|
3205 | + * @return void |
|
3206 | + */ |
|
3207 | + public function recheck_values() |
|
3208 | + { |
|
3209 | + $this->_set_php_values(); |
|
3210 | + } |
|
3211 | 3211 | } |
3212 | 3212 | |
3213 | 3213 | /** |
@@ -3220,21 +3220,21 @@ discard block |
||
3220 | 3220 | class EE_Tax_Config extends EE_Config_Base |
3221 | 3221 | { |
3222 | 3222 | |
3223 | - /* |
|
3223 | + /* |
|
3224 | 3224 | * flag to indicate whether or not to display ticket prices with the taxes included |
3225 | 3225 | * |
3226 | 3226 | * @var boolean $prices_displayed_including_taxes |
3227 | 3227 | */ |
3228 | - public $prices_displayed_including_taxes; |
|
3228 | + public $prices_displayed_including_taxes; |
|
3229 | 3229 | |
3230 | 3230 | |
3231 | - /** |
|
3232 | - * class constructor |
|
3233 | - */ |
|
3234 | - public function __construct() |
|
3235 | - { |
|
3236 | - $this->prices_displayed_including_taxes = true; |
|
3237 | - } |
|
3231 | + /** |
|
3232 | + * class constructor |
|
3233 | + */ |
|
3234 | + public function __construct() |
|
3235 | + { |
|
3236 | + $this->prices_displayed_including_taxes = true; |
|
3237 | + } |
|
3238 | 3238 | } |
3239 | 3239 | |
3240 | 3240 | /** |
@@ -3248,19 +3248,19 @@ discard block |
||
3248 | 3248 | class EE_Messages_Config extends EE_Config_Base |
3249 | 3249 | { |
3250 | 3250 | |
3251 | - /** |
|
3252 | - * This is an integer representing the deletion threshold in months for when old messages will get deleted. |
|
3253 | - * A value of 0 represents never deleting. Default is 0. |
|
3254 | - * |
|
3255 | - * @var integer |
|
3256 | - */ |
|
3257 | - public $delete_threshold; |
|
3251 | + /** |
|
3252 | + * This is an integer representing the deletion threshold in months for when old messages will get deleted. |
|
3253 | + * A value of 0 represents never deleting. Default is 0. |
|
3254 | + * |
|
3255 | + * @var integer |
|
3256 | + */ |
|
3257 | + public $delete_threshold; |
|
3258 | 3258 | |
3259 | 3259 | |
3260 | - public function __construct() |
|
3261 | - { |
|
3262 | - $this->delete_threshold = 0; |
|
3263 | - } |
|
3260 | + public function __construct() |
|
3261 | + { |
|
3262 | + $this->delete_threshold = 0; |
|
3263 | + } |
|
3264 | 3264 | } |
3265 | 3265 | |
3266 | 3266 | /** |
@@ -3271,31 +3271,31 @@ discard block |
||
3271 | 3271 | class EE_Gateway_Config extends EE_Config_Base |
3272 | 3272 | { |
3273 | 3273 | |
3274 | - /** |
|
3275 | - * Array with keys that are payment gateways slugs, and values are arrays |
|
3276 | - * with any config info the gateway wants to store |
|
3277 | - * |
|
3278 | - * @var array |
|
3279 | - */ |
|
3280 | - public $payment_settings; |
|
3281 | - |
|
3282 | - /** |
|
3283 | - * Where keys are gateway slugs, and values are booleans indicating whether or not |
|
3284 | - * the gateway is stored in the uploads directory |
|
3285 | - * |
|
3286 | - * @var array |
|
3287 | - */ |
|
3288 | - public $active_gateways; |
|
3289 | - |
|
3290 | - |
|
3291 | - /** |
|
3292 | - * class constructor |
|
3293 | - * |
|
3294 | - * @deprecated |
|
3295 | - */ |
|
3296 | - public function __construct() |
|
3297 | - { |
|
3298 | - $this->payment_settings = array(); |
|
3299 | - $this->active_gateways = array('Invoice' => false); |
|
3300 | - } |
|
3274 | + /** |
|
3275 | + * Array with keys that are payment gateways slugs, and values are arrays |
|
3276 | + * with any config info the gateway wants to store |
|
3277 | + * |
|
3278 | + * @var array |
|
3279 | + */ |
|
3280 | + public $payment_settings; |
|
3281 | + |
|
3282 | + /** |
|
3283 | + * Where keys are gateway slugs, and values are booleans indicating whether or not |
|
3284 | + * the gateway is stored in the uploads directory |
|
3285 | + * |
|
3286 | + * @var array |
|
3287 | + */ |
|
3288 | + public $active_gateways; |
|
3289 | + |
|
3290 | + |
|
3291 | + /** |
|
3292 | + * class constructor |
|
3293 | + * |
|
3294 | + * @deprecated |
|
3295 | + */ |
|
3296 | + public function __construct() |
|
3297 | + { |
|
3298 | + $this->payment_settings = array(); |
|
3299 | + $this->active_gateways = array('Invoice' => false); |
|
3300 | + } |
|
3301 | 3301 | } |
@@ -17,196 +17,196 @@ |
||
17 | 17 | class EE_Log |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var string |
|
22 | - */ |
|
23 | - private $_log = ''; |
|
24 | - |
|
25 | - /** |
|
26 | - * Used for remote logging |
|
27 | - * |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - private $_remote_logging_url = ''; |
|
31 | - |
|
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - private $_remote_log = ''; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var EE_Log |
|
39 | - */ |
|
40 | - private static $_instance; |
|
41 | - |
|
42 | - |
|
43 | - /** |
|
44 | - * @return EE_Log |
|
45 | - */ |
|
46 | - public static function instance() |
|
47 | - { |
|
48 | - if (! self::$_instance instanceof EE_Log) { |
|
49 | - self::$_instance = new self(); |
|
50 | - } |
|
51 | - return self::$_instance; |
|
52 | - } |
|
53 | - |
|
54 | - /** |
|
55 | - * @access private |
|
56 | - * @return EE_Log |
|
57 | - */ |
|
58 | - private function __construct() |
|
59 | - { |
|
60 | - |
|
61 | - if (! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
62 | - return; |
|
63 | - } |
|
64 | - |
|
65 | - $this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url; |
|
66 | - $this->_remote_log = ''; |
|
67 | - |
|
68 | - if (EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
69 | - add_action('shutdown', array($this, 'send_log'), 9999); |
|
70 | - } |
|
71 | - } |
|
72 | - |
|
73 | - |
|
74 | - /** |
|
75 | - * verify_filesystem |
|
76 | - * tests that the required files and folders exist and are writable |
|
77 | - * |
|
78 | - */ |
|
79 | - public function verify_filesystem() |
|
80 | - { |
|
81 | - $msg = esc_html__( |
|
82 | - 'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.', |
|
83 | - 'event_espresso' |
|
84 | - ); |
|
85 | - EE_Error::doing_it_wrong( |
|
86 | - __METHOD__, |
|
87 | - $msg, |
|
88 | - '$VID:$' |
|
89 | - ); |
|
90 | - } |
|
91 | - |
|
92 | - |
|
93 | - /** |
|
94 | - * _format_message |
|
95 | - * makes yer log entries look all purdy |
|
96 | - * |
|
97 | - * @param string $file |
|
98 | - * @param string $function |
|
99 | - * @param string $message |
|
100 | - * @param string $type |
|
101 | - * @return string |
|
102 | - */ |
|
103 | - private function _format_message($file = '', $function = '', $message = '', $type = '') |
|
104 | - { |
|
105 | - $msg = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
106 | - $msg .= '[' . current_time('mysql') . '] '; |
|
107 | - $msg .= ! empty($file) ? basename($file) : ''; |
|
108 | - $msg .= ! empty($file) && ! empty($function) ? ' -> ' : ''; |
|
109 | - $msg .= ! empty($function) ? $function . '()' : ''; |
|
110 | - $msg .= PHP_EOL; |
|
111 | - $type = ! empty($type) ? $type : 'log message'; |
|
112 | - $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : ''; |
|
113 | - return $msg; |
|
114 | - } |
|
115 | - |
|
116 | - |
|
117 | - /** |
|
118 | - * log |
|
119 | - * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the |
|
120 | - * EE_Log::write_log() callback |
|
121 | - * |
|
122 | - * @param string $file |
|
123 | - * @param string $function |
|
124 | - * @param string $message |
|
125 | - * @param string $type |
|
126 | - */ |
|
127 | - public function log($file = '', $function = '', $message = '', $type = '') |
|
128 | - { |
|
129 | - $this->_log .= $this->_format_message($file, $function, $message, $type); |
|
130 | - } |
|
131 | - |
|
132 | - |
|
133 | - /** |
|
134 | - * write_log |
|
135 | - * appends the results of the 'AHEE_log' filter to the espresso log file |
|
136 | - */ |
|
137 | - public function write_log() |
|
138 | - { |
|
139 | - $msg = esc_html__( |
|
140 | - 'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.', |
|
141 | - 'event_espresso' |
|
142 | - ); |
|
143 | - EE_Error::doing_it_wrong( |
|
144 | - __METHOD__, |
|
145 | - $msg, |
|
146 | - '$VID:$' |
|
147 | - ); |
|
148 | - } |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * send_log |
|
153 | - * sends the espresso log to a remote URL via a PHP cURL request |
|
154 | - */ |
|
155 | - public function send_log() |
|
156 | - { |
|
157 | - |
|
158 | - if (empty($this->_remote_logging_url)) { |
|
159 | - return; |
|
160 | - } |
|
161 | - |
|
162 | - $data = 'domain=' . $_SERVER['HTTP_HOST']; |
|
163 | - $data .= '&ip=' . $_SERVER['SERVER_ADDR']; |
|
164 | - $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE']; |
|
165 | - $data .= '&time=' . time(); |
|
166 | - $data .= '&remote_log=' . $this->_log; |
|
167 | - $data .= '&request_array=' . json_encode($_REQUEST); |
|
168 | - $data .= '&action=save'; |
|
169 | - |
|
170 | - if (defined('EELOGGING_PASS')) { |
|
171 | - $data .= '&pass=' . EELOGGING_PASS; |
|
172 | - } |
|
173 | - if (defined('EELOGGING_KEY')) { |
|
174 | - $data .= '&key=' . EELOGGING_KEY; |
|
175 | - } |
|
176 | - |
|
177 | - $c = curl_init($this->_remote_logging_url); |
|
178 | - curl_setopt($c, CURLOPT_POST, true); |
|
179 | - curl_setopt($c, CURLOPT_POSTFIELDS, $data); |
|
180 | - curl_setopt($c, CURLOPT_RETURNTRANSFER, true); |
|
181 | - curl_exec($c); |
|
182 | - curl_close($c); |
|
183 | - } |
|
184 | - |
|
185 | - |
|
186 | - /** |
|
187 | - * write_debug |
|
188 | - * writes the contents of the current request's $_GET and $_POST arrays to a log file. |
|
189 | - * previous entries are overwritten |
|
190 | - */ |
|
191 | - public function write_debug() |
|
192 | - { |
|
193 | - $msg = esc_html__( |
|
194 | - 'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.', |
|
195 | - 'event_espresso' |
|
196 | - ); |
|
197 | - EE_Error::doing_it_wrong( |
|
198 | - __METHOD__, |
|
199 | - $msg, |
|
200 | - '$VID:$' |
|
201 | - ); |
|
202 | - } |
|
203 | - |
|
204 | - |
|
205 | - /** |
|
206 | - * __clone |
|
207 | - */ |
|
208 | - public function __clone() |
|
209 | - { |
|
210 | - trigger_error(__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR); |
|
211 | - } |
|
20 | + /** |
|
21 | + * @var string |
|
22 | + */ |
|
23 | + private $_log = ''; |
|
24 | + |
|
25 | + /** |
|
26 | + * Used for remote logging |
|
27 | + * |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + private $_remote_logging_url = ''; |
|
31 | + |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + private $_remote_log = ''; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var EE_Log |
|
39 | + */ |
|
40 | + private static $_instance; |
|
41 | + |
|
42 | + |
|
43 | + /** |
|
44 | + * @return EE_Log |
|
45 | + */ |
|
46 | + public static function instance() |
|
47 | + { |
|
48 | + if (! self::$_instance instanceof EE_Log) { |
|
49 | + self::$_instance = new self(); |
|
50 | + } |
|
51 | + return self::$_instance; |
|
52 | + } |
|
53 | + |
|
54 | + /** |
|
55 | + * @access private |
|
56 | + * @return EE_Log |
|
57 | + */ |
|
58 | + private function __construct() |
|
59 | + { |
|
60 | + |
|
61 | + if (! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
62 | + return; |
|
63 | + } |
|
64 | + |
|
65 | + $this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url; |
|
66 | + $this->_remote_log = ''; |
|
67 | + |
|
68 | + if (EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
69 | + add_action('shutdown', array($this, 'send_log'), 9999); |
|
70 | + } |
|
71 | + } |
|
72 | + |
|
73 | + |
|
74 | + /** |
|
75 | + * verify_filesystem |
|
76 | + * tests that the required files and folders exist and are writable |
|
77 | + * |
|
78 | + */ |
|
79 | + public function verify_filesystem() |
|
80 | + { |
|
81 | + $msg = esc_html__( |
|
82 | + 'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.', |
|
83 | + 'event_espresso' |
|
84 | + ); |
|
85 | + EE_Error::doing_it_wrong( |
|
86 | + __METHOD__, |
|
87 | + $msg, |
|
88 | + '$VID:$' |
|
89 | + ); |
|
90 | + } |
|
91 | + |
|
92 | + |
|
93 | + /** |
|
94 | + * _format_message |
|
95 | + * makes yer log entries look all purdy |
|
96 | + * |
|
97 | + * @param string $file |
|
98 | + * @param string $function |
|
99 | + * @param string $message |
|
100 | + * @param string $type |
|
101 | + * @return string |
|
102 | + */ |
|
103 | + private function _format_message($file = '', $function = '', $message = '', $type = '') |
|
104 | + { |
|
105 | + $msg = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
106 | + $msg .= '[' . current_time('mysql') . '] '; |
|
107 | + $msg .= ! empty($file) ? basename($file) : ''; |
|
108 | + $msg .= ! empty($file) && ! empty($function) ? ' -> ' : ''; |
|
109 | + $msg .= ! empty($function) ? $function . '()' : ''; |
|
110 | + $msg .= PHP_EOL; |
|
111 | + $type = ! empty($type) ? $type : 'log message'; |
|
112 | + $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : ''; |
|
113 | + return $msg; |
|
114 | + } |
|
115 | + |
|
116 | + |
|
117 | + /** |
|
118 | + * log |
|
119 | + * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the |
|
120 | + * EE_Log::write_log() callback |
|
121 | + * |
|
122 | + * @param string $file |
|
123 | + * @param string $function |
|
124 | + * @param string $message |
|
125 | + * @param string $type |
|
126 | + */ |
|
127 | + public function log($file = '', $function = '', $message = '', $type = '') |
|
128 | + { |
|
129 | + $this->_log .= $this->_format_message($file, $function, $message, $type); |
|
130 | + } |
|
131 | + |
|
132 | + |
|
133 | + /** |
|
134 | + * write_log |
|
135 | + * appends the results of the 'AHEE_log' filter to the espresso log file |
|
136 | + */ |
|
137 | + public function write_log() |
|
138 | + { |
|
139 | + $msg = esc_html__( |
|
140 | + 'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.', |
|
141 | + 'event_espresso' |
|
142 | + ); |
|
143 | + EE_Error::doing_it_wrong( |
|
144 | + __METHOD__, |
|
145 | + $msg, |
|
146 | + '$VID:$' |
|
147 | + ); |
|
148 | + } |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * send_log |
|
153 | + * sends the espresso log to a remote URL via a PHP cURL request |
|
154 | + */ |
|
155 | + public function send_log() |
|
156 | + { |
|
157 | + |
|
158 | + if (empty($this->_remote_logging_url)) { |
|
159 | + return; |
|
160 | + } |
|
161 | + |
|
162 | + $data = 'domain=' . $_SERVER['HTTP_HOST']; |
|
163 | + $data .= '&ip=' . $_SERVER['SERVER_ADDR']; |
|
164 | + $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE']; |
|
165 | + $data .= '&time=' . time(); |
|
166 | + $data .= '&remote_log=' . $this->_log; |
|
167 | + $data .= '&request_array=' . json_encode($_REQUEST); |
|
168 | + $data .= '&action=save'; |
|
169 | + |
|
170 | + if (defined('EELOGGING_PASS')) { |
|
171 | + $data .= '&pass=' . EELOGGING_PASS; |
|
172 | + } |
|
173 | + if (defined('EELOGGING_KEY')) { |
|
174 | + $data .= '&key=' . EELOGGING_KEY; |
|
175 | + } |
|
176 | + |
|
177 | + $c = curl_init($this->_remote_logging_url); |
|
178 | + curl_setopt($c, CURLOPT_POST, true); |
|
179 | + curl_setopt($c, CURLOPT_POSTFIELDS, $data); |
|
180 | + curl_setopt($c, CURLOPT_RETURNTRANSFER, true); |
|
181 | + curl_exec($c); |
|
182 | + curl_close($c); |
|
183 | + } |
|
184 | + |
|
185 | + |
|
186 | + /** |
|
187 | + * write_debug |
|
188 | + * writes the contents of the current request's $_GET and $_POST arrays to a log file. |
|
189 | + * previous entries are overwritten |
|
190 | + */ |
|
191 | + public function write_debug() |
|
192 | + { |
|
193 | + $msg = esc_html__( |
|
194 | + 'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.', |
|
195 | + 'event_espresso' |
|
196 | + ); |
|
197 | + EE_Error::doing_it_wrong( |
|
198 | + __METHOD__, |
|
199 | + $msg, |
|
200 | + '$VID:$' |
|
201 | + ); |
|
202 | + } |
|
203 | + |
|
204 | + |
|
205 | + /** |
|
206 | + * __clone |
|
207 | + */ |
|
208 | + public function __clone() |
|
209 | + { |
|
210 | + trigger_error(__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR); |
|
211 | + } |
|
212 | 212 | } |
@@ -45,7 +45,7 @@ discard block |
||
45 | 45 | */ |
46 | 46 | public static function instance() |
47 | 47 | { |
48 | - if (! self::$_instance instanceof EE_Log) { |
|
48 | + if ( ! self::$_instance instanceof EE_Log) { |
|
49 | 49 | self::$_instance = new self(); |
50 | 50 | } |
51 | 51 | return self::$_instance; |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | private function __construct() |
59 | 59 | { |
60 | 60 | |
61 | - if (! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
61 | + if ( ! EE_Registry::instance()->CFG->admin->use_remote_logging) { |
|
62 | 62 | return; |
63 | 63 | } |
64 | 64 | |
@@ -102,14 +102,14 @@ discard block |
||
102 | 102 | */ |
103 | 103 | private function _format_message($file = '', $function = '', $message = '', $type = '') |
104 | 104 | { |
105 | - $msg = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
106 | - $msg .= '[' . current_time('mysql') . '] '; |
|
105 | + $msg = '----------------------------------------------------------------------------------------'.PHP_EOL; |
|
106 | + $msg .= '['.current_time('mysql').'] '; |
|
107 | 107 | $msg .= ! empty($file) ? basename($file) : ''; |
108 | 108 | $msg .= ! empty($file) && ! empty($function) ? ' -> ' : ''; |
109 | - $msg .= ! empty($function) ? $function . '()' : ''; |
|
109 | + $msg .= ! empty($function) ? $function.'()' : ''; |
|
110 | 110 | $msg .= PHP_EOL; |
111 | 111 | $type = ! empty($type) ? $type : 'log message'; |
112 | - $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : ''; |
|
112 | + $msg .= ! empty($message) ? "\t".'['.$type.'] '.$message.PHP_EOL : ''; |
|
113 | 113 | return $msg; |
114 | 114 | } |
115 | 115 | |
@@ -159,19 +159,19 @@ discard block |
||
159 | 159 | return; |
160 | 160 | } |
161 | 161 | |
162 | - $data = 'domain=' . $_SERVER['HTTP_HOST']; |
|
163 | - $data .= '&ip=' . $_SERVER['SERVER_ADDR']; |
|
164 | - $data .= '&server_type=' . $_SERVER['SERVER_SOFTWARE']; |
|
165 | - $data .= '&time=' . time(); |
|
166 | - $data .= '&remote_log=' . $this->_log; |
|
167 | - $data .= '&request_array=' . json_encode($_REQUEST); |
|
162 | + $data = 'domain='.$_SERVER['HTTP_HOST']; |
|
163 | + $data .= '&ip='.$_SERVER['SERVER_ADDR']; |
|
164 | + $data .= '&server_type='.$_SERVER['SERVER_SOFTWARE']; |
|
165 | + $data .= '&time='.time(); |
|
166 | + $data .= '&remote_log='.$this->_log; |
|
167 | + $data .= '&request_array='.json_encode($_REQUEST); |
|
168 | 168 | $data .= '&action=save'; |
169 | 169 | |
170 | 170 | if (defined('EELOGGING_PASS')) { |
171 | - $data .= '&pass=' . EELOGGING_PASS; |
|
171 | + $data .= '&pass='.EELOGGING_PASS; |
|
172 | 172 | } |
173 | 173 | if (defined('EELOGGING_KEY')) { |
174 | - $data .= '&key=' . EELOGGING_KEY; |
|
174 | + $data .= '&key='.EELOGGING_KEY; |
|
175 | 175 | } |
176 | 176 | |
177 | 177 | $c = curl_init($this->_remote_logging_url); |
@@ -103,286 +103,286 @@ |
||
103 | 103 | class EE_DMS_4_1_0_org_options extends EE_Data_Migration_Script_Stage |
104 | 104 | { |
105 | 105 | |
106 | - public function _migration_step($num_items = 50) |
|
107 | - { |
|
106 | + public function _migration_step($num_items = 50) |
|
107 | + { |
|
108 | 108 | |
109 | - $items_actually_migrated = 0; |
|
110 | - $old_org_options = get_option('events_organization_settings'); |
|
111 | - foreach ($this->_org_options_we_know_how_to_migrate as $option_name) { |
|
112 | - // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default |
|
113 | - if (isset($old_org_options[ $option_name ])) { |
|
114 | - $this->_handle_org_option($option_name, $old_org_options[ $option_name ]); |
|
115 | - } |
|
116 | - if ($option_name=='surcharge') { |
|
117 | - $this->_insert_new_global_surcharge_price($old_org_options); |
|
118 | - } |
|
119 | - $items_actually_migrated++; |
|
120 | - } |
|
109 | + $items_actually_migrated = 0; |
|
110 | + $old_org_options = get_option('events_organization_settings'); |
|
111 | + foreach ($this->_org_options_we_know_how_to_migrate as $option_name) { |
|
112 | + // only bother migrating if there's a setting to migrate. Otherwise we'll just use the default |
|
113 | + if (isset($old_org_options[ $option_name ])) { |
|
114 | + $this->_handle_org_option($option_name, $old_org_options[ $option_name ]); |
|
115 | + } |
|
116 | + if ($option_name=='surcharge') { |
|
117 | + $this->_insert_new_global_surcharge_price($old_org_options); |
|
118 | + } |
|
119 | + $items_actually_migrated++; |
|
120 | + } |
|
121 | 121 | |
122 | - $success = EE_Config::instance()->update_espresso_config(false, true); |
|
123 | - if (! $success) { |
|
124 | - $this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false))); |
|
125 | - EE_Error::overwrite_errors(); |
|
126 | - } |
|
127 | - EE_Network_Config::instance()->update_config(false, false); |
|
128 | - if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
129 | - // we may have added new pages and this might be necessary |
|
130 | - flush_rewrite_rules(); |
|
131 | - $this->set_completed(); |
|
132 | - } |
|
133 | - return $items_actually_migrated; |
|
134 | - } |
|
135 | - public function _count_records_to_migrate() |
|
136 | - { |
|
137 | - $count_of_options_to_migrate = count($this->_org_options_we_know_how_to_migrate); |
|
138 | - return $count_of_options_to_migrate; |
|
139 | - } |
|
140 | - public function __construct() |
|
141 | - { |
|
142 | - $this->_pretty_name = __("Organization Options/Config", "event_espresso"); |
|
143 | - $this->_org_options_we_know_how_to_migrate = apply_filters('FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate', $this->_org_options_we_know_how_to_migrate); |
|
144 | - parent::__construct(); |
|
145 | - } |
|
122 | + $success = EE_Config::instance()->update_espresso_config(false, true); |
|
123 | + if (! $success) { |
|
124 | + $this->add_error(sprintf(__('Could not save EE Config during org options stage. Reason: %s', 'event_espresso'), EE_Error::get_notices(false))); |
|
125 | + EE_Error::overwrite_errors(); |
|
126 | + } |
|
127 | + EE_Network_Config::instance()->update_config(false, false); |
|
128 | + if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) { |
|
129 | + // we may have added new pages and this might be necessary |
|
130 | + flush_rewrite_rules(); |
|
131 | + $this->set_completed(); |
|
132 | + } |
|
133 | + return $items_actually_migrated; |
|
134 | + } |
|
135 | + public function _count_records_to_migrate() |
|
136 | + { |
|
137 | + $count_of_options_to_migrate = count($this->_org_options_we_know_how_to_migrate); |
|
138 | + return $count_of_options_to_migrate; |
|
139 | + } |
|
140 | + public function __construct() |
|
141 | + { |
|
142 | + $this->_pretty_name = __("Organization Options/Config", "event_espresso"); |
|
143 | + $this->_org_options_we_know_how_to_migrate = apply_filters('FHEE__EE_DMS_4_1_0_org_options__org_options_we_know_how_to_migrate', $this->_org_options_we_know_how_to_migrate); |
|
144 | + parent::__construct(); |
|
145 | + } |
|
146 | 146 | |
147 | - private function _handle_org_option($option_name, $value) |
|
148 | - { |
|
149 | - $c = EE_Config::instance(); |
|
150 | - $cn = EE_Network_Config::instance(); |
|
151 | - switch ($option_name) { |
|
152 | - case 'organization': |
|
153 | - $c->organization->name = $value; |
|
154 | - break; |
|
155 | - case 'organization_street1': |
|
156 | - $c->organization->address_1 = $value; |
|
157 | - break; |
|
158 | - case 'organization_street2': |
|
159 | - $c->organization->address_2 = $value; |
|
160 | - break; |
|
161 | - case 'organization_city': |
|
162 | - $c->organization->city = $value; |
|
163 | - break; |
|
164 | - case 'organization_state': |
|
165 | - try { |
|
166 | - $state = $this->get_migration_script()->get_or_create_state($value); |
|
167 | - $state_id = $state['STA_ID']; |
|
168 | - $c->organization->STA_ID = $state_id; |
|
169 | - } catch (EE_Error $e) { |
|
170 | - } |
|
171 | - break; |
|
172 | - case 'organization_zip': |
|
173 | - $c->organization->zip = $value; |
|
174 | - break; |
|
175 | - case 'contact_email': |
|
176 | - $c->organization->email = $value; |
|
177 | - break; |
|
178 | - case 'default_payment_status': |
|
179 | - $c->registration->default_STS_ID = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value); |
|
180 | - break; |
|
181 | - case 'organization_country': |
|
182 | - $iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value); |
|
183 | - $c->organization->CNT_ISO = $iso; |
|
184 | - $country_row = $this->get_migration_script()->get_or_create_country($iso); |
|
185 | - if (! $country_row) { |
|
186 | - $this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso)); |
|
187 | - } |
|
188 | - // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them) |
|
189 | - $c->currency->code = $country_row['CNT_cur_code']; // currency code: USD, CAD, EUR |
|
190 | - $c->currency->name = $country_row['CNT_cur_single']; // Dollar |
|
191 | - $c->currency->plural = $country_row['CNT_cur_plural']; // Dollars |
|
192 | - $c->currency->sign = $country_row['CNT_cur_sign']; // currency sign: $ |
|
193 | - $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN); // currency sign before or after: $TRUE or FALSE$ |
|
194 | - $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc']; // decimal places: 2 = 0.00 3 = 0.000 |
|
195 | - $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk']; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
196 | - $c->currency->thsnds = $country_row['CNT_cur_thsnds']; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
147 | + private function _handle_org_option($option_name, $value) |
|
148 | + { |
|
149 | + $c = EE_Config::instance(); |
|
150 | + $cn = EE_Network_Config::instance(); |
|
151 | + switch ($option_name) { |
|
152 | + case 'organization': |
|
153 | + $c->organization->name = $value; |
|
154 | + break; |
|
155 | + case 'organization_street1': |
|
156 | + $c->organization->address_1 = $value; |
|
157 | + break; |
|
158 | + case 'organization_street2': |
|
159 | + $c->organization->address_2 = $value; |
|
160 | + break; |
|
161 | + case 'organization_city': |
|
162 | + $c->organization->city = $value; |
|
163 | + break; |
|
164 | + case 'organization_state': |
|
165 | + try { |
|
166 | + $state = $this->get_migration_script()->get_or_create_state($value); |
|
167 | + $state_id = $state['STA_ID']; |
|
168 | + $c->organization->STA_ID = $state_id; |
|
169 | + } catch (EE_Error $e) { |
|
170 | + } |
|
171 | + break; |
|
172 | + case 'organization_zip': |
|
173 | + $c->organization->zip = $value; |
|
174 | + break; |
|
175 | + case 'contact_email': |
|
176 | + $c->organization->email = $value; |
|
177 | + break; |
|
178 | + case 'default_payment_status': |
|
179 | + $c->registration->default_STS_ID = $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID($value); |
|
180 | + break; |
|
181 | + case 'organization_country': |
|
182 | + $iso =$this->get_migration_script()->get_iso_from_3_1_country_id($value); |
|
183 | + $c->organization->CNT_ISO = $iso; |
|
184 | + $country_row = $this->get_migration_script()->get_or_create_country($iso); |
|
185 | + if (! $country_row) { |
|
186 | + $this->add_error(sprintf(__("Could not set country's currency config because no country exists for ISO %s", "event_espresso"), $iso)); |
|
187 | + } |
|
188 | + // can't use EE_Currency_Config's handy constructor because the models are off-limits right now (and it uses them) |
|
189 | + $c->currency->code = $country_row['CNT_cur_code']; // currency code: USD, CAD, EUR |
|
190 | + $c->currency->name = $country_row['CNT_cur_single']; // Dollar |
|
191 | + $c->currency->plural = $country_row['CNT_cur_plural']; // Dollars |
|
192 | + $c->currency->sign = $country_row['CNT_cur_sign']; // currency sign: $ |
|
193 | + $c->currency->sign_b4 = filter_var($country_row['CNT_cur_sign_b4'], FILTER_VALIDATE_BOOLEAN); // currency sign before or after: $TRUE or FALSE$ |
|
194 | + $c->currency->dec_plc = (int) $country_row['CNT_cur_dec_plc']; // decimal places: 2 = 0.00 3 = 0.000 |
|
195 | + $c->currency->dec_mrk = $country_row['CNT_cur_dec_mrk']; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
196 | + $c->currency->thsnds = $country_row['CNT_cur_thsnds']; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
197 | 197 | // $c->currency = new EE_Currency_Config($c->organization->CNT_ISO);break; |
198 | 198 | // case 'currency_symbol': ignore the currency symbol. we'll just go by their country. |
199 | 199 | // $c->currency->sign = $value;break; |
200 | - case 'show_pending_payment_options': |
|
201 | - $c->registration->show_pending_payment_options = ($value == 'Y'); |
|
202 | - break; |
|
203 | - case 'display_address_in_regform': |
|
204 | - $c->template_settings->display_address_in_regform = ($value == 'Y'); |
|
205 | - break; |
|
206 | - case 'default_logo_url': |
|
207 | - $c->organization->logo_url = $value; |
|
208 | - break; |
|
209 | - case 'event_page_id': |
|
210 | - // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS |
|
211 | - // to ESPRESSO_THANK_YOU |
|
212 | - $reg_page_post = get_post($value); |
|
213 | - $reg_page_post->post_content = str_replace("[ESPRESSO_EVENTS]", "[ESPRESSO_CHECKOUT]", $reg_page_post->post_content); |
|
214 | - wp_update_post($reg_page_post); |
|
215 | - $c->core->reg_page_id = $value; |
|
216 | - break; |
|
217 | - case 'return_url': |
|
218 | - // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS |
|
219 | - // to ESPRESSO_THANK_YOU |
|
220 | - $thank_you_page_post = get_post($value); |
|
221 | - $thank_you_page_post->post_content = str_replace("[ESPRESSO_PAYMENTS]", "[ESPRESSO_THANK_YOU]", $thank_you_page_post->post_content); |
|
222 | - wp_update_post($thank_you_page_post); |
|
223 | - $c->core->thank_you_page_id = $value; |
|
224 | - break; |
|
225 | - case 'cancel_return': |
|
226 | - $c->core->cancel_page_id = $value; |
|
200 | + case 'show_pending_payment_options': |
|
201 | + $c->registration->show_pending_payment_options = ($value == 'Y'); |
|
202 | + break; |
|
203 | + case 'display_address_in_regform': |
|
204 | + $c->template_settings->display_address_in_regform = ($value == 'Y'); |
|
205 | + break; |
|
206 | + case 'default_logo_url': |
|
207 | + $c->organization->logo_url = $value; |
|
208 | + break; |
|
209 | + case 'event_page_id': |
|
210 | + // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS |
|
211 | + // to ESPRESSO_THANK_YOU |
|
212 | + $reg_page_post = get_post($value); |
|
213 | + $reg_page_post->post_content = str_replace("[ESPRESSO_EVENTS]", "[ESPRESSO_CHECKOUT]", $reg_page_post->post_content); |
|
214 | + wp_update_post($reg_page_post); |
|
215 | + $c->core->reg_page_id = $value; |
|
216 | + break; |
|
217 | + case 'return_url': |
|
218 | + // also, find that post, and changes the shortcode in it from ESPRESSO_PAYMENTS |
|
219 | + // to ESPRESSO_THANK_YOU |
|
220 | + $thank_you_page_post = get_post($value); |
|
221 | + $thank_you_page_post->post_content = str_replace("[ESPRESSO_PAYMENTS]", "[ESPRESSO_THANK_YOU]", $thank_you_page_post->post_content); |
|
222 | + wp_update_post($thank_you_page_post); |
|
223 | + $c->core->thank_you_page_id = $value; |
|
224 | + break; |
|
225 | + case 'cancel_return': |
|
226 | + $c->core->cancel_page_id = $value; |
|
227 | 227 | |
228 | - break; |
|
229 | - case 'notify_url': |
|
230 | - $c->core->txn_page_id = $value; |
|
231 | - break; |
|
232 | - case 'use_captcha': |
|
233 | - $c->registration->use_captcha = ($value == 'Y'); |
|
234 | - break; |
|
235 | - case 'recaptcha_publickey': |
|
236 | - $c->registration->recaptcha_publickey = $value; |
|
237 | - break; |
|
238 | - case 'recaptcha_privatekey': |
|
239 | - $c->registration->recaptcha_privatekey = $value; |
|
240 | - break; |
|
241 | - case 'recaptcha_theme': |
|
242 | - $c->registration->recaptcha_theme = $value; |
|
243 | - break; |
|
244 | - case 'recaptcha_width': |
|
245 | - $c->registration->recaptcha_width = $value; |
|
246 | - break; |
|
247 | - case 'recaptcha_language': |
|
248 | - $c->registration->recaptcha_language = $value; |
|
249 | - break; |
|
250 | - case 'espresso_dashboard_widget': |
|
251 | - $c->admin->use_dashboard_widget = ($value == 'Y'); |
|
252 | - break; |
|
253 | - case 'use_personnel_manager': |
|
254 | - $c->admin->use_personnel_manager = ($value == 'Y'); |
|
255 | - break; |
|
256 | - case 'use_event_timezones': |
|
257 | - $c->admin->use_event_timezones = ($value == 'Y'); |
|
258 | - break; |
|
259 | - case 'affiliate_id': |
|
260 | - $c->admin->affiliate_id = $value; |
|
261 | - break; |
|
262 | - case 'site_license_key': |
|
263 | - $cn->core->site_license_key = $value; |
|
264 | - break; |
|
265 | - default: |
|
266 | - do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value); |
|
267 | - } |
|
268 | - } |
|
228 | + break; |
|
229 | + case 'notify_url': |
|
230 | + $c->core->txn_page_id = $value; |
|
231 | + break; |
|
232 | + case 'use_captcha': |
|
233 | + $c->registration->use_captcha = ($value == 'Y'); |
|
234 | + break; |
|
235 | + case 'recaptcha_publickey': |
|
236 | + $c->registration->recaptcha_publickey = $value; |
|
237 | + break; |
|
238 | + case 'recaptcha_privatekey': |
|
239 | + $c->registration->recaptcha_privatekey = $value; |
|
240 | + break; |
|
241 | + case 'recaptcha_theme': |
|
242 | + $c->registration->recaptcha_theme = $value; |
|
243 | + break; |
|
244 | + case 'recaptcha_width': |
|
245 | + $c->registration->recaptcha_width = $value; |
|
246 | + break; |
|
247 | + case 'recaptcha_language': |
|
248 | + $c->registration->recaptcha_language = $value; |
|
249 | + break; |
|
250 | + case 'espresso_dashboard_widget': |
|
251 | + $c->admin->use_dashboard_widget = ($value == 'Y'); |
|
252 | + break; |
|
253 | + case 'use_personnel_manager': |
|
254 | + $c->admin->use_personnel_manager = ($value == 'Y'); |
|
255 | + break; |
|
256 | + case 'use_event_timezones': |
|
257 | + $c->admin->use_event_timezones = ($value == 'Y'); |
|
258 | + break; |
|
259 | + case 'affiliate_id': |
|
260 | + $c->admin->affiliate_id = $value; |
|
261 | + break; |
|
262 | + case 'site_license_key': |
|
263 | + $cn->core->site_license_key = $value; |
|
264 | + break; |
|
265 | + default: |
|
266 | + do_action('AHEE__EE_DMS_4_1_0__handle_org_option', $option_name, $value); |
|
267 | + } |
|
268 | + } |
|
269 | 269 | |
270 | - /** |
|
271 | - * Creates a 4.1 member price discount |
|
272 | - * @global type $wpdb |
|
273 | - * @param type $old_price |
|
274 | - * @return int |
|
275 | - */ |
|
276 | - private function _insert_new_global_surcharge_price($org_options) |
|
277 | - { |
|
278 | - $amount = floatval($org_options['surcharge']); |
|
279 | - // dont createa a price if the surcharge is 0 |
|
280 | - if ($amount <=.01) { |
|
281 | - return 0; |
|
282 | - } |
|
283 | - if ($org_options['surcharge_type'] == 'flat_rate') { |
|
284 | - $price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge; |
|
285 | - } else { |
|
286 | - $price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge; |
|
287 | - } |
|
288 | - global $wpdb; |
|
289 | - $cols_n_values = array( |
|
290 | - 'PRT_ID'=>$price_type, |
|
291 | - 'PRC_amount'=>$amount, |
|
292 | - 'PRC_name'=> $org_options['surcharge_text'], |
|
293 | - 'PRC_is_default'=>true, |
|
294 | - 'PRC_overrides'=>false, |
|
295 | - 'PRC_order'=>100, |
|
296 | - 'PRC_deleted'=>false, |
|
297 | - 'PRC_parent'=>null |
|
270 | + /** |
|
271 | + * Creates a 4.1 member price discount |
|
272 | + * @global type $wpdb |
|
273 | + * @param type $old_price |
|
274 | + * @return int |
|
275 | + */ |
|
276 | + private function _insert_new_global_surcharge_price($org_options) |
|
277 | + { |
|
278 | + $amount = floatval($org_options['surcharge']); |
|
279 | + // dont createa a price if the surcharge is 0 |
|
280 | + if ($amount <=.01) { |
|
281 | + return 0; |
|
282 | + } |
|
283 | + if ($org_options['surcharge_type'] == 'flat_rate') { |
|
284 | + $price_type = EE_DMS_4_1_0_prices::price_type_flat_surcharge; |
|
285 | + } else { |
|
286 | + $price_type = EE_DMS_4_1_0_prices::price_type_percent_surcharge; |
|
287 | + } |
|
288 | + global $wpdb; |
|
289 | + $cols_n_values = array( |
|
290 | + 'PRT_ID'=>$price_type, |
|
291 | + 'PRC_amount'=>$amount, |
|
292 | + 'PRC_name'=> $org_options['surcharge_text'], |
|
293 | + 'PRC_is_default'=>true, |
|
294 | + 'PRC_overrides'=>false, |
|
295 | + 'PRC_order'=>100, |
|
296 | + 'PRC_deleted'=>false, |
|
297 | + 'PRC_parent'=>null |
|
298 | 298 | |
299 | - ); |
|
300 | - $datatypes = array( |
|
301 | - '%d',// PRT_ID |
|
302 | - '%f',// PRT_amount |
|
303 | - '%s',// PRC_name |
|
304 | - '%d',// PRC_is_default |
|
305 | - '%d',// PRC_overrides |
|
306 | - '%d',// PRC_order |
|
307 | - '%d',// PRC_deleted |
|
308 | - '%d',// PRC_parent |
|
309 | - ); |
|
310 | - $price_table = $wpdb->prefix."esp_price"; |
|
311 | - $success = $wpdb->insert($price_table, $cols_n_values, $datatypes); |
|
312 | - if (! $success) { |
|
313 | - $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion( |
|
314 | - 'org_options', |
|
315 | - array( |
|
316 | - 'surcharge'=>$org_options['surcharge'], |
|
317 | - 'surcharge_type'=>$org_options['surcharge_type'], |
|
318 | - 'surcharge_text'=>$org_options['surcharge_text']), |
|
319 | - $price_table, |
|
320 | - $cols_n_values, |
|
321 | - $datatypes |
|
322 | - )); |
|
323 | - return 0; |
|
324 | - } |
|
325 | - $new_id = $wpdb->insert_id; |
|
326 | - return $new_id; |
|
327 | - } |
|
299 | + ); |
|
300 | + $datatypes = array( |
|
301 | + '%d',// PRT_ID |
|
302 | + '%f',// PRT_amount |
|
303 | + '%s',// PRC_name |
|
304 | + '%d',// PRC_is_default |
|
305 | + '%d',// PRC_overrides |
|
306 | + '%d',// PRC_order |
|
307 | + '%d',// PRC_deleted |
|
308 | + '%d',// PRC_parent |
|
309 | + ); |
|
310 | + $price_table = $wpdb->prefix."esp_price"; |
|
311 | + $success = $wpdb->insert($price_table, $cols_n_values, $datatypes); |
|
312 | + if (! $success) { |
|
313 | + $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion( |
|
314 | + 'org_options', |
|
315 | + array( |
|
316 | + 'surcharge'=>$org_options['surcharge'], |
|
317 | + 'surcharge_type'=>$org_options['surcharge_type'], |
|
318 | + 'surcharge_text'=>$org_options['surcharge_text']), |
|
319 | + $price_table, |
|
320 | + $cols_n_values, |
|
321 | + $datatypes |
|
322 | + )); |
|
323 | + return 0; |
|
324 | + } |
|
325 | + $new_id = $wpdb->insert_id; |
|
326 | + return $new_id; |
|
327 | + } |
|
328 | 328 | |
329 | - protected $_org_options_we_know_how_to_migrate = array( |
|
330 | - 'organization', |
|
331 | - 'organization_street1', |
|
332 | - 'organization_street2', |
|
333 | - 'organization_city', |
|
334 | - 'organization_state', |
|
335 | - 'organization_zip', |
|
336 | - 'contact_email', |
|
337 | - 'default_mail', |
|
338 | - 'payment_subject', |
|
339 | - 'payment_message', |
|
340 | - 'message', |
|
341 | - 'default_payment_status', |
|
342 | - 'surcharge',// unused? |
|
343 | - 'country_id',// unused? |
|
344 | - 'organization_country', |
|
329 | + protected $_org_options_we_know_how_to_migrate = array( |
|
330 | + 'organization', |
|
331 | + 'organization_street1', |
|
332 | + 'organization_street2', |
|
333 | + 'organization_city', |
|
334 | + 'organization_state', |
|
335 | + 'organization_zip', |
|
336 | + 'contact_email', |
|
337 | + 'default_mail', |
|
338 | + 'payment_subject', |
|
339 | + 'payment_message', |
|
340 | + 'message', |
|
341 | + 'default_payment_status', |
|
342 | + 'surcharge',// unused? |
|
343 | + 'country_id',// unused? |
|
344 | + 'organization_country', |
|
345 | 345 | // 'currency_symbol', |
346 | - 'expire_on_registration_end', |
|
347 | - 'email_before_payment', |
|
348 | - 'email_fancy_headers', |
|
349 | - 'enable_default_style', |
|
350 | - 'event_ssl_active', |
|
351 | - 'selected_style', |
|
352 | - 'show_pending_payment_options', |
|
353 | - 'show_reg_footer', |
|
354 | - 'skip_confirmation_page', |
|
355 | - 'allow_mer_discounts',// no equiv |
|
356 | - 'allow_mer_vouchers',// no equiv |
|
357 | - 'display_short_description_in_event_list', |
|
358 | - 'display_description_on_multi_reg_page', |
|
359 | - 'display_address_in_event_list', |
|
360 | - 'display_address_in_regform', |
|
361 | - 'use_custom_post_types',// no equiv |
|
362 | - 'display_ical_download', |
|
363 | - 'display_featured_image', |
|
364 | - 'themeroller', |
|
365 | - 'default_logo_url', |
|
366 | - 'event_page_id', |
|
367 | - 'return_url', |
|
368 | - 'cancel_return', |
|
369 | - 'notify_url', |
|
370 | - 'events_in_dashboard', |
|
371 | - 'use_captcha', |
|
372 | - 'recaptcha_publickey', |
|
373 | - 'recaptcha_privatekey', |
|
374 | - 'recaptcha_theme', |
|
375 | - 'recaptcha_width', |
|
376 | - 'recaptcha_language', |
|
377 | - 'espresso_dashboard_widget', |
|
378 | - 'time_reg_limit', |
|
346 | + 'expire_on_registration_end', |
|
347 | + 'email_before_payment', |
|
348 | + 'email_fancy_headers', |
|
349 | + 'enable_default_style', |
|
350 | + 'event_ssl_active', |
|
351 | + 'selected_style', |
|
352 | + 'show_pending_payment_options', |
|
353 | + 'show_reg_footer', |
|
354 | + 'skip_confirmation_page', |
|
355 | + 'allow_mer_discounts',// no equiv |
|
356 | + 'allow_mer_vouchers',// no equiv |
|
357 | + 'display_short_description_in_event_list', |
|
358 | + 'display_description_on_multi_reg_page', |
|
359 | + 'display_address_in_event_list', |
|
360 | + 'display_address_in_regform', |
|
361 | + 'use_custom_post_types',// no equiv |
|
362 | + 'display_ical_download', |
|
363 | + 'display_featured_image', |
|
364 | + 'themeroller', |
|
365 | + 'default_logo_url', |
|
366 | + 'event_page_id', |
|
367 | + 'return_url', |
|
368 | + 'cancel_return', |
|
369 | + 'notify_url', |
|
370 | + 'events_in_dashboard', |
|
371 | + 'use_captcha', |
|
372 | + 'recaptcha_publickey', |
|
373 | + 'recaptcha_privatekey', |
|
374 | + 'recaptcha_theme', |
|
375 | + 'recaptcha_width', |
|
376 | + 'recaptcha_language', |
|
377 | + 'espresso_dashboard_widget', |
|
378 | + 'time_reg_limit', |
|
379 | 379 | // 'use_attendee_pre_approval', removed in 4.1- instead this is factored into the default reg status |
380 | - 'use_personnel_manager',// no equiv |
|
381 | - 'use_event_timezones', |
|
382 | - 'full_logging', |
|
383 | - 'surcharge_type',// unused |
|
384 | - 'surcharge_text',// unused |
|
385 | - 'affiliate_id', |
|
386 | - 'site_license_key', |
|
387 | - ); |
|
380 | + 'use_personnel_manager',// no equiv |
|
381 | + 'use_event_timezones', |
|
382 | + 'full_logging', |
|
383 | + 'surcharge_type',// unused |
|
384 | + 'surcharge_text',// unused |
|
385 | + 'affiliate_id', |
|
386 | + 'site_license_key', |
|
387 | + ); |
|
388 | 388 | } |
@@ -18,68 +18,68 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - public function __construct($routing = true) |
|
22 | - { |
|
23 | - parent::__construct($routing); |
|
24 | - define('GEN_SET_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'general_settings/templates/'); |
|
25 | - } |
|
21 | + public function __construct($routing = true) |
|
22 | + { |
|
23 | + parent::__construct($routing); |
|
24 | + define('GEN_SET_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'general_settings/templates/'); |
|
25 | + } |
|
26 | 26 | |
27 | 27 | |
28 | - protected function _extend_page_config() |
|
29 | - { |
|
28 | + protected function _extend_page_config() |
|
29 | + { |
|
30 | 30 | |
31 | - $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'general_settings'; |
|
31 | + $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'general_settings'; |
|
32 | 32 | |
33 | - // filters and action hooks here |
|
34 | - add_action('AHEE__admin_option_settings__template__before', array($this, 'debug_logging_options'), 9); |
|
35 | - add_filter( |
|
36 | - 'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin', |
|
37 | - array($this, 'update_debug_logging_options'), |
|
38 | - 10, |
|
39 | - 1 |
|
40 | - ); |
|
41 | - } |
|
33 | + // filters and action hooks here |
|
34 | + add_action('AHEE__admin_option_settings__template__before', array($this, 'debug_logging_options'), 9); |
|
35 | + add_filter( |
|
36 | + 'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin', |
|
37 | + array($this, 'update_debug_logging_options'), |
|
38 | + 10, |
|
39 | + 1 |
|
40 | + ); |
|
41 | + } |
|
42 | 42 | |
43 | 43 | |
44 | 44 | |
45 | - /************* Logging Settings *************/ |
|
45 | + /************* Logging Settings *************/ |
|
46 | 46 | |
47 | - /** |
|
48 | - * debug_logging_options |
|
49 | - * |
|
50 | - * @param array $template_args |
|
51 | - * |
|
52 | - * @return void |
|
53 | - */ |
|
54 | - public function debug_logging_options($template_args = array()) |
|
55 | - { |
|
56 | - $template_args['use_remote_logging'] = isset(EE_Registry::instance()->CFG->admin->use_remote_logging) ? absint( |
|
57 | - EE_Registry::instance()->CFG->admin->use_remote_logging |
|
58 | - ) : false; |
|
59 | - $template_args['remote_logging_url'] = isset(EE_Registry::instance()->CFG->admin->remote_logging_url) |
|
60 | - && ! empty(EE_Registry::instance()->CFG->admin->remote_logging_url) |
|
61 | - ? stripslashes(EE_Registry::instance()->CFG->admin->remote_logging_url) : ''; |
|
62 | - $template = GEN_SET_CAF_TEMPLATE_PATH . 'debug_log_settings.template.php'; |
|
63 | - EEH_Template::display_template($template, $template_args); |
|
64 | - } |
|
47 | + /** |
|
48 | + * debug_logging_options |
|
49 | + * |
|
50 | + * @param array $template_args |
|
51 | + * |
|
52 | + * @return void |
|
53 | + */ |
|
54 | + public function debug_logging_options($template_args = array()) |
|
55 | + { |
|
56 | + $template_args['use_remote_logging'] = isset(EE_Registry::instance()->CFG->admin->use_remote_logging) ? absint( |
|
57 | + EE_Registry::instance()->CFG->admin->use_remote_logging |
|
58 | + ) : false; |
|
59 | + $template_args['remote_logging_url'] = isset(EE_Registry::instance()->CFG->admin->remote_logging_url) |
|
60 | + && ! empty(EE_Registry::instance()->CFG->admin->remote_logging_url) |
|
61 | + ? stripslashes(EE_Registry::instance()->CFG->admin->remote_logging_url) : ''; |
|
62 | + $template = GEN_SET_CAF_TEMPLATE_PATH . 'debug_log_settings.template.php'; |
|
63 | + EEH_Template::display_template($template, $template_args); |
|
64 | + } |
|
65 | 65 | |
66 | 66 | |
67 | - /** |
|
68 | - * update_debug_logging_options |
|
69 | - * |
|
70 | - * @param array $admin_options |
|
71 | - * |
|
72 | - * @return array |
|
73 | - */ |
|
74 | - public function update_debug_logging_options($admin_options = array()) |
|
75 | - { |
|
76 | - $admin_options->use_remote_logging = isset($this->_req_data['use_remote_logging']) ? absint( |
|
77 | - $this->_req_data['use_remote_logging'] |
|
78 | - ) : $admin_options->use_remote_logging; |
|
79 | - $admin_options->remote_logging_url = isset($this->_req_data['remote_logging_url']) ? esc_url_raw( |
|
80 | - $this->_req_data['remote_logging_url'] |
|
81 | - ) : $admin_options->remote_logging_url; |
|
67 | + /** |
|
68 | + * update_debug_logging_options |
|
69 | + * |
|
70 | + * @param array $admin_options |
|
71 | + * |
|
72 | + * @return array |
|
73 | + */ |
|
74 | + public function update_debug_logging_options($admin_options = array()) |
|
75 | + { |
|
76 | + $admin_options->use_remote_logging = isset($this->_req_data['use_remote_logging']) ? absint( |
|
77 | + $this->_req_data['use_remote_logging'] |
|
78 | + ) : $admin_options->use_remote_logging; |
|
79 | + $admin_options->remote_logging_url = isset($this->_req_data['remote_logging_url']) ? esc_url_raw( |
|
80 | + $this->_req_data['remote_logging_url'] |
|
81 | + ) : $admin_options->remote_logging_url; |
|
82 | 82 | |
83 | - return $admin_options; |
|
84 | - } |
|
83 | + return $admin_options; |
|
84 | + } |
|
85 | 85 | } |
@@ -15,81 +15,81 @@ |
||
15 | 15 | class Admin_Options_Help_Tour extends EE_Help_Tour |
16 | 16 | { |
17 | 17 | |
18 | - protected function _set_tour_properties() |
|
19 | - { |
|
20 | - $this->_label = __('Admin Options Tour', 'event_espresso'); |
|
21 | - $this->_slug = 'admin-options-joyride'; |
|
22 | - } |
|
18 | + protected function _set_tour_properties() |
|
19 | + { |
|
20 | + $this->_label = __('Admin Options Tour', 'event_espresso'); |
|
21 | + $this->_slug = 'admin-options-joyride'; |
|
22 | + } |
|
23 | 23 | |
24 | - protected function _set_tour_stops() |
|
25 | - { |
|
26 | - $this->_stops = array( |
|
27 | - 10 => array( |
|
28 | - 'content' => $this->_start(), |
|
29 | - ), |
|
30 | - 30 => array( |
|
31 | - 'id' => 'use_remote_logging', |
|
32 | - 'content' => $this->_use_remote_logging_stop(), |
|
33 | - 'options' => array( |
|
34 | - 'tipLocation' => 'right', |
|
35 | - 'tipAdjustmentY' => -50, |
|
36 | - 'tipAdjustmentX' => 15, |
|
37 | - ), |
|
38 | - ), |
|
39 | - 40 => array( |
|
40 | - 'id' => 'affiliate_info', |
|
41 | - 'content' => $this->_show_reg_footer_stop(), |
|
42 | - 'options' => array( |
|
43 | - 'tipLocation' => 'right', |
|
44 | - 'tipAdjustmentY' => -50, |
|
45 | - 'tipAdjustmentX' => 15, |
|
46 | - ), |
|
47 | - ), |
|
24 | + protected function _set_tour_stops() |
|
25 | + { |
|
26 | + $this->_stops = array( |
|
27 | + 10 => array( |
|
28 | + 'content' => $this->_start(), |
|
29 | + ), |
|
30 | + 30 => array( |
|
31 | + 'id' => 'use_remote_logging', |
|
32 | + 'content' => $this->_use_remote_logging_stop(), |
|
33 | + 'options' => array( |
|
34 | + 'tipLocation' => 'right', |
|
35 | + 'tipAdjustmentY' => -50, |
|
36 | + 'tipAdjustmentX' => 15, |
|
37 | + ), |
|
38 | + ), |
|
39 | + 40 => array( |
|
40 | + 'id' => 'affiliate_info', |
|
41 | + 'content' => $this->_show_reg_footer_stop(), |
|
42 | + 'options' => array( |
|
43 | + 'tipLocation' => 'right', |
|
44 | + 'tipAdjustmentY' => -50, |
|
45 | + 'tipAdjustmentX' => 15, |
|
46 | + ), |
|
47 | + ), |
|
48 | 48 | |
49 | - 60 => array( |
|
50 | - 'id' => 'help_tour_activation', |
|
51 | - 'content' => $this->_help_tour_activation_stop(), |
|
52 | - 'options' => array( |
|
53 | - 'tipLocation' => 'right', |
|
54 | - 'tipAdjustmentY' => -50, |
|
55 | - 'tipAdjustmentX' => 15, |
|
56 | - ), |
|
57 | - ), |
|
58 | - ); |
|
59 | - } |
|
49 | + 60 => array( |
|
50 | + 'id' => 'help_tour_activation', |
|
51 | + 'content' => $this->_help_tour_activation_stop(), |
|
52 | + 'options' => array( |
|
53 | + 'tipLocation' => 'right', |
|
54 | + 'tipAdjustmentY' => -50, |
|
55 | + 'tipAdjustmentX' => 15, |
|
56 | + ), |
|
57 | + ), |
|
58 | + ); |
|
59 | + } |
|
60 | 60 | |
61 | 61 | |
62 | - protected function _start() |
|
63 | - { |
|
64 | - $content = '<h3>' . __('Admin Options', 'event_espresso') . '</h3>'; |
|
65 | - $content .= '<p>' |
|
66 | - . __( |
|
67 | - 'This tour of the Admin Options page will go over different areas of the screen to help you understand what they are used for.', |
|
68 | - 'event_espresso' |
|
69 | - ) . '</p>'; |
|
70 | - return $content; |
|
71 | - } |
|
62 | + protected function _start() |
|
63 | + { |
|
64 | + $content = '<h3>' . __('Admin Options', 'event_espresso') . '</h3>'; |
|
65 | + $content .= '<p>' |
|
66 | + . __( |
|
67 | + 'This tour of the Admin Options page will go over different areas of the screen to help you understand what they are used for.', |
|
68 | + 'event_espresso' |
|
69 | + ) . '</p>'; |
|
70 | + return $content; |
|
71 | + } |
|
72 | 72 | |
73 | - protected function _use_remote_logging_stop() |
|
74 | - { |
|
75 | - return '<p>' |
|
76 | - . __( |
|
77 | - ' This option sends all Event Espresso debugging data and get / post variables to the specified URL below.', |
|
78 | - 'event_espresso' |
|
79 | - ) . '</p>'; |
|
80 | - } |
|
73 | + protected function _use_remote_logging_stop() |
|
74 | + { |
|
75 | + return '<p>' |
|
76 | + . __( |
|
77 | + ' This option sends all Event Espresso debugging data and get / post variables to the specified URL below.', |
|
78 | + 'event_espresso' |
|
79 | + ) . '</p>'; |
|
80 | + } |
|
81 | 81 | |
82 | - protected function _show_reg_footer_stop() |
|
83 | - { |
|
84 | - return '<p>' |
|
85 | - . __( |
|
86 | - 'Support us by adding a small link to Event Espresso in your event pages. You can even earn money for yourself by adding your affiliate link there!', |
|
87 | - 'event_espresso' |
|
88 | - ) . '</p>'; |
|
89 | - } |
|
82 | + protected function _show_reg_footer_stop() |
|
83 | + { |
|
84 | + return '<p>' |
|
85 | + . __( |
|
86 | + 'Support us by adding a small link to Event Espresso in your event pages. You can even earn money for yourself by adding your affiliate link there!', |
|
87 | + 'event_espresso' |
|
88 | + ) . '</p>'; |
|
89 | + } |
|
90 | 90 | |
91 | - protected function _help_tour_activation_stop() |
|
92 | - { |
|
93 | - return '<p>' . __('Turn these help tours on / off for Event Espresso pages.', 'event_espresso') . '</p>'; |
|
94 | - } |
|
91 | + protected function _help_tour_activation_stop() |
|
92 | + { |
|
93 | + return '<p>' . __('Turn these help tours on / off for Event Espresso pages.', 'event_espresso') . '</p>'; |
|
94 | + } |
|
95 | 95 | } |
@@ -61,12 +61,12 @@ discard block |
||
61 | 61 | |
62 | 62 | protected function _start() |
63 | 63 | { |
64 | - $content = '<h3>' . __('Admin Options', 'event_espresso') . '</h3>'; |
|
64 | + $content = '<h3>'.__('Admin Options', 'event_espresso').'</h3>'; |
|
65 | 65 | $content .= '<p>' |
66 | 66 | . __( |
67 | 67 | 'This tour of the Admin Options page will go over different areas of the screen to help you understand what they are used for.', |
68 | 68 | 'event_espresso' |
69 | - ) . '</p>'; |
|
69 | + ).'</p>'; |
|
70 | 70 | return $content; |
71 | 71 | } |
72 | 72 | |
@@ -76,7 +76,7 @@ discard block |
||
76 | 76 | . __( |
77 | 77 | ' This option sends all Event Espresso debugging data and get / post variables to the specified URL below.', |
78 | 78 | 'event_espresso' |
79 | - ) . '</p>'; |
|
79 | + ).'</p>'; |
|
80 | 80 | } |
81 | 81 | |
82 | 82 | protected function _show_reg_footer_stop() |
@@ -85,11 +85,11 @@ discard block |
||
85 | 85 | . __( |
86 | 86 | 'Support us by adding a small link to Event Espresso in your event pages. You can even earn money for yourself by adding your affiliate link there!', |
87 | 87 | 'event_espresso' |
88 | - ) . '</p>'; |
|
88 | + ).'</p>'; |
|
89 | 89 | } |
90 | 90 | |
91 | 91 | protected function _help_tour_activation_stop() |
92 | 92 | { |
93 | - return '<p>' . __('Turn these help tours on / off for Event Espresso pages.', 'event_espresso') . '</p>'; |
|
93 | + return '<p>'.__('Turn these help tours on / off for Event Espresso pages.', 'event_espresso').'</p>'; |
|
94 | 94 | } |
95 | 95 | } |
@@ -32,12 +32,12 @@ |
||
32 | 32 | <li> |
33 | 33 | <strong><?php esc_html_e('Event Espresso Affiliate ID', 'event_espresso'); ?></strong><br /> |
34 | 34 | <?php printf( |
35 | - esc_html__( |
|
36 | - 'You can also monetize this link by signing up to our %1$saffiliate program%2$s and adding in your affiliate ID here.', |
|
37 | - 'event_espresso' |
|
38 | - ), |
|
39 | - '<a href="https://eventespresso.com/affiliates/">', |
|
40 | - '</a>' |
|
35 | + esc_html__( |
|
36 | + 'You can also monetize this link by signing up to our %1$saffiliate program%2$s and adding in your affiliate ID here.', |
|
37 | + 'event_espresso' |
|
38 | + ), |
|
39 | + '<a href="https://eventespresso.com/affiliates/">', |
|
40 | + '</a>' |
|
41 | 41 | ); ?> |
42 | 42 | </li> |
43 | 43 | </ul> |