@@ -16,1426 +16,1426 @@ |
||
16 | 16 | class EE_Registry |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * EE_Registry Object |
|
21 | - * |
|
22 | - * @var EE_Registry $_instance |
|
23 | - * @access private |
|
24 | - */ |
|
25 | - private static $_instance = null; |
|
26 | - |
|
27 | - /** |
|
28 | - * @var EE_Dependency_Map $_dependency_map |
|
29 | - * @access protected |
|
30 | - */ |
|
31 | - protected $_dependency_map = null; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var array $_class_abbreviations |
|
35 | - * @access protected |
|
36 | - */ |
|
37 | - protected $_class_abbreviations = array(); |
|
38 | - |
|
39 | - /** |
|
40 | - * @access public |
|
41 | - * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS |
|
42 | - */ |
|
43 | - public $BUS; |
|
44 | - |
|
45 | - /** |
|
46 | - * EE_Cart Object |
|
47 | - * |
|
48 | - * @access public |
|
49 | - * @var EE_Cart $CART |
|
50 | - */ |
|
51 | - public $CART = null; |
|
52 | - |
|
53 | - /** |
|
54 | - * EE_Config Object |
|
55 | - * |
|
56 | - * @access public |
|
57 | - * @var EE_Config $CFG |
|
58 | - */ |
|
59 | - public $CFG = null; |
|
60 | - |
|
61 | - /** |
|
62 | - * EE_Network_Config Object |
|
63 | - * |
|
64 | - * @access public |
|
65 | - * @var EE_Network_Config $NET_CFG |
|
66 | - */ |
|
67 | - public $NET_CFG = null; |
|
68 | - |
|
69 | - /** |
|
70 | - * StdClass object for storing library classes in |
|
71 | - * |
|
72 | - * @public LIB |
|
73 | - * @var StdClass $LIB |
|
74 | - */ |
|
75 | - public $LIB = null; |
|
76 | - |
|
77 | - /** |
|
78 | - * EE_Request_Handler Object |
|
79 | - * |
|
80 | - * @access public |
|
81 | - * @var EE_Request_Handler $REQ |
|
82 | - */ |
|
83 | - public $REQ = null; |
|
84 | - |
|
85 | - /** |
|
86 | - * EE_Session Object |
|
87 | - * |
|
88 | - * @access public |
|
89 | - * @var EE_Session $SSN |
|
90 | - */ |
|
91 | - public $SSN = null; |
|
92 | - |
|
93 | - /** |
|
94 | - * holds the ee capabilities object. |
|
95 | - * |
|
96 | - * @since 4.5.0 |
|
97 | - * @var EE_Capabilities |
|
98 | - */ |
|
99 | - public $CAP = null; |
|
100 | - |
|
101 | - /** |
|
102 | - * holds the EE_Message_Resource_Manager object. |
|
103 | - * |
|
104 | - * @since 4.9.0 |
|
105 | - * @var EE_Message_Resource_Manager |
|
106 | - */ |
|
107 | - public $MRM = null; |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * Holds the Assets Registry instance |
|
112 | - * @var Registry |
|
113 | - */ |
|
114 | - public $AssetsRegistry = null; |
|
115 | - |
|
116 | - /** |
|
117 | - * $addons - StdClass object for holding addons which have registered themselves to work with EE core |
|
118 | - * |
|
119 | - * @access public |
|
120 | - * @var EE_Addon[] |
|
121 | - */ |
|
122 | - public $addons = null; |
|
123 | - |
|
124 | - /** |
|
125 | - * $models |
|
126 | - * @access public |
|
127 | - * @var EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
|
128 | - */ |
|
129 | - public $models = array(); |
|
130 | - |
|
131 | - /** |
|
132 | - * $modules |
|
133 | - * @access public |
|
134 | - * @var EED_Module[] $modules |
|
135 | - */ |
|
136 | - public $modules = null; |
|
137 | - |
|
138 | - /** |
|
139 | - * $shortcodes |
|
140 | - * @access public |
|
141 | - * @var EES_Shortcode[] $shortcodes |
|
142 | - */ |
|
143 | - public $shortcodes = null; |
|
144 | - |
|
145 | - /** |
|
146 | - * $widgets |
|
147 | - * @access public |
|
148 | - * @var WP_Widget[] $widgets |
|
149 | - */ |
|
150 | - public $widgets = null; |
|
151 | - |
|
152 | - /** |
|
153 | - * $non_abstract_db_models |
|
154 | - * @access public |
|
155 | - * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models |
|
156 | - * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
|
157 | - * Keys are model "short names" (eg "Event") as used in model relations, and values are |
|
158 | - * classnames (eg "EEM_Event") |
|
159 | - */ |
|
160 | - public $non_abstract_db_models = array(); |
|
161 | - |
|
162 | - |
|
163 | - /** |
|
164 | - * $i18n_js_strings - internationalization for JS strings |
|
165 | - * usage: EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' ); |
|
166 | - * in js file: var translatedString = eei18n.string_key; |
|
167 | - * |
|
168 | - * @access public |
|
169 | - * @var array |
|
170 | - */ |
|
171 | - public static $i18n_js_strings = array(); |
|
172 | - |
|
173 | - |
|
174 | - /** |
|
175 | - * $main_file - path to espresso.php |
|
176 | - * |
|
177 | - * @access public |
|
178 | - * @var array |
|
179 | - */ |
|
180 | - public $main_file; |
|
181 | - |
|
182 | - /** |
|
183 | - * array of ReflectionClass objects where the key is the class name |
|
184 | - * |
|
185 | - * @access public |
|
186 | - * @var ReflectionClass[] |
|
187 | - */ |
|
188 | - public $_reflectors; |
|
189 | - |
|
190 | - /** |
|
191 | - * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
|
192 | - * |
|
193 | - * @access protected |
|
194 | - * @var boolean $_cache_on |
|
195 | - */ |
|
196 | - protected $_cache_on = true; |
|
197 | - |
|
198 | - |
|
199 | - |
|
200 | - /** |
|
201 | - * @singleton method used to instantiate class object |
|
202 | - * @access public |
|
203 | - * @param \EE_Dependency_Map $dependency_map |
|
204 | - * @return \EE_Registry instance |
|
205 | - */ |
|
206 | - public static function instance(\EE_Dependency_Map $dependency_map = null) |
|
207 | - { |
|
208 | - // check if class object is instantiated |
|
209 | - if ( ! self::$_instance instanceof EE_Registry) { |
|
210 | - self::$_instance = new EE_Registry($dependency_map); |
|
211 | - } |
|
212 | - return self::$_instance; |
|
213 | - } |
|
214 | - |
|
215 | - |
|
216 | - |
|
217 | - /** |
|
218 | - *protected constructor to prevent direct creation |
|
219 | - * |
|
220 | - * @Constructor |
|
221 | - * @access protected |
|
222 | - * @param \EE_Dependency_Map $dependency_map |
|
223 | - */ |
|
224 | - protected function __construct(\EE_Dependency_Map $dependency_map) |
|
225 | - { |
|
226 | - $this->_dependency_map = $dependency_map; |
|
227 | - $this->LIB = new stdClass(); |
|
228 | - $this->addons = new stdClass(); |
|
229 | - $this->modules = new stdClass(); |
|
230 | - $this->shortcodes = new stdClass(); |
|
231 | - $this->widgets = new stdClass(); |
|
232 | - add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
233 | - } |
|
234 | - |
|
235 | - |
|
236 | - |
|
237 | - /** |
|
238 | - * initialize |
|
239 | - */ |
|
240 | - public function initialize() |
|
241 | - { |
|
242 | - $this->_class_abbreviations = apply_filters( |
|
243 | - 'FHEE__EE_Registry____construct___class_abbreviations', |
|
244 | - array( |
|
245 | - 'EE_Config' => 'CFG', |
|
246 | - 'EE_Session' => 'SSN', |
|
247 | - 'EE_Capabilities' => 'CAP', |
|
248 | - 'EE_Cart' => 'CART', |
|
249 | - 'EE_Network_Config' => 'NET_CFG', |
|
250 | - 'EE_Request_Handler' => 'REQ', |
|
251 | - 'EE_Message_Resource_Manager' => 'MRM', |
|
252 | - 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
|
253 | - 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
|
254 | - ) |
|
255 | - ); |
|
256 | - $this->load_core('Base', array(), true); |
|
257 | - // add our request and response objects to the cache |
|
258 | - $request_loader = $this->_dependency_map->class_loader('EE_Request'); |
|
259 | - $this->_set_cached_class( |
|
260 | - $request_loader(), |
|
261 | - 'EE_Request' |
|
262 | - ); |
|
263 | - $response_loader = $this->_dependency_map->class_loader('EE_Response'); |
|
264 | - $this->_set_cached_class( |
|
265 | - $response_loader(), |
|
266 | - 'EE_Response' |
|
267 | - ); |
|
268 | - add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
|
269 | - } |
|
270 | - |
|
271 | - |
|
272 | - |
|
273 | - /** |
|
274 | - * init |
|
275 | - * |
|
276 | - * @access public |
|
277 | - * @return void |
|
278 | - */ |
|
279 | - public function init() |
|
280 | - { |
|
281 | - // Get current page protocol |
|
282 | - $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
|
283 | - // Output admin-ajax.php URL with same protocol as current page |
|
284 | - self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
|
285 | - self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
|
286 | - } |
|
287 | - |
|
288 | - |
|
289 | - |
|
290 | - /** |
|
291 | - * localize_i18n_js_strings |
|
292 | - * |
|
293 | - * @return string |
|
294 | - */ |
|
295 | - public static function localize_i18n_js_strings() |
|
296 | - { |
|
297 | - $i18n_js_strings = (array)EE_Registry::$i18n_js_strings; |
|
298 | - foreach ($i18n_js_strings as $key => $value) { |
|
299 | - if (is_scalar($value)) { |
|
300 | - $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
|
301 | - } |
|
302 | - } |
|
303 | - return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
304 | - } |
|
305 | - |
|
306 | - |
|
307 | - |
|
308 | - /** |
|
309 | - * @param mixed string | EED_Module $module |
|
310 | - */ |
|
311 | - public function add_module($module) |
|
312 | - { |
|
313 | - if ($module instanceof EED_Module) { |
|
314 | - $module_class = get_class($module); |
|
315 | - $this->modules->{$module_class} = $module; |
|
316 | - } else { |
|
317 | - if ( ! class_exists('EE_Module_Request_Router')) { |
|
318 | - $this->load_core('Module_Request_Router'); |
|
319 | - } |
|
320 | - $this->modules->{$module} = EE_Module_Request_Router::module_factory($module); |
|
321 | - } |
|
322 | - } |
|
323 | - |
|
324 | - |
|
325 | - |
|
326 | - /** |
|
327 | - * @param string $module_name |
|
328 | - * @return mixed EED_Module | NULL |
|
329 | - */ |
|
330 | - public function get_module($module_name = '') |
|
331 | - { |
|
332 | - return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null; |
|
333 | - } |
|
334 | - |
|
335 | - |
|
336 | - |
|
337 | - /** |
|
338 | - * loads core classes - must be singletons |
|
339 | - * |
|
340 | - * @access public |
|
341 | - * @param string $class_name - simple class name ie: session |
|
342 | - * @param mixed $arguments |
|
343 | - * @param bool $load_only |
|
344 | - * @return mixed |
|
345 | - */ |
|
346 | - public function load_core($class_name, $arguments = array(), $load_only = false) |
|
347 | - { |
|
348 | - $core_paths = apply_filters( |
|
349 | - 'FHEE__EE_Registry__load_core__core_paths', |
|
350 | - array( |
|
351 | - EE_CORE, |
|
352 | - EE_ADMIN, |
|
353 | - EE_CPTS, |
|
354 | - EE_CORE . 'data_migration_scripts' . DS, |
|
355 | - EE_CORE . 'request_stack' . DS, |
|
356 | - EE_CORE . 'middleware' . DS, |
|
357 | - ) |
|
358 | - ); |
|
359 | - // retrieve instantiated class |
|
360 | - return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only); |
|
361 | - } |
|
362 | - |
|
363 | - |
|
364 | - |
|
365 | - /** |
|
366 | - * loads service classes |
|
367 | - * |
|
368 | - * @access public |
|
369 | - * @param string $class_name - simple class name ie: session |
|
370 | - * @param mixed $arguments |
|
371 | - * @param bool $load_only |
|
372 | - * @return mixed |
|
373 | - */ |
|
374 | - public function load_service($class_name, $arguments = array(), $load_only = false) |
|
375 | - { |
|
376 | - $service_paths = apply_filters( |
|
377 | - 'FHEE__EE_Registry__load_service__service_paths', |
|
378 | - array( |
|
379 | - EE_CORE . 'services' . DS, |
|
380 | - ) |
|
381 | - ); |
|
382 | - // retrieve instantiated class |
|
383 | - return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only); |
|
384 | - } |
|
385 | - |
|
386 | - |
|
387 | - |
|
388 | - /** |
|
389 | - * loads data_migration_scripts |
|
390 | - * |
|
391 | - * @access public |
|
392 | - * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
|
393 | - * @param mixed $arguments |
|
394 | - * @return EE_Data_Migration_Script_Base|mixed |
|
395 | - */ |
|
396 | - public function load_dms($class_name, $arguments = array()) |
|
397 | - { |
|
398 | - // retrieve instantiated class |
|
399 | - return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false); |
|
400 | - } |
|
401 | - |
|
402 | - |
|
403 | - |
|
404 | - /** |
|
405 | - * loads object creating classes - must be singletons |
|
406 | - * |
|
407 | - * @param string $class_name - simple class name ie: attendee |
|
408 | - * @param mixed $arguments - an array of arguments to pass to the class |
|
409 | - * @param bool $from_db - some classes are instantiated from the db and thus call a different method to instantiate |
|
410 | - * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop) |
|
411 | - * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate (default) |
|
412 | - * @return EE_Base_Class | bool |
|
413 | - */ |
|
414 | - public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
|
415 | - { |
|
416 | - $paths = apply_filters('FHEE__EE_Registry__load_class__paths', array( |
|
417 | - EE_CORE, |
|
418 | - EE_CLASSES, |
|
419 | - EE_BUSINESS, |
|
420 | - )); |
|
421 | - // retrieve instantiated class |
|
422 | - return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only); |
|
423 | - } |
|
424 | - |
|
425 | - |
|
426 | - |
|
427 | - /** |
|
428 | - * loads helper classes - must be singletons |
|
429 | - * |
|
430 | - * @param string $class_name - simple class name ie: price |
|
431 | - * @param mixed $arguments |
|
432 | - * @param bool $load_only |
|
433 | - * @return EEH_Base | bool |
|
434 | - */ |
|
435 | - public function load_helper($class_name, $arguments = array(), $load_only = true) |
|
436 | - { |
|
437 | - // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
|
438 | - $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
|
439 | - // retrieve instantiated class |
|
440 | - return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only); |
|
441 | - } |
|
442 | - |
|
443 | - |
|
444 | - |
|
445 | - /** |
|
446 | - * loads core classes - must be singletons |
|
447 | - * |
|
448 | - * @access public |
|
449 | - * @param string $class_name - simple class name ie: session |
|
450 | - * @param mixed $arguments |
|
451 | - * @param bool $load_only |
|
452 | - * @param bool $cache whether to cache the object or not. |
|
453 | - * @return mixed |
|
454 | - */ |
|
455 | - public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
|
456 | - { |
|
457 | - $paths = array( |
|
458 | - EE_LIBRARIES, |
|
459 | - EE_LIBRARIES . 'messages' . DS, |
|
460 | - EE_LIBRARIES . 'shortcodes' . DS, |
|
461 | - EE_LIBRARIES . 'qtips' . DS, |
|
462 | - EE_LIBRARIES . 'payment_methods' . DS, |
|
463 | - ); |
|
464 | - // retrieve instantiated class |
|
465 | - return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only); |
|
466 | - } |
|
467 | - |
|
468 | - |
|
469 | - |
|
470 | - /** |
|
471 | - * loads model classes - must be singletons |
|
472 | - * |
|
473 | - * @param string $class_name - simple class name ie: price |
|
474 | - * @param mixed $arguments |
|
475 | - * @param bool $load_only |
|
476 | - * @return EEM_Base | bool |
|
477 | - */ |
|
478 | - public function load_model($class_name, $arguments = array(), $load_only = false) |
|
479 | - { |
|
480 | - $paths = apply_filters('FHEE__EE_Registry__load_model__paths', array( |
|
481 | - EE_MODELS, |
|
482 | - EE_CORE, |
|
483 | - )); |
|
484 | - // retrieve instantiated class |
|
485 | - return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only); |
|
486 | - } |
|
487 | - |
|
488 | - |
|
489 | - |
|
490 | - /** |
|
491 | - * loads model classes - must be singletons |
|
492 | - * |
|
493 | - * @param string $class_name - simple class name ie: price |
|
494 | - * @param mixed $arguments |
|
495 | - * @param bool $load_only |
|
496 | - * @return mixed | bool |
|
497 | - */ |
|
498 | - public function load_model_class($class_name, $arguments = array(), $load_only = true) |
|
499 | - { |
|
500 | - $paths = array( |
|
501 | - EE_MODELS . 'fields' . DS, |
|
502 | - EE_MODELS . 'helpers' . DS, |
|
503 | - EE_MODELS . 'relations' . DS, |
|
504 | - EE_MODELS . 'strategies' . DS, |
|
505 | - ); |
|
506 | - // retrieve instantiated class |
|
507 | - return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only); |
|
508 | - } |
|
509 | - |
|
510 | - |
|
511 | - |
|
512 | - /** |
|
513 | - * Determines if $model_name is the name of an actual EE model. |
|
514 | - * |
|
515 | - * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
|
516 | - * @return boolean |
|
517 | - */ |
|
518 | - public function is_model_name($model_name) |
|
519 | - { |
|
520 | - return isset($this->models[$model_name]) ? true : false; |
|
521 | - } |
|
522 | - |
|
523 | - |
|
524 | - |
|
525 | - /** |
|
526 | - * generic class loader |
|
527 | - * |
|
528 | - * @param string $path_to_file - directory path to file location, not including filename |
|
529 | - * @param string $file_name - file name ie: my_file.php, including extension |
|
530 | - * @param string $type - file type - core? class? helper? model? |
|
531 | - * @param mixed $arguments |
|
532 | - * @param bool $load_only |
|
533 | - * @return mixed |
|
534 | - */ |
|
535 | - public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
|
536 | - { |
|
537 | - // retrieve instantiated class |
|
538 | - return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only); |
|
539 | - } |
|
540 | - |
|
541 | - |
|
542 | - |
|
543 | - /** |
|
544 | - * load_addon |
|
545 | - * |
|
546 | - * @param string $path_to_file - directory path to file location, not including filename |
|
547 | - * @param string $class_name - full class name ie: My_Class |
|
548 | - * @param string $type - file type - core? class? helper? model? |
|
549 | - * @param mixed $arguments |
|
550 | - * @param bool $load_only |
|
551 | - * @return EE_Addon |
|
552 | - */ |
|
553 | - public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
|
554 | - { |
|
555 | - // retrieve instantiated class |
|
556 | - return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only); |
|
557 | - } |
|
558 | - |
|
559 | - |
|
560 | - |
|
561 | - /** |
|
562 | - * instantiates, caches, and automatically resolves dependencies |
|
563 | - * for classes that use a Fully Qualified Class Name. |
|
564 | - * if the class is not capable of being loaded using PSR-4 autoloading, |
|
565 | - * then you need to use one of the existing load_*() methods |
|
566 | - * which can resolve the classname and filepath from the passed arguments |
|
567 | - * |
|
568 | - * @param bool|string $class_name Fully Qualified Class Name |
|
569 | - * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
|
570 | - * @param bool $cache whether to cache the instantiated object for reuse |
|
571 | - * @param bool $from_db some classes are instantiated from the db |
|
572 | - * and thus call a different method to instantiate |
|
573 | - * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
574 | - * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
|
575 | - * @return mixed null = failure to load or instantiate class object. |
|
576 | - * object = class loaded and instantiated successfully. |
|
577 | - * bool = fail or success when $load_only is true |
|
578 | - */ |
|
579 | - public function create( |
|
580 | - $class_name = false, |
|
581 | - $arguments = array(), |
|
582 | - $cache = false, |
|
583 | - $from_db = false, |
|
584 | - $load_only = false, |
|
585 | - $addon = false |
|
586 | - ) { |
|
587 | - $class_name = ltrim($class_name, '\\'); |
|
588 | - $class_name = $this->_dependency_map->get_alias($class_name); |
|
589 | - if ( ! class_exists($class_name)) { |
|
590 | - // maybe the class is registered with a preceding \ |
|
591 | - $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name; |
|
592 | - // still doesn't exist ? |
|
593 | - if ( ! class_exists($class_name)) { |
|
594 | - return null; |
|
595 | - } |
|
596 | - } |
|
597 | - // if we're only loading the class and it already exists, then let's just return true immediately |
|
598 | - if ($load_only) { |
|
599 | - return true; |
|
600 | - } |
|
601 | - $addon = $addon ? 'addon' : ''; |
|
602 | - // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
603 | - // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
604 | - // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
605 | - if ($this->_cache_on && $cache && ! $load_only) { |
|
606 | - // return object if it's already cached |
|
607 | - $cached_class = $this->_get_cached_class($class_name, $addon); |
|
608 | - if ($cached_class !== null) { |
|
609 | - return $cached_class; |
|
610 | - } |
|
611 | - } |
|
612 | - // instantiate the requested object |
|
613 | - $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
|
614 | - if ($this->_cache_on && $cache) { |
|
615 | - // save it for later... kinda like gum { : $ |
|
616 | - $this->_set_cached_class($class_obj, $class_name, $addon, $from_db); |
|
617 | - } |
|
618 | - $this->_cache_on = true; |
|
619 | - return $class_obj; |
|
620 | - } |
|
621 | - |
|
622 | - |
|
623 | - |
|
624 | - /** |
|
625 | - * instantiates, caches, and injects dependencies for classes |
|
626 | - * |
|
627 | - * @param array $file_paths an array of paths to folders to look in |
|
628 | - * @param string $class_prefix EE or EEM or... ??? |
|
629 | - * @param bool|string $class_name $class name |
|
630 | - * @param string $type file type - core? class? helper? model? |
|
631 | - * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
|
632 | - * @param bool $from_db some classes are instantiated from the db |
|
633 | - * and thus call a different method to instantiate |
|
634 | - * @param bool $cache whether to cache the instantiated object for reuse |
|
635 | - * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
636 | - * @return null|object|bool null = failure to load or instantiate class object. |
|
637 | - * object = class loaded and instantiated successfully. |
|
638 | - * bool = fail or success when $load_only is true |
|
639 | - */ |
|
640 | - protected function _load( |
|
641 | - $file_paths = array(), |
|
642 | - $class_prefix = 'EE_', |
|
643 | - $class_name = false, |
|
644 | - $type = 'class', |
|
645 | - $arguments = array(), |
|
646 | - $from_db = false, |
|
647 | - $cache = true, |
|
648 | - $load_only = false |
|
649 | - ) { |
|
650 | - $class_name = ltrim($class_name, '\\'); |
|
651 | - // strip php file extension |
|
652 | - $class_name = str_replace('.php', '', trim($class_name)); |
|
653 | - // does the class have a prefix ? |
|
654 | - if ( ! empty($class_prefix) && $class_prefix != 'addon') { |
|
655 | - // make sure $class_prefix is uppercase |
|
656 | - $class_prefix = strtoupper(trim($class_prefix)); |
|
657 | - // add class prefix ONCE!!! |
|
658 | - $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
659 | - } |
|
660 | - $class_name = $this->_dependency_map->get_alias($class_name); |
|
661 | - $class_exists = class_exists($class_name); |
|
662 | - // if we're only loading the class and it already exists, then let's just return true immediately |
|
663 | - if ($load_only && $class_exists) { |
|
664 | - return true; |
|
665 | - } |
|
666 | - // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
667 | - // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
668 | - // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
669 | - if ($this->_cache_on && $cache && ! $load_only) { |
|
670 | - // return object if it's already cached |
|
671 | - $cached_class = $this->_get_cached_class($class_name, $class_prefix); |
|
672 | - if ($cached_class !== null) { |
|
673 | - return $cached_class; |
|
674 | - } |
|
675 | - } |
|
676 | - // if the class doesn't already exist.. then we need to try and find the file and load it |
|
677 | - if ( ! $class_exists) { |
|
678 | - // get full path to file |
|
679 | - $path = $this->_resolve_path($class_name, $type, $file_paths); |
|
680 | - // load the file |
|
681 | - $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
|
682 | - // if loading failed, or we are only loading a file but NOT instantiating an object |
|
683 | - if ( ! $loaded || $load_only) { |
|
684 | - // return boolean if only loading, or null if an object was expected |
|
685 | - return $load_only ? $loaded : null; |
|
686 | - } |
|
687 | - } |
|
688 | - // instantiate the requested object |
|
689 | - $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db); |
|
690 | - if ($this->_cache_on && $cache) { |
|
691 | - // save it for later... kinda like gum { : $ |
|
692 | - $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db); |
|
693 | - } |
|
694 | - $this->_cache_on = true; |
|
695 | - return $class_obj; |
|
696 | - } |
|
697 | - |
|
698 | - |
|
699 | - |
|
700 | - |
|
701 | - /** |
|
702 | - * _get_cached_class |
|
703 | - * attempts to find a cached version of the requested class |
|
704 | - * by looking in the following places: |
|
705 | - * $this->{$class_abbreviation} ie: $this->CART |
|
706 | - * $this->{$class_name} ie: $this->Some_Class |
|
707 | - * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
708 | - * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
|
709 | - * |
|
710 | - * @access protected |
|
711 | - * @param string $class_name |
|
712 | - * @param string $class_prefix |
|
713 | - * @return mixed |
|
714 | - */ |
|
715 | - protected function _get_cached_class($class_name, $class_prefix = '') |
|
716 | - { |
|
717 | - // have to specify something, but not anything that will conflict |
|
718 | - $class_abbreviation = isset($this->_class_abbreviations[ $class_name ]) |
|
719 | - ? $this->_class_abbreviations[ $class_name ] |
|
720 | - : 'FANCY_BATMAN_PANTS'; |
|
721 | - $class_name = str_replace('\\', '_', $class_name); |
|
722 | - // check if class has already been loaded, and return it if it has been |
|
723 | - if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) { |
|
724 | - return $this->{$class_abbreviation}; |
|
725 | - } |
|
726 | - if (isset ($this->{$class_name})) { |
|
727 | - return $this->{$class_name}; |
|
728 | - } |
|
729 | - if (isset ($this->LIB->{$class_name})) { |
|
730 | - return $this->LIB->{$class_name}; |
|
731 | - } |
|
732 | - if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) { |
|
733 | - return $this->addons->{$class_name}; |
|
734 | - } |
|
735 | - return null; |
|
736 | - } |
|
737 | - |
|
738 | - |
|
739 | - |
|
740 | - /** |
|
741 | - * removes a cached version of the requested class |
|
742 | - * |
|
743 | - * @param string $class_name |
|
744 | - * @param boolean $addon |
|
745 | - * @return boolean |
|
746 | - */ |
|
747 | - public function clear_cached_class($class_name, $addon = false) |
|
748 | - { |
|
749 | - // have to specify something, but not anything that will conflict |
|
750 | - $class_abbreviation = isset($this->_class_abbreviations[ $class_name ]) |
|
751 | - ? $this->_class_abbreviations[ $class_name ] |
|
752 | - : 'FANCY_BATMAN_PANTS'; |
|
753 | - $class_name = str_replace('\\', '_', $class_name); |
|
754 | - // check if class has already been loaded, and return it if it has been |
|
755 | - if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) { |
|
756 | - $this->{$class_abbreviation} = null; |
|
757 | - return true; |
|
758 | - } |
|
759 | - if (isset($this->{$class_name})) { |
|
760 | - $this->{$class_name} = null; |
|
761 | - return true; |
|
762 | - } |
|
763 | - if (isset($this->LIB->{$class_name})) { |
|
764 | - unset($this->LIB->{$class_name}); |
|
765 | - return true; |
|
766 | - } |
|
767 | - if ($addon && isset($this->addons->{$class_name})) { |
|
768 | - unset($this->addons->{$class_name}); |
|
769 | - return true; |
|
770 | - } |
|
771 | - return false; |
|
772 | - } |
|
773 | - |
|
774 | - |
|
775 | - /** |
|
776 | - * _resolve_path |
|
777 | - * attempts to find a full valid filepath for the requested class. |
|
778 | - * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
|
779 | - * then returns that path if the target file has been found and is readable |
|
780 | - * |
|
781 | - * @access protected |
|
782 | - * @param string $class_name |
|
783 | - * @param string $type |
|
784 | - * @param array $file_paths |
|
785 | - * @return string | bool |
|
786 | - */ |
|
787 | - protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
|
788 | - { |
|
789 | - // make sure $file_paths is an array |
|
790 | - $file_paths = is_array($file_paths) ? $file_paths : array($file_paths); |
|
791 | - // cycle thru paths |
|
792 | - foreach ($file_paths as $key => $file_path) { |
|
793 | - // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
|
794 | - $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES; |
|
795 | - // prep file type |
|
796 | - $type = ! empty($type) ? trim($type, '.') . '.' : ''; |
|
797 | - // build full file path |
|
798 | - $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
799 | - //does the file exist and can be read ? |
|
800 | - if (is_readable($file_paths[$key])) { |
|
801 | - return $file_paths[$key]; |
|
802 | - } |
|
803 | - } |
|
804 | - return false; |
|
805 | - } |
|
806 | - |
|
807 | - |
|
808 | - |
|
809 | - /** |
|
810 | - * _require_file |
|
811 | - * basically just performs a require_once() |
|
812 | - * but with some error handling |
|
813 | - * |
|
814 | - * @access protected |
|
815 | - * @param string $path |
|
816 | - * @param string $class_name |
|
817 | - * @param string $type |
|
818 | - * @param array $file_paths |
|
819 | - * @return boolean |
|
820 | - * @throws \EE_Error |
|
821 | - */ |
|
822 | - protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
|
823 | - { |
|
824 | - // don't give up! you gotta... |
|
825 | - try { |
|
826 | - //does the file exist and can it be read ? |
|
827 | - if ( ! $path) { |
|
828 | - // so sorry, can't find the file |
|
829 | - throw new EE_Error ( |
|
830 | - sprintf( |
|
831 | - __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'), |
|
832 | - trim($type, '.'), |
|
833 | - $class_name, |
|
834 | - '<br />' . implode(',<br />', $file_paths) |
|
835 | - ) |
|
836 | - ); |
|
837 | - } |
|
838 | - // get the file |
|
839 | - require_once($path); |
|
840 | - // if the class isn't already declared somewhere |
|
841 | - if (class_exists($class_name, false) === false) { |
|
842 | - // so sorry, not a class |
|
843 | - throw new EE_Error( |
|
844 | - sprintf( |
|
845 | - __('The %s file %s does not appear to contain the %s Class.', 'event_espresso'), |
|
846 | - $type, |
|
847 | - $path, |
|
848 | - $class_name |
|
849 | - ) |
|
850 | - ); |
|
851 | - } |
|
852 | - } catch (EE_Error $e) { |
|
853 | - $e->get_error(); |
|
854 | - return false; |
|
855 | - } |
|
856 | - return true; |
|
857 | - } |
|
858 | - |
|
859 | - |
|
860 | - |
|
861 | - /** |
|
862 | - * _create_object |
|
863 | - * Attempts to instantiate the requested class via any of the |
|
864 | - * commonly used instantiation methods employed throughout EE. |
|
865 | - * The priority for instantiation is as follows: |
|
866 | - * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
|
867 | - * - model objects via their 'new_instance_from_db' method |
|
868 | - * - model objects via their 'new_instance' method |
|
869 | - * - "singleton" classes" via their 'instance' method |
|
870 | - * - standard instantiable classes via their __constructor |
|
871 | - * Prior to instantiation, if the classname exists in the dependency_map, |
|
872 | - * then the constructor for the requested class will be examined to determine |
|
873 | - * if any dependencies exist, and if they can be injected. |
|
874 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
875 | - * |
|
876 | - * @access protected |
|
877 | - * @param string $class_name |
|
878 | - * @param array $arguments |
|
879 | - * @param string $type |
|
880 | - * @param bool $from_db |
|
881 | - * @return null | object |
|
882 | - * @throws \EE_Error |
|
883 | - */ |
|
884 | - protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
|
885 | - { |
|
886 | - $class_obj = null; |
|
887 | - $instantiation_mode = '0) none'; |
|
888 | - // don't give up! you gotta... |
|
889 | - try { |
|
890 | - // create reflection |
|
891 | - $reflector = $this->get_ReflectionClass($class_name); |
|
892 | - // make sure arguments are an array |
|
893 | - $arguments = is_array($arguments) ? $arguments : array($arguments); |
|
894 | - // and if arguments array is numerically and sequentially indexed, then we want it to remain as is, |
|
895 | - // else wrap it in an additional array so that it doesn't get split into multiple parameters |
|
896 | - $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments) |
|
897 | - ? $arguments |
|
898 | - : array($arguments); |
|
899 | - // attempt to inject dependencies ? |
|
900 | - if ($this->_dependency_map->has($class_name)) { |
|
901 | - $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments); |
|
902 | - } |
|
903 | - // instantiate the class if possible |
|
904 | - if ($reflector->isAbstract()) { |
|
905 | - // nothing to instantiate, loading file was enough |
|
906 | - // does not throw an exception so $instantiation_mode is unused |
|
907 | - // $instantiation_mode = "1) no constructor abstract class"; |
|
908 | - $class_obj = true; |
|
909 | - } else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) { |
|
910 | - // no constructor = static methods only... nothing to instantiate, loading file was enough |
|
911 | - $instantiation_mode = "2) no constructor but instantiable"; |
|
912 | - $class_obj = $reflector->newInstance(); |
|
913 | - } else if ($from_db && method_exists($class_name, 'new_instance_from_db')) { |
|
914 | - $instantiation_mode = "3) new_instance_from_db()"; |
|
915 | - $class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments); |
|
916 | - } else if (method_exists($class_name, 'new_instance')) { |
|
917 | - $instantiation_mode = "4) new_instance()"; |
|
918 | - $class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments); |
|
919 | - } else if (method_exists($class_name, 'instance')) { |
|
920 | - $instantiation_mode = "5) instance()"; |
|
921 | - $class_obj = call_user_func_array(array($class_name, 'instance'), $arguments); |
|
922 | - } else if ($reflector->isInstantiable()) { |
|
923 | - $instantiation_mode = "6) constructor"; |
|
924 | - $class_obj = $reflector->newInstanceArgs($arguments); |
|
925 | - } else { |
|
926 | - // heh ? something's not right ! |
|
927 | - throw new EE_Error( |
|
928 | - sprintf( |
|
929 | - __('The %s file %s could not be instantiated.', 'event_espresso'), |
|
930 | - $type, |
|
931 | - $class_name |
|
932 | - ) |
|
933 | - ); |
|
934 | - } |
|
935 | - } catch (Exception $e) { |
|
936 | - if ( ! $e instanceof EE_Error) { |
|
937 | - $e = new EE_Error( |
|
938 | - sprintf( |
|
939 | - __('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'), |
|
940 | - $class_name, |
|
941 | - '<br />', |
|
942 | - $e->getMessage(), |
|
943 | - $instantiation_mode |
|
944 | - ) |
|
945 | - ); |
|
946 | - } |
|
947 | - $e->get_error(); |
|
948 | - } |
|
949 | - return $class_obj; |
|
950 | - } |
|
951 | - |
|
952 | - |
|
953 | - |
|
954 | - /** |
|
955 | - * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
|
956 | - * @param array $array |
|
957 | - * @return bool |
|
958 | - */ |
|
959 | - protected function _array_is_numerically_and_sequentially_indexed(array $array) |
|
960 | - { |
|
961 | - return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true; |
|
962 | - } |
|
963 | - |
|
964 | - |
|
965 | - |
|
966 | - /** |
|
967 | - * getReflectionClass |
|
968 | - * checks if a ReflectionClass object has already been generated for a class |
|
969 | - * and returns that instead of creating a new one |
|
970 | - * |
|
971 | - * @access public |
|
972 | - * @param string $class_name |
|
973 | - * @return ReflectionClass |
|
974 | - */ |
|
975 | - public function get_ReflectionClass($class_name) |
|
976 | - { |
|
977 | - if ( |
|
978 | - ! isset($this->_reflectors[$class_name]) |
|
979 | - || ! $this->_reflectors[$class_name] instanceof ReflectionClass |
|
980 | - ) { |
|
981 | - $this->_reflectors[$class_name] = new ReflectionClass($class_name); |
|
982 | - } |
|
983 | - return $this->_reflectors[$class_name]; |
|
984 | - } |
|
985 | - |
|
986 | - |
|
987 | - |
|
988 | - /** |
|
989 | - * _resolve_dependencies |
|
990 | - * examines the constructor for the requested class to determine |
|
991 | - * if any dependencies exist, and if they can be injected. |
|
992 | - * If so, then those classes will be added to the array of arguments passed to the constructor |
|
993 | - * PLZ NOTE: this is achieved by type hinting the constructor params |
|
994 | - * For example: |
|
995 | - * if attempting to load a class "Foo" with the following constructor: |
|
996 | - * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
997 | - * then $bar_class and $grohl_class will be added to the $arguments array, |
|
998 | - * but only IF they are NOT already present in the incoming arguments array, |
|
999 | - * and the correct classes can be loaded |
|
1000 | - * |
|
1001 | - * @access protected |
|
1002 | - * @param ReflectionClass $reflector |
|
1003 | - * @param string $class_name |
|
1004 | - * @param array $arguments |
|
1005 | - * @return array |
|
1006 | - * @throws \ReflectionException |
|
1007 | - */ |
|
1008 | - protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array()) |
|
1009 | - { |
|
1010 | - // let's examine the constructor |
|
1011 | - $constructor = $reflector->getConstructor(); |
|
1012 | - // whu? huh? nothing? |
|
1013 | - if ( ! $constructor) { |
|
1014 | - return $arguments; |
|
1015 | - } |
|
1016 | - // get constructor parameters |
|
1017 | - $params = $constructor->getParameters(); |
|
1018 | - // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected |
|
1019 | - $argument_keys = array_keys($arguments); |
|
1020 | - // now loop thru all of the constructors expected parameters |
|
1021 | - foreach ($params as $index => $param) { |
|
1022 | - // is this a dependency for a specific class ? |
|
1023 | - $param_class = $param->getClass() ? $param->getClass()->name : null; |
|
1024 | - // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime) |
|
1025 | - $param_class = $this->_dependency_map->has_alias($param_class, $class_name) |
|
1026 | - ? $this->_dependency_map->get_alias($param_class, $class_name) |
|
1027 | - : $param_class; |
|
1028 | - if ( |
|
1029 | - // param is not even a class |
|
1030 | - empty($param_class) |
|
1031 | - // and something already exists in the incoming arguments for this param |
|
1032 | - && isset($argument_keys[$index], $arguments[$argument_keys[$index]]) |
|
1033 | - ) { |
|
1034 | - // so let's skip this argument and move on to the next |
|
1035 | - continue; |
|
1036 | - } |
|
1037 | - if ( |
|
1038 | - // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class |
|
1039 | - ! empty($param_class) |
|
1040 | - && isset($argument_keys[$index], $arguments[$argument_keys[$index]]) |
|
1041 | - && $arguments[$argument_keys[$index]] instanceof $param_class |
|
1042 | - ) { |
|
1043 | - // skip this argument and move on to the next |
|
1044 | - continue; |
|
1045 | - } |
|
1046 | - if ( |
|
1047 | - // parameter is type hinted as a class, and should be injected |
|
1048 | - ! empty($param_class) |
|
1049 | - && $this->_dependency_map->has_dependency_for_class($class_name, $param_class) |
|
1050 | - ) { |
|
1051 | - $arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index); |
|
1052 | - } else { |
|
1053 | - try { |
|
1054 | - $arguments[$index] = $param->getDefaultValue(); |
|
1055 | - } catch (ReflectionException $e) { |
|
1056 | - throw new ReflectionException( |
|
1057 | - sprintf( |
|
1058 | - __('%1$s for parameter "$%2$s"', 'event_espresso'), |
|
1059 | - $e->getMessage(), |
|
1060 | - $param->getName() |
|
1061 | - ) |
|
1062 | - ); |
|
1063 | - } |
|
1064 | - } |
|
1065 | - } |
|
1066 | - return $arguments; |
|
1067 | - } |
|
1068 | - |
|
1069 | - |
|
1070 | - |
|
1071 | - /** |
|
1072 | - * @access protected |
|
1073 | - * @param string $class_name |
|
1074 | - * @param string $param_class |
|
1075 | - * @param array $arguments |
|
1076 | - * @param mixed $index |
|
1077 | - * @return array |
|
1078 | - */ |
|
1079 | - protected function _resolve_dependency($class_name, $param_class, $arguments, $index) |
|
1080 | - { |
|
1081 | - $dependency = null; |
|
1082 | - // should dependency be loaded from cache ? |
|
1083 | - $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class) |
|
1084 | - !== EE_Dependency_Map::load_new_object |
|
1085 | - ? true |
|
1086 | - : false; |
|
1087 | - // we might have a dependency... |
|
1088 | - // let's MAYBE try and find it in our cache if that's what's been requested |
|
1089 | - $cached_class = $cache_on ? $this->_get_cached_class($param_class) : null; |
|
1090 | - // and grab it if it exists |
|
1091 | - if ($cached_class instanceof $param_class) { |
|
1092 | - $dependency = $cached_class; |
|
1093 | - } else if ($param_class !== $class_name) { |
|
1094 | - // obtain the loader method from the dependency map |
|
1095 | - $loader = $this->_dependency_map->class_loader($param_class); |
|
1096 | - // is loader a custom closure ? |
|
1097 | - if ($loader instanceof Closure) { |
|
1098 | - $dependency = $loader(); |
|
1099 | - } else { |
|
1100 | - // set the cache on property for the recursive loading call |
|
1101 | - $this->_cache_on = $cache_on; |
|
1102 | - // if not, then let's try and load it via the registry |
|
1103 | - if ($loader && method_exists($this, $loader)) { |
|
1104 | - $dependency = $this->{$loader}($param_class); |
|
1105 | - } else { |
|
1106 | - $dependency = $this->create($param_class, array(), $cache_on); |
|
1107 | - } |
|
1108 | - } |
|
1109 | - } |
|
1110 | - // did we successfully find the correct dependency ? |
|
1111 | - if ($dependency instanceof $param_class) { |
|
1112 | - // then let's inject it into the incoming array of arguments at the correct location |
|
1113 | - if (isset($argument_keys[$index])) { |
|
1114 | - $arguments[$argument_keys[$index]] = $dependency; |
|
1115 | - } else { |
|
1116 | - $arguments[$index] = $dependency; |
|
1117 | - } |
|
1118 | - } |
|
1119 | - return $arguments; |
|
1120 | - } |
|
1121 | - |
|
1122 | - |
|
1123 | - |
|
1124 | - /** |
|
1125 | - * _set_cached_class |
|
1126 | - * attempts to cache the instantiated class locally |
|
1127 | - * in one of the following places, in the following order: |
|
1128 | - * $this->{class_abbreviation} ie: $this->CART |
|
1129 | - * $this->{$class_name} ie: $this->Some_Class |
|
1130 | - * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
|
1131 | - * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
1132 | - * |
|
1133 | - * @access protected |
|
1134 | - * @param object $class_obj |
|
1135 | - * @param string $class_name |
|
1136 | - * @param string $class_prefix |
|
1137 | - * @param bool $from_db |
|
1138 | - * @return void |
|
1139 | - */ |
|
1140 | - protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false) |
|
1141 | - { |
|
1142 | - if (empty($class_obj)) { |
|
1143 | - return; |
|
1144 | - } |
|
1145 | - // return newly instantiated class |
|
1146 | - if (isset($this->_class_abbreviations[$class_name])) { |
|
1147 | - $class_abbreviation = $this->_class_abbreviations[$class_name]; |
|
1148 | - $this->{$class_abbreviation} = $class_obj; |
|
1149 | - return; |
|
1150 | - } |
|
1151 | - $class_name = str_replace('\\', '_', $class_name); |
|
1152 | - if (property_exists($this, $class_name)) { |
|
1153 | - $this->{$class_name} = $class_obj; |
|
1154 | - return; |
|
1155 | - } |
|
1156 | - if ($class_prefix === 'addon') { |
|
1157 | - $this->addons->{$class_name} = $class_obj; |
|
1158 | - return; |
|
1159 | - } |
|
1160 | - if ( ! $from_db) { |
|
1161 | - $this->LIB->{$class_name} = $class_obj; |
|
1162 | - } |
|
1163 | - } |
|
1164 | - |
|
1165 | - |
|
1166 | - |
|
1167 | - /** |
|
1168 | - * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
|
1169 | - * |
|
1170 | - * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
|
1171 | - * in the EE_Dependency_Map::$_class_loaders array, |
|
1172 | - * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
|
1173 | - * @param array $arguments |
|
1174 | - * @return object |
|
1175 | - */ |
|
1176 | - public static function factory($classname, $arguments = array()) |
|
1177 | - { |
|
1178 | - $loader = self::instance()->_dependency_map->class_loader($classname); |
|
1179 | - if ($loader instanceof Closure) { |
|
1180 | - return $loader($arguments); |
|
1181 | - } |
|
1182 | - if (method_exists(EE_Registry::instance(), $loader)) { |
|
1183 | - return EE_Registry::instance()->{$loader}($classname, $arguments); |
|
1184 | - } |
|
1185 | - return null; |
|
1186 | - } |
|
1187 | - |
|
1188 | - |
|
1189 | - |
|
1190 | - /** |
|
1191 | - * Gets the addon by its name/slug (not classname. For that, just |
|
1192 | - * use the classname as the property name on EE_Config::instance()->addons) |
|
1193 | - * |
|
1194 | - * @param string $name |
|
1195 | - * @return EE_Addon |
|
1196 | - */ |
|
1197 | - public function get_addon_by_name($name) |
|
1198 | - { |
|
1199 | - foreach ($this->addons as $addon) { |
|
1200 | - if ($addon->name() == $name) { |
|
1201 | - return $addon; |
|
1202 | - } |
|
1203 | - } |
|
1204 | - return null; |
|
1205 | - } |
|
1206 | - |
|
1207 | - |
|
1208 | - |
|
1209 | - /** |
|
1210 | - * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is |
|
1211 | - * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname} |
|
1212 | - * |
|
1213 | - * @return EE_Addon[] where the KEYS are the addon's name() |
|
1214 | - */ |
|
1215 | - public function get_addons_by_name() |
|
1216 | - { |
|
1217 | - $addons = array(); |
|
1218 | - foreach ($this->addons as $addon) { |
|
1219 | - $addons[$addon->name()] = $addon; |
|
1220 | - } |
|
1221 | - return $addons; |
|
1222 | - } |
|
1223 | - |
|
1224 | - |
|
1225 | - |
|
1226 | - /** |
|
1227 | - * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
|
1228 | - * a stale copy of it around |
|
1229 | - * |
|
1230 | - * @param string $model_name |
|
1231 | - * @return \EEM_Base |
|
1232 | - * @throws \EE_Error |
|
1233 | - */ |
|
1234 | - public function reset_model($model_name) |
|
1235 | - { |
|
1236 | - $model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name; |
|
1237 | - if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
1238 | - return null; |
|
1239 | - } |
|
1240 | - //get that model reset it and make sure we nuke the old reference to it |
|
1241 | - if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) { |
|
1242 | - $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset(); |
|
1243 | - } else { |
|
1244 | - throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name)); |
|
1245 | - } |
|
1246 | - return $this->LIB->{$model_class_name}; |
|
1247 | - } |
|
1248 | - |
|
1249 | - |
|
1250 | - |
|
1251 | - /** |
|
1252 | - * Resets the registry. |
|
1253 | - * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog |
|
1254 | - * is used in a multisite install. Here is a list of things that are NOT reset. |
|
1255 | - * - $_dependency_map |
|
1256 | - * - $_class_abbreviations |
|
1257 | - * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
|
1258 | - * - $REQ: Still on the same request so no need to change. |
|
1259 | - * - $CAP: There is no site specific state in the EE_Capability class. |
|
1260 | - * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session |
|
1261 | - * can be active in a single request. Resetting could resolve in "headers already sent" errors. |
|
1262 | - * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
|
1263 | - * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
|
1264 | - * switch or on the restore. |
|
1265 | - * - $modules |
|
1266 | - * - $shortcodes |
|
1267 | - * - $widgets |
|
1268 | - * |
|
1269 | - * @param boolean $hard whether to reset data in the database too, or just refresh |
|
1270 | - * the Registry to its state at the beginning of the request |
|
1271 | - * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
|
1272 | - * or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN |
|
1273 | - * currently reinstantiate the singletons at the moment) |
|
1274 | - * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so client |
|
1275 | - * code instead can just change the model context to a different blog id if necessary |
|
1276 | - * @return EE_Registry |
|
1277 | - */ |
|
1278 | - public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
|
1279 | - { |
|
1280 | - $instance = self::instance(); |
|
1281 | - EEH_Activation::reset(); |
|
1282 | - //properties that get reset |
|
1283 | - $instance->_cache_on = true; |
|
1284 | - $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
|
1285 | - $instance->CART = null; |
|
1286 | - $instance->MRM = null; |
|
1287 | - $instance->AssetsRegistry = null; |
|
1288 | - $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry'); |
|
1289 | - //messages reset |
|
1290 | - EED_Messages::reset(); |
|
1291 | - if ($reset_models) { |
|
1292 | - foreach (array_keys($instance->non_abstract_db_models) as $model_name) { |
|
1293 | - $instance->reset_model($model_name); |
|
1294 | - } |
|
1295 | - } |
|
1296 | - $instance->LIB = new stdClass(); |
|
1297 | - return $instance; |
|
1298 | - } |
|
1299 | - |
|
1300 | - |
|
1301 | - |
|
1302 | - /** |
|
1303 | - * @override magic methods |
|
1304 | - * @return void |
|
1305 | - */ |
|
1306 | - public final function __destruct() |
|
1307 | - { |
|
1308 | - } |
|
1309 | - |
|
1310 | - |
|
1311 | - |
|
1312 | - /** |
|
1313 | - * @param $a |
|
1314 | - * @param $b |
|
1315 | - */ |
|
1316 | - public final function __call($a, $b) |
|
1317 | - { |
|
1318 | - } |
|
1319 | - |
|
1320 | - |
|
1321 | - |
|
1322 | - /** |
|
1323 | - * @param $a |
|
1324 | - */ |
|
1325 | - public final function __get($a) |
|
1326 | - { |
|
1327 | - } |
|
1328 | - |
|
1329 | - |
|
1330 | - |
|
1331 | - /** |
|
1332 | - * @param $a |
|
1333 | - * @param $b |
|
1334 | - */ |
|
1335 | - public final function __set($a, $b) |
|
1336 | - { |
|
1337 | - } |
|
1338 | - |
|
1339 | - |
|
1340 | - |
|
1341 | - /** |
|
1342 | - * @param $a |
|
1343 | - */ |
|
1344 | - public final function __isset($a) |
|
1345 | - { |
|
1346 | - } |
|
19 | + /** |
|
20 | + * EE_Registry Object |
|
21 | + * |
|
22 | + * @var EE_Registry $_instance |
|
23 | + * @access private |
|
24 | + */ |
|
25 | + private static $_instance = null; |
|
26 | + |
|
27 | + /** |
|
28 | + * @var EE_Dependency_Map $_dependency_map |
|
29 | + * @access protected |
|
30 | + */ |
|
31 | + protected $_dependency_map = null; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var array $_class_abbreviations |
|
35 | + * @access protected |
|
36 | + */ |
|
37 | + protected $_class_abbreviations = array(); |
|
38 | + |
|
39 | + /** |
|
40 | + * @access public |
|
41 | + * @var \EventEspresso\core\services\commands\CommandBusInterface $BUS |
|
42 | + */ |
|
43 | + public $BUS; |
|
44 | + |
|
45 | + /** |
|
46 | + * EE_Cart Object |
|
47 | + * |
|
48 | + * @access public |
|
49 | + * @var EE_Cart $CART |
|
50 | + */ |
|
51 | + public $CART = null; |
|
52 | + |
|
53 | + /** |
|
54 | + * EE_Config Object |
|
55 | + * |
|
56 | + * @access public |
|
57 | + * @var EE_Config $CFG |
|
58 | + */ |
|
59 | + public $CFG = null; |
|
60 | + |
|
61 | + /** |
|
62 | + * EE_Network_Config Object |
|
63 | + * |
|
64 | + * @access public |
|
65 | + * @var EE_Network_Config $NET_CFG |
|
66 | + */ |
|
67 | + public $NET_CFG = null; |
|
68 | + |
|
69 | + /** |
|
70 | + * StdClass object for storing library classes in |
|
71 | + * |
|
72 | + * @public LIB |
|
73 | + * @var StdClass $LIB |
|
74 | + */ |
|
75 | + public $LIB = null; |
|
76 | + |
|
77 | + /** |
|
78 | + * EE_Request_Handler Object |
|
79 | + * |
|
80 | + * @access public |
|
81 | + * @var EE_Request_Handler $REQ |
|
82 | + */ |
|
83 | + public $REQ = null; |
|
84 | + |
|
85 | + /** |
|
86 | + * EE_Session Object |
|
87 | + * |
|
88 | + * @access public |
|
89 | + * @var EE_Session $SSN |
|
90 | + */ |
|
91 | + public $SSN = null; |
|
92 | + |
|
93 | + /** |
|
94 | + * holds the ee capabilities object. |
|
95 | + * |
|
96 | + * @since 4.5.0 |
|
97 | + * @var EE_Capabilities |
|
98 | + */ |
|
99 | + public $CAP = null; |
|
100 | + |
|
101 | + /** |
|
102 | + * holds the EE_Message_Resource_Manager object. |
|
103 | + * |
|
104 | + * @since 4.9.0 |
|
105 | + * @var EE_Message_Resource_Manager |
|
106 | + */ |
|
107 | + public $MRM = null; |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * Holds the Assets Registry instance |
|
112 | + * @var Registry |
|
113 | + */ |
|
114 | + public $AssetsRegistry = null; |
|
115 | + |
|
116 | + /** |
|
117 | + * $addons - StdClass object for holding addons which have registered themselves to work with EE core |
|
118 | + * |
|
119 | + * @access public |
|
120 | + * @var EE_Addon[] |
|
121 | + */ |
|
122 | + public $addons = null; |
|
123 | + |
|
124 | + /** |
|
125 | + * $models |
|
126 | + * @access public |
|
127 | + * @var EEM_Base[] $models keys are 'short names' (eg Event), values are class names (eg 'EEM_Event') |
|
128 | + */ |
|
129 | + public $models = array(); |
|
130 | + |
|
131 | + /** |
|
132 | + * $modules |
|
133 | + * @access public |
|
134 | + * @var EED_Module[] $modules |
|
135 | + */ |
|
136 | + public $modules = null; |
|
137 | + |
|
138 | + /** |
|
139 | + * $shortcodes |
|
140 | + * @access public |
|
141 | + * @var EES_Shortcode[] $shortcodes |
|
142 | + */ |
|
143 | + public $shortcodes = null; |
|
144 | + |
|
145 | + /** |
|
146 | + * $widgets |
|
147 | + * @access public |
|
148 | + * @var WP_Widget[] $widgets |
|
149 | + */ |
|
150 | + public $widgets = null; |
|
151 | + |
|
152 | + /** |
|
153 | + * $non_abstract_db_models |
|
154 | + * @access public |
|
155 | + * @var array this is an array of all implemented model names (i.e. not the parent abstract models, or models |
|
156 | + * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)). |
|
157 | + * Keys are model "short names" (eg "Event") as used in model relations, and values are |
|
158 | + * classnames (eg "EEM_Event") |
|
159 | + */ |
|
160 | + public $non_abstract_db_models = array(); |
|
161 | + |
|
162 | + |
|
163 | + /** |
|
164 | + * $i18n_js_strings - internationalization for JS strings |
|
165 | + * usage: EE_Registry::i18n_js_strings['string_key'] = __( 'string to translate.', 'event_espresso' ); |
|
166 | + * in js file: var translatedString = eei18n.string_key; |
|
167 | + * |
|
168 | + * @access public |
|
169 | + * @var array |
|
170 | + */ |
|
171 | + public static $i18n_js_strings = array(); |
|
172 | + |
|
173 | + |
|
174 | + /** |
|
175 | + * $main_file - path to espresso.php |
|
176 | + * |
|
177 | + * @access public |
|
178 | + * @var array |
|
179 | + */ |
|
180 | + public $main_file; |
|
181 | + |
|
182 | + /** |
|
183 | + * array of ReflectionClass objects where the key is the class name |
|
184 | + * |
|
185 | + * @access public |
|
186 | + * @var ReflectionClass[] |
|
187 | + */ |
|
188 | + public $_reflectors; |
|
189 | + |
|
190 | + /** |
|
191 | + * boolean flag to indicate whether or not to load/save dependencies from/to the cache |
|
192 | + * |
|
193 | + * @access protected |
|
194 | + * @var boolean $_cache_on |
|
195 | + */ |
|
196 | + protected $_cache_on = true; |
|
197 | + |
|
198 | + |
|
199 | + |
|
200 | + /** |
|
201 | + * @singleton method used to instantiate class object |
|
202 | + * @access public |
|
203 | + * @param \EE_Dependency_Map $dependency_map |
|
204 | + * @return \EE_Registry instance |
|
205 | + */ |
|
206 | + public static function instance(\EE_Dependency_Map $dependency_map = null) |
|
207 | + { |
|
208 | + // check if class object is instantiated |
|
209 | + if ( ! self::$_instance instanceof EE_Registry) { |
|
210 | + self::$_instance = new EE_Registry($dependency_map); |
|
211 | + } |
|
212 | + return self::$_instance; |
|
213 | + } |
|
214 | + |
|
215 | + |
|
216 | + |
|
217 | + /** |
|
218 | + *protected constructor to prevent direct creation |
|
219 | + * |
|
220 | + * @Constructor |
|
221 | + * @access protected |
|
222 | + * @param \EE_Dependency_Map $dependency_map |
|
223 | + */ |
|
224 | + protected function __construct(\EE_Dependency_Map $dependency_map) |
|
225 | + { |
|
226 | + $this->_dependency_map = $dependency_map; |
|
227 | + $this->LIB = new stdClass(); |
|
228 | + $this->addons = new stdClass(); |
|
229 | + $this->modules = new stdClass(); |
|
230 | + $this->shortcodes = new stdClass(); |
|
231 | + $this->widgets = new stdClass(); |
|
232 | + add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
233 | + } |
|
234 | + |
|
235 | + |
|
236 | + |
|
237 | + /** |
|
238 | + * initialize |
|
239 | + */ |
|
240 | + public function initialize() |
|
241 | + { |
|
242 | + $this->_class_abbreviations = apply_filters( |
|
243 | + 'FHEE__EE_Registry____construct___class_abbreviations', |
|
244 | + array( |
|
245 | + 'EE_Config' => 'CFG', |
|
246 | + 'EE_Session' => 'SSN', |
|
247 | + 'EE_Capabilities' => 'CAP', |
|
248 | + 'EE_Cart' => 'CART', |
|
249 | + 'EE_Network_Config' => 'NET_CFG', |
|
250 | + 'EE_Request_Handler' => 'REQ', |
|
251 | + 'EE_Message_Resource_Manager' => 'MRM', |
|
252 | + 'EventEspresso\core\services\commands\CommandBus' => 'BUS', |
|
253 | + 'EventEspresso\core\services\assets\Registry' => 'AssetsRegistry', |
|
254 | + ) |
|
255 | + ); |
|
256 | + $this->load_core('Base', array(), true); |
|
257 | + // add our request and response objects to the cache |
|
258 | + $request_loader = $this->_dependency_map->class_loader('EE_Request'); |
|
259 | + $this->_set_cached_class( |
|
260 | + $request_loader(), |
|
261 | + 'EE_Request' |
|
262 | + ); |
|
263 | + $response_loader = $this->_dependency_map->class_loader('EE_Response'); |
|
264 | + $this->_set_cached_class( |
|
265 | + $response_loader(), |
|
266 | + 'EE_Response' |
|
267 | + ); |
|
268 | + add_action('AHEE__EE_System__set_hooks_for_core', array($this, 'init')); |
|
269 | + } |
|
270 | + |
|
271 | + |
|
272 | + |
|
273 | + /** |
|
274 | + * init |
|
275 | + * |
|
276 | + * @access public |
|
277 | + * @return void |
|
278 | + */ |
|
279 | + public function init() |
|
280 | + { |
|
281 | + // Get current page protocol |
|
282 | + $protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://'; |
|
283 | + // Output admin-ajax.php URL with same protocol as current page |
|
284 | + self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol); |
|
285 | + self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') ? WP_DEBUG : false; |
|
286 | + } |
|
287 | + |
|
288 | + |
|
289 | + |
|
290 | + /** |
|
291 | + * localize_i18n_js_strings |
|
292 | + * |
|
293 | + * @return string |
|
294 | + */ |
|
295 | + public static function localize_i18n_js_strings() |
|
296 | + { |
|
297 | + $i18n_js_strings = (array)EE_Registry::$i18n_js_strings; |
|
298 | + foreach ($i18n_js_strings as $key => $value) { |
|
299 | + if (is_scalar($value)) { |
|
300 | + $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
|
301 | + } |
|
302 | + } |
|
303 | + return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
304 | + } |
|
305 | + |
|
306 | + |
|
307 | + |
|
308 | + /** |
|
309 | + * @param mixed string | EED_Module $module |
|
310 | + */ |
|
311 | + public function add_module($module) |
|
312 | + { |
|
313 | + if ($module instanceof EED_Module) { |
|
314 | + $module_class = get_class($module); |
|
315 | + $this->modules->{$module_class} = $module; |
|
316 | + } else { |
|
317 | + if ( ! class_exists('EE_Module_Request_Router')) { |
|
318 | + $this->load_core('Module_Request_Router'); |
|
319 | + } |
|
320 | + $this->modules->{$module} = EE_Module_Request_Router::module_factory($module); |
|
321 | + } |
|
322 | + } |
|
323 | + |
|
324 | + |
|
325 | + |
|
326 | + /** |
|
327 | + * @param string $module_name |
|
328 | + * @return mixed EED_Module | NULL |
|
329 | + */ |
|
330 | + public function get_module($module_name = '') |
|
331 | + { |
|
332 | + return isset($this->modules->{$module_name}) ? $this->modules->{$module_name} : null; |
|
333 | + } |
|
334 | + |
|
335 | + |
|
336 | + |
|
337 | + /** |
|
338 | + * loads core classes - must be singletons |
|
339 | + * |
|
340 | + * @access public |
|
341 | + * @param string $class_name - simple class name ie: session |
|
342 | + * @param mixed $arguments |
|
343 | + * @param bool $load_only |
|
344 | + * @return mixed |
|
345 | + */ |
|
346 | + public function load_core($class_name, $arguments = array(), $load_only = false) |
|
347 | + { |
|
348 | + $core_paths = apply_filters( |
|
349 | + 'FHEE__EE_Registry__load_core__core_paths', |
|
350 | + array( |
|
351 | + EE_CORE, |
|
352 | + EE_ADMIN, |
|
353 | + EE_CPTS, |
|
354 | + EE_CORE . 'data_migration_scripts' . DS, |
|
355 | + EE_CORE . 'request_stack' . DS, |
|
356 | + EE_CORE . 'middleware' . DS, |
|
357 | + ) |
|
358 | + ); |
|
359 | + // retrieve instantiated class |
|
360 | + return $this->_load($core_paths, 'EE_', $class_name, 'core', $arguments, false, true, $load_only); |
|
361 | + } |
|
362 | + |
|
363 | + |
|
364 | + |
|
365 | + /** |
|
366 | + * loads service classes |
|
367 | + * |
|
368 | + * @access public |
|
369 | + * @param string $class_name - simple class name ie: session |
|
370 | + * @param mixed $arguments |
|
371 | + * @param bool $load_only |
|
372 | + * @return mixed |
|
373 | + */ |
|
374 | + public function load_service($class_name, $arguments = array(), $load_only = false) |
|
375 | + { |
|
376 | + $service_paths = apply_filters( |
|
377 | + 'FHEE__EE_Registry__load_service__service_paths', |
|
378 | + array( |
|
379 | + EE_CORE . 'services' . DS, |
|
380 | + ) |
|
381 | + ); |
|
382 | + // retrieve instantiated class |
|
383 | + return $this->_load($service_paths, 'EE_', $class_name, 'class', $arguments, false, true, $load_only); |
|
384 | + } |
|
385 | + |
|
386 | + |
|
387 | + |
|
388 | + /** |
|
389 | + * loads data_migration_scripts |
|
390 | + * |
|
391 | + * @access public |
|
392 | + * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0 |
|
393 | + * @param mixed $arguments |
|
394 | + * @return EE_Data_Migration_Script_Base|mixed |
|
395 | + */ |
|
396 | + public function load_dms($class_name, $arguments = array()) |
|
397 | + { |
|
398 | + // retrieve instantiated class |
|
399 | + return $this->_load(EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(), 'EE_DMS_', $class_name, 'dms', $arguments, false, false, false); |
|
400 | + } |
|
401 | + |
|
402 | + |
|
403 | + |
|
404 | + /** |
|
405 | + * loads object creating classes - must be singletons |
|
406 | + * |
|
407 | + * @param string $class_name - simple class name ie: attendee |
|
408 | + * @param mixed $arguments - an array of arguments to pass to the class |
|
409 | + * @param bool $from_db - some classes are instantiated from the db and thus call a different method to instantiate |
|
410 | + * @param bool $cache if you don't want the class to be stored in the internal cache (non-persistent) then set this to FALSE (ie. when instantiating model objects from client in a loop) |
|
411 | + * @param bool $load_only whether or not to just load the file and NOT instantiate, or load AND instantiate (default) |
|
412 | + * @return EE_Base_Class | bool |
|
413 | + */ |
|
414 | + public function load_class($class_name, $arguments = array(), $from_db = false, $cache = true, $load_only = false) |
|
415 | + { |
|
416 | + $paths = apply_filters('FHEE__EE_Registry__load_class__paths', array( |
|
417 | + EE_CORE, |
|
418 | + EE_CLASSES, |
|
419 | + EE_BUSINESS, |
|
420 | + )); |
|
421 | + // retrieve instantiated class |
|
422 | + return $this->_load($paths, 'EE_', $class_name, 'class', $arguments, $from_db, $cache, $load_only); |
|
423 | + } |
|
424 | + |
|
425 | + |
|
426 | + |
|
427 | + /** |
|
428 | + * loads helper classes - must be singletons |
|
429 | + * |
|
430 | + * @param string $class_name - simple class name ie: price |
|
431 | + * @param mixed $arguments |
|
432 | + * @param bool $load_only |
|
433 | + * @return EEH_Base | bool |
|
434 | + */ |
|
435 | + public function load_helper($class_name, $arguments = array(), $load_only = true) |
|
436 | + { |
|
437 | + // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed |
|
438 | + $helper_paths = apply_filters('FHEE__EE_Registry__load_helper__helper_paths', array(EE_HELPERS)); |
|
439 | + // retrieve instantiated class |
|
440 | + return $this->_load($helper_paths, 'EEH_', $class_name, 'helper', $arguments, false, true, $load_only); |
|
441 | + } |
|
442 | + |
|
443 | + |
|
444 | + |
|
445 | + /** |
|
446 | + * loads core classes - must be singletons |
|
447 | + * |
|
448 | + * @access public |
|
449 | + * @param string $class_name - simple class name ie: session |
|
450 | + * @param mixed $arguments |
|
451 | + * @param bool $load_only |
|
452 | + * @param bool $cache whether to cache the object or not. |
|
453 | + * @return mixed |
|
454 | + */ |
|
455 | + public function load_lib($class_name, $arguments = array(), $load_only = false, $cache = true) |
|
456 | + { |
|
457 | + $paths = array( |
|
458 | + EE_LIBRARIES, |
|
459 | + EE_LIBRARIES . 'messages' . DS, |
|
460 | + EE_LIBRARIES . 'shortcodes' . DS, |
|
461 | + EE_LIBRARIES . 'qtips' . DS, |
|
462 | + EE_LIBRARIES . 'payment_methods' . DS, |
|
463 | + ); |
|
464 | + // retrieve instantiated class |
|
465 | + return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only); |
|
466 | + } |
|
467 | + |
|
468 | + |
|
469 | + |
|
470 | + /** |
|
471 | + * loads model classes - must be singletons |
|
472 | + * |
|
473 | + * @param string $class_name - simple class name ie: price |
|
474 | + * @param mixed $arguments |
|
475 | + * @param bool $load_only |
|
476 | + * @return EEM_Base | bool |
|
477 | + */ |
|
478 | + public function load_model($class_name, $arguments = array(), $load_only = false) |
|
479 | + { |
|
480 | + $paths = apply_filters('FHEE__EE_Registry__load_model__paths', array( |
|
481 | + EE_MODELS, |
|
482 | + EE_CORE, |
|
483 | + )); |
|
484 | + // retrieve instantiated class |
|
485 | + return $this->_load($paths, 'EEM_', $class_name, 'model', $arguments, false, true, $load_only); |
|
486 | + } |
|
487 | + |
|
488 | + |
|
489 | + |
|
490 | + /** |
|
491 | + * loads model classes - must be singletons |
|
492 | + * |
|
493 | + * @param string $class_name - simple class name ie: price |
|
494 | + * @param mixed $arguments |
|
495 | + * @param bool $load_only |
|
496 | + * @return mixed | bool |
|
497 | + */ |
|
498 | + public function load_model_class($class_name, $arguments = array(), $load_only = true) |
|
499 | + { |
|
500 | + $paths = array( |
|
501 | + EE_MODELS . 'fields' . DS, |
|
502 | + EE_MODELS . 'helpers' . DS, |
|
503 | + EE_MODELS . 'relations' . DS, |
|
504 | + EE_MODELS . 'strategies' . DS, |
|
505 | + ); |
|
506 | + // retrieve instantiated class |
|
507 | + return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only); |
|
508 | + } |
|
509 | + |
|
510 | + |
|
511 | + |
|
512 | + /** |
|
513 | + * Determines if $model_name is the name of an actual EE model. |
|
514 | + * |
|
515 | + * @param string $model_name like Event, Attendee, Question_Group_Question, etc. |
|
516 | + * @return boolean |
|
517 | + */ |
|
518 | + public function is_model_name($model_name) |
|
519 | + { |
|
520 | + return isset($this->models[$model_name]) ? true : false; |
|
521 | + } |
|
522 | + |
|
523 | + |
|
524 | + |
|
525 | + /** |
|
526 | + * generic class loader |
|
527 | + * |
|
528 | + * @param string $path_to_file - directory path to file location, not including filename |
|
529 | + * @param string $file_name - file name ie: my_file.php, including extension |
|
530 | + * @param string $type - file type - core? class? helper? model? |
|
531 | + * @param mixed $arguments |
|
532 | + * @param bool $load_only |
|
533 | + * @return mixed |
|
534 | + */ |
|
535 | + public function load_file($path_to_file, $file_name, $type = '', $arguments = array(), $load_only = true) |
|
536 | + { |
|
537 | + // retrieve instantiated class |
|
538 | + return $this->_load($path_to_file, '', $file_name, $type, $arguments, false, true, $load_only); |
|
539 | + } |
|
540 | + |
|
541 | + |
|
542 | + |
|
543 | + /** |
|
544 | + * load_addon |
|
545 | + * |
|
546 | + * @param string $path_to_file - directory path to file location, not including filename |
|
547 | + * @param string $class_name - full class name ie: My_Class |
|
548 | + * @param string $type - file type - core? class? helper? model? |
|
549 | + * @param mixed $arguments |
|
550 | + * @param bool $load_only |
|
551 | + * @return EE_Addon |
|
552 | + */ |
|
553 | + public function load_addon($path_to_file, $class_name, $type = 'class', $arguments = array(), $load_only = false) |
|
554 | + { |
|
555 | + // retrieve instantiated class |
|
556 | + return $this->_load($path_to_file, 'addon', $class_name, $type, $arguments, false, true, $load_only); |
|
557 | + } |
|
558 | + |
|
559 | + |
|
560 | + |
|
561 | + /** |
|
562 | + * instantiates, caches, and automatically resolves dependencies |
|
563 | + * for classes that use a Fully Qualified Class Name. |
|
564 | + * if the class is not capable of being loaded using PSR-4 autoloading, |
|
565 | + * then you need to use one of the existing load_*() methods |
|
566 | + * which can resolve the classname and filepath from the passed arguments |
|
567 | + * |
|
568 | + * @param bool|string $class_name Fully Qualified Class Name |
|
569 | + * @param array $arguments an argument, or array of arguments to pass to the class upon instantiation |
|
570 | + * @param bool $cache whether to cache the instantiated object for reuse |
|
571 | + * @param bool $from_db some classes are instantiated from the db |
|
572 | + * and thus call a different method to instantiate |
|
573 | + * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
574 | + * @param bool|string $addon if true, will cache the object in the EE_Registry->$addons array |
|
575 | + * @return mixed null = failure to load or instantiate class object. |
|
576 | + * object = class loaded and instantiated successfully. |
|
577 | + * bool = fail or success when $load_only is true |
|
578 | + */ |
|
579 | + public function create( |
|
580 | + $class_name = false, |
|
581 | + $arguments = array(), |
|
582 | + $cache = false, |
|
583 | + $from_db = false, |
|
584 | + $load_only = false, |
|
585 | + $addon = false |
|
586 | + ) { |
|
587 | + $class_name = ltrim($class_name, '\\'); |
|
588 | + $class_name = $this->_dependency_map->get_alias($class_name); |
|
589 | + if ( ! class_exists($class_name)) { |
|
590 | + // maybe the class is registered with a preceding \ |
|
591 | + $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name; |
|
592 | + // still doesn't exist ? |
|
593 | + if ( ! class_exists($class_name)) { |
|
594 | + return null; |
|
595 | + } |
|
596 | + } |
|
597 | + // if we're only loading the class and it already exists, then let's just return true immediately |
|
598 | + if ($load_only) { |
|
599 | + return true; |
|
600 | + } |
|
601 | + $addon = $addon ? 'addon' : ''; |
|
602 | + // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
603 | + // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
604 | + // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
605 | + if ($this->_cache_on && $cache && ! $load_only) { |
|
606 | + // return object if it's already cached |
|
607 | + $cached_class = $this->_get_cached_class($class_name, $addon); |
|
608 | + if ($cached_class !== null) { |
|
609 | + return $cached_class; |
|
610 | + } |
|
611 | + } |
|
612 | + // instantiate the requested object |
|
613 | + $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db); |
|
614 | + if ($this->_cache_on && $cache) { |
|
615 | + // save it for later... kinda like gum { : $ |
|
616 | + $this->_set_cached_class($class_obj, $class_name, $addon, $from_db); |
|
617 | + } |
|
618 | + $this->_cache_on = true; |
|
619 | + return $class_obj; |
|
620 | + } |
|
621 | + |
|
622 | + |
|
623 | + |
|
624 | + /** |
|
625 | + * instantiates, caches, and injects dependencies for classes |
|
626 | + * |
|
627 | + * @param array $file_paths an array of paths to folders to look in |
|
628 | + * @param string $class_prefix EE or EEM or... ??? |
|
629 | + * @param bool|string $class_name $class name |
|
630 | + * @param string $type file type - core? class? helper? model? |
|
631 | + * @param mixed $arguments an argument or array of arguments to pass to the class upon instantiation |
|
632 | + * @param bool $from_db some classes are instantiated from the db |
|
633 | + * and thus call a different method to instantiate |
|
634 | + * @param bool $cache whether to cache the instantiated object for reuse |
|
635 | + * @param bool $load_only if true, will only load the file, but will NOT instantiate an object |
|
636 | + * @return null|object|bool null = failure to load or instantiate class object. |
|
637 | + * object = class loaded and instantiated successfully. |
|
638 | + * bool = fail or success when $load_only is true |
|
639 | + */ |
|
640 | + protected function _load( |
|
641 | + $file_paths = array(), |
|
642 | + $class_prefix = 'EE_', |
|
643 | + $class_name = false, |
|
644 | + $type = 'class', |
|
645 | + $arguments = array(), |
|
646 | + $from_db = false, |
|
647 | + $cache = true, |
|
648 | + $load_only = false |
|
649 | + ) { |
|
650 | + $class_name = ltrim($class_name, '\\'); |
|
651 | + // strip php file extension |
|
652 | + $class_name = str_replace('.php', '', trim($class_name)); |
|
653 | + // does the class have a prefix ? |
|
654 | + if ( ! empty($class_prefix) && $class_prefix != 'addon') { |
|
655 | + // make sure $class_prefix is uppercase |
|
656 | + $class_prefix = strtoupper(trim($class_prefix)); |
|
657 | + // add class prefix ONCE!!! |
|
658 | + $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
659 | + } |
|
660 | + $class_name = $this->_dependency_map->get_alias($class_name); |
|
661 | + $class_exists = class_exists($class_name); |
|
662 | + // if we're only loading the class and it already exists, then let's just return true immediately |
|
663 | + if ($load_only && $class_exists) { |
|
664 | + return true; |
|
665 | + } |
|
666 | + // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection |
|
667 | + // $cache is controlled by individual calls to separate Registry loader methods like load_class() |
|
668 | + // $load_only is also controlled by individual calls to separate Registry loader methods like load_file() |
|
669 | + if ($this->_cache_on && $cache && ! $load_only) { |
|
670 | + // return object if it's already cached |
|
671 | + $cached_class = $this->_get_cached_class($class_name, $class_prefix); |
|
672 | + if ($cached_class !== null) { |
|
673 | + return $cached_class; |
|
674 | + } |
|
675 | + } |
|
676 | + // if the class doesn't already exist.. then we need to try and find the file and load it |
|
677 | + if ( ! $class_exists) { |
|
678 | + // get full path to file |
|
679 | + $path = $this->_resolve_path($class_name, $type, $file_paths); |
|
680 | + // load the file |
|
681 | + $loaded = $this->_require_file($path, $class_name, $type, $file_paths); |
|
682 | + // if loading failed, or we are only loading a file but NOT instantiating an object |
|
683 | + if ( ! $loaded || $load_only) { |
|
684 | + // return boolean if only loading, or null if an object was expected |
|
685 | + return $load_only ? $loaded : null; |
|
686 | + } |
|
687 | + } |
|
688 | + // instantiate the requested object |
|
689 | + $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db); |
|
690 | + if ($this->_cache_on && $cache) { |
|
691 | + // save it for later... kinda like gum { : $ |
|
692 | + $this->_set_cached_class($class_obj, $class_name, $class_prefix, $from_db); |
|
693 | + } |
|
694 | + $this->_cache_on = true; |
|
695 | + return $class_obj; |
|
696 | + } |
|
697 | + |
|
698 | + |
|
699 | + |
|
700 | + |
|
701 | + /** |
|
702 | + * _get_cached_class |
|
703 | + * attempts to find a cached version of the requested class |
|
704 | + * by looking in the following places: |
|
705 | + * $this->{$class_abbreviation} ie: $this->CART |
|
706 | + * $this->{$class_name} ie: $this->Some_Class |
|
707 | + * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
708 | + * $this->addon->{$class_name} ie: $this->addon->Some_Addon_Class |
|
709 | + * |
|
710 | + * @access protected |
|
711 | + * @param string $class_name |
|
712 | + * @param string $class_prefix |
|
713 | + * @return mixed |
|
714 | + */ |
|
715 | + protected function _get_cached_class($class_name, $class_prefix = '') |
|
716 | + { |
|
717 | + // have to specify something, but not anything that will conflict |
|
718 | + $class_abbreviation = isset($this->_class_abbreviations[ $class_name ]) |
|
719 | + ? $this->_class_abbreviations[ $class_name ] |
|
720 | + : 'FANCY_BATMAN_PANTS'; |
|
721 | + $class_name = str_replace('\\', '_', $class_name); |
|
722 | + // check if class has already been loaded, and return it if it has been |
|
723 | + if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) { |
|
724 | + return $this->{$class_abbreviation}; |
|
725 | + } |
|
726 | + if (isset ($this->{$class_name})) { |
|
727 | + return $this->{$class_name}; |
|
728 | + } |
|
729 | + if (isset ($this->LIB->{$class_name})) { |
|
730 | + return $this->LIB->{$class_name}; |
|
731 | + } |
|
732 | + if ($class_prefix === 'addon' && isset ($this->addons->{$class_name})) { |
|
733 | + return $this->addons->{$class_name}; |
|
734 | + } |
|
735 | + return null; |
|
736 | + } |
|
737 | + |
|
738 | + |
|
739 | + |
|
740 | + /** |
|
741 | + * removes a cached version of the requested class |
|
742 | + * |
|
743 | + * @param string $class_name |
|
744 | + * @param boolean $addon |
|
745 | + * @return boolean |
|
746 | + */ |
|
747 | + public function clear_cached_class($class_name, $addon = false) |
|
748 | + { |
|
749 | + // have to specify something, but not anything that will conflict |
|
750 | + $class_abbreviation = isset($this->_class_abbreviations[ $class_name ]) |
|
751 | + ? $this->_class_abbreviations[ $class_name ] |
|
752 | + : 'FANCY_BATMAN_PANTS'; |
|
753 | + $class_name = str_replace('\\', '_', $class_name); |
|
754 | + // check if class has already been loaded, and return it if it has been |
|
755 | + if (isset($this->{$class_abbreviation}) && ! is_null($this->{$class_abbreviation})) { |
|
756 | + $this->{$class_abbreviation} = null; |
|
757 | + return true; |
|
758 | + } |
|
759 | + if (isset($this->{$class_name})) { |
|
760 | + $this->{$class_name} = null; |
|
761 | + return true; |
|
762 | + } |
|
763 | + if (isset($this->LIB->{$class_name})) { |
|
764 | + unset($this->LIB->{$class_name}); |
|
765 | + return true; |
|
766 | + } |
|
767 | + if ($addon && isset($this->addons->{$class_name})) { |
|
768 | + unset($this->addons->{$class_name}); |
|
769 | + return true; |
|
770 | + } |
|
771 | + return false; |
|
772 | + } |
|
773 | + |
|
774 | + |
|
775 | + /** |
|
776 | + * _resolve_path |
|
777 | + * attempts to find a full valid filepath for the requested class. |
|
778 | + * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php" |
|
779 | + * then returns that path if the target file has been found and is readable |
|
780 | + * |
|
781 | + * @access protected |
|
782 | + * @param string $class_name |
|
783 | + * @param string $type |
|
784 | + * @param array $file_paths |
|
785 | + * @return string | bool |
|
786 | + */ |
|
787 | + protected function _resolve_path($class_name, $type = '', $file_paths = array()) |
|
788 | + { |
|
789 | + // make sure $file_paths is an array |
|
790 | + $file_paths = is_array($file_paths) ? $file_paths : array($file_paths); |
|
791 | + // cycle thru paths |
|
792 | + foreach ($file_paths as $key => $file_path) { |
|
793 | + // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
|
794 | + $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES; |
|
795 | + // prep file type |
|
796 | + $type = ! empty($type) ? trim($type, '.') . '.' : ''; |
|
797 | + // build full file path |
|
798 | + $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
799 | + //does the file exist and can be read ? |
|
800 | + if (is_readable($file_paths[$key])) { |
|
801 | + return $file_paths[$key]; |
|
802 | + } |
|
803 | + } |
|
804 | + return false; |
|
805 | + } |
|
806 | + |
|
807 | + |
|
808 | + |
|
809 | + /** |
|
810 | + * _require_file |
|
811 | + * basically just performs a require_once() |
|
812 | + * but with some error handling |
|
813 | + * |
|
814 | + * @access protected |
|
815 | + * @param string $path |
|
816 | + * @param string $class_name |
|
817 | + * @param string $type |
|
818 | + * @param array $file_paths |
|
819 | + * @return boolean |
|
820 | + * @throws \EE_Error |
|
821 | + */ |
|
822 | + protected function _require_file($path, $class_name, $type = '', $file_paths = array()) |
|
823 | + { |
|
824 | + // don't give up! you gotta... |
|
825 | + try { |
|
826 | + //does the file exist and can it be read ? |
|
827 | + if ( ! $path) { |
|
828 | + // so sorry, can't find the file |
|
829 | + throw new EE_Error ( |
|
830 | + sprintf( |
|
831 | + __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'), |
|
832 | + trim($type, '.'), |
|
833 | + $class_name, |
|
834 | + '<br />' . implode(',<br />', $file_paths) |
|
835 | + ) |
|
836 | + ); |
|
837 | + } |
|
838 | + // get the file |
|
839 | + require_once($path); |
|
840 | + // if the class isn't already declared somewhere |
|
841 | + if (class_exists($class_name, false) === false) { |
|
842 | + // so sorry, not a class |
|
843 | + throw new EE_Error( |
|
844 | + sprintf( |
|
845 | + __('The %s file %s does not appear to contain the %s Class.', 'event_espresso'), |
|
846 | + $type, |
|
847 | + $path, |
|
848 | + $class_name |
|
849 | + ) |
|
850 | + ); |
|
851 | + } |
|
852 | + } catch (EE_Error $e) { |
|
853 | + $e->get_error(); |
|
854 | + return false; |
|
855 | + } |
|
856 | + return true; |
|
857 | + } |
|
858 | + |
|
859 | + |
|
860 | + |
|
861 | + /** |
|
862 | + * _create_object |
|
863 | + * Attempts to instantiate the requested class via any of the |
|
864 | + * commonly used instantiation methods employed throughout EE. |
|
865 | + * The priority for instantiation is as follows: |
|
866 | + * - abstract classes or any class flagged as "load only" (no instantiation occurs) |
|
867 | + * - model objects via their 'new_instance_from_db' method |
|
868 | + * - model objects via their 'new_instance' method |
|
869 | + * - "singleton" classes" via their 'instance' method |
|
870 | + * - standard instantiable classes via their __constructor |
|
871 | + * Prior to instantiation, if the classname exists in the dependency_map, |
|
872 | + * then the constructor for the requested class will be examined to determine |
|
873 | + * if any dependencies exist, and if they can be injected. |
|
874 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
875 | + * |
|
876 | + * @access protected |
|
877 | + * @param string $class_name |
|
878 | + * @param array $arguments |
|
879 | + * @param string $type |
|
880 | + * @param bool $from_db |
|
881 | + * @return null | object |
|
882 | + * @throws \EE_Error |
|
883 | + */ |
|
884 | + protected function _create_object($class_name, $arguments = array(), $type = '', $from_db = false) |
|
885 | + { |
|
886 | + $class_obj = null; |
|
887 | + $instantiation_mode = '0) none'; |
|
888 | + // don't give up! you gotta... |
|
889 | + try { |
|
890 | + // create reflection |
|
891 | + $reflector = $this->get_ReflectionClass($class_name); |
|
892 | + // make sure arguments are an array |
|
893 | + $arguments = is_array($arguments) ? $arguments : array($arguments); |
|
894 | + // and if arguments array is numerically and sequentially indexed, then we want it to remain as is, |
|
895 | + // else wrap it in an additional array so that it doesn't get split into multiple parameters |
|
896 | + $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments) |
|
897 | + ? $arguments |
|
898 | + : array($arguments); |
|
899 | + // attempt to inject dependencies ? |
|
900 | + if ($this->_dependency_map->has($class_name)) { |
|
901 | + $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments); |
|
902 | + } |
|
903 | + // instantiate the class if possible |
|
904 | + if ($reflector->isAbstract()) { |
|
905 | + // nothing to instantiate, loading file was enough |
|
906 | + // does not throw an exception so $instantiation_mode is unused |
|
907 | + // $instantiation_mode = "1) no constructor abstract class"; |
|
908 | + $class_obj = true; |
|
909 | + } else if ($reflector->getConstructor() === null && $reflector->isInstantiable() && empty($arguments)) { |
|
910 | + // no constructor = static methods only... nothing to instantiate, loading file was enough |
|
911 | + $instantiation_mode = "2) no constructor but instantiable"; |
|
912 | + $class_obj = $reflector->newInstance(); |
|
913 | + } else if ($from_db && method_exists($class_name, 'new_instance_from_db')) { |
|
914 | + $instantiation_mode = "3) new_instance_from_db()"; |
|
915 | + $class_obj = call_user_func_array(array($class_name, 'new_instance_from_db'), $arguments); |
|
916 | + } else if (method_exists($class_name, 'new_instance')) { |
|
917 | + $instantiation_mode = "4) new_instance()"; |
|
918 | + $class_obj = call_user_func_array(array($class_name, 'new_instance'), $arguments); |
|
919 | + } else if (method_exists($class_name, 'instance')) { |
|
920 | + $instantiation_mode = "5) instance()"; |
|
921 | + $class_obj = call_user_func_array(array($class_name, 'instance'), $arguments); |
|
922 | + } else if ($reflector->isInstantiable()) { |
|
923 | + $instantiation_mode = "6) constructor"; |
|
924 | + $class_obj = $reflector->newInstanceArgs($arguments); |
|
925 | + } else { |
|
926 | + // heh ? something's not right ! |
|
927 | + throw new EE_Error( |
|
928 | + sprintf( |
|
929 | + __('The %s file %s could not be instantiated.', 'event_espresso'), |
|
930 | + $type, |
|
931 | + $class_name |
|
932 | + ) |
|
933 | + ); |
|
934 | + } |
|
935 | + } catch (Exception $e) { |
|
936 | + if ( ! $e instanceof EE_Error) { |
|
937 | + $e = new EE_Error( |
|
938 | + sprintf( |
|
939 | + __('The following error occurred while attempting to instantiate "%1$s": %2$s %3$s %2$s instantiation mode : %4$s', 'event_espresso'), |
|
940 | + $class_name, |
|
941 | + '<br />', |
|
942 | + $e->getMessage(), |
|
943 | + $instantiation_mode |
|
944 | + ) |
|
945 | + ); |
|
946 | + } |
|
947 | + $e->get_error(); |
|
948 | + } |
|
949 | + return $class_obj; |
|
950 | + } |
|
951 | + |
|
952 | + |
|
953 | + |
|
954 | + /** |
|
955 | + * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential |
|
956 | + * @param array $array |
|
957 | + * @return bool |
|
958 | + */ |
|
959 | + protected function _array_is_numerically_and_sequentially_indexed(array $array) |
|
960 | + { |
|
961 | + return ! empty($array) ? array_keys($array) === range(0, count($array) - 1) : true; |
|
962 | + } |
|
963 | + |
|
964 | + |
|
965 | + |
|
966 | + /** |
|
967 | + * getReflectionClass |
|
968 | + * checks if a ReflectionClass object has already been generated for a class |
|
969 | + * and returns that instead of creating a new one |
|
970 | + * |
|
971 | + * @access public |
|
972 | + * @param string $class_name |
|
973 | + * @return ReflectionClass |
|
974 | + */ |
|
975 | + public function get_ReflectionClass($class_name) |
|
976 | + { |
|
977 | + if ( |
|
978 | + ! isset($this->_reflectors[$class_name]) |
|
979 | + || ! $this->_reflectors[$class_name] instanceof ReflectionClass |
|
980 | + ) { |
|
981 | + $this->_reflectors[$class_name] = new ReflectionClass($class_name); |
|
982 | + } |
|
983 | + return $this->_reflectors[$class_name]; |
|
984 | + } |
|
985 | + |
|
986 | + |
|
987 | + |
|
988 | + /** |
|
989 | + * _resolve_dependencies |
|
990 | + * examines the constructor for the requested class to determine |
|
991 | + * if any dependencies exist, and if they can be injected. |
|
992 | + * If so, then those classes will be added to the array of arguments passed to the constructor |
|
993 | + * PLZ NOTE: this is achieved by type hinting the constructor params |
|
994 | + * For example: |
|
995 | + * if attempting to load a class "Foo" with the following constructor: |
|
996 | + * __construct( Bar $bar_class, Fighter $grohl_class ) |
|
997 | + * then $bar_class and $grohl_class will be added to the $arguments array, |
|
998 | + * but only IF they are NOT already present in the incoming arguments array, |
|
999 | + * and the correct classes can be loaded |
|
1000 | + * |
|
1001 | + * @access protected |
|
1002 | + * @param ReflectionClass $reflector |
|
1003 | + * @param string $class_name |
|
1004 | + * @param array $arguments |
|
1005 | + * @return array |
|
1006 | + * @throws \ReflectionException |
|
1007 | + */ |
|
1008 | + protected function _resolve_dependencies(ReflectionClass $reflector, $class_name, $arguments = array()) |
|
1009 | + { |
|
1010 | + // let's examine the constructor |
|
1011 | + $constructor = $reflector->getConstructor(); |
|
1012 | + // whu? huh? nothing? |
|
1013 | + if ( ! $constructor) { |
|
1014 | + return $arguments; |
|
1015 | + } |
|
1016 | + // get constructor parameters |
|
1017 | + $params = $constructor->getParameters(); |
|
1018 | + // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected |
|
1019 | + $argument_keys = array_keys($arguments); |
|
1020 | + // now loop thru all of the constructors expected parameters |
|
1021 | + foreach ($params as $index => $param) { |
|
1022 | + // is this a dependency for a specific class ? |
|
1023 | + $param_class = $param->getClass() ? $param->getClass()->name : null; |
|
1024 | + // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime) |
|
1025 | + $param_class = $this->_dependency_map->has_alias($param_class, $class_name) |
|
1026 | + ? $this->_dependency_map->get_alias($param_class, $class_name) |
|
1027 | + : $param_class; |
|
1028 | + if ( |
|
1029 | + // param is not even a class |
|
1030 | + empty($param_class) |
|
1031 | + // and something already exists in the incoming arguments for this param |
|
1032 | + && isset($argument_keys[$index], $arguments[$argument_keys[$index]]) |
|
1033 | + ) { |
|
1034 | + // so let's skip this argument and move on to the next |
|
1035 | + continue; |
|
1036 | + } |
|
1037 | + if ( |
|
1038 | + // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class |
|
1039 | + ! empty($param_class) |
|
1040 | + && isset($argument_keys[$index], $arguments[$argument_keys[$index]]) |
|
1041 | + && $arguments[$argument_keys[$index]] instanceof $param_class |
|
1042 | + ) { |
|
1043 | + // skip this argument and move on to the next |
|
1044 | + continue; |
|
1045 | + } |
|
1046 | + if ( |
|
1047 | + // parameter is type hinted as a class, and should be injected |
|
1048 | + ! empty($param_class) |
|
1049 | + && $this->_dependency_map->has_dependency_for_class($class_name, $param_class) |
|
1050 | + ) { |
|
1051 | + $arguments = $this->_resolve_dependency($class_name, $param_class, $arguments, $index); |
|
1052 | + } else { |
|
1053 | + try { |
|
1054 | + $arguments[$index] = $param->getDefaultValue(); |
|
1055 | + } catch (ReflectionException $e) { |
|
1056 | + throw new ReflectionException( |
|
1057 | + sprintf( |
|
1058 | + __('%1$s for parameter "$%2$s"', 'event_espresso'), |
|
1059 | + $e->getMessage(), |
|
1060 | + $param->getName() |
|
1061 | + ) |
|
1062 | + ); |
|
1063 | + } |
|
1064 | + } |
|
1065 | + } |
|
1066 | + return $arguments; |
|
1067 | + } |
|
1068 | + |
|
1069 | + |
|
1070 | + |
|
1071 | + /** |
|
1072 | + * @access protected |
|
1073 | + * @param string $class_name |
|
1074 | + * @param string $param_class |
|
1075 | + * @param array $arguments |
|
1076 | + * @param mixed $index |
|
1077 | + * @return array |
|
1078 | + */ |
|
1079 | + protected function _resolve_dependency($class_name, $param_class, $arguments, $index) |
|
1080 | + { |
|
1081 | + $dependency = null; |
|
1082 | + // should dependency be loaded from cache ? |
|
1083 | + $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency($class_name, $param_class) |
|
1084 | + !== EE_Dependency_Map::load_new_object |
|
1085 | + ? true |
|
1086 | + : false; |
|
1087 | + // we might have a dependency... |
|
1088 | + // let's MAYBE try and find it in our cache if that's what's been requested |
|
1089 | + $cached_class = $cache_on ? $this->_get_cached_class($param_class) : null; |
|
1090 | + // and grab it if it exists |
|
1091 | + if ($cached_class instanceof $param_class) { |
|
1092 | + $dependency = $cached_class; |
|
1093 | + } else if ($param_class !== $class_name) { |
|
1094 | + // obtain the loader method from the dependency map |
|
1095 | + $loader = $this->_dependency_map->class_loader($param_class); |
|
1096 | + // is loader a custom closure ? |
|
1097 | + if ($loader instanceof Closure) { |
|
1098 | + $dependency = $loader(); |
|
1099 | + } else { |
|
1100 | + // set the cache on property for the recursive loading call |
|
1101 | + $this->_cache_on = $cache_on; |
|
1102 | + // if not, then let's try and load it via the registry |
|
1103 | + if ($loader && method_exists($this, $loader)) { |
|
1104 | + $dependency = $this->{$loader}($param_class); |
|
1105 | + } else { |
|
1106 | + $dependency = $this->create($param_class, array(), $cache_on); |
|
1107 | + } |
|
1108 | + } |
|
1109 | + } |
|
1110 | + // did we successfully find the correct dependency ? |
|
1111 | + if ($dependency instanceof $param_class) { |
|
1112 | + // then let's inject it into the incoming array of arguments at the correct location |
|
1113 | + if (isset($argument_keys[$index])) { |
|
1114 | + $arguments[$argument_keys[$index]] = $dependency; |
|
1115 | + } else { |
|
1116 | + $arguments[$index] = $dependency; |
|
1117 | + } |
|
1118 | + } |
|
1119 | + return $arguments; |
|
1120 | + } |
|
1121 | + |
|
1122 | + |
|
1123 | + |
|
1124 | + /** |
|
1125 | + * _set_cached_class |
|
1126 | + * attempts to cache the instantiated class locally |
|
1127 | + * in one of the following places, in the following order: |
|
1128 | + * $this->{class_abbreviation} ie: $this->CART |
|
1129 | + * $this->{$class_name} ie: $this->Some_Class |
|
1130 | + * $this->addon->{$$class_name} ie: $this->addon->Some_Addon_Class |
|
1131 | + * $this->LIB->{$class_name} ie: $this->LIB->Some_Class |
|
1132 | + * |
|
1133 | + * @access protected |
|
1134 | + * @param object $class_obj |
|
1135 | + * @param string $class_name |
|
1136 | + * @param string $class_prefix |
|
1137 | + * @param bool $from_db |
|
1138 | + * @return void |
|
1139 | + */ |
|
1140 | + protected function _set_cached_class($class_obj, $class_name, $class_prefix = '', $from_db = false) |
|
1141 | + { |
|
1142 | + if (empty($class_obj)) { |
|
1143 | + return; |
|
1144 | + } |
|
1145 | + // return newly instantiated class |
|
1146 | + if (isset($this->_class_abbreviations[$class_name])) { |
|
1147 | + $class_abbreviation = $this->_class_abbreviations[$class_name]; |
|
1148 | + $this->{$class_abbreviation} = $class_obj; |
|
1149 | + return; |
|
1150 | + } |
|
1151 | + $class_name = str_replace('\\', '_', $class_name); |
|
1152 | + if (property_exists($this, $class_name)) { |
|
1153 | + $this->{$class_name} = $class_obj; |
|
1154 | + return; |
|
1155 | + } |
|
1156 | + if ($class_prefix === 'addon') { |
|
1157 | + $this->addons->{$class_name} = $class_obj; |
|
1158 | + return; |
|
1159 | + } |
|
1160 | + if ( ! $from_db) { |
|
1161 | + $this->LIB->{$class_name} = $class_obj; |
|
1162 | + } |
|
1163 | + } |
|
1164 | + |
|
1165 | + |
|
1166 | + |
|
1167 | + /** |
|
1168 | + * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array |
|
1169 | + * |
|
1170 | + * @param string $classname PLEASE NOTE: the class name needs to match what's registered |
|
1171 | + * in the EE_Dependency_Map::$_class_loaders array, |
|
1172 | + * including the class prefix, ie: "EE_", "EEM_", "EEH_", etc |
|
1173 | + * @param array $arguments |
|
1174 | + * @return object |
|
1175 | + */ |
|
1176 | + public static function factory($classname, $arguments = array()) |
|
1177 | + { |
|
1178 | + $loader = self::instance()->_dependency_map->class_loader($classname); |
|
1179 | + if ($loader instanceof Closure) { |
|
1180 | + return $loader($arguments); |
|
1181 | + } |
|
1182 | + if (method_exists(EE_Registry::instance(), $loader)) { |
|
1183 | + return EE_Registry::instance()->{$loader}($classname, $arguments); |
|
1184 | + } |
|
1185 | + return null; |
|
1186 | + } |
|
1187 | + |
|
1188 | + |
|
1189 | + |
|
1190 | + /** |
|
1191 | + * Gets the addon by its name/slug (not classname. For that, just |
|
1192 | + * use the classname as the property name on EE_Config::instance()->addons) |
|
1193 | + * |
|
1194 | + * @param string $name |
|
1195 | + * @return EE_Addon |
|
1196 | + */ |
|
1197 | + public function get_addon_by_name($name) |
|
1198 | + { |
|
1199 | + foreach ($this->addons as $addon) { |
|
1200 | + if ($addon->name() == $name) { |
|
1201 | + return $addon; |
|
1202 | + } |
|
1203 | + } |
|
1204 | + return null; |
|
1205 | + } |
|
1206 | + |
|
1207 | + |
|
1208 | + |
|
1209 | + /** |
|
1210 | + * Gets an array of all the registered addons, where the keys are their names. (ie, what each returns for their name() function) They're already available on EE_Config::instance()->addons as properties, where each property's name is |
|
1211 | + * the addon's classname. So if you just want to get the addon by classname, use EE_Config::instance()->addons->{classname} |
|
1212 | + * |
|
1213 | + * @return EE_Addon[] where the KEYS are the addon's name() |
|
1214 | + */ |
|
1215 | + public function get_addons_by_name() |
|
1216 | + { |
|
1217 | + $addons = array(); |
|
1218 | + foreach ($this->addons as $addon) { |
|
1219 | + $addons[$addon->name()] = $addon; |
|
1220 | + } |
|
1221 | + return $addons; |
|
1222 | + } |
|
1223 | + |
|
1224 | + |
|
1225 | + |
|
1226 | + /** |
|
1227 | + * Resets the specified model's instance AND makes sure EE_Registry doesn't keep |
|
1228 | + * a stale copy of it around |
|
1229 | + * |
|
1230 | + * @param string $model_name |
|
1231 | + * @return \EEM_Base |
|
1232 | + * @throws \EE_Error |
|
1233 | + */ |
|
1234 | + public function reset_model($model_name) |
|
1235 | + { |
|
1236 | + $model_class_name = strpos($model_name, 'EEM_') !== 0 ? "EEM_{$model_name}" : $model_name; |
|
1237 | + if ( ! isset($this->LIB->{$model_class_name}) || ! $this->LIB->{$model_class_name} instanceof EEM_Base) { |
|
1238 | + return null; |
|
1239 | + } |
|
1240 | + //get that model reset it and make sure we nuke the old reference to it |
|
1241 | + if ($this->LIB->{$model_class_name} instanceof $model_class_name && is_callable(array($model_class_name, 'reset'))) { |
|
1242 | + $this->LIB->{$model_class_name} = $this->LIB->{$model_class_name}->reset(); |
|
1243 | + } else { |
|
1244 | + throw new EE_Error(sprintf(__('Model %s does not have a method "reset"', 'event_espresso'), $model_name)); |
|
1245 | + } |
|
1246 | + return $this->LIB->{$model_class_name}; |
|
1247 | + } |
|
1248 | + |
|
1249 | + |
|
1250 | + |
|
1251 | + /** |
|
1252 | + * Resets the registry. |
|
1253 | + * The criteria for what gets reset is based on what can be shared between sites on the same request when switch_to_blog |
|
1254 | + * is used in a multisite install. Here is a list of things that are NOT reset. |
|
1255 | + * - $_dependency_map |
|
1256 | + * - $_class_abbreviations |
|
1257 | + * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset. |
|
1258 | + * - $REQ: Still on the same request so no need to change. |
|
1259 | + * - $CAP: There is no site specific state in the EE_Capability class. |
|
1260 | + * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only one Session |
|
1261 | + * can be active in a single request. Resetting could resolve in "headers already sent" errors. |
|
1262 | + * - $addons: In multisite, the state of the addons is something controlled via hooks etc in a normal request. So |
|
1263 | + * for now, we won't reset the addons because it could break calls to an add-ons class/methods in the |
|
1264 | + * switch or on the restore. |
|
1265 | + * - $modules |
|
1266 | + * - $shortcodes |
|
1267 | + * - $widgets |
|
1268 | + * |
|
1269 | + * @param boolean $hard whether to reset data in the database too, or just refresh |
|
1270 | + * the Registry to its state at the beginning of the request |
|
1271 | + * @param boolean $reinstantiate whether to create new instances of EE_Registry's singletons too, |
|
1272 | + * or just reset without re-instantiating (handy to set to FALSE if you're not sure if you CAN |
|
1273 | + * currently reinstantiate the singletons at the moment) |
|
1274 | + * @param bool $reset_models Defaults to true. When false, then the models are not reset. This is so client |
|
1275 | + * code instead can just change the model context to a different blog id if necessary |
|
1276 | + * @return EE_Registry |
|
1277 | + */ |
|
1278 | + public static function reset($hard = false, $reinstantiate = true, $reset_models = true) |
|
1279 | + { |
|
1280 | + $instance = self::instance(); |
|
1281 | + EEH_Activation::reset(); |
|
1282 | + //properties that get reset |
|
1283 | + $instance->_cache_on = true; |
|
1284 | + $instance->CFG = EE_Config::reset($hard, $reinstantiate); |
|
1285 | + $instance->CART = null; |
|
1286 | + $instance->MRM = null; |
|
1287 | + $instance->AssetsRegistry = null; |
|
1288 | + $instance->AssetsRegistry = $instance->create('EventEspresso\core\services\assets\Registry'); |
|
1289 | + //messages reset |
|
1290 | + EED_Messages::reset(); |
|
1291 | + if ($reset_models) { |
|
1292 | + foreach (array_keys($instance->non_abstract_db_models) as $model_name) { |
|
1293 | + $instance->reset_model($model_name); |
|
1294 | + } |
|
1295 | + } |
|
1296 | + $instance->LIB = new stdClass(); |
|
1297 | + return $instance; |
|
1298 | + } |
|
1299 | + |
|
1300 | + |
|
1301 | + |
|
1302 | + /** |
|
1303 | + * @override magic methods |
|
1304 | + * @return void |
|
1305 | + */ |
|
1306 | + public final function __destruct() |
|
1307 | + { |
|
1308 | + } |
|
1309 | + |
|
1310 | + |
|
1311 | + |
|
1312 | + /** |
|
1313 | + * @param $a |
|
1314 | + * @param $b |
|
1315 | + */ |
|
1316 | + public final function __call($a, $b) |
|
1317 | + { |
|
1318 | + } |
|
1319 | + |
|
1320 | + |
|
1321 | + |
|
1322 | + /** |
|
1323 | + * @param $a |
|
1324 | + */ |
|
1325 | + public final function __get($a) |
|
1326 | + { |
|
1327 | + } |
|
1328 | + |
|
1329 | + |
|
1330 | + |
|
1331 | + /** |
|
1332 | + * @param $a |
|
1333 | + * @param $b |
|
1334 | + */ |
|
1335 | + public final function __set($a, $b) |
|
1336 | + { |
|
1337 | + } |
|
1338 | + |
|
1339 | + |
|
1340 | + |
|
1341 | + /** |
|
1342 | + * @param $a |
|
1343 | + */ |
|
1344 | + public final function __isset($a) |
|
1345 | + { |
|
1346 | + } |
|
1347 | 1347 | |
1348 | 1348 | |
1349 | 1349 | |
1350 | - /** |
|
1351 | - * @param $a |
|
1352 | - */ |
|
1353 | - public final function __unset($a) |
|
1354 | - { |
|
1355 | - } |
|
1350 | + /** |
|
1351 | + * @param $a |
|
1352 | + */ |
|
1353 | + public final function __unset($a) |
|
1354 | + { |
|
1355 | + } |
|
1356 | 1356 | |
1357 | 1357 | |
1358 | 1358 | |
1359 | - /** |
|
1360 | - * @return array |
|
1361 | - */ |
|
1362 | - public final function __sleep() |
|
1363 | - { |
|
1364 | - return array(); |
|
1365 | - } |
|
1359 | + /** |
|
1360 | + * @return array |
|
1361 | + */ |
|
1362 | + public final function __sleep() |
|
1363 | + { |
|
1364 | + return array(); |
|
1365 | + } |
|
1366 | 1366 | |
1367 | 1367 | |
1368 | 1368 | |
1369 | - public final function __wakeup() |
|
1370 | - { |
|
1371 | - } |
|
1369 | + public final function __wakeup() |
|
1370 | + { |
|
1371 | + } |
|
1372 | 1372 | |
1373 | 1373 | |
1374 | 1374 | |
1375 | - /** |
|
1376 | - * @return string |
|
1377 | - */ |
|
1378 | - public final function __toString() |
|
1379 | - { |
|
1380 | - return ''; |
|
1381 | - } |
|
1375 | + /** |
|
1376 | + * @return string |
|
1377 | + */ |
|
1378 | + public final function __toString() |
|
1379 | + { |
|
1380 | + return ''; |
|
1381 | + } |
|
1382 | 1382 | |
1383 | 1383 | |
1384 | 1384 | |
1385 | - public final function __invoke() |
|
1386 | - { |
|
1387 | - } |
|
1385 | + public final function __invoke() |
|
1386 | + { |
|
1387 | + } |
|
1388 | 1388 | |
1389 | 1389 | |
1390 | 1390 | |
1391 | - public final static function __set_state($array = array()) |
|
1392 | - { |
|
1393 | - return EE_Registry::instance(); |
|
1394 | - } |
|
1391 | + public final static function __set_state($array = array()) |
|
1392 | + { |
|
1393 | + return EE_Registry::instance(); |
|
1394 | + } |
|
1395 | 1395 | |
1396 | 1396 | |
1397 | 1397 | |
1398 | - public final function __clone() |
|
1399 | - { |
|
1400 | - } |
|
1398 | + public final function __clone() |
|
1399 | + { |
|
1400 | + } |
|
1401 | 1401 | |
1402 | 1402 | |
1403 | 1403 | |
1404 | - /** |
|
1405 | - * @param $a |
|
1406 | - * @param $b |
|
1407 | - */ |
|
1408 | - public final static function __callStatic($a, $b) |
|
1409 | - { |
|
1410 | - } |
|
1404 | + /** |
|
1405 | + * @param $a |
|
1406 | + * @param $b |
|
1407 | + */ |
|
1408 | + public final static function __callStatic($a, $b) |
|
1409 | + { |
|
1410 | + } |
|
1411 | 1411 | |
1412 | 1412 | |
1413 | 1413 | |
1414 | - /** |
|
1415 | - * Gets all the custom post type models defined |
|
1416 | - * |
|
1417 | - * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
|
1418 | - */ |
|
1419 | - public function cpt_models() |
|
1420 | - { |
|
1421 | - $cpt_models = array(); |
|
1422 | - foreach ($this->non_abstract_db_models as $short_name => $classname) { |
|
1423 | - if (is_subclass_of($classname, 'EEM_CPT_Base')) { |
|
1424 | - $cpt_models[$short_name] = $classname; |
|
1425 | - } |
|
1426 | - } |
|
1427 | - return $cpt_models; |
|
1428 | - } |
|
1414 | + /** |
|
1415 | + * Gets all the custom post type models defined |
|
1416 | + * |
|
1417 | + * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event") |
|
1418 | + */ |
|
1419 | + public function cpt_models() |
|
1420 | + { |
|
1421 | + $cpt_models = array(); |
|
1422 | + foreach ($this->non_abstract_db_models as $short_name => $classname) { |
|
1423 | + if (is_subclass_of($classname, 'EEM_CPT_Base')) { |
|
1424 | + $cpt_models[$short_name] = $classname; |
|
1425 | + } |
|
1426 | + } |
|
1427 | + return $cpt_models; |
|
1428 | + } |
|
1429 | 1429 | |
1430 | 1430 | |
1431 | 1431 | |
1432 | - /** |
|
1433 | - * @return \EE_Config |
|
1434 | - */ |
|
1435 | - public static function CFG() |
|
1436 | - { |
|
1437 | - return self::instance()->CFG; |
|
1438 | - } |
|
1432 | + /** |
|
1433 | + * @return \EE_Config |
|
1434 | + */ |
|
1435 | + public static function CFG() |
|
1436 | + { |
|
1437 | + return self::instance()->CFG; |
|
1438 | + } |
|
1439 | 1439 | |
1440 | 1440 | |
1441 | 1441 | } |
@@ -294,13 +294,13 @@ discard block |
||
294 | 294 | */ |
295 | 295 | public static function localize_i18n_js_strings() |
296 | 296 | { |
297 | - $i18n_js_strings = (array)EE_Registry::$i18n_js_strings; |
|
297 | + $i18n_js_strings = (array) EE_Registry::$i18n_js_strings; |
|
298 | 298 | foreach ($i18n_js_strings as $key => $value) { |
299 | 299 | if (is_scalar($value)) { |
300 | - $i18n_js_strings[$key] = html_entity_decode((string)$value, ENT_QUOTES, 'UTF-8'); |
|
300 | + $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8'); |
|
301 | 301 | } |
302 | 302 | } |
303 | - return "/* <![CDATA[ */ var eei18n = " . wp_json_encode($i18n_js_strings) . '; /* ]]> */'; |
|
303 | + return "/* <![CDATA[ */ var eei18n = ".wp_json_encode($i18n_js_strings).'; /* ]]> */'; |
|
304 | 304 | } |
305 | 305 | |
306 | 306 | |
@@ -351,9 +351,9 @@ discard block |
||
351 | 351 | EE_CORE, |
352 | 352 | EE_ADMIN, |
353 | 353 | EE_CPTS, |
354 | - EE_CORE . 'data_migration_scripts' . DS, |
|
355 | - EE_CORE . 'request_stack' . DS, |
|
356 | - EE_CORE . 'middleware' . DS, |
|
354 | + EE_CORE.'data_migration_scripts'.DS, |
|
355 | + EE_CORE.'request_stack'.DS, |
|
356 | + EE_CORE.'middleware'.DS, |
|
357 | 357 | ) |
358 | 358 | ); |
359 | 359 | // retrieve instantiated class |
@@ -376,7 +376,7 @@ discard block |
||
376 | 376 | $service_paths = apply_filters( |
377 | 377 | 'FHEE__EE_Registry__load_service__service_paths', |
378 | 378 | array( |
379 | - EE_CORE . 'services' . DS, |
|
379 | + EE_CORE.'services'.DS, |
|
380 | 380 | ) |
381 | 381 | ); |
382 | 382 | // retrieve instantiated class |
@@ -456,10 +456,10 @@ discard block |
||
456 | 456 | { |
457 | 457 | $paths = array( |
458 | 458 | EE_LIBRARIES, |
459 | - EE_LIBRARIES . 'messages' . DS, |
|
460 | - EE_LIBRARIES . 'shortcodes' . DS, |
|
461 | - EE_LIBRARIES . 'qtips' . DS, |
|
462 | - EE_LIBRARIES . 'payment_methods' . DS, |
|
459 | + EE_LIBRARIES.'messages'.DS, |
|
460 | + EE_LIBRARIES.'shortcodes'.DS, |
|
461 | + EE_LIBRARIES.'qtips'.DS, |
|
462 | + EE_LIBRARIES.'payment_methods'.DS, |
|
463 | 463 | ); |
464 | 464 | // retrieve instantiated class |
465 | 465 | return $this->_load($paths, 'EE_', $class_name, 'lib', $arguments, false, $cache, $load_only); |
@@ -498,10 +498,10 @@ discard block |
||
498 | 498 | public function load_model_class($class_name, $arguments = array(), $load_only = true) |
499 | 499 | { |
500 | 500 | $paths = array( |
501 | - EE_MODELS . 'fields' . DS, |
|
502 | - EE_MODELS . 'helpers' . DS, |
|
503 | - EE_MODELS . 'relations' . DS, |
|
504 | - EE_MODELS . 'strategies' . DS, |
|
501 | + EE_MODELS.'fields'.DS, |
|
502 | + EE_MODELS.'helpers'.DS, |
|
503 | + EE_MODELS.'relations'.DS, |
|
504 | + EE_MODELS.'strategies'.DS, |
|
505 | 505 | ); |
506 | 506 | // retrieve instantiated class |
507 | 507 | return $this->_load($paths, 'EE_', $class_name, '', $arguments, false, true, $load_only); |
@@ -588,7 +588,7 @@ discard block |
||
588 | 588 | $class_name = $this->_dependency_map->get_alias($class_name); |
589 | 589 | if ( ! class_exists($class_name)) { |
590 | 590 | // maybe the class is registered with a preceding \ |
591 | - $class_name = strpos($class_name, '\\') !== 0 ? '\\' . $class_name : $class_name; |
|
591 | + $class_name = strpos($class_name, '\\') !== 0 ? '\\'.$class_name : $class_name; |
|
592 | 592 | // still doesn't exist ? |
593 | 593 | if ( ! class_exists($class_name)) { |
594 | 594 | return null; |
@@ -655,7 +655,7 @@ discard block |
||
655 | 655 | // make sure $class_prefix is uppercase |
656 | 656 | $class_prefix = strtoupper(trim($class_prefix)); |
657 | 657 | // add class prefix ONCE!!! |
658 | - $class_name = $class_prefix . str_replace($class_prefix, '', $class_name); |
|
658 | + $class_name = $class_prefix.str_replace($class_prefix, '', $class_name); |
|
659 | 659 | } |
660 | 660 | $class_name = $this->_dependency_map->get_alias($class_name); |
661 | 661 | $class_exists = class_exists($class_name); |
@@ -715,8 +715,8 @@ discard block |
||
715 | 715 | protected function _get_cached_class($class_name, $class_prefix = '') |
716 | 716 | { |
717 | 717 | // have to specify something, but not anything that will conflict |
718 | - $class_abbreviation = isset($this->_class_abbreviations[ $class_name ]) |
|
719 | - ? $this->_class_abbreviations[ $class_name ] |
|
718 | + $class_abbreviation = isset($this->_class_abbreviations[$class_name]) |
|
719 | + ? $this->_class_abbreviations[$class_name] |
|
720 | 720 | : 'FANCY_BATMAN_PANTS'; |
721 | 721 | $class_name = str_replace('\\', '_', $class_name); |
722 | 722 | // check if class has already been loaded, and return it if it has been |
@@ -747,8 +747,8 @@ discard block |
||
747 | 747 | public function clear_cached_class($class_name, $addon = false) |
748 | 748 | { |
749 | 749 | // have to specify something, but not anything that will conflict |
750 | - $class_abbreviation = isset($this->_class_abbreviations[ $class_name ]) |
|
751 | - ? $this->_class_abbreviations[ $class_name ] |
|
750 | + $class_abbreviation = isset($this->_class_abbreviations[$class_name]) |
|
751 | + ? $this->_class_abbreviations[$class_name] |
|
752 | 752 | : 'FANCY_BATMAN_PANTS'; |
753 | 753 | $class_name = str_replace('\\', '_', $class_name); |
754 | 754 | // check if class has already been loaded, and return it if it has been |
@@ -793,9 +793,9 @@ discard block |
||
793 | 793 | // convert all separators to proper DS, if no filepath, then use EE_CLASSES |
794 | 794 | $file_path = $file_path ? str_replace(array('/', '\\'), DS, $file_path) : EE_CLASSES; |
795 | 795 | // prep file type |
796 | - $type = ! empty($type) ? trim($type, '.') . '.' : ''; |
|
796 | + $type = ! empty($type) ? trim($type, '.').'.' : ''; |
|
797 | 797 | // build full file path |
798 | - $file_paths[$key] = rtrim($file_path, DS) . DS . $class_name . '.' . $type . 'php'; |
|
798 | + $file_paths[$key] = rtrim($file_path, DS).DS.$class_name.'.'.$type.'php'; |
|
799 | 799 | //does the file exist and can be read ? |
800 | 800 | if (is_readable($file_paths[$key])) { |
801 | 801 | return $file_paths[$key]; |
@@ -826,12 +826,12 @@ discard block |
||
826 | 826 | //does the file exist and can it be read ? |
827 | 827 | if ( ! $path) { |
828 | 828 | // so sorry, can't find the file |
829 | - throw new EE_Error ( |
|
829 | + throw new EE_Error( |
|
830 | 830 | sprintf( |
831 | 831 | __('The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s', 'event_espresso'), |
832 | 832 | trim($type, '.'), |
833 | 833 | $class_name, |
834 | - '<br />' . implode(',<br />', $file_paths) |
|
834 | + '<br />'.implode(',<br />', $file_paths) |
|
835 | 835 | ) |
836 | 836 | ); |
837 | 837 | } |
@@ -6,24 +6,33 @@ discard block |
||
6 | 6 | <?php if ( $disabled ) : ?> |
7 | 7 | <input type="hidden" id="edit-ticket-TKT_start_date-<?php echo $tkt_row; ?>" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp" value="<?php echo $TKT_start_date; ?>" > |
8 | 8 | <input type="text" name="archived_ticket[TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp" value="<?php echo $TKT_start_date; ?>" disabled> |
9 | - <?php else : ?> |
|
10 | - <input id="edit-ticket-TKT_start_date-<?php echo $tkt_row; ?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp ee-datepicker" value="<?php echo $TKT_start_date; ?>" data-context="start-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_end_date" data-next-field=".edit-ticket-TKT_end_date"> |
|
9 | + <?php else { |
|
10 | + : ?> |
|
11 | + <input id="edit-ticket-TKT_start_date-<?php echo $tkt_row; |
|
12 | +} |
|
13 | +?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_start_date]" class="edit-ticket-TKT_start_date ee-text-inp ee-datepicker" value="<?php echo $TKT_start_date; ?>" data-context="start-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_end_date" data-next-field=".edit-ticket-TKT_end_date"> |
|
11 | 14 | <?php endif; ?> |
12 | 15 | </td> |
13 | 16 | <td> |
14 | 17 | <?php if ( $disabled ) : ?> |
15 | 18 | <input type="hidden" id="edit-ticket-TKT_end_date-<?php echo $tkt_row; ?>" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp" value="<?php echo $TKT_end_date; ?>" > |
16 | 19 | <input type="text" name="archived_ticket[TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp" value="<?php echo $TKT_end_date; ?>" disabled> |
17 | - <?php else : ?> |
|
18 | - <input id="edit-ticket-TKT_end_date-<?php echo $tkt_row; ?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp ee-datepicker" value="<?php echo $TKT_end_date; ?>" data-context="end-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_start_date" data-next-field=".edit-ticket-TKT_qty"> |
|
20 | + <?php else { |
|
21 | + : ?> |
|
22 | + <input id="edit-ticket-TKT_end_date-<?php echo $tkt_row; |
|
23 | +} |
|
24 | +?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_end_date]" class="edit-ticket-TKT_end_date ee-text-inp ee-datepicker" value="<?php echo $TKT_end_date; ?>" data-context="end-ticket" data-date-field-context="#display-ticketrow-<?php echo $tkt_row; ?>" data-related-field=".edit-ticket-TKT_start_date" data-next-field=".edit-ticket-TKT_qty"> |
|
19 | 25 | <?php endif; ?> |
20 | 26 | </td> |
21 | 27 | <td> |
22 | 28 | <?php if ( $disabled ) : ?> |
23 | 29 | <input id="edit-ticket-TKT_base_price-<?php echo $tkt_row; ?>" type="hidden" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>"> |
24 | 30 | <input type="text" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>" disabled> |
25 | - <?php else : ?> |
|
26 | - <input id="edit-ticket-TKT_base_price-<?php echo $tkt_row; ?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>"> |
|
31 | + <?php else { |
|
32 | + : ?> |
|
33 | + <input id="edit-ticket-TKT_base_price-<?php echo $tkt_row; |
|
34 | +} |
|
35 | +?>" type="text" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price]" class="edit-ticket-TKT_base_price ee-small-text-inp edit-price-PRC_amount ee-numeric" value="<?php echo $TKT_base_price; ?>"> |
|
27 | 36 | <?php endif; ?> |
28 | 37 | <input type="hidden" id="edit-ticket-TKT_base_price_ID-<?php echo $tkt_row; ?>" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_base_price_ID]" value="<?php echo $TKT_base_price_ID; ?>"> |
29 | 38 | </td> |
@@ -31,8 +40,11 @@ discard block |
||
31 | 40 | <?php if ( $disabled ) : ?> |
32 | 41 | <input type="hidden" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>"> |
33 | 42 | <input type="text" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>" disabled> |
34 | - <?php else : ?> |
|
35 | - <input type="text" id="edit-ticket-TKT_qty-<?php echo $tkt_row; ?>" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>"> |
|
43 | + <?php else { |
|
44 | + : ?> |
|
45 | + <input type="text" id="edit-ticket-TKT_qty-<?php echo $tkt_row; |
|
46 | +} |
|
47 | +?>" class="edit-ticket-TKT_qty ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_qty]" value="<?php echo $TKT_qty_for_input; ?>"> |
|
36 | 48 | <?php endif; ?> |
37 | 49 | </td> |
38 | 50 | <!--<td><span class="ticket-display-row-TKT_price"><?php //echo $TKT_price; ?></span></td>--> |
@@ -78,24 +90,33 @@ discard block |
||
78 | 90 | <?php if ( $disabled ) : ?> |
79 | 91 | <input type="hidden" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>"> |
80 | 92 | <input type="text" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>" disabled> |
81 | - <?php else : ?> |
|
82 | - <input type="text" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>"> |
|
93 | + <?php else { |
|
94 | + : ?> |
|
95 | + <input type="text" class="edit-ticket-TKT_uses ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; |
|
96 | +} |
|
97 | +?>[<?php echo $tkt_row; ?>][TKT_uses]" value="<?php echo $TKT_uses; ?>"> |
|
83 | 98 | <?php endif; ?> |
84 | 99 | </td> |
85 | 100 | <td> |
86 | 101 | <?php if ( $disabled ) : ?> |
87 | 102 | <input type="hidden" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>"> |
88 | 103 | <input type="text" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>" disabled> |
89 | - <?php else: ?> |
|
90 | - <input type="text" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>"> |
|
104 | + <?php else { |
|
105 | + : ?> |
|
106 | + <input type="text" class="edit-ticket-TKT_min ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; |
|
107 | +} |
|
108 | +?>[<?php echo $tkt_row; ?>][TKT_min]" value="<?php echo $TKT_min; ?>"> |
|
91 | 109 | <?php endif; ?> |
92 | 110 | </td> |
93 | 111 | <td> |
94 | 112 | <?php if ( $disabled ) : ?> |
95 | 113 | <input type="hidden" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>"> |
96 | 114 | <input type="text" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>" disabled> |
97 | - <?php else : ?> |
|
98 | - <input type="text" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; ?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>"> |
|
115 | + <?php else { |
|
116 | + : ?> |
|
117 | + <input type="text" class="edit-ticket-TKT_max ee-small-text-inp ee-numeric" name="<?php echo $edit_tickets_name; |
|
118 | +} |
|
119 | +?>[<?php echo $tkt_row; ?>][TKT_max]" value="<?php echo $TKT_max; ?>"> |
|
99 | 120 | <?php endif; ?> |
100 | 121 | </td> |
101 | 122 | </tr> |
@@ -116,8 +137,11 @@ discard block |
||
116 | 137 | ?> |
117 | 138 | <input class="TKT-taxable-checkbox" type="hidden" name="<?php echo $edit_tickets_name;?>[<?php echo $tkt_row; ?>][TKT_taxable]" value="<?php echo $tax_value; ?>"> |
118 | 139 | <input class="TKT-taxable-checkbox" id="edit-ticket-TKT_taxable-<?php echo $tkt_row; ?>" type="checkbox" name="archived_ticket[<?php echo $tkt_row; ?>][TKT_taxable]" value="1"<?php echo $TKT_taxable; ?> disabled> |
119 | - <?php else : ?> |
|
120 | - <input class="TKT-taxable-checkbox" id="edit-ticket-TKT_taxable-<?php echo $tkt_row; ?>" type="checkbox" name="<?php echo $edit_tickets_name;?>[<?php echo $tkt_row; ?>][TKT_taxable]" value="1"<?php echo $TKT_taxable; ?>> |
|
140 | + <?php else { |
|
141 | + : ?> |
|
142 | + <input class="TKT-taxable-checkbox" id="edit-ticket-TKT_taxable-<?php echo $tkt_row; |
|
143 | +} |
|
144 | +?>" type="checkbox" name="<?php echo $edit_tickets_name;?>[<?php echo $tkt_row; ?>][TKT_taxable]" value="1"<?php echo $TKT_taxable; ?>> |
|
121 | 145 | <?php endif; ?> |
122 | 146 | <label for="edit-ticket-TKT_taxable-<?php echo $tkt_row; ?>"> <?php esc_html_e('This ticket is taxable.', 'event_espresso'); ?> |
123 | 147 | <?php } //end tax_rows check ?> |
@@ -120,7 +120,7 @@ |
||
120 | 120 | |
121 | 121 | /** |
122 | 122 | * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor. |
123 | - * @param $field_name |
|
123 | + * @param string $field_name |
|
124 | 124 | * @param int $row_number |
125 | 125 | * @return string |
126 | 126 | */ |
@@ -14,181 +14,181 @@ |
||
14 | 14 | class EventsAdmin extends CoreAdmin |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * Selector for the Add new Event button in the admin. |
|
19 | - * @var string |
|
20 | - */ |
|
21 | - const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event'; |
|
22 | - |
|
23 | - |
|
24 | - /** |
|
25 | - * Selector for the Event Title field in the event editor |
|
26 | - * @var string |
|
27 | - */ |
|
28 | - const EVENT_EDITOR_TITLE_FIELD_SELECTOR = "//input[@id='title']"; |
|
29 | - |
|
30 | - /** |
|
31 | - * Selector for the publish submit button in the event editor. |
|
32 | - * @var string |
|
33 | - */ |
|
34 | - const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = "#publish"; |
|
35 | - |
|
36 | - |
|
37 | - /** |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status'; |
|
41 | - |
|
42 | - /** |
|
43 | - * Selector for the view link after publishing an event. |
|
44 | - * @var string |
|
45 | - */ |
|
46 | - const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//div[@id='message']/p/a"; |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * Selector for the ID of the event in the event editor |
|
51 | - * @var string |
|
52 | - */ |
|
53 | - const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']"; |
|
54 | - |
|
55 | - |
|
56 | - /** |
|
57 | - * Selector for the search input on the event list table page. |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input'; |
|
61 | - |
|
62 | - |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * @param string $additional_params |
|
67 | - * @return string |
|
68 | - */ |
|
69 | - public static function defaultEventsListTableUrl($additional_params = '') |
|
70 | - { |
|
71 | - return self::adminUrl('espresso_events', 'default', $additional_params); |
|
72 | - } |
|
73 | - |
|
74 | - |
|
75 | - /** |
|
76 | - * The selector for the DTTname field for the given row in the event editor. |
|
77 | - * @param int $row_number |
|
78 | - * @return string |
|
79 | - */ |
|
80 | - public static function eventEditorDatetimeNameFieldSelector($row_number = 1) |
|
81 | - { |
|
82 | - return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number); |
|
83 | - } |
|
84 | - |
|
85 | - |
|
86 | - /** |
|
87 | - * The selector for the DTT_EVT_start field for the given row in the event editor.d |
|
88 | - * @param int $row_number |
|
89 | - * @return string |
|
90 | - */ |
|
91 | - public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1) |
|
92 | - { |
|
93 | - return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number); |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - /** |
|
98 | - * Wrapper for getting the selector for a given field and given row of a datetime in the event editor. |
|
99 | - * |
|
100 | - * @param string $field_name |
|
101 | - * @param int $row_number |
|
102 | - * @return string |
|
103 | - */ |
|
104 | - public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1) |
|
105 | - { |
|
106 | - return "//input[@id='event-datetime-$field_name-$row_number']"; |
|
107 | - } |
|
108 | - |
|
109 | - |
|
110 | - /** |
|
111 | - * The selector for the TKT_name field for the given display row in the event editor. |
|
112 | - * @param int $row_number |
|
113 | - * @return string |
|
114 | - */ |
|
115 | - public static function eventEditorTicketNameFieldSelector($row_number = 1) |
|
116 | - { |
|
117 | - return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number); |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor. |
|
123 | - * @param $field_name |
|
124 | - * @param int $row_number |
|
125 | - * @return string |
|
126 | - */ |
|
127 | - public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1) |
|
128 | - { |
|
129 | - return "//tr[@id='display-ticketrow-$row_number']" |
|
130 | - . "/td[2]/input[@class='edit-ticket-$field_name ee-large-text-inp']"; |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * Returns the selector for the event title edit link in the events list table for the given Event Title. |
|
136 | - * @param string $event_title |
|
137 | - * @return string |
|
138 | - */ |
|
139 | - public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title) |
|
140 | - { |
|
141 | - return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"; |
|
142 | - } |
|
143 | - |
|
144 | - |
|
145 | - /** |
|
146 | - * Locator for for the ID column in the event list table for a given event title. |
|
147 | - * @param string $event_title |
|
148 | - * @return string |
|
149 | - */ |
|
150 | - public static function eventListTableEventIdSelectorForTitle($event_title) |
|
151 | - { |
|
152 | - return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
153 | - . "//ancestor::tr/th[contains(@class, 'check-column')]/input"; |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * Locator for the view link in the row of an event list table for the given event title. |
|
159 | - * @param string $event_title |
|
160 | - * @return string |
|
161 | - */ |
|
162 | - public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title) |
|
163 | - { |
|
164 | - return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
165 | - . "//ancestor::td//span[@class='view']/a"; |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - /** |
|
170 | - * Locator for the messenger tab in the Notifications metabox in the event editor. |
|
171 | - * @param string $messenger_slug The slug for the messenger (it's reference slug). |
|
172 | - * @return string |
|
173 | - */ |
|
174 | - public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug) |
|
175 | - { |
|
176 | - return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
177 | - . "//a[@rel='ee-tab-$messenger_slug']"; |
|
178 | - } |
|
179 | - |
|
180 | - |
|
181 | - /** |
|
182 | - * Locator for the select input within the notifications metabox. |
|
183 | - * Note, this assumes the tab content for the related messenger is already visible. |
|
184 | - * @param string $message_type_label The message type label (visible string in the table) you want the selector for. |
|
185 | - * @return string |
|
186 | - */ |
|
187 | - public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label) |
|
188 | - { |
|
189 | - return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
190 | - . "//table[@class='messages-custom-template-switcher']" |
|
191 | - . "//tr/td[contains(.,'Registration Approved')]" |
|
192 | - . "//ancestor::tr//select[contains(@class,'message-template-selector')]"; |
|
193 | - } |
|
17 | + /** |
|
18 | + * Selector for the Add new Event button in the admin. |
|
19 | + * @var string |
|
20 | + */ |
|
21 | + const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event'; |
|
22 | + |
|
23 | + |
|
24 | + /** |
|
25 | + * Selector for the Event Title field in the event editor |
|
26 | + * @var string |
|
27 | + */ |
|
28 | + const EVENT_EDITOR_TITLE_FIELD_SELECTOR = "//input[@id='title']"; |
|
29 | + |
|
30 | + /** |
|
31 | + * Selector for the publish submit button in the event editor. |
|
32 | + * @var string |
|
33 | + */ |
|
34 | + const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = "#publish"; |
|
35 | + |
|
36 | + |
|
37 | + /** |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status'; |
|
41 | + |
|
42 | + /** |
|
43 | + * Selector for the view link after publishing an event. |
|
44 | + * @var string |
|
45 | + */ |
|
46 | + const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//div[@id='message']/p/a"; |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * Selector for the ID of the event in the event editor |
|
51 | + * @var string |
|
52 | + */ |
|
53 | + const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']"; |
|
54 | + |
|
55 | + |
|
56 | + /** |
|
57 | + * Selector for the search input on the event list table page. |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input'; |
|
61 | + |
|
62 | + |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * @param string $additional_params |
|
67 | + * @return string |
|
68 | + */ |
|
69 | + public static function defaultEventsListTableUrl($additional_params = '') |
|
70 | + { |
|
71 | + return self::adminUrl('espresso_events', 'default', $additional_params); |
|
72 | + } |
|
73 | + |
|
74 | + |
|
75 | + /** |
|
76 | + * The selector for the DTTname field for the given row in the event editor. |
|
77 | + * @param int $row_number |
|
78 | + * @return string |
|
79 | + */ |
|
80 | + public static function eventEditorDatetimeNameFieldSelector($row_number = 1) |
|
81 | + { |
|
82 | + return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number); |
|
83 | + } |
|
84 | + |
|
85 | + |
|
86 | + /** |
|
87 | + * The selector for the DTT_EVT_start field for the given row in the event editor.d |
|
88 | + * @param int $row_number |
|
89 | + * @return string |
|
90 | + */ |
|
91 | + public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1) |
|
92 | + { |
|
93 | + return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number); |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + /** |
|
98 | + * Wrapper for getting the selector for a given field and given row of a datetime in the event editor. |
|
99 | + * |
|
100 | + * @param string $field_name |
|
101 | + * @param int $row_number |
|
102 | + * @return string |
|
103 | + */ |
|
104 | + public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1) |
|
105 | + { |
|
106 | + return "//input[@id='event-datetime-$field_name-$row_number']"; |
|
107 | + } |
|
108 | + |
|
109 | + |
|
110 | + /** |
|
111 | + * The selector for the TKT_name field for the given display row in the event editor. |
|
112 | + * @param int $row_number |
|
113 | + * @return string |
|
114 | + */ |
|
115 | + public static function eventEditorTicketNameFieldSelector($row_number = 1) |
|
116 | + { |
|
117 | + return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number); |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor. |
|
123 | + * @param $field_name |
|
124 | + * @param int $row_number |
|
125 | + * @return string |
|
126 | + */ |
|
127 | + public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1) |
|
128 | + { |
|
129 | + return "//tr[@id='display-ticketrow-$row_number']" |
|
130 | + . "/td[2]/input[@class='edit-ticket-$field_name ee-large-text-inp']"; |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * Returns the selector for the event title edit link in the events list table for the given Event Title. |
|
136 | + * @param string $event_title |
|
137 | + * @return string |
|
138 | + */ |
|
139 | + public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title) |
|
140 | + { |
|
141 | + return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"; |
|
142 | + } |
|
143 | + |
|
144 | + |
|
145 | + /** |
|
146 | + * Locator for for the ID column in the event list table for a given event title. |
|
147 | + * @param string $event_title |
|
148 | + * @return string |
|
149 | + */ |
|
150 | + public static function eventListTableEventIdSelectorForTitle($event_title) |
|
151 | + { |
|
152 | + return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
153 | + . "//ancestor::tr/th[contains(@class, 'check-column')]/input"; |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * Locator for the view link in the row of an event list table for the given event title. |
|
159 | + * @param string $event_title |
|
160 | + * @return string |
|
161 | + */ |
|
162 | + public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title) |
|
163 | + { |
|
164 | + return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']" |
|
165 | + . "//ancestor::td//span[@class='view']/a"; |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + /** |
|
170 | + * Locator for the messenger tab in the Notifications metabox in the event editor. |
|
171 | + * @param string $messenger_slug The slug for the messenger (it's reference slug). |
|
172 | + * @return string |
|
173 | + */ |
|
174 | + public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug) |
|
175 | + { |
|
176 | + return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
177 | + . "//a[@rel='ee-tab-$messenger_slug']"; |
|
178 | + } |
|
179 | + |
|
180 | + |
|
181 | + /** |
|
182 | + * Locator for the select input within the notifications metabox. |
|
183 | + * Note, this assumes the tab content for the related messenger is already visible. |
|
184 | + * @param string $message_type_label The message type label (visible string in the table) you want the selector for. |
|
185 | + * @return string |
|
186 | + */ |
|
187 | + public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label) |
|
188 | + { |
|
189 | + return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']" |
|
190 | + . "//table[@class='messages-custom-template-switcher']" |
|
191 | + . "//tr/td[contains(.,'Registration Approved')]" |
|
192 | + . "//ancestor::tr//select[contains(@class,'message-template-selector')]"; |
|
193 | + } |
|
194 | 194 | } |
@@ -13,58 +13,58 @@ |
||
13 | 13 | trait BaseCoreAdmin |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * Core method for going to an Event Espresso Admin page. |
|
18 | - * @param string $page |
|
19 | - * @param string $action |
|
20 | - * @param string $additional_params |
|
21 | - */ |
|
22 | - public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '') |
|
23 | - { |
|
24 | - $this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params)); |
|
25 | - } |
|
16 | + /** |
|
17 | + * Core method for going to an Event Espresso Admin page. |
|
18 | + * @param string $page |
|
19 | + * @param string $action |
|
20 | + * @param string $additional_params |
|
21 | + */ |
|
22 | + public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '') |
|
23 | + { |
|
24 | + $this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params)); |
|
25 | + } |
|
26 | 26 | |
27 | 27 | |
28 | - /** |
|
29 | - * Helper method for returning an instance of the Actor. Intended to help with IDE fill out of methods. |
|
30 | - * @return \EventEspressoAcceptanceTester; |
|
31 | - */ |
|
32 | - protected function actor() |
|
33 | - { |
|
34 | - /** @var \EventEspressoAcceptanceTester $this */ |
|
35 | - return $this; |
|
36 | - } |
|
28 | + /** |
|
29 | + * Helper method for returning an instance of the Actor. Intended to help with IDE fill out of methods. |
|
30 | + * @return \EventEspressoAcceptanceTester; |
|
31 | + */ |
|
32 | + protected function actor() |
|
33 | + { |
|
34 | + /** @var \EventEspressoAcceptanceTester $this */ |
|
35 | + return $this; |
|
36 | + } |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * Use this to set the per page option for a list table page. |
|
41 | - * Assumes you are on a page that has this field exposed. |
|
42 | - * |
|
43 | - * @param int|string $per_page_value |
|
44 | - * @throws \Codeception\Exception\TestRuntimeException |
|
45 | - */ |
|
46 | - public function setPerPageOptionForScreen($per_page_value) |
|
47 | - { |
|
48 | - $this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR); |
|
49 | - $this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value); |
|
50 | - $this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR); |
|
51 | - $this->actor()->wait(8); |
|
52 | - } |
|
39 | + /** |
|
40 | + * Use this to set the per page option for a list table page. |
|
41 | + * Assumes you are on a page that has this field exposed. |
|
42 | + * |
|
43 | + * @param int|string $per_page_value |
|
44 | + * @throws \Codeception\Exception\TestRuntimeException |
|
45 | + */ |
|
46 | + public function setPerPageOptionForScreen($per_page_value) |
|
47 | + { |
|
48 | + $this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR); |
|
49 | + $this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value); |
|
50 | + $this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR); |
|
51 | + $this->actor()->wait(8); |
|
52 | + } |
|
53 | 53 | |
54 | 54 | |
55 | 55 | |
56 | - /** |
|
57 | - * Use this to append a given value to a wpEditor instance. |
|
58 | - * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and |
|
59 | - * the value is added to the text area. |
|
60 | - * |
|
61 | - * @param $field_reference |
|
62 | - * @param $value |
|
63 | - * @throws \Codeception\Exception\ElementNotFound |
|
64 | - */ |
|
65 | - public function appendToWPEditorField($field_reference, $value) |
|
66 | - { |
|
67 | - $this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference)); |
|
68 | - $this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value); |
|
69 | - } |
|
56 | + /** |
|
57 | + * Use this to append a given value to a wpEditor instance. |
|
58 | + * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and |
|
59 | + * the value is added to the text area. |
|
60 | + * |
|
61 | + * @param $field_reference |
|
62 | + * @param $value |
|
63 | + * @throws \Codeception\Exception\ElementNotFound |
|
64 | + */ |
|
65 | + public function appendToWPEditorField($field_reference, $value) |
|
66 | + { |
|
67 | + $this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference)); |
|
68 | + $this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value); |
|
69 | + } |
|
70 | 70 | } |
@@ -10,228 +10,228 @@ |
||
10 | 10 | */ |
11 | 11 | trait MessagesAdmin |
12 | 12 | { |
13 | - /** |
|
14 | - * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
15 | - * a string. |
|
16 | - */ |
|
17 | - public function amOnMessagesActivityListTablePage($additional_params = '') |
|
18 | - { |
|
19 | - $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params)); |
|
20 | - } |
|
21 | - |
|
22 | - /** |
|
23 | - * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
24 | - * a string. |
|
25 | - */ |
|
26 | - public function amOnDefaultMessageTemplateListTablePage($additional_params = '') |
|
27 | - { |
|
28 | - $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params)); |
|
29 | - } |
|
30 | - |
|
31 | - |
|
32 | - /** |
|
33 | - * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
34 | - * a string. |
|
35 | - */ |
|
36 | - public function amOnCustomMessageTemplateListTablePage($additional_params = '') |
|
37 | - { |
|
38 | - $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params)); |
|
39 | - } |
|
40 | - |
|
41 | - |
|
42 | - /** |
|
43 | - * Directs to message settings page |
|
44 | - */ |
|
45 | - public function amOnMessageSettingsPage() |
|
46 | - { |
|
47 | - $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl()); |
|
48 | - } |
|
49 | - |
|
50 | - |
|
51 | - public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email') |
|
52 | - { |
|
53 | - $this->actor()->dragAndDrop( |
|
54 | - MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug), |
|
55 | - MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR |
|
56 | - ); |
|
57 | - } |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * Assumes you are already on the list table page that has the ui for editing the template. |
|
62 | - * @param string $message_type_slug |
|
63 | - * @param string $context [optional] if you want to click directly to the given context in the editor |
|
64 | - */ |
|
65 | - public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '') |
|
66 | - { |
|
67 | - $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context)); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * Use this action to verify that the count for the given text in the specified field is as expected. For example |
|
73 | - * filling the condition of, "There should only be 1 instance of `[email protected]` in all the 'to' column. |
|
74 | - * |
|
75 | - * @param int $expected_occurence_count |
|
76 | - * @param string $text_to_check_for |
|
77 | - * @param string $field |
|
78 | - * @param string $message_type_label |
|
79 | - * @param string $message_status |
|
80 | - * @param string $messenger |
|
81 | - * @param string $context |
|
82 | - */ |
|
83 | - public function verifyMatchingCountofTextInMessageActivityListTableFor( |
|
84 | - $expected_occurence_count, |
|
85 | - $text_to_check_for, |
|
86 | - $field, |
|
87 | - $message_type_label, |
|
88 | - $message_status = MessagesPage::MESSAGE_STATUS_SENT, |
|
89 | - $messenger = 'Email', |
|
90 | - $context = 'Event Admin' |
|
91 | - ) { |
|
92 | - $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor( |
|
93 | - $field, |
|
94 | - $message_type_label, |
|
95 | - $message_status, |
|
96 | - $messenger, |
|
97 | - $context, |
|
98 | - $text_to_check_for, |
|
99 | - 0 |
|
100 | - )); |
|
101 | - $actual_count = count($elements); |
|
102 | - $this->actor()->assertEquals( |
|
103 | - $expected_occurence_count, |
|
104 | - $actual_count, |
|
105 | - sprintf( |
|
106 | - 'Expected %s of the %s text for the %s field but there were actually %s counted.', |
|
107 | - $expected_occurence_count, |
|
108 | - $text_to_check_for, |
|
109 | - $field, |
|
110 | - $actual_count |
|
111 | - ) |
|
112 | - ); |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * This will create a custom message template for the given messenger and message type from the context of the |
|
118 | - * default (global) message template list table. |
|
119 | - * Also takes care of verifying the template was created. |
|
120 | - * @param string $message_type_label |
|
121 | - * @param string $messenger_label |
|
122 | - */ |
|
123 | - public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label) |
|
124 | - { |
|
125 | - $this->amOnDefaultMessageTemplateListTablePage(); |
|
126 | - $this->actor()->click( |
|
127 | - MessagesPage::createCustomButtonForMessageTypeAndMessenger( |
|
128 | - $message_type_label, |
|
129 | - $messenger_label |
|
130 | - ) |
|
131 | - ); |
|
132 | - $this->actor()->seeInField('#title', 'New Custom Template'); |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * This switches the context of the current messages template to the given reference. |
|
138 | - * @param string $context_reference This should be the visible label for the option. |
|
139 | - */ |
|
140 | - public function switchContextTo($context_reference) |
|
141 | - { |
|
142 | - $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference); |
|
143 | - $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR); |
|
144 | - $this->actor()->waitForText($context_reference, 10, 'h1'); |
|
145 | - } |
|
146 | - |
|
147 | - |
|
148 | - /** |
|
149 | - * This takes care of clicking the View Message icon for the given parameters. |
|
150 | - * Assumes you are already viewing the messages activity list table. |
|
151 | - * @param $message_type_label |
|
152 | - * @param $message_status |
|
153 | - * @param string $messenger |
|
154 | - * @param string $context |
|
155 | - * @param int $number_in_set |
|
156 | - */ |
|
157 | - public function viewMessageInMessagesListTableFor( |
|
158 | - $message_type_label, |
|
159 | - $message_status = MessagesPage::MESSAGE_STATUS_SENT, |
|
160 | - $messenger = 'Email', |
|
161 | - $context = 'Event Admin', |
|
162 | - $number_in_set = 1 |
|
163 | - ) { |
|
164 | - $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor( |
|
165 | - $message_type_label, |
|
166 | - $message_status, |
|
167 | - $messenger, |
|
168 | - $context, |
|
169 | - $number_in_set |
|
170 | - )); |
|
171 | - } |
|
172 | - |
|
173 | - |
|
174 | - /** |
|
175 | - * Takes care of deleting a message matching the given parameters via the message activity list table. |
|
176 | - * Assumes you are already viewing the messages activity list table. |
|
177 | - * @param $message_type_label |
|
178 | - * @param $message_status |
|
179 | - * @param string $messenger |
|
180 | - * @param string $context |
|
181 | - * @param int $number_in_set |
|
182 | - */ |
|
183 | - public function deleteMessageInMessagesListTableFor( |
|
184 | - $message_type_label, |
|
185 | - $message_status = MessagesPage::MESSAGE_STATUS_SENT, |
|
186 | - $messenger = 'Email', |
|
187 | - $context = 'Event Admin', |
|
188 | - $number_in_set = 1 |
|
189 | - ) { |
|
190 | - $this->actor()->moveMouseOver( |
|
191 | - MessagesPage::messagesActivityListTableCellSelectorFor( |
|
192 | - 'to', |
|
193 | - $message_type_label, |
|
194 | - $message_status, |
|
195 | - $messenger, |
|
196 | - $context, |
|
197 | - '', |
|
198 | - $number_in_set |
|
199 | - ) |
|
200 | - ); |
|
201 | - $this->actor()->click( |
|
202 | - MessagesPage::messagesActivityListTableDeleteActionSelectorFor( |
|
203 | - $message_type_label, |
|
204 | - $message_status, |
|
205 | - $messenger, |
|
206 | - $context, |
|
207 | - $number_in_set |
|
208 | - ) |
|
209 | - ); |
|
210 | - $this->actor()->waitForText('successfully deleted'); |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - /** |
|
215 | - * Assuming you have already triggered the view modal for a single message from the context of the message activity |
|
216 | - * list table, this will take care of validating the given text is in that window. |
|
217 | - * @param string $text_to_view |
|
218 | - */ |
|
219 | - public function seeTextInViewMessageModal($text_to_view, $should_not_see = false) |
|
220 | - { |
|
221 | - $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content'); |
|
222 | - $this->actor()->switchToIframe('message-view-window'); |
|
223 | - $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view); |
|
224 | - $this->actor()->switchToIframe(); |
|
225 | - } |
|
226 | - |
|
227 | - |
|
228 | - /** |
|
229 | - * Assuming you have already triggered the view modal for a single message from the context of the message activity |
|
230 | - * list table, this will take care of validating the given text is NOT that window. |
|
231 | - * @param string $text_to_view |
|
232 | - */ |
|
233 | - public function dontSeeTextInViewMessageModal($text_to_view) |
|
234 | - { |
|
235 | - $this->seeTextInViewMessageModal($text_to_view, true); |
|
236 | - } |
|
13 | + /** |
|
14 | + * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
15 | + * a string. |
|
16 | + */ |
|
17 | + public function amOnMessagesActivityListTablePage($additional_params = '') |
|
18 | + { |
|
19 | + $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params)); |
|
20 | + } |
|
21 | + |
|
22 | + /** |
|
23 | + * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
24 | + * a string. |
|
25 | + */ |
|
26 | + public function amOnDefaultMessageTemplateListTablePage($additional_params = '') |
|
27 | + { |
|
28 | + $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params)); |
|
29 | + } |
|
30 | + |
|
31 | + |
|
32 | + /** |
|
33 | + * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
34 | + * a string. |
|
35 | + */ |
|
36 | + public function amOnCustomMessageTemplateListTablePage($additional_params = '') |
|
37 | + { |
|
38 | + $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params)); |
|
39 | + } |
|
40 | + |
|
41 | + |
|
42 | + /** |
|
43 | + * Directs to message settings page |
|
44 | + */ |
|
45 | + public function amOnMessageSettingsPage() |
|
46 | + { |
|
47 | + $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl()); |
|
48 | + } |
|
49 | + |
|
50 | + |
|
51 | + public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email') |
|
52 | + { |
|
53 | + $this->actor()->dragAndDrop( |
|
54 | + MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug), |
|
55 | + MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR |
|
56 | + ); |
|
57 | + } |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * Assumes you are already on the list table page that has the ui for editing the template. |
|
62 | + * @param string $message_type_slug |
|
63 | + * @param string $context [optional] if you want to click directly to the given context in the editor |
|
64 | + */ |
|
65 | + public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '') |
|
66 | + { |
|
67 | + $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context)); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * Use this action to verify that the count for the given text in the specified field is as expected. For example |
|
73 | + * filling the condition of, "There should only be 1 instance of `[email protected]` in all the 'to' column. |
|
74 | + * |
|
75 | + * @param int $expected_occurence_count |
|
76 | + * @param string $text_to_check_for |
|
77 | + * @param string $field |
|
78 | + * @param string $message_type_label |
|
79 | + * @param string $message_status |
|
80 | + * @param string $messenger |
|
81 | + * @param string $context |
|
82 | + */ |
|
83 | + public function verifyMatchingCountofTextInMessageActivityListTableFor( |
|
84 | + $expected_occurence_count, |
|
85 | + $text_to_check_for, |
|
86 | + $field, |
|
87 | + $message_type_label, |
|
88 | + $message_status = MessagesPage::MESSAGE_STATUS_SENT, |
|
89 | + $messenger = 'Email', |
|
90 | + $context = 'Event Admin' |
|
91 | + ) { |
|
92 | + $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor( |
|
93 | + $field, |
|
94 | + $message_type_label, |
|
95 | + $message_status, |
|
96 | + $messenger, |
|
97 | + $context, |
|
98 | + $text_to_check_for, |
|
99 | + 0 |
|
100 | + )); |
|
101 | + $actual_count = count($elements); |
|
102 | + $this->actor()->assertEquals( |
|
103 | + $expected_occurence_count, |
|
104 | + $actual_count, |
|
105 | + sprintf( |
|
106 | + 'Expected %s of the %s text for the %s field but there were actually %s counted.', |
|
107 | + $expected_occurence_count, |
|
108 | + $text_to_check_for, |
|
109 | + $field, |
|
110 | + $actual_count |
|
111 | + ) |
|
112 | + ); |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * This will create a custom message template for the given messenger and message type from the context of the |
|
118 | + * default (global) message template list table. |
|
119 | + * Also takes care of verifying the template was created. |
|
120 | + * @param string $message_type_label |
|
121 | + * @param string $messenger_label |
|
122 | + */ |
|
123 | + public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label) |
|
124 | + { |
|
125 | + $this->amOnDefaultMessageTemplateListTablePage(); |
|
126 | + $this->actor()->click( |
|
127 | + MessagesPage::createCustomButtonForMessageTypeAndMessenger( |
|
128 | + $message_type_label, |
|
129 | + $messenger_label |
|
130 | + ) |
|
131 | + ); |
|
132 | + $this->actor()->seeInField('#title', 'New Custom Template'); |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * This switches the context of the current messages template to the given reference. |
|
138 | + * @param string $context_reference This should be the visible label for the option. |
|
139 | + */ |
|
140 | + public function switchContextTo($context_reference) |
|
141 | + { |
|
142 | + $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference); |
|
143 | + $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR); |
|
144 | + $this->actor()->waitForText($context_reference, 10, 'h1'); |
|
145 | + } |
|
146 | + |
|
147 | + |
|
148 | + /** |
|
149 | + * This takes care of clicking the View Message icon for the given parameters. |
|
150 | + * Assumes you are already viewing the messages activity list table. |
|
151 | + * @param $message_type_label |
|
152 | + * @param $message_status |
|
153 | + * @param string $messenger |
|
154 | + * @param string $context |
|
155 | + * @param int $number_in_set |
|
156 | + */ |
|
157 | + public function viewMessageInMessagesListTableFor( |
|
158 | + $message_type_label, |
|
159 | + $message_status = MessagesPage::MESSAGE_STATUS_SENT, |
|
160 | + $messenger = 'Email', |
|
161 | + $context = 'Event Admin', |
|
162 | + $number_in_set = 1 |
|
163 | + ) { |
|
164 | + $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor( |
|
165 | + $message_type_label, |
|
166 | + $message_status, |
|
167 | + $messenger, |
|
168 | + $context, |
|
169 | + $number_in_set |
|
170 | + )); |
|
171 | + } |
|
172 | + |
|
173 | + |
|
174 | + /** |
|
175 | + * Takes care of deleting a message matching the given parameters via the message activity list table. |
|
176 | + * Assumes you are already viewing the messages activity list table. |
|
177 | + * @param $message_type_label |
|
178 | + * @param $message_status |
|
179 | + * @param string $messenger |
|
180 | + * @param string $context |
|
181 | + * @param int $number_in_set |
|
182 | + */ |
|
183 | + public function deleteMessageInMessagesListTableFor( |
|
184 | + $message_type_label, |
|
185 | + $message_status = MessagesPage::MESSAGE_STATUS_SENT, |
|
186 | + $messenger = 'Email', |
|
187 | + $context = 'Event Admin', |
|
188 | + $number_in_set = 1 |
|
189 | + ) { |
|
190 | + $this->actor()->moveMouseOver( |
|
191 | + MessagesPage::messagesActivityListTableCellSelectorFor( |
|
192 | + 'to', |
|
193 | + $message_type_label, |
|
194 | + $message_status, |
|
195 | + $messenger, |
|
196 | + $context, |
|
197 | + '', |
|
198 | + $number_in_set |
|
199 | + ) |
|
200 | + ); |
|
201 | + $this->actor()->click( |
|
202 | + MessagesPage::messagesActivityListTableDeleteActionSelectorFor( |
|
203 | + $message_type_label, |
|
204 | + $message_status, |
|
205 | + $messenger, |
|
206 | + $context, |
|
207 | + $number_in_set |
|
208 | + ) |
|
209 | + ); |
|
210 | + $this->actor()->waitForText('successfully deleted'); |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + /** |
|
215 | + * Assuming you have already triggered the view modal for a single message from the context of the message activity |
|
216 | + * list table, this will take care of validating the given text is in that window. |
|
217 | + * @param string $text_to_view |
|
218 | + */ |
|
219 | + public function seeTextInViewMessageModal($text_to_view, $should_not_see = false) |
|
220 | + { |
|
221 | + $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content'); |
|
222 | + $this->actor()->switchToIframe('message-view-window'); |
|
223 | + $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view); |
|
224 | + $this->actor()->switchToIframe(); |
|
225 | + } |
|
226 | + |
|
227 | + |
|
228 | + /** |
|
229 | + * Assuming you have already triggered the view modal for a single message from the context of the message activity |
|
230 | + * list table, this will take care of validating the given text is NOT that window. |
|
231 | + * @param string $text_to_view |
|
232 | + */ |
|
233 | + public function dontSeeTextInViewMessageModal($text_to_view) |
|
234 | + { |
|
235 | + $this->seeTextInViewMessageModal($text_to_view, true); |
|
236 | + } |
|
237 | 237 | } |
@@ -14,84 +14,84 @@ |
||
14 | 14 | trait EventsAdmin |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @param string $additional_params |
|
19 | - */ |
|
20 | - public function amOnDefaultEventsListTablePage($additional_params = '') |
|
21 | - { |
|
22 | - $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
23 | - } |
|
17 | + /** |
|
18 | + * @param string $additional_params |
|
19 | + */ |
|
20 | + public function amOnDefaultEventsListTablePage($additional_params = '') |
|
21 | + { |
|
22 | + $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
23 | + } |
|
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * Triggers the publishing of the Event. |
|
28 | - */ |
|
29 | - public function publishEvent() |
|
30 | - { |
|
31 | - $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
32 | - } |
|
26 | + /** |
|
27 | + * Triggers the publishing of the Event. |
|
28 | + */ |
|
29 | + public function publishEvent() |
|
30 | + { |
|
31 | + $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
32 | + } |
|
33 | 33 | |
34 | 34 | |
35 | - /** |
|
36 | - * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
37 | - * First this will search using the given title and then attempt to edit from the results of the search. |
|
38 | - * |
|
39 | - * Assumes actor is already logged in. |
|
40 | - * @param $event_title |
|
41 | - */ |
|
42 | - public function amEditingTheEventWithTitle($event_title) |
|
43 | - { |
|
44 | - $this->amOnDefaultEventsListTablePage(); |
|
45 | - $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
46 | - $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
47 | - $this->actor()->waitForText('Displaying search results for'); |
|
48 | - $this->actor()->click(EventsPage::eventListTableEventTitleEditLink($event_title)); |
|
49 | - } |
|
35 | + /** |
|
36 | + * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
37 | + * First this will search using the given title and then attempt to edit from the results of the search. |
|
38 | + * |
|
39 | + * Assumes actor is already logged in. |
|
40 | + * @param $event_title |
|
41 | + */ |
|
42 | + public function amEditingTheEventWithTitle($event_title) |
|
43 | + { |
|
44 | + $this->amOnDefaultEventsListTablePage(); |
|
45 | + $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
46 | + $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
47 | + $this->actor()->waitForText('Displaying search results for'); |
|
48 | + $this->actor()->click(EventsPage::eventListTableEventTitleEditLink($event_title)); |
|
49 | + } |
|
50 | 50 | |
51 | 51 | |
52 | - /** |
|
53 | - * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
54 | - * link for the event in the event list table. |
|
55 | - * Assumes the actor is already logged in and on the Event list table page. |
|
56 | - * |
|
57 | - * @param string $event_title |
|
58 | - */ |
|
59 | - public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
60 | - { |
|
61 | - $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
62 | - $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
63 | - } |
|
52 | + /** |
|
53 | + * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
54 | + * link for the event in the event list table. |
|
55 | + * Assumes the actor is already logged in and on the Event list table page. |
|
56 | + * |
|
57 | + * @param string $event_title |
|
58 | + */ |
|
59 | + public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
60 | + { |
|
61 | + $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
62 | + $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
63 | + } |
|
64 | 64 | |
65 | 65 | |
66 | - /** |
|
67 | - * Use to change the default registration status for the event. |
|
68 | - * Assumes the view is already on the event editor. |
|
69 | - * @param $registration_status |
|
70 | - */ |
|
71 | - public function changeDefaultRegistrationStatusTo($registration_status) |
|
72 | - { |
|
73 | - $this->actor()->selectOption( |
|
74 | - EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
75 | - $registration_status |
|
76 | - ); |
|
77 | - } |
|
66 | + /** |
|
67 | + * Use to change the default registration status for the event. |
|
68 | + * Assumes the view is already on the event editor. |
|
69 | + * @param $registration_status |
|
70 | + */ |
|
71 | + public function changeDefaultRegistrationStatusTo($registration_status) |
|
72 | + { |
|
73 | + $this->actor()->selectOption( |
|
74 | + EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
75 | + $registration_status |
|
76 | + ); |
|
77 | + } |
|
78 | 78 | |
79 | 79 | |
80 | - /** |
|
81 | - * Use this from the context of the event editor to select the given custom template for a given message type and |
|
82 | - * messenger. |
|
83 | - * |
|
84 | - * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
85 | - * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
86 | - * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
87 | - * selected. |
|
88 | - */ |
|
89 | - public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
90 | - { |
|
91 | - $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
92 | - $this->actor()->selectOption( |
|
93 | - EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
94 | - $custom_template_label |
|
95 | - ); |
|
96 | - } |
|
80 | + /** |
|
81 | + * Use this from the context of the event editor to select the given custom template for a given message type and |
|
82 | + * messenger. |
|
83 | + * |
|
84 | + * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
85 | + * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
86 | + * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
87 | + * selected. |
|
88 | + */ |
|
89 | + public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
90 | + { |
|
91 | + $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
92 | + $this->actor()->selectOption( |
|
93 | + EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
94 | + $custom_template_label |
|
95 | + ); |
|
96 | + } |
|
97 | 97 | } |
98 | 98 | \ No newline at end of file |
@@ -13,84 +13,84 @@ |
||
13 | 13 | class CoreAdmin |
14 | 14 | { |
15 | 15 | |
16 | - /** |
|
17 | - * @var string |
|
18 | - */ |
|
19 | - const URL_PREFIX = 'admin.php?page='; |
|
20 | - |
|
21 | - |
|
22 | - /** |
|
23 | - * This is the selector for the next page button on list tables. |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page'; |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * The selector for the search input submit button on list table pages |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit'; |
|
34 | - |
|
35 | - |
|
36 | - /** |
|
37 | - * Selector for the screen options dropdown. |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link'; |
|
41 | - |
|
42 | - |
|
43 | - /** |
|
44 | - * Selector for the per page field setting selector (found within screen options dropdown) |
|
45 | - * @var string |
|
46 | - */ |
|
47 | - const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page'; |
|
48 | - |
|
49 | - |
|
50 | - /** |
|
51 | - * Selector for apply screen options settings. |
|
52 | - * @var string |
|
53 | - */ |
|
54 | - const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply'; |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * Get the EE admin url for the given properties. |
|
59 | - * Note, this is JUST the endpoint for the admin route. It is expected that the actor/test would be calling this |
|
60 | - * with `amOnAdminPage` action. |
|
61 | - * |
|
62 | - * @param string $page |
|
63 | - * @param string $action |
|
64 | - * @param string $additional_params |
|
65 | - * @return string |
|
66 | - */ |
|
67 | - public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '') |
|
68 | - { |
|
69 | - $url = self::URL_PREFIX . $page; |
|
70 | - $url .= $action ? '&action=' . $action : ''; |
|
71 | - $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : ''; |
|
72 | - return $url; |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * Returns the selector for the text tab switcher for a wp-editor instance. |
|
78 | - * @param $field_reference |
|
79 | - * @return string |
|
80 | - */ |
|
81 | - public static function wpEditorTextTabSelector($field_reference) |
|
82 | - { |
|
83 | - return '#content-' . $field_reference . '-content-html'; |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance. |
|
89 | - * @param $field_reference |
|
90 | - * @return string |
|
91 | - */ |
|
92 | - public static function wpEditorTextAreaSelector($field_reference) |
|
93 | - { |
|
94 | - return '#content-' . $field_reference . '-content'; |
|
95 | - } |
|
16 | + /** |
|
17 | + * @var string |
|
18 | + */ |
|
19 | + const URL_PREFIX = 'admin.php?page='; |
|
20 | + |
|
21 | + |
|
22 | + /** |
|
23 | + * This is the selector for the next page button on list tables. |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page'; |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * The selector for the search input submit button on list table pages |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit'; |
|
34 | + |
|
35 | + |
|
36 | + /** |
|
37 | + * Selector for the screen options dropdown. |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link'; |
|
41 | + |
|
42 | + |
|
43 | + /** |
|
44 | + * Selector for the per page field setting selector (found within screen options dropdown) |
|
45 | + * @var string |
|
46 | + */ |
|
47 | + const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page'; |
|
48 | + |
|
49 | + |
|
50 | + /** |
|
51 | + * Selector for apply screen options settings. |
|
52 | + * @var string |
|
53 | + */ |
|
54 | + const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply'; |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * Get the EE admin url for the given properties. |
|
59 | + * Note, this is JUST the endpoint for the admin route. It is expected that the actor/test would be calling this |
|
60 | + * with `amOnAdminPage` action. |
|
61 | + * |
|
62 | + * @param string $page |
|
63 | + * @param string $action |
|
64 | + * @param string $additional_params |
|
65 | + * @return string |
|
66 | + */ |
|
67 | + public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '') |
|
68 | + { |
|
69 | + $url = self::URL_PREFIX . $page; |
|
70 | + $url .= $action ? '&action=' . $action : ''; |
|
71 | + $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : ''; |
|
72 | + return $url; |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * Returns the selector for the text tab switcher for a wp-editor instance. |
|
78 | + * @param $field_reference |
|
79 | + * @return string |
|
80 | + */ |
|
81 | + public static function wpEditorTextTabSelector($field_reference) |
|
82 | + { |
|
83 | + return '#content-' . $field_reference . '-content-html'; |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance. |
|
89 | + * @param $field_reference |
|
90 | + * @return string |
|
91 | + */ |
|
92 | + public static function wpEditorTextAreaSelector($field_reference) |
|
93 | + { |
|
94 | + return '#content-' . $field_reference . '-content'; |
|
95 | + } |
|
96 | 96 | } |
@@ -66,9 +66,9 @@ discard block |
||
66 | 66 | */ |
67 | 67 | public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '') |
68 | 68 | { |
69 | - $url = self::URL_PREFIX . $page; |
|
70 | - $url .= $action ? '&action=' . $action : ''; |
|
71 | - $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : ''; |
|
69 | + $url = self::URL_PREFIX.$page; |
|
70 | + $url .= $action ? '&action='.$action : ''; |
|
71 | + $url .= $additional_params ? '&'.ltrim('&', ltrim('?', $additional_params)) : ''; |
|
72 | 72 | return $url; |
73 | 73 | } |
74 | 74 | |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | */ |
81 | 81 | public static function wpEditorTextTabSelector($field_reference) |
82 | 82 | { |
83 | - return '#content-' . $field_reference . '-content-html'; |
|
83 | + return '#content-'.$field_reference.'-content-html'; |
|
84 | 84 | } |
85 | 85 | |
86 | 86 | |
@@ -91,6 +91,6 @@ discard block |
||
91 | 91 | */ |
92 | 92 | public static function wpEditorTextAreaSelector($field_reference) |
93 | 93 | { |
94 | - return '#content-' . $field_reference . '-content'; |
|
94 | + return '#content-'.$field_reference.'-content'; |
|
95 | 95 | } |
96 | 96 | } |
@@ -12,255 +12,255 @@ |
||
12 | 12 | class MessagesAdmin extends CoreAdmin |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * Context slug for the admin messages context. |
|
17 | - * @var string |
|
18 | - */ |
|
19 | - const ADMIN_CONTEXT_SLUG = 'admin'; |
|
15 | + /** |
|
16 | + * Context slug for the admin messages context. |
|
17 | + * @var string |
|
18 | + */ |
|
19 | + const ADMIN_CONTEXT_SLUG = 'admin'; |
|
20 | 20 | |
21 | - /** |
|
22 | - * Context slug for the primary attendee messages context |
|
23 | - * @var string |
|
24 | - */ |
|
25 | - const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee'; |
|
21 | + /** |
|
22 | + * Context slug for the primary attendee messages context |
|
23 | + * @var string |
|
24 | + */ |
|
25 | + const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee'; |
|
26 | 26 | |
27 | 27 | |
28 | - /** |
|
29 | - * Status reference for the EEM_Message::status_sent status. |
|
30 | - * @var string |
|
31 | - */ |
|
32 | - const MESSAGE_STATUS_SENT = 'MSN'; |
|
28 | + /** |
|
29 | + * Status reference for the EEM_Message::status_sent status. |
|
30 | + * @var string |
|
31 | + */ |
|
32 | + const MESSAGE_STATUS_SENT = 'MSN'; |
|
33 | 33 | |
34 | 34 | |
35 | - /** |
|
36 | - * Message type slug for the Payment Failed message type |
|
37 | - */ |
|
38 | - const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed'; |
|
35 | + /** |
|
36 | + * Message type slug for the Payment Failed message type |
|
37 | + */ |
|
38 | + const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed'; |
|
39 | 39 | |
40 | 40 | |
41 | - /** |
|
42 | - * Selector for the Global Messages "Send on same request" field in the Messages Settings tab. |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR = |
|
46 | - '#global_messages_settings-do-messages-on-same-request'; |
|
47 | - |
|
41 | + /** |
|
42 | + * Selector for the Global Messages "Send on same request" field in the Messages Settings tab. |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR = |
|
46 | + '#global_messages_settings-do-messages-on-same-request'; |
|
47 | + |
|
48 | 48 | |
49 | - /** |
|
50 | - * Selector for the Global Messages Settings submit button in the Messages Settings tab. |
|
51 | - * @var string |
|
52 | - */ |
|
53 | - const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit'; |
|
54 | - |
|
55 | - |
|
56 | - /** |
|
57 | - * This is the container where active message types for a messenger are found/dragged to. |
|
58 | - * @var string |
|
59 | - */ |
|
60 | - const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types'; |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * Locator for the context switcher selector on the Message Template Editor page. |
|
65 | - * @var string |
|
66 | - */ |
|
67 | - const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select"; |
|
68 | - |
|
69 | - |
|
70 | - /** |
|
71 | - * Locator for the context switcher submit button in the Message Template Editor page. |
|
72 | - * @var string |
|
73 | - */ |
|
74 | - const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt"; |
|
75 | - |
|
76 | - |
|
77 | - /** |
|
78 | - * Locator for the dialog container used for housing viewed messages in the message activity list table. |
|
79 | - * @var string |
|
80 | - */ |
|
81 | - const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content'; |
|
82 | - |
|
83 | - |
|
84 | - |
|
85 | - /** |
|
86 | - * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
87 | - * a string. |
|
88 | - * @return string |
|
89 | - */ |
|
90 | - public static function messageActivityListTableUrl($additional_params = '') |
|
91 | - { |
|
92 | - return self::adminUrl('espresso_messages', 'default', $additional_params); |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
98 | - * a string. |
|
99 | - * @return string |
|
100 | - */ |
|
101 | - public static function defaultMessageTemplateListTableUrl($additional_params = '') |
|
102 | - { |
|
103 | - return self::adminUrl('espresso_messages', 'global_mtps', $additional_params); |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
109 | - * a string. |
|
110 | - * @return string |
|
111 | - */ |
|
112 | - public static function customMessageTemplateListTableUrl($additional_params = '') |
|
113 | - { |
|
114 | - return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params); |
|
115 | - } |
|
116 | - |
|
117 | - |
|
118 | - /** |
|
119 | - * @return string |
|
120 | - */ |
|
121 | - public static function messageSettingsUrl() |
|
122 | - { |
|
123 | - return self::adminUrl('espresso_messages', 'settings'); |
|
124 | - } |
|
125 | - |
|
126 | - |
|
127 | - |
|
128 | - public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger( |
|
129 | - $message_type_slug, |
|
130 | - $messenger_slug = 'email' |
|
131 | - ) { |
|
132 | - return "#$message_type_slug-messagetype-$messenger_slug"; |
|
133 | - } |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * @param string $message_type_slug |
|
138 | - * @param string $context |
|
139 | - * @return string |
|
140 | - */ |
|
141 | - public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '') |
|
142 | - { |
|
143 | - return $context |
|
144 | - ? '.' . $message_type_slug . '-' . $context . '-edit-link' |
|
145 | - : '.' . $message_type_slug . '-edit-link'; |
|
146 | - } |
|
147 | - |
|
148 | - |
|
149 | - /** |
|
150 | - * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters. |
|
151 | - * |
|
152 | - * @param $field |
|
153 | - * @param $message_type_label |
|
154 | - * @param string $message_status |
|
155 | - * @param string $messenger |
|
156 | - * @param string $context |
|
157 | - * @param string $table_cell_content_for_field |
|
158 | - * @param int $number_in_set It's possible that the given parameters could match multiple items in the view. |
|
159 | - * This allows you to indicate which item from the set to match. If this is set to 0 |
|
160 | - * then all matches for the locator will be returned. |
|
161 | - * @return string |
|
162 | - */ |
|
163 | - public static function messagesActivityListTableCellSelectorFor( |
|
164 | - $field, |
|
165 | - $message_type_label, |
|
166 | - $message_status = self::MESSAGE_STATUS_SENT, |
|
167 | - $messenger = 'Email', |
|
168 | - $context = 'Event Admin', |
|
169 | - $table_cell_content_for_field = '', |
|
170 | - $number_in_set = 1 |
|
171 | - ) { |
|
172 | - $selector = $number_in_set > 0 ? '(' : ''; |
|
173 | - $selector .= "//tr[contains(@class, 'msg-status-$message_status')]" |
|
174 | - . "//td[contains(@class, 'message_type') and text()='$message_type_label']"; |
|
175 | - if ($messenger) { |
|
176 | - $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']"; |
|
177 | - } |
|
178 | - $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']"; |
|
179 | - $selector .= $table_cell_content_for_field |
|
180 | - ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']" |
|
181 | - : "/ancestor::tr/td[contains(@class, 'column-$field')]"; |
|
182 | - $selector .= $number_in_set > 0 ? ")[$number_in_set]" : ''; |
|
183 | - return $selector; |
|
184 | - } |
|
185 | - |
|
186 | - |
|
187 | - /** |
|
188 | - * Selector for the Create Custom button found in the message template list table. |
|
189 | - * @param string $message_type_label |
|
190 | - * @param string $messenger_label |
|
191 | - * @return string |
|
192 | - */ |
|
193 | - public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label) |
|
194 | - { |
|
195 | - $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']" |
|
196 | - . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]" |
|
197 | - . "//ancestor::tr/td/a[@class='button button-small']"; |
|
198 | - return $selector; |
|
199 | - } |
|
200 | - |
|
201 | - |
|
202 | - /** |
|
203 | - * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to |
|
204 | - * the FIRST match (which will be the latest message sent if the table is default sorted). |
|
205 | - * |
|
206 | - * @param string $message_type_label The visible message type label for the row you want to match |
|
207 | - * @param string $message_status The status of the message for the row you want to match. |
|
208 | - * @param string $messenger The visible messenger label for the row you want to match. |
|
209 | - * @param string $context The visible context label for the row you want to match. |
|
210 | - * @param int $number_in_set It's possible that the given parameters could match multiple items in the |
|
211 | - * view. This allows you to indicate which item from the set to match. |
|
212 | - * @return string |
|
213 | - */ |
|
214 | - public static function messagesActivityListTableViewButtonSelectorFor( |
|
215 | - $message_type_label, |
|
216 | - $message_status = self::MESSAGE_STATUS_SENT, |
|
217 | - $messenger = 'Email', |
|
218 | - $context = 'Event Admin', |
|
219 | - $number_in_set = 1 |
|
220 | - ) { |
|
221 | - $selector = self::messagesActivityListTableCellSelectorFor( |
|
222 | - 'action', |
|
223 | - $message_type_label, |
|
224 | - $message_status, |
|
225 | - $messenger, |
|
226 | - $context, |
|
227 | - '', |
|
228 | - $number_in_set |
|
229 | - ); |
|
230 | - $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')" |
|
231 | - . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]"; |
|
232 | - return $selector; |
|
233 | - } |
|
234 | - |
|
235 | - |
|
236 | - |
|
237 | - /** |
|
238 | - * Locator for the delete action link for a message item in the message activity list table. |
|
239 | - * Note: The link is not visible by default, so the column would need hovered over for the link to appear. |
|
240 | - * @param $message_type_label |
|
241 | - * @param string $message_status |
|
242 | - * @param string $messenger |
|
243 | - * @param string $context |
|
244 | - * @param int $number_in_set |
|
245 | - * @return string |
|
246 | - */ |
|
247 | - public static function messagesActivityListTableDeleteActionSelectorFor( |
|
248 | - $message_type_label, |
|
249 | - $message_status = self::MESSAGE_STATUS_SENT, |
|
250 | - $messenger = 'Email', |
|
251 | - $context = 'Event Admin', |
|
252 | - $number_in_set = 1 |
|
253 | - ) { |
|
254 | - $selector = self::messagesActivityListTableCellSelectorFor( |
|
255 | - 'to', |
|
256 | - $message_type_label, |
|
257 | - $message_status, |
|
258 | - $messenger, |
|
259 | - $context, |
|
260 | - '', |
|
261 | - $number_in_set |
|
262 | - ); |
|
263 | - $selector .= "/div/span[@class='delete']/a"; |
|
264 | - return $selector; |
|
265 | - } |
|
49 | + /** |
|
50 | + * Selector for the Global Messages Settings submit button in the Messages Settings tab. |
|
51 | + * @var string |
|
52 | + */ |
|
53 | + const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit'; |
|
54 | + |
|
55 | + |
|
56 | + /** |
|
57 | + * This is the container where active message types for a messenger are found/dragged to. |
|
58 | + * @var string |
|
59 | + */ |
|
60 | + const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types'; |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * Locator for the context switcher selector on the Message Template Editor page. |
|
65 | + * @var string |
|
66 | + */ |
|
67 | + const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select"; |
|
68 | + |
|
69 | + |
|
70 | + /** |
|
71 | + * Locator for the context switcher submit button in the Message Template Editor page. |
|
72 | + * @var string |
|
73 | + */ |
|
74 | + const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt"; |
|
75 | + |
|
76 | + |
|
77 | + /** |
|
78 | + * Locator for the dialog container used for housing viewed messages in the message activity list table. |
|
79 | + * @var string |
|
80 | + */ |
|
81 | + const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content'; |
|
82 | + |
|
83 | + |
|
84 | + |
|
85 | + /** |
|
86 | + * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
87 | + * a string. |
|
88 | + * @return string |
|
89 | + */ |
|
90 | + public static function messageActivityListTableUrl($additional_params = '') |
|
91 | + { |
|
92 | + return self::adminUrl('espresso_messages', 'default', $additional_params); |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
98 | + * a string. |
|
99 | + * @return string |
|
100 | + */ |
|
101 | + public static function defaultMessageTemplateListTableUrl($additional_params = '') |
|
102 | + { |
|
103 | + return self::adminUrl('espresso_messages', 'global_mtps', $additional_params); |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * @param string $additional_params Any additional request parameters for the generated url should be included as |
|
109 | + * a string. |
|
110 | + * @return string |
|
111 | + */ |
|
112 | + public static function customMessageTemplateListTableUrl($additional_params = '') |
|
113 | + { |
|
114 | + return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params); |
|
115 | + } |
|
116 | + |
|
117 | + |
|
118 | + /** |
|
119 | + * @return string |
|
120 | + */ |
|
121 | + public static function messageSettingsUrl() |
|
122 | + { |
|
123 | + return self::adminUrl('espresso_messages', 'settings'); |
|
124 | + } |
|
125 | + |
|
126 | + |
|
127 | + |
|
128 | + public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger( |
|
129 | + $message_type_slug, |
|
130 | + $messenger_slug = 'email' |
|
131 | + ) { |
|
132 | + return "#$message_type_slug-messagetype-$messenger_slug"; |
|
133 | + } |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * @param string $message_type_slug |
|
138 | + * @param string $context |
|
139 | + * @return string |
|
140 | + */ |
|
141 | + public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '') |
|
142 | + { |
|
143 | + return $context |
|
144 | + ? '.' . $message_type_slug . '-' . $context . '-edit-link' |
|
145 | + : '.' . $message_type_slug . '-edit-link'; |
|
146 | + } |
|
147 | + |
|
148 | + |
|
149 | + /** |
|
150 | + * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters. |
|
151 | + * |
|
152 | + * @param $field |
|
153 | + * @param $message_type_label |
|
154 | + * @param string $message_status |
|
155 | + * @param string $messenger |
|
156 | + * @param string $context |
|
157 | + * @param string $table_cell_content_for_field |
|
158 | + * @param int $number_in_set It's possible that the given parameters could match multiple items in the view. |
|
159 | + * This allows you to indicate which item from the set to match. If this is set to 0 |
|
160 | + * then all matches for the locator will be returned. |
|
161 | + * @return string |
|
162 | + */ |
|
163 | + public static function messagesActivityListTableCellSelectorFor( |
|
164 | + $field, |
|
165 | + $message_type_label, |
|
166 | + $message_status = self::MESSAGE_STATUS_SENT, |
|
167 | + $messenger = 'Email', |
|
168 | + $context = 'Event Admin', |
|
169 | + $table_cell_content_for_field = '', |
|
170 | + $number_in_set = 1 |
|
171 | + ) { |
|
172 | + $selector = $number_in_set > 0 ? '(' : ''; |
|
173 | + $selector .= "//tr[contains(@class, 'msg-status-$message_status')]" |
|
174 | + . "//td[contains(@class, 'message_type') and text()='$message_type_label']"; |
|
175 | + if ($messenger) { |
|
176 | + $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']"; |
|
177 | + } |
|
178 | + $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']"; |
|
179 | + $selector .= $table_cell_content_for_field |
|
180 | + ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']" |
|
181 | + : "/ancestor::tr/td[contains(@class, 'column-$field')]"; |
|
182 | + $selector .= $number_in_set > 0 ? ")[$number_in_set]" : ''; |
|
183 | + return $selector; |
|
184 | + } |
|
185 | + |
|
186 | + |
|
187 | + /** |
|
188 | + * Selector for the Create Custom button found in the message template list table. |
|
189 | + * @param string $message_type_label |
|
190 | + * @param string $messenger_label |
|
191 | + * @return string |
|
192 | + */ |
|
193 | + public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label) |
|
194 | + { |
|
195 | + $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']" |
|
196 | + . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]" |
|
197 | + . "//ancestor::tr/td/a[@class='button button-small']"; |
|
198 | + return $selector; |
|
199 | + } |
|
200 | + |
|
201 | + |
|
202 | + /** |
|
203 | + * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to |
|
204 | + * the FIRST match (which will be the latest message sent if the table is default sorted). |
|
205 | + * |
|
206 | + * @param string $message_type_label The visible message type label for the row you want to match |
|
207 | + * @param string $message_status The status of the message for the row you want to match. |
|
208 | + * @param string $messenger The visible messenger label for the row you want to match. |
|
209 | + * @param string $context The visible context label for the row you want to match. |
|
210 | + * @param int $number_in_set It's possible that the given parameters could match multiple items in the |
|
211 | + * view. This allows you to indicate which item from the set to match. |
|
212 | + * @return string |
|
213 | + */ |
|
214 | + public static function messagesActivityListTableViewButtonSelectorFor( |
|
215 | + $message_type_label, |
|
216 | + $message_status = self::MESSAGE_STATUS_SENT, |
|
217 | + $messenger = 'Email', |
|
218 | + $context = 'Event Admin', |
|
219 | + $number_in_set = 1 |
|
220 | + ) { |
|
221 | + $selector = self::messagesActivityListTableCellSelectorFor( |
|
222 | + 'action', |
|
223 | + $message_type_label, |
|
224 | + $message_status, |
|
225 | + $messenger, |
|
226 | + $context, |
|
227 | + '', |
|
228 | + $number_in_set |
|
229 | + ); |
|
230 | + $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')" |
|
231 | + . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]"; |
|
232 | + return $selector; |
|
233 | + } |
|
234 | + |
|
235 | + |
|
236 | + |
|
237 | + /** |
|
238 | + * Locator for the delete action link for a message item in the message activity list table. |
|
239 | + * Note: The link is not visible by default, so the column would need hovered over for the link to appear. |
|
240 | + * @param $message_type_label |
|
241 | + * @param string $message_status |
|
242 | + * @param string $messenger |
|
243 | + * @param string $context |
|
244 | + * @param int $number_in_set |
|
245 | + * @return string |
|
246 | + */ |
|
247 | + public static function messagesActivityListTableDeleteActionSelectorFor( |
|
248 | + $message_type_label, |
|
249 | + $message_status = self::MESSAGE_STATUS_SENT, |
|
250 | + $messenger = 'Email', |
|
251 | + $context = 'Event Admin', |
|
252 | + $number_in_set = 1 |
|
253 | + ) { |
|
254 | + $selector = self::messagesActivityListTableCellSelectorFor( |
|
255 | + 'to', |
|
256 | + $message_type_label, |
|
257 | + $message_status, |
|
258 | + $messenger, |
|
259 | + $context, |
|
260 | + '', |
|
261 | + $number_in_set |
|
262 | + ); |
|
263 | + $selector .= "/div/span[@class='delete']/a"; |
|
264 | + return $selector; |
|
265 | + } |
|
266 | 266 | } |
267 | 267 | \ No newline at end of file |
@@ -7,7 +7,7 @@ discard block |
||
7 | 7 | * @since 4.5.0 |
8 | 8 | */ |
9 | 9 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
10 | - exit('No direct script access allowed'); |
|
10 | + exit('No direct script access allowed'); |
|
11 | 11 | } |
12 | 12 | |
13 | 13 | /** |
@@ -21,166 +21,166 @@ discard block |
||
21 | 21 | class EE_Register_Capabilities implements EEI_Plugin_API |
22 | 22 | { |
23 | 23 | |
24 | - /** |
|
25 | - * Holds the settings for a specific registration. |
|
26 | - * |
|
27 | - * @var array |
|
28 | - */ |
|
29 | - protected static $_registry = array(); |
|
24 | + /** |
|
25 | + * Holds the settings for a specific registration. |
|
26 | + * |
|
27 | + * @var array |
|
28 | + */ |
|
29 | + protected static $_registry = array(); |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * Used to register capability items with EE core. |
|
34 | - * |
|
35 | - * @since 4.5.0 |
|
36 | - * @param string $cap_reference usually will be a class name |
|
37 | - * that references capability |
|
38 | - * related items setup for |
|
39 | - * something. |
|
40 | - * @param array $setup_args { |
|
41 | - * An array of items related to |
|
42 | - * registering capabilities. |
|
43 | - * @type array $capabilities An array mapping capability |
|
44 | - * strings to core WP Role. Something like: array( |
|
45 | - * 'administrator' => array( |
|
46 | - * 'read_cap', 'edit_cap', |
|
47 | - * 'delete_cap'), |
|
48 | - * 'author' => |
|
49 | - * array( 'read_cap' ) |
|
50 | - * ). |
|
51 | - * @type array $capability_maps EE_Meta_Capability_Map[] |
|
52 | - * @see EE_Capabilities.php for php docs on these objects. |
|
53 | - * Should be indexed by the |
|
54 | - * classname for the capability |
|
55 | - * map and values representing |
|
56 | - * the arguments for the map. |
|
57 | - * } |
|
58 | - * @throws EE_Error |
|
59 | - * @return void |
|
60 | - */ |
|
61 | - public static function register($cap_reference = null, $setup_args = array()) |
|
62 | - { |
|
63 | - //required fields MUST be present, so let's make sure they are. |
|
64 | - if (! isset($cap_reference) || ! is_array($setup_args) || empty($setup_args['capabilities'])) { |
|
65 | - throw new EE_Error( |
|
66 | - __('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".', |
|
67 | - 'event_espresso') |
|
68 | - ); |
|
69 | - } |
|
70 | - //make sure we don't register twice |
|
71 | - if (isset(self::$_registry[$cap_reference])) { |
|
72 | - return; |
|
73 | - } |
|
74 | - //make sure this is not registered too late or too early. |
|
75 | - if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) { |
|
76 | - EE_Error::doing_it_wrong(__METHOD__, |
|
77 | - sprintf(__('%s has been registered too late. Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.', |
|
78 | - 'event_espresso'), $cap_reference), '4.5.0'); |
|
79 | - } |
|
80 | - //some preliminary sanitization and setting to the $_registry property |
|
81 | - self::$_registry[$cap_reference] = array( |
|
82 | - 'caps' => isset($setup_args['capabilities']) && is_array($setup_args['capabilities']) ? $setup_args['capabilities'] : array(), |
|
83 | - 'cap_maps' => isset($setup_args['capability_maps']) ? $setup_args['capability_maps'] : array(), |
|
84 | - ); |
|
85 | - //set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once) |
|
86 | - add_filter('FHEE__EE_Capabilities__init_caps_map__caps', |
|
87 | - array('EE_Register_Capabilities', 'register_capabilities'), 10); |
|
88 | - //add filter for cap maps |
|
89 | - add_filter('FHEE__EE_Capabilities___set_meta_caps__meta_caps', |
|
90 | - array('EE_Register_Capabilities', 'register_cap_maps'), 10); |
|
91 | - //init_role_caps to register new capabilities |
|
92 | - if (is_admin()) { |
|
93 | - EE_Registry::instance()->load_core('Capabilities'); |
|
94 | - EE_Capabilities::instance()->init_caps(); |
|
95 | - } |
|
96 | - } |
|
32 | + /** |
|
33 | + * Used to register capability items with EE core. |
|
34 | + * |
|
35 | + * @since 4.5.0 |
|
36 | + * @param string $cap_reference usually will be a class name |
|
37 | + * that references capability |
|
38 | + * related items setup for |
|
39 | + * something. |
|
40 | + * @param array $setup_args { |
|
41 | + * An array of items related to |
|
42 | + * registering capabilities. |
|
43 | + * @type array $capabilities An array mapping capability |
|
44 | + * strings to core WP Role. Something like: array( |
|
45 | + * 'administrator' => array( |
|
46 | + * 'read_cap', 'edit_cap', |
|
47 | + * 'delete_cap'), |
|
48 | + * 'author' => |
|
49 | + * array( 'read_cap' ) |
|
50 | + * ). |
|
51 | + * @type array $capability_maps EE_Meta_Capability_Map[] |
|
52 | + * @see EE_Capabilities.php for php docs on these objects. |
|
53 | + * Should be indexed by the |
|
54 | + * classname for the capability |
|
55 | + * map and values representing |
|
56 | + * the arguments for the map. |
|
57 | + * } |
|
58 | + * @throws EE_Error |
|
59 | + * @return void |
|
60 | + */ |
|
61 | + public static function register($cap_reference = null, $setup_args = array()) |
|
62 | + { |
|
63 | + //required fields MUST be present, so let's make sure they are. |
|
64 | + if (! isset($cap_reference) || ! is_array($setup_args) || empty($setup_args['capabilities'])) { |
|
65 | + throw new EE_Error( |
|
66 | + __('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".', |
|
67 | + 'event_espresso') |
|
68 | + ); |
|
69 | + } |
|
70 | + //make sure we don't register twice |
|
71 | + if (isset(self::$_registry[$cap_reference])) { |
|
72 | + return; |
|
73 | + } |
|
74 | + //make sure this is not registered too late or too early. |
|
75 | + if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) { |
|
76 | + EE_Error::doing_it_wrong(__METHOD__, |
|
77 | + sprintf(__('%s has been registered too late. Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.', |
|
78 | + 'event_espresso'), $cap_reference), '4.5.0'); |
|
79 | + } |
|
80 | + //some preliminary sanitization and setting to the $_registry property |
|
81 | + self::$_registry[$cap_reference] = array( |
|
82 | + 'caps' => isset($setup_args['capabilities']) && is_array($setup_args['capabilities']) ? $setup_args['capabilities'] : array(), |
|
83 | + 'cap_maps' => isset($setup_args['capability_maps']) ? $setup_args['capability_maps'] : array(), |
|
84 | + ); |
|
85 | + //set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once) |
|
86 | + add_filter('FHEE__EE_Capabilities__init_caps_map__caps', |
|
87 | + array('EE_Register_Capabilities', 'register_capabilities'), 10); |
|
88 | + //add filter for cap maps |
|
89 | + add_filter('FHEE__EE_Capabilities___set_meta_caps__meta_caps', |
|
90 | + array('EE_Register_Capabilities', 'register_cap_maps'), 10); |
|
91 | + //init_role_caps to register new capabilities |
|
92 | + if (is_admin()) { |
|
93 | + EE_Registry::instance()->load_core('Capabilities'); |
|
94 | + EE_Capabilities::instance()->init_caps(); |
|
95 | + } |
|
96 | + } |
|
97 | 97 | |
98 | 98 | |
99 | - /** |
|
100 | - * callback for FHEE__EE_Capabilities__init_caps_map__caps filter. |
|
101 | - * Takes care of registering additional capabilities to the caps map. Note, that this also on the initial |
|
102 | - * registration ensures that new capabilities are added to existing roles. |
|
103 | - * |
|
104 | - * @param array $incoming_caps The original caps map. |
|
105 | - * @return array merged in new caps. |
|
106 | - */ |
|
107 | - public static function register_capabilities($incoming_caps) |
|
108 | - { |
|
109 | - foreach (self::$_registry as $ref => $caps_and_cap_map) { |
|
110 | - $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']); |
|
111 | - } |
|
112 | - return $incoming_caps; |
|
113 | - } |
|
99 | + /** |
|
100 | + * callback for FHEE__EE_Capabilities__init_caps_map__caps filter. |
|
101 | + * Takes care of registering additional capabilities to the caps map. Note, that this also on the initial |
|
102 | + * registration ensures that new capabilities are added to existing roles. |
|
103 | + * |
|
104 | + * @param array $incoming_caps The original caps map. |
|
105 | + * @return array merged in new caps. |
|
106 | + */ |
|
107 | + public static function register_capabilities($incoming_caps) |
|
108 | + { |
|
109 | + foreach (self::$_registry as $ref => $caps_and_cap_map) { |
|
110 | + $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']); |
|
111 | + } |
|
112 | + return $incoming_caps; |
|
113 | + } |
|
114 | 114 | |
115 | 115 | |
116 | - /** |
|
117 | - * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of |
|
118 | - * capability maps for the WP meta_caps filter called in EE_Capabilities. |
|
119 | - * |
|
120 | - * @since 4.5.0 |
|
121 | - * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array. |
|
122 | - * @return EE_Meta_Capability_Map[] |
|
123 | - * @throws EE_Error |
|
124 | - */ |
|
125 | - public static function register_cap_maps($cap_maps) |
|
126 | - { |
|
127 | - //loop through and instantiate cap maps. |
|
128 | - foreach (self::$_registry as $cap_reference => $setup) { |
|
129 | - if (! isset($setup['cap_maps'])) { |
|
130 | - continue; |
|
131 | - } |
|
132 | - foreach ($setup['cap_maps'] as $cap_class => $args) { |
|
116 | + /** |
|
117 | + * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of |
|
118 | + * capability maps for the WP meta_caps filter called in EE_Capabilities. |
|
119 | + * |
|
120 | + * @since 4.5.0 |
|
121 | + * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array. |
|
122 | + * @return EE_Meta_Capability_Map[] |
|
123 | + * @throws EE_Error |
|
124 | + */ |
|
125 | + public static function register_cap_maps($cap_maps) |
|
126 | + { |
|
127 | + //loop through and instantiate cap maps. |
|
128 | + foreach (self::$_registry as $cap_reference => $setup) { |
|
129 | + if (! isset($setup['cap_maps'])) { |
|
130 | + continue; |
|
131 | + } |
|
132 | + foreach ($setup['cap_maps'] as $cap_class => $args) { |
|
133 | 133 | |
134 | - /** |
|
135 | - * account for cases where capability maps may be indexed |
|
136 | - * numerically to allow for the same map class to be utilized |
|
137 | - * In those cases, maps will be setup in an array like: |
|
138 | - * array( |
|
139 | - * 0 => array( 'EE_Meta_Capability' => array( |
|
140 | - * 'ee_edit_cap', array( 'Object_Name', |
|
141 | - * 'ee_edit_published_cap', |
|
142 | - * 'ee_edit_others_cap', 'ee_edit_private_cap' ) |
|
143 | - * ) ) |
|
144 | - * 1 => ... |
|
145 | - * ) |
|
146 | - * instead of: |
|
147 | - * array( |
|
148 | - * 'EE_Meta_Capability' => array( |
|
149 | - * 'ee_edit_cap', array( 'Object_Name', |
|
150 | - * 'ee_edit_published_cap', |
|
151 | - * 'ee_edit_others_cap', 'ee_edit_private_cap' ) |
|
152 | - * ), |
|
153 | - * ... |
|
154 | - * ) |
|
155 | - */ |
|
156 | - if (is_numeric($cap_class)) { |
|
157 | - $cap_class = key($args); |
|
158 | - $args = $args[$cap_class]; |
|
159 | - } |
|
134 | + /** |
|
135 | + * account for cases where capability maps may be indexed |
|
136 | + * numerically to allow for the same map class to be utilized |
|
137 | + * In those cases, maps will be setup in an array like: |
|
138 | + * array( |
|
139 | + * 0 => array( 'EE_Meta_Capability' => array( |
|
140 | + * 'ee_edit_cap', array( 'Object_Name', |
|
141 | + * 'ee_edit_published_cap', |
|
142 | + * 'ee_edit_others_cap', 'ee_edit_private_cap' ) |
|
143 | + * ) ) |
|
144 | + * 1 => ... |
|
145 | + * ) |
|
146 | + * instead of: |
|
147 | + * array( |
|
148 | + * 'EE_Meta_Capability' => array( |
|
149 | + * 'ee_edit_cap', array( 'Object_Name', |
|
150 | + * 'ee_edit_published_cap', |
|
151 | + * 'ee_edit_others_cap', 'ee_edit_private_cap' ) |
|
152 | + * ), |
|
153 | + * ... |
|
154 | + * ) |
|
155 | + */ |
|
156 | + if (is_numeric($cap_class)) { |
|
157 | + $cap_class = key($args); |
|
158 | + $args = $args[$cap_class]; |
|
159 | + } |
|
160 | 160 | |
161 | - if (! class_exists($cap_class)) { |
|
162 | - throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly. Capability map arrays must be indexed by capability map classname, and an array for the class arguments', |
|
163 | - 'event_espresso'), $cap_reference)); |
|
164 | - } |
|
161 | + if (! class_exists($cap_class)) { |
|
162 | + throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly. Capability map arrays must be indexed by capability map classname, and an array for the class arguments', |
|
163 | + 'event_espresso'), $cap_reference)); |
|
164 | + } |
|
165 | 165 | |
166 | - if (count($args) !== 2) { |
|
167 | - throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly. Capability map arrays must be indexed by capability map classname, and an array for the class arguments. The array should have two values the first being a string and the second an array.', |
|
168 | - 'event_espresso'), $cap_reference)); |
|
169 | - } |
|
170 | - $cap_maps[] = new $cap_class($args[0], $args[1]); |
|
171 | - } |
|
172 | - } |
|
173 | - return $cap_maps; |
|
174 | - } |
|
166 | + if (count($args) !== 2) { |
|
167 | + throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly. Capability map arrays must be indexed by capability map classname, and an array for the class arguments. The array should have two values the first being a string and the second an array.', |
|
168 | + 'event_espresso'), $cap_reference)); |
|
169 | + } |
|
170 | + $cap_maps[] = new $cap_class($args[0], $args[1]); |
|
171 | + } |
|
172 | + } |
|
173 | + return $cap_maps; |
|
174 | + } |
|
175 | 175 | |
176 | 176 | |
177 | - public static function deregister($cap_reference = null) |
|
178 | - { |
|
179 | - if (! empty(self::$_registry[$cap_reference])) { |
|
180 | - unset(self::$_registry[$cap_reference]); |
|
181 | - } |
|
177 | + public static function deregister($cap_reference = null) |
|
178 | + { |
|
179 | + if (! empty(self::$_registry[$cap_reference])) { |
|
180 | + unset(self::$_registry[$cap_reference]); |
|
181 | + } |
|
182 | 182 | |
183 | - //re init caps to grab the changes due to removed caps. |
|
184 | - EE_Capabilities::instance()->init_caps(); |
|
185 | - } |
|
183 | + //re init caps to grab the changes due to removed caps. |
|
184 | + EE_Capabilities::instance()->init_caps(); |
|
185 | + } |
|
186 | 186 | } |
@@ -6,7 +6,7 @@ discard block |
||
6 | 6 | * @subpackage plugin api, capabilities |
7 | 7 | * @since 4.5.0 |
8 | 8 | */ |
9 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
9 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
10 | 10 | exit('No direct script access allowed'); |
11 | 11 | } |
12 | 12 | |
@@ -61,7 +61,7 @@ discard block |
||
61 | 61 | public static function register($cap_reference = null, $setup_args = array()) |
62 | 62 | { |
63 | 63 | //required fields MUST be present, so let's make sure they are. |
64 | - if (! isset($cap_reference) || ! is_array($setup_args) || empty($setup_args['capabilities'])) { |
|
64 | + if ( ! isset($cap_reference) || ! is_array($setup_args) || empty($setup_args['capabilities'])) { |
|
65 | 65 | throw new EE_Error( |
66 | 66 | __('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".', |
67 | 67 | 'event_espresso') |
@@ -72,7 +72,7 @@ discard block |
||
72 | 72 | return; |
73 | 73 | } |
74 | 74 | //make sure this is not registered too late or too early. |
75 | - if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) { |
|
75 | + if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) { |
|
76 | 76 | EE_Error::doing_it_wrong(__METHOD__, |
77 | 77 | sprintf(__('%s has been registered too late. Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.', |
78 | 78 | 'event_espresso'), $cap_reference), '4.5.0'); |
@@ -126,7 +126,7 @@ discard block |
||
126 | 126 | { |
127 | 127 | //loop through and instantiate cap maps. |
128 | 128 | foreach (self::$_registry as $cap_reference => $setup) { |
129 | - if (! isset($setup['cap_maps'])) { |
|
129 | + if ( ! isset($setup['cap_maps'])) { |
|
130 | 130 | continue; |
131 | 131 | } |
132 | 132 | foreach ($setup['cap_maps'] as $cap_class => $args) { |
@@ -158,7 +158,7 @@ discard block |
||
158 | 158 | $args = $args[$cap_class]; |
159 | 159 | } |
160 | 160 | |
161 | - if (! class_exists($cap_class)) { |
|
161 | + if ( ! class_exists($cap_class)) { |
|
162 | 162 | throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly. Capability map arrays must be indexed by capability map classname, and an array for the class arguments', |
163 | 163 | 'event_espresso'), $cap_reference)); |
164 | 164 | } |
@@ -176,7 +176,7 @@ discard block |
||
176 | 176 | |
177 | 177 | public static function deregister($cap_reference = null) |
178 | 178 | { |
179 | - if (! empty(self::$_registry[$cap_reference])) { |
|
179 | + if ( ! empty(self::$_registry[$cap_reference])) { |
|
180 | 180 | unset(self::$_registry[$cap_reference]); |
181 | 181 | } |
182 | 182 |