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